[6484] combine Beginning and Ending a File

[Gavin D. Smith]

Revision: 6484
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6484
Author:   gavin
Date:     2015-07-29 18:09:24 +0000 (Wed, 29 Jul 2015)
Log Message:
-----------
combine Beginning and Ending a File

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

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2015-07-29 16:51:22 UTC (rev 6483)
+++ trunk/ChangeLog     2015-07-29 18:09:24 UTC (rev 6484)
@@ -1,5 +1,17 @@
 2015-07-29  Gavin Smith  <address@hidden>
 
+       * doc/texinfo.texi (Printing Indices & Menus): Move node to 
+       indices chapter.
+       (Ending a File): Add cross-reference to Printing Indices & 
+       Menus.
+       (File End): Move into end of Ending a File.
+       (Ending a File): Subordinate to Beginning a File chapter.
+       (Beginning a File): Rename Beginning and Ending a File.  (This 
+       also makes the document short table of contents fit on a single 
+       page.)  Remove a sentence.
+
+2015-07-29  Gavin Smith  <address@hidden>
+
        * info/nodes.c (info_node_of_tag): Don't save a pointer into a 
        file buffer, only an offset.
 

Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi      2015-07-29 16:51:22 UTC (rev 6483)
+++ trunk/doc/texinfo.texi      2015-07-29 18:09:24 UTC (rev 6484)
@@ -133,8 +133,7 @@
 * Copying Conditions::          Your rights.
 * Overview::                    Texinfo in brief.
 * Texinfo Mode::                Using the GNU Emacs Texinfo mode.
-* Beginning a File::            What is at the beginning of a Texinfo file?
-* Ending a File::               What is at the end of a Texinfo file?
+* Beginning and Ending a File:: Beginning and end of a Texinfo file.
 * Chapter Structuring::         Creating chapters, sections, appendices, etc.
 * Nodes::                       Writing nodes, the basic unit of Texinfo.
 * Menus::                       Writing menus.
@@ -266,7 +265,6 @@
 
 * Printing Indices & Menus::    How to print an index in hardcopy and
                                  generate index menus in Info.
-* File End::                    How to mark the end of a file.
 
 Chapter Structuring
 
@@ -1568,9 +1566,9 @@
 boilerplate; when writing a manual, you simply change the names as
 appropriate.
 
address@hidden a File}, for full documentation on the commands listed
-here.  @xref{GNU Sample Texts}, for the full texts to be used in GNU
-manuals.
address@hidden and Ending a File}, for full documentation on the 
+commands listed here.  @xref{GNU Sample Texts}, for the full texts to be 
+used in GNU manuals.
 
 In the following, the sample text is @emph{indented}; comments on it are
 not.  The complete file, without interspersed comments, is shown in
@@ -2806,21 +2804,21 @@
 @end example
 
 
address@hidden Beginning a File
address@hidden Beginning a Texinfo File
address@hidden Beginning and Ending a File
address@hidden a File} @c old name
address@hidden Beginning and Ending a Texinfo File
 @cindex Beginning a Texinfo file
 @cindex Texinfo file beginning
 @cindex File beginning
 
+This chapter expands on the minimal complete Texinfo source file
+previously given (@pxref{Six Parts}).
+
 Certain pieces of information must be provided at the beginning of a
 Texinfo file, such as the name for the output file(s), the title of the
 document, and the Top node.  A table of contents is also generally
 produced here.
 
-This chapter expands on the minimal complete Texinfo source file
-previously given (@pxref{Six Parts}).  It describes the numerous
-commands for handling the traditional frontmatter items in Texinfo.
-
 @cindex Frontmatter, text in
 Straight text outside of any command before the Top node should be
 avoided.  Such text is treated differently in the different output
@@ -2835,6 +2833,7 @@
 * Contents::                    How to create a table of contents.
 * The Top Node::                Creating the `Top' node and master menu.
 * Global Document Commands::    Affecting formatting throughout.
+* Ending a File::               What is at the end of a Texinfo file?
 @end menu
 
 
@@ -4205,15 +4204,15 @@
 
 
 @node Ending a File
address@hidden Ending a Texinfo File
address@hidden Ending a Texinfo File
 @cindex Ending a Texinfo file
 @cindex Texinfo file ending
 @cindex File ending
 @findex bye
 
-The end of a Texinfo file should include commands to create indices,
-and the @code{@@bye} command to mark the last line to be processed.
-For example:
+The end of a Texinfo file should include commands to create indices
+(@pxref{Printing Indices & Menus}), and the @code{@@bye} command to mark
+the last line to be processed.  For example:
 
 @example
 @@node Index
@@ -4224,110 +4223,8 @@
 @@bye
 @end example
 
address@hidden
-* Printing Indices & Menus::    How to print an index in hardcopy and
-                                 generate index menus in Info.
-* File End::                    How to mark the end of a file.
address@hidden menu
-
-
address@hidden Printing Indices & Menus
address@hidden Printing Indices and Menus
address@hidden Printing an index
address@hidden Indices, printing and menus
address@hidden Generating menus with indices
address@hidden 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
address@hidden (@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.  @xref{Indices}, for information on this, as well
-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
address@hidden@@printindex} command.
-
address@hidden printindex
address@hidden@@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.
-
-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
-a suitable section or chapter command (usually @code{@@appendix} or
address@hidden@@unnumbered}) to supply the chapter heading and put the index
-into the table of contents.  Precede the chapter heading with an
address@hidden@@node} line as usual.
-
-For example:
-
address@hidden
address@hidden
-@@node Variable Index
-@@unnumbered Variable Index
-
-@@printindex vr
address@hidden group
-
address@hidden
-@@node Concept Index
-@@unnumbered Concept Index
-
-@@printindex cp
address@hidden group
address@hidden smallexample
-
-If you have more than one index, we recommend placing the concept index last.
-
address@hidden
address@hidden
-In printed output, @code{@@printindex} produces a traditional
-two-column index, with dot leaders between the index terms and page
-numbers.
-
address@hidden
-In Info output, @code{@@printindex} produces a special menu containing
-the line number of the entry, relative to the start of the node.  Info
-readers can use this to go to the exact line of an entry, not just the
-containing node.  (Older Info readers will just go to the node.)
-Here's an example:
-
address@hidden
-* First index entry:   Top.   (line  7)
address@hidden smallexample
-
address@hidden The actual number of spaces is variable, to right-justify
-the line number; it's been reduced here to make the line fit in the
-printed manual.
-
address@hidden
-In plain text output, @code{@@printindex} produces the same menu, but
-the line numbers are relative to the start of the file, since that's
-more convenient for that format.
-
address@hidden
-In HTML output, @code{@@printindex} produces links to the index
-entries.
-
address@hidden
-In XML and Docbook output, it simply records the index to be printed.
address@hidden itemize
-
-
address@hidden File End
address@hidden @code{@@bye} File Ending
 @findex bye
-
address@hidden End}
 An @code{@@bye} command terminates Texinfo processing.  None of the
 formatters process anything following @code{@@bye}; any such text is
 completely ignored.  The @code{@@bye} command should be on a line by
@@ -10422,6 +10319,8 @@
 * Predefined Indices::          Use different indices for different kinds
                                  of entries.
 * Indexing Commands::           How to make an index entry.
+* Printing Indices & Menus::    How to print an index in hardcopy and
+                                 generate index menus in Info.
 * Combining Indices::           How to combine indices.
 * New Indices::                 How to define your own indices.
 @end menu
@@ -10607,6 +10506,99 @@
 @end quotation
 
 
address@hidden Printing Indices & Menus
address@hidden Printing Indices and Menus
address@hidden Printing an index
address@hidden Indices, printing and menus
address@hidden Generating menus with indices
address@hidden 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
address@hidden (@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.  @xref{Indices}, for information on this, as well
+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
address@hidden@@printindex} command.
+
address@hidden printindex
address@hidden@@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.
+
+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
+a suitable section or chapter command (usually @code{@@appendix} or
address@hidden@@unnumbered}) to supply the chapter heading and put the index
+into the table of contents.  Precede the chapter heading with an
address@hidden@@node} line as usual.
+
+For example:
+
address@hidden
address@hidden
+@@node Variable Index
+@@unnumbered Variable Index
+
+@@printindex vr
address@hidden group
+
address@hidden
+@@node Concept Index
+@@unnumbered Concept Index
+
+@@printindex cp
address@hidden group
address@hidden smallexample
+
+If you have more than one index, we recommend placing the concept index last.
+
address@hidden
address@hidden
+In printed output, @code{@@printindex} produces a traditional
+two-column index, with dot leaders between the index terms and page
+numbers.
+
address@hidden
+In Info output, @code{@@printindex} produces a special menu containing
+the line number of the entry, relative to the start of the node.  Info
+readers can use this to go to the exact line of an entry, not just the
+containing node.  (Older Info readers will just go to the node.)
+Here's an example:
+
address@hidden
+* First index entry:   Top.   (line  7)
address@hidden smallexample
+
address@hidden The actual number of spaces is variable, to right-justify
+the line number; it's been reduced here to make the line fit in the
+printed manual.
+
address@hidden
+In plain text output, @code{@@printindex} produces the same menu, but
+the line numbers are relative to the start of the file, since that's
+more convenient for that format.
+
address@hidden
+In HTML output, @code{@@printindex} produces links to the index
+entries.
+
address@hidden
+In XML and Docbook output, it simply records the index to be printed.
address@hidden itemize
+
+
 @node Combining Indices
 @section Combining Indices
 @cindex Combining indices
@@ -22693,8 +22685,8 @@
 benefit from them.
 
 @xref{Short Sample}, for a minimal example of a Texinfo file.
address@hidden a File}, for a full explanation of that minimal
-example.
address@hidden and Ending a File}, for a full explanation of that
+minimal example.
 
 Here are some notes on the example: