texinfo ChangeLog doc/texinfo.txi

[karl]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     karl <karl>     13/01/25 18:23:10

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        document and use indent_menu_descriptions (and regenerate_master_menu)

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1528&r2=1.1529
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.532&r2=1.533

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1528
retrieving revision 1.1529
diff -u -b -r1.1528 -r1.1529
--- ChangeLog   22 Jan 2013 00:46:35 -0000      1.1528
+++ ChangeLog   25 Jan 2013 18:23:09 -0000      1.1529
@@ -1,3 +1,10 @@
+2013-01-25  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (Other Customization Variables)
+       <TEXINFO_COLUMN_FOR_DESCRIPTION>: new.
+       <TREE_TRANSFORMATIONS>: add indent_menu_descriptions.
+       Also, use it to re-indent the menus and regenerate_master_menu.
+
 2013-01-21  Karl Berry  <address@hidden>
 
        * doc/texinfo.txi (Raw Formatter Commands): be more emphatic

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.532
retrieving revision 1.533
diff -u -b -r1.532 -r1.533
--- doc/texinfo.txi     22 Jan 2013 00:46:35 -0000      1.532
+++ doc/texinfo.txi     25 Jan 2013 18:23:10 -0000      1.533
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.532 2013/01/22 00:46:35 karl Exp $
address@hidden $Id: texinfo.txi,v 1.533 2013/01/25 18:23:10 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.
 
@@ -169,7 +169,7 @@
 * Headings::                      How to write page headings and footings.
 * Catching Mistakes::             How to find mistakes in formatting.
 * Info Format Specification::     Technical details of the Info file format.
-* GNU Free Documentation License::Copying this manual.
+* GNU Free Documentation License:: Copying this manual.
 * Command and Variable Index::    A menu containing commands and variables.
 * General Index::                 A menu covering many topics.
 
@@ -664,12 +664,6 @@
 * Verbatim Copying License::
 * All-permissive Copying License::
 
-GNU Sample
-
-* Invoking sample::
-* GNU Free Documentation License::
-* Index::
-
 Page Headings
 
 * Headings Introduced::         Conventions for using page headings.
@@ -713,7 +707,6 @@
 * Image: Info Format Image.
 * Printindex: Info Format Printindex.
 * Xref:  Info Format Cross Reference.
-
 @end detailmenu
 @end menu
 
@@ -2144,8 +2137,10 @@
 @xref{Pages, , , emacs, The GNU Emacs Manual}, for more information
 about the page commands.
 
+
 @node Updating Nodes and Menus
 @section Updating Nodes and Menus
+
 @cindex Updating nodes and menus
 @cindex Create nodes, menus automatically
 @cindex Insert nodes, menus automatically
@@ -2158,7 +2153,7 @@
 `Previous', and `Up' pointers into an @code{@@node} line that has none
 and to create menus in a file that has none.
 
-If you do not use the updating commands, you need to write menus and
+If you do not use any updating commands, you need to write menus and
 node pointers by hand, which is a tedious task.
 
 @menu
@@ -12655,8 +12650,7 @@
 
 @noindent produces:
 
address@hidden fn-name @
-  arg1 arg2 arg3
address@hidden fn-name   arg1 arg2 arg3
 This is the basic continued defun.
 @end defun
 
@@ -13025,8 +13019,7 @@
 produces:
 
 @quotation
address@hidden {Library Function} int foobar @
- (int @var{foo}, float @var{bar})
address@hidden {Library Function} int foobar  (int @var{foo}, float @var{bar})
 @dots{}
 @end deftypefn
 @end quotation
@@ -17919,6 +17912,11 @@
 @item NO_CSS
 For address@hidden  Do not use CSS; default false.  @xref{HTML CSS}.
 
address@hidden NO_USE_SETFILENAME
+If set, do not use @code{@@setfilename} to set the document name;
+instead, base the output document name only on the input file name.
+The default is false.
+
 @item NODE_FILE_EXTENSION
 For address@hidden  Extension for node files if @code{NODE_FILENAMES} is set;
 default @samp{html}.
@@ -18054,6 +18052,11 @@
 Generate HTML and try to be as compatible as possible with
 @command{texi2html}; default false.
 
address@hidden TEXINFO_COLUMN_DESCRIPTION
+Used with the @code{indent_menu_descriptions} tree transformation,
+described below; default 32 (matching
address@hidden in Emacs)).
+
 @item TEXINFO_DTD_VERSION
 For address@hidden  Version of the DTD used in the XML output preamble.  The
 default is set based on a variable in @file{configure.ac}.
@@ -18096,11 +18099,29 @@
 
 @item TREE_TRANSFORMATIONS
 The associated value is a comma separated list of transformations that
-can be applied to the Texinfo tree prior to outputting the result.
+can be applied to the Texinfo tree prior to outputting the result.  If
+more than one is specified, the ordering is irrelevant; each is always
+applied at the necessary point during processing.
+
 The only one executed by default is
 @samp{move_index_entries_after_items} for HTML and Docbook output.
+Here's an example of updating the master menu in a document:
+
address@hidden
+makeinfo \
+  -c TREE_TRANSFORMATIONS=regenerate_master_menu \
+  -c PLAINTEXINFO=1 \
+  mydoc.texi \
+  -o /tmp/out
address@hidden example
+
address@hidden (Caveat: Since @code{PLAINTEXINFO} output does expand
+Texinfo macros and conditionals, it's necessary to remove any such
+differences before installing the updates in the original document.
+This will be remedied in a future release.)
 
-The following transformations are currently supported:
+The following transformations are currently supported (many are used
+in the @code{pod2texi} utility distributed with Texinfo):
 
 @ftable @samp
 @item complete_tree_nodes_menus
@@ -18112,6 +18133,10 @@
 For example, an @code{@@unnumberedsec} will be inserted if an
 @code{@@chapter} is followed by an @code{@@subsection}.
 
address@hidden indent_menu_descriptions
+Reformat menus so that descriptions start at column
address@hidden
+
 @item insert_nodes_for_sectioning_commands
 Insert nodes for sectioning commands lacking a corresponding node.
 
@@ -18119,18 +18144,18 @@
 In @code{@@enumerate} and @code{@@itemize}, move index entries
 appearing just before an @code{@@item} to just after the
 @code{@@item}.  Comment lines between index entries are moved too.  As
-mentioned above, this is always done for HTML and Docbook output.
-
address@hidden simple_menu
-Does the same as @code{SIMPLE_MENU}: use a simple preformatted style
-for the menu.  It differs from setting @code{SIMPLE_MENU} in that
address@hidden only has an effect in HTML output.
+mentioned, this is always done for HTML and Docbook output.
 
 @item regenerate_master_menu
 Update the Top node master menu, either replacing the (first)
 @code{@@detailmenu} in the Top node menu, or creating it at the end of
 the Top node menu.
 
address@hidden simple_menu
+Mostly the same as @code{SIMPLE_MENU}: use a simple preformatted style
+for the menu.  It differs from setting @code{SIMPLE_MENU} in that
address@hidden only has an effect in HTML output.
+
 @end ftable
 
 @item USE_ACCESSKEY
@@ -18170,11 +18195,6 @@
 sectioning up direction.  In practice this can only happen when there
 is no @@top section.  Not set by default.
 
address@hidden NO_USE_SETFILENAME
-If set, do not use @code{@@setfilename} to set the document name;
-instead, base the output document name only on the input file name.
-The default is false.
-
 @item USE_SETFILENAME_EXTENSION
 Default is on for Info, off for other output.  If set, use exactly
 what @code{@@setfilename} gives for the output file name, including
@@ -22032,7 +22052,7 @@
 as:
 
 @example
-$Id: texinfo.txi,v 1.532 2013/01/22 00:46:35 karl Exp $
+$Id: texinfo.txi,v 1.533 2013/01/25 18:23:10 karl Exp $
 @end example
 
 (This is potentially useful in all sources that use version control,