[6573] document @sortas

[Gavin D. Smith]

Revision: 6573
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6573
Author:   gavin
Date:     2015-08-25 15:43:38 +0000 (Tue, 25 Aug 2015)
Log Message:
-----------
document @sortas

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/doc/texinfo.texi

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2015-08-25 15:21:04 UTC (rev 6572)
+++ trunk/ChangeLog     2015-08-25 15:43:38 UTC (rev 6573)
@@ -1,5 +1,14 @@
 2015-08-25  Gavin Smith  <address@hidden>
 
+       * doc/texinfo.texi (Indexing Commands): Document @sortas{}.  
+       Move example usage earlier.  Move discussion of typeface 
+       earlier, leaving general advice on writing index entries at the 
+       end.
+       (Index Entries): Move to after Indexing Commands, and move 
+       advice from there to here.
+
+2015-08-25  Gavin Smith  <address@hidden>
+
        * doc/texinfo.texi (Writing a Texinfo File): Add a short blurb 
        to say what chapter is about.
 

Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi      2015-08-25 15:21:04 UTC (rev 6572)
+++ trunk/doc/texinfo.texi      2015-08-25 15:43:38 UTC (rev 6573)
@@ -9344,10 +9344,10 @@
 purpose.  Lastly, you can define your own new indices.
 
 @menu
-* Index Entries::               Choose different words for index entries.
 * Predefined Indices::          Use different indices for different kinds
                                  of entries.
 * Indexing Commands::           How to make an index entry.
+* Index Entries::               Choose different words for index entries.
 * Printing Indices & Menus::    How to print an index in hardcopy and
                                  generate index menus in Info.
 * Combining Indices::           How to combine indices.
@@ -9355,31 +9355,6 @@
 @end menu
 
 
address@hidden Index Entries
address@hidden Making Index Entries
address@hidden Index entries, making
address@hidden Entries, making index
-
-When you are making index entries, it is good practice to think of the
-different ways people may look for something.  Different people
address@hidden not} think of the same words when they look something up.  A
-helpful index will have items indexed under all the different words
-that people may use.  For example, one reader may think it obvious
-that the two-letter names for indices should be listed under
-``Indices, two-letter names, since ``Indices'' are the general
-concept.  But another reader may remember the specific concept of
-two-letter names and search for the entry listed as ``Two letter names
-for indices''.  A good index will have both entries and will help both
-readers.
-
-Like typesetting, the construction of an index is a skilled art, the
-subtleties of which may not be appreciated until you need to do it
-yourself.
-
address@hidden Indices & Menus}, for information about printing an
-index at the end of a book or creating an index menu in an Info file.
-
-
 @node Predefined Indices
 @section Predefined Indices
 
@@ -9475,6 +9450,49 @@
 for the concept index, @code{@@findex} for the function index, and so
 on, as listed in the previous section.
 
+Index entries should precede the visible material that is being
+indexed.  For instance:
+
address@hidden
+@@cindex hello
+Hello, there!
address@hidden example
+
address@hidden Among other reasons, that way following indexing links (in
+whatever context) ends up before the material, where readers want to
+be, instead of after.
+
address@hidden Index font types
+By default, entries for a concept index are printed in a small roman
+font and entries for the other indices are printed in a small
address@hidden@@code} font.  You may change the way part of an entry is
+printed with the usual Texinfo commands, such as @code{@@file} for
+file names (@pxref{Marking Text}), and @code{@@r} for the normal roman
+font (@pxref{Fonts}).
+
address@hidden sortas
address@hidden 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{@@sortkey} immediately 
+following the index command.  For example: @samp{@@findex 
+@@address@hidden@} \mathopsup}.
+
address@hidden 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
+confuses Info.  @xref{Menu Parts}, for more information about the
+structure of a menu entry.
address@hidden quotation
+
address@hidden Index Entries
address@hidden Making Index Entries
address@hidden Index entries, making
address@hidden Entries, making index
+
 @cindex Writing index entries
 @cindex Index entries, advice on writing
 @cindex Advice on writing entries
@@ -9507,34 +9525,24 @@
 specific, so readers can more easily find the exact place they are
 looking for.
 
-Index entries should precede the visible material that is being
-indexed.  For instance:
 
address@hidden
-@@cindex hello
-Hello, there!
address@hidden example
+When you are making index entries, it is good practice to think of the
+different ways people may look for something.  Different people
address@hidden not} think of the same words when they look something up.  A
+helpful index will have items indexed under all the different words
+that people may use.  For example, one reader may think it obvious
+that the two-letter names for indices should be listed under
+``Indices, two-letter names, since ``Indices'' are the general
+concept.  But another reader may remember the specific concept of
+two-letter names and search for the entry listed as ``Two letter names
+for indices''.  A good index will have both entries and will help both
+readers.
 
address@hidden Among other reasons, that way following indexing links (in
-whatever context) ends up before the material, where readers want to
-be, instead of after.
+Like typesetting, the construction of an index is a skilled art, the
+subtleties of which may not be appreciated until you need to do it
+yourself.
 
address@hidden Index font types
-By default, entries for a concept index are printed in a small roman
-font and entries for the other indices are printed in a small
address@hidden@@code} font.  You may change the way part of an entry is
-printed with the usual Texinfo commands, such as @code{@@file} for
-file names (@pxref{Marking Text}), and @code{@@r} for the normal roman
-font (@pxref{Fonts}).
 
address@hidden 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
-confuses Info.  @xref{Menu Parts}, for more information about the
-structure of a menu entry.
address@hidden quotation
-
-
 @node Printing Indices & Menus
 @section Printing Indices and Menus
 @cindex Printing an index