texinfo ChangeLog doc/texinfo.txi

[Karl Berry]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       09/01/19 01:03:37

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        index commands should precede the indexed material

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.973&r2=1.974
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.236&r2=1.237

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.973
retrieving revision 1.974
diff -u -b -r1.973 -r1.974
--- ChangeLog   19 Jan 2009 00:51:47 -0000      1.973
+++ ChangeLog   19 Jan 2009 01:03:36 -0000      1.974
@@ -1,5 +1,8 @@
 2009-01-18  Karl Berry  <address@hidden>
 
+       * doc/texinfo.txi (Indexing Commands): document that index
+       commands should precede the indexed material.
+
        * doc/txirefcard.tex: update copyright date.
 
        * doc/texinfo.txi (@raggedright): minor tweaks.

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.236
retrieving revision 1.237
diff -u -b -r1.236 -r1.237
--- doc/texinfo.txi     19 Jan 2009 00:51:47 -0000      1.236
+++ doc/texinfo.txi     19 Jan 2009 01:03:37 -0000      1.237
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.236 2009/01/19 00:51:47 karl Exp $
address@hidden $Id: texinfo.txi,v 1.237 2009/01/19 01:03:37 karl Exp $
 @c Ordinarily, Texinfo files have the extension .texi.  But texinfo.texi
 @c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
 
@@ -9874,12 +9874,32 @@
 case-sensitive name such as a C or Lisp function name or a shell
 command; that would be a spelling error.
 
-Whichever case convention you use, please use it consistently!
+Whichever case convention you use, use it consistently.
 
 Entries in indices other than the concept index are symbol names in
 programming languages, or program names; these names are usually
 case-sensitive, so use upper and lower case as required for them.
 
+Index entries should precede the visible material that is being
+indexed.  For instance:
+
address@hidden
address@hidden 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 if an index command follows the material, there can be a spurious
address@hidden space in the output, which can end up as a whole extra blank line
address@hidden in TeX.  This is the glue between the last character in the
address@hidden paragraph and the whatsit from the index.  The solution is to
address@hidden comment out the space, as in:
address@hidden     He said, "Hello, there!"address@hidden
address@hidden     @cindex hello
+
 @cindex 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
@@ -19237,7 +19257,7 @@
 (@url{http://www.gnu.org/software/rcs}) version control systems, which
 expand it into a string such as:
 @example
-$Id: texinfo.txi,v 1.236 2009/01/19 00:51:47 karl Exp $
+$Id: texinfo.txi,v 1.237 2009/01/19 01:03:37 karl Exp $
 @end example
 (This is useful in all sources that use version control, not just manuals.)
 You may wish to include the @samp{$Id:} comment in the @code{@@copying}
@@ -19313,7 +19333,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.236 2009/01/19 00:51:47 karl Exp $
address@hidden $Id: texinfo.txi,v 1.237 2009/01/19 01:03:37 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi