[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[6721] update documentation of index entry sort keys
From: |
Gavin D. Smith |
Subject: |
[6721] update documentation of index entry sort keys |
Date: |
Fri, 23 Oct 2015 12:46:39 +0000 |
Revision: 6721
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6721
Author: gavin
Date: 2015-10-23 12:46:37 +0000 (Fri, 23 Oct 2015)
Log Message:
-----------
update documentation of index entry sort keys
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/texinfo.texi
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2015-10-23 11:40:58 UTC (rev 6720)
+++ trunk/ChangeLog 2015-10-23 12:46:37 UTC (rev 6721)
@@ -1,3 +1,8 @@
+2015-10-23 Gavin Smith <address@hidden>
+
+ * doc/texinfo.texi (Indexing Commands): Update to mention
+ txiindexhyphenignore etc.
+
2015-10-21 Gavin Smith <address@hidden>
* doc/texinfo.tex (\scanmacro, \commondummiesnofonts): Remove
Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi 2015-10-23 11:40:58 UTC (rev 6720)
+++ trunk/doc/texinfo.texi 2015-10-23 12:46:37 UTC (rev 6721)
@@ -9135,17 +9135,29 @@
@findex sortas
@cindex sort keys for index entries
@cindex index sorting
-For the printed output, some characters are ignored in the text for
-index entries for the purposes of sorting. For example, the
address@hidden entry in the index for this manual is sorted as if it
-were @samp{mathopsup}, as if the backslash were not there. Hence, it
-will appear among the other entries beginning `M'.
+For the printed output, you may specify an explicit sort key for an
+index entry using @code{@@sortas} immediately following the index
+command. For example: @samp{@@findex @@address@hidden@} \
@@address@hidden(literal
+\ in @@address@hidden@@@@address@hidden)} sorts the index entry this produces
under
+backslash.
-You may specify an explicit sort key with @code{@@sortas} immediately
-following the index command. For example: @samp{@@findex @@address@hidden@}
-\ @@address@hidden(literal \ in @@address@hidden@@@@address@hidden)} sorts the
index entry this
-produces under backslash.
address@hidden txiindexbackslashignore
address@hidden txiindexhyphenignore
address@hidden txiindexlessthanignore
address@hidden txiindexatsignignore
+To reduce the quantity of sort keys you need to provide explicitly,
+you may choose to ignore certain characters in index entries
+for the purposes of sorting. The characters that you can
+currently choose to ignore are @samp{\}, @samp{-}, @samp{<}
+and @samp{@@}, which are ignored by giving as an argument to the
address@hidden@@set} command, respectively, @code{txiindexbackslashignore},
address@hidden, @code{txiindexlessthanignore} and
address@hidden For example, specifying @samp{@@set
+txiindexbackslashignore} causes the @samp{\mathopsup} entry in the
+index for this manual to be sorted as if it were @samp{mathopsup},
+so that it appears among the other entries beginning `M'.
+
@quotation Caution
Do not use a colon in an index entry. In Info, a colon separates the
menu entry name from the node name, so a colon in the entry itself
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [6721] update documentation of index entry sort keys,
Gavin D. Smith <=