branch master updated: Document index node name requirement

[Gavin D. Smith]

This is an automated email from the git hooks/post-receive script.

gavin pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new d46dc21da4 Document index node name requirement
d46dc21da4 is described below

commit d46dc21da400c1e1563fa5b6397c140ba9cec232
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Wed Mar 9 18:01:40 2022 +0000

    Document index node name requirement
    
    * doc/texinfo.tex (Printing Indices & Menus): Document
    requirement for "Index" to appear in node name.  Edit and
    trim extraneous language.
    (Advanced Indexing): Edit slightly.
---
 ChangeLog        |  9 +++++++++
 doc/texinfo.texi | 49 +++++++++++++++++++++----------------------------
 2 files changed, 30 insertions(+), 28 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 4d249bca24..2d082703b9 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2022-03-09  Gavin Smith  <gavinsmith0123@gmail.com>
+
+       Document index node name requirement
+
+       * doc/texinfo.tex (Printing Indices & Menus): Document
+       requirement for "Index" to appear in node name.  Edit and
+       trim extraneous language.
+       (Advanced Indexing): Edit slightly.
+
 2022-03-09  Gavin Smith  <gavinsmith0123@gmail.com>
 
        Find first index entry under initial substring search
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 98864224b9..d07cce8df9 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -8689,8 +8689,7 @@ so that it appears among the other entries beginning with 
`M'.
 @cindex Indexing, advanced
 @cindex Advanced indexing
 
-Texinfo provides several commands for doing advanced indexing,
-similar to the indices you may see in professionally published books.
+Texinfo provides several further commands for indexing,
 
 @findex @@subentry
 First, you can create @dfn{multilevel} index entries, allowing you
@@ -8745,7 +8744,7 @@ place a comma between the different parts of the index 
text. The
 generates the indexing formatting commands, takes care of placing
 commas in the correct places for you.
 
-These features are most useful with printed documents created
+These features are the most useful with printed documents created
 with @TeX{}, and when translating Texinfo to DocBook.
 
 @node Index Entries
@@ -8812,32 +8811,16 @@ yourself.
 @cindex Generating menus with indices
 @cindex Menus generated with indices
 
-To print an index means to include it as part of a manual or Info file.
-This does not happen automatically just because you use @code{@@cindex}
-or other index-entry generating commands in the Texinfo file; those just
-cause the raw data for the index to be accumulated.  To generate an
-index, you must include the @code{@@printindex} command at the place in
-the document where you want the index to appear.  Also, as part of the
-process of creating a printed manual, you must run a program called
-@code{texindex} (@pxref{Hardcopy}) to sort the raw data to produce a
-sorted index file.  The sorted index file is what is actually used to
-print the index.
-
-Texinfo offers six separate types of predefined index, which suffice in
-most cases. See the other parts of this chapter for information on this,
-as well as advanced indexing commands, defining your own new indices,
-combining indices, and, most importantly, advice on writing the actual
-index entries.  This section focuses on printing indices, which is done
-with the @code{@@printindex} command.
 
 @findex printindex
 @code{@@printindex} takes one argument, a two-letter index
-abbreviation.  It reads the corresponding sorted index file (for
-printed output), and formats it appropriately into an index.
+abbreviation.  You must include the @code{@@printindex} command at the
+place in the document where you want the index to appear.  This does
+not happen automatically just because you use @code{@@cindex} or other
+index-entry generating commands in the Texinfo file; those just cause
+the raw data for the index to be accumulated.
 
-The @code{@@printindex} command does not generate a chapter heading
-for the index, since different manuals have different needs.
-Consequently, you should precede the @code{@@printindex} command with
+You should precede the @code{@@printindex} command with
 a suitable section or chapter command (usually @code{@@appendix} or
 @code{@@unnumbered}) to supply the chapter heading and put the index
 into the table of contents.  Precede the chapter heading with an
@@ -8861,13 +8844,23 @@ For example:
 @end group
 @end example
 
+The text @samp{Index} needs to appear in the name of the node containing the
+index for the index to be found by Info readers.
+
 If you have more than one index, we recommend placing the concept index last.
 
+Other details of index output in output formats:
+
 @itemize
 @item
-In printed output, @code{@@printindex} produces a traditional
-two-column index, with dot leaders between the index terms and page
-numbers.
+As part of the process of creating a printed manual, you run a program called
+@code{texindex} (@pxref{Hardcopy}) to sort the raw data to produce a
+sorted index file.  The sorted index file is what is actually used to
+print the index.
+
+@code{@@printindex} reads the corresponding sorted index file and produces
+a traditional two-column index, with dot leaders between the index terms
+and page numbers.
 
 @item
 In Info output, @code{@@printindex} produces a special menu containing