[6593] documentation of @sortas

[Gavin D. Smith]

Revision: 6593
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6593
Author:   gavin
Date:     2015-09-03 22:13:22 +0000 (Thu, 03 Sep 2015)
Log Message:
-----------
documentation of @sortas

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/NEWS
    trunk/doc/refcard/txirefcard-a4.pdf
    trunk/doc/refcard/txirefcard.pdf
    trunk/doc/refcard/txirefcard.tex
    trunk/doc/texinfo.texi

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2015-09-03 20:49:54 UTC (rev 6592)
+++ trunk/ChangeLog     2015-09-03 22:13:22 UTC (rev 6593)
@@ -1,5 +1,13 @@
 2015-08-03  Gavin Smith  <address@hidden>
 
+       * doc/texinfo.texi (Indexing Commands): Update documentation of 
+       @sortas.
+       (Command List): Add @sortas.
+       * doc/refcard/txirefcard.tex: Add @sortas.
+       * NEWS: Mention @sortas.
+
+2015-08-03  Gavin Smith  <address@hidden>
+
        * doc/texinfo.tex: Let - always be active, and set it to 
        \normaldash.
        (\indexnonalnumdisappear, \indexnonalnumreappear): New control 

Modified: trunk/NEWS
===================================================================
--- trunk/NEWS  2015-09-03 20:49:54 UTC (rev 6592)
+++ trunk/NEWS  2015-09-03 22:13:22 UTC (rev 6593)
@@ -30,6 +30,10 @@
     given explicitly.
 
 * texinfo.tex:
+  . A few characters (like \ and -) are now ignored in index entries for
+    the purposes of sorting.  You may explicity specify a sort key by
+    preceding the text of the entry with the @sortas commmand with the
+    sort key desired as a braced argument.
   . The default indices (cp, ky and so on) now don't get a file opened
     for them unless they are actually used.  This reduces the number of
     files that a run of TeX produces, and also allows for a greater

Modified: trunk/doc/refcard/txirefcard-a4.pdf
===================================================================
(Binary files differ)

Modified: trunk/doc/refcard/txirefcard.pdf
===================================================================
(Binary files differ)

Modified: trunk/doc/refcard/txirefcard.tex
===================================================================
--- trunk/doc/refcard/txirefcard.tex    2015-09-03 20:49:54 UTC (rev 6592)
+++ trunk/doc/refcard/txirefcard.tex    2015-09-03 22:13:22 UTC (rev 6593)
@@ -667,6 +667,8 @@
 address@hidden to-index}{Merge the contents of \var{from-index} into 
\code{to-index}, formatting the entries in \var{from-index} with address@hidden
 address@hidden to-index}{Merge the contents of \var{from-index} into 
\var{to-index}; no special formatting.}
 address@hidden an alphabetized index (using two columns in a printed manual).}
address@hidden a string by which to sort an 
+index entry.}
 
 
 \section{Insertions within a paragraph}

Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi      2015-09-03 20:49:54 UTC (rev 6592)
+++ trunk/doc/texinfo.texi      2015-09-03 22:13:22 UTC (rev 6593)
@@ -9359,15 +9359,18 @@
 
 @findex sortas
 @cindex sort keys for index entries
-Sometimes you may wish to have an index entry sorted as if it were
-something else.  For example, the index for this manual has an entry
address@hidden@@findex \mathopsup}.  In the printed output, this will be sorted 
-under its first character, a backslash, but it might be nicer to sort it 
-under the letter `M', as if the backslash were not there.  For such 
-cases, you can specify a sort key with @code{@@sortas} immediately 
-following the index command.  For example: @samp{@@findex 
-@@address@hidden@} \mathopsup}.
address@hidden 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'.
 
+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.
+
 @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
@@ -20655,6 +20658,10 @@
 Like @code{@@quotation}, but use a smaller font size where possible.
 Pair with @code{@@end smallquotation}.  @address@hidden@@address@hidden
 
address@hidden @@sortas @address@hidden@}
+Used in the arguments to index commands to give a string by which the 
+index entry should be sorted.  @xref{Indexing Commands}.
+
 @item @@sp @var{n}
 Skip @var{n} blank lines.  @address@hidden@@sp}}.