texinfo ChangeLog doc/texinfo.txi

[Karl Berry]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       10/08/26 00:49:37

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        (Init File General Block Commands): edit.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1116&r2=1.1117
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.295&r2=1.296

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1116
retrieving revision 1.1117
diff -u -b -r1.1116 -r1.1117
--- ChangeLog   25 Aug 2010 18:49:36 -0000      1.1116
+++ ChangeLog   26 Aug 2010 00:49:36 -0000      1.1117
@@ -1,5 +1,7 @@
 2010-08-25  Karl Berry  <address@hidden>
 
+       * doc/texinfo.txi (Init File General Block Commands): edit.
+
        * doc/texinfo.txi (Init File Global Information): split into subnodes,
        and merge in `Program String Customization'.
 

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.295
retrieving revision 1.296
diff -u -b -r1.295 -r1.296
--- doc/texinfo.txi     25 Aug 2010 18:49:36 -0000      1.295
+++ doc/texinfo.txi     26 Aug 2010 00:49:36 -0000      1.296
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.295 2010/08/25 18:49:36 karl Exp $
address@hidden $Id: texinfo.txi,v 1.296 2010/08/26 00:49:36 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.
 
@@ -15997,7 +15997,7 @@
 turn.  If an input file name is @samp{-}, or no input file names at
 all are given, standard input is read.
 
address@hidden options}
address@hidden Options}
 @cindex @code{makeinfo} options
 @cindex Options for @code{makeinfo}
 
@@ -16377,7 +16377,7 @@
 @opindex --no-split
 @cindex Splitting of output files
 @cindex Output file splitting
address@hidden output}
address@hidden Output}
 @c
 When generating Info, by default large output files are split into
 smaller subfiles, of approximately 300k bytes.  When generating HTML,
@@ -17003,7 +17003,7 @@
 @end example
 
 @noindent
address@hidden If you write these three cross references using xref, you see
address@hidden Writing these three cross references using xref results in
 @c three references to the same named manual, which looks strange.
 @iftex
 For more information, see @ref{makeinfo options, , Options for
@@ -17016,16 +17016,17 @@
 @ref{Easy Customization, , Easy Customization Interface, emacs, The GNU Emacs 
Manual},@*
 @ref{Examining, , Examining and Setting Variables, emacs, The GNU Emacs 
Manual},@*
 @ref{Init File, , , emacs, The GNU Emacs Manual}, address@hidden
address@hidden options, , Options for @code{makeinfo}}.
address@hidden Options}.
 @end ifnottex
 
+
 @node texinfo-format commands
 @subsection The @address@hidden Commands
 
 In GNU Emacs in Texinfo mode, you can format part or all of a Texinfo
 file with the @code{texinfo-format-region} command.  This formats the
 current region and displays the formatted text in a temporary buffer
-called @samp{*Info address@hidden
+called @samp{*Info Region*}.
 
 Similarly, you can format a buffer with the
 @code{texinfo-format-buffer} command.  This command creates a new
@@ -18632,12 +18633,12 @@
 * Init File Namespaces:: @code{Texi2HTML::Config}, @code{Texi2HTML}, and 
@code{main}.
 * Init File Functions::  Redefining functions through references.
 * Setting and Getting Configuration Variables::
-* Init File Global Information::  Accessing the document title, file name, etc.
+* Init File Global Information::    Accessing document title, file name, etc.
 * Init File Encodings::           Overriding input and output encodings.
-* texi2any's Three Passes::       @command{texi2any} works in three passes.
+* texi2any's Three Passes::         @command{texi2any} works in three stages.
 * Init File Calling at Different Stages::  Calling functions at various times.
 * Init File Formatting of Commands:: Overriding default formatting completely.
-* Customizing generalized block command opening:: 
+* Init File General Block Commands:: Customizing usual environments.
 * Four contexts::             Four different contexts for command expansion: 
                               normal text, preformatted text, strings and math.
 * Internationalization of Strings::
@@ -18850,6 +18851,7 @@
 * Command Line String Variables::    Input and output file names, etc.
 * Global Document String Variables:: @code{@@copying}, CSS, TOC, etc.
 * Index String Variables::           @code{defindex}, @code{@@synindex}, etc.
+* Init File Flag Values::            @code{@@set} values.
 * Program String Customization::     For the About element and footers.
 @end menu
 
@@ -19071,6 +19073,19 @@
 @end table
 
 
address@hidden Init File Flag Values
address@hidden Init File Flag Values
+
address@hidden Init file flag values
address@hidden Flag values, in init files
address@hidden @code{@@set} values, in init files
address@hidden %main::value
+
+Flags defined with @code{@@set} (@pxref{set value})
+may be accessed through the @code{%main::value} hash.  The key is the
+flag name, and the value is the flag value.
+
+
 @node Program String Customization
 @subsubsection Program String Customization
 
@@ -19089,15 +19104,6 @@
 @end deftypefn
 
 
address@hidden Init file flag values
address@hidden Flag values, in init files
address@hidden @code{@@set} values, in init files
address@hidden %main::value
-Finally, flags defined with @code{@@set} (@pxref{set value})
-may be accessed through the @code{%main::value} hash.  The key is the
-flag name, and the value is the flag value.
-
-
 @node Init File Encodings
 @subsection Init File Encodings
 
@@ -19138,7 +19144,7 @@
 and for other formats is UTF-8.
 
 The values for the encoding related variables are set in the default
address@hidden function reference (@pxref{Output initialization}).
address@hidden function reference (@pxref{Output Initialization}).
 
 
 @node texi2any's Three Passes
@@ -19163,7 +19169,7 @@
 @code{@@setfilename}, etc., cannot be known before the Texinfo
 parsing.
 
address@hidden initialization}
address@hidden Initialization}
 @cindex Output initialization
 @cindex Initialization of output
 The following function reference may be redefined to be called after 
@@ -19197,7 +19203,7 @@
 @}
 @end example
 
address@hidden finalization}
address@hidden Finalization}
 @cindex Output finalization
 @cindex Finalization of output
 At the other end of things, if you want to do some clean-up after the
@@ -19331,35 +19337,39 @@
 and the text are discarded.
 @end deftypefn
 
address@hidden {Function Reference} $result 
address@hidden'$command'@}->@{'expand'@} $command $count $state $text
address@hidden {Function Reference} $result 
address@hidden'$command'@}->@{'expand'@} $command $count \%state $text
 @var{$command} is the @@-command name, @var{$count} counts how many
-times this @@-command has appeared, and @var{$state} is a hash
-reference containing detailed information about the context;
address@hidden should be empty.  @var{$result} is the expanded resulting
-text.
+times this @@-command has appeared, and @var{\%state} is a hash
+reference with detailed context information; @var{$text} should be
+empty.  @var{$result} is the expanded resulting text.
 @end deftypefn
 
 
address@hidden Customizing generalized block command opening
address@hidden Customizing generalized block command opening
address@hidden Init File General Block Commands
address@hidden Init File General Block Commands
+
address@hidden Init file general block commands
address@hidden General block commands, in init files
address@hidden Block commands, in init files
 
-A  generalized block
- @@-command is any @@-command that ends with a @code{@@end} except 
-@@-commands that only select if the input is processed (like 
address@hidden@@ignore} or @code{@@ifhtml}) or raw @@-commands (like 
@code{@@verbatim}
-and @code{@@html}).
+A @dfn{general block @code{@@}-command} is any @code{@@}-command which
+is paired with an @code{@@end @var{cmdname}}, with the exception of
+those @code{@@}-commands selecting whether input is processed (such as
address@hidden@@ignore} and @code{@@ifhtml}) and ``raw'' @code{@@}-commands
+(such as @code{@@verbatim} and @code{@@html}).
 
 @deftypefn {Function Reference} $line begin_format_texi $command $line \%state
-The @var{$command} is the format command, the @var{$line} is the 
-line following the @@-command, @var{\%state} is a reference on
-a hash containing many formatting information.  It can modify the 
-line and return something else.
-
-In the default case, it is used to keep track of the multitable nesting.
-As a consequence, it is linked with the multitable formating. 
address@hidden formatting}.
address@hidden is the format command, @var{$line} is the rest of the
+line following the @code{@@}-command, and @var{\%state} is a hash
+reference with detailed context information.  The function can modify
address@hidden and return something else.
 @end deftypefn
 
+By default, this is used to keep track of multitable nesting, and so
+it is linked with multitable formating (@pxref{Multitable
+Formatting}).
+
+
 @node Four contexts
 @subsection Four contexts for expansions: preformatted, normal, string and math
 
@@ -19535,7 +19545,7 @@
 We will call the main unit of output documents an @dfn{element}
 (nodes, to a first approximation).  An element's association with
 output files is determined by the split options (@pxref{Splitting
-output}).  This section describes precisely how elements work, with
+Output}).  This section describes precisely how elements work, with
 details for customization.
 
 @menu
@@ -19845,7 +19855,7 @@
 no @samp{[} and @samp{]}. 
 The element of the @code{%NAVIGATION_TEXT} hash are defined 
 dynamically, in the @code{init_out} function reference
-(@pxref{Output initialization}).
+(@pxref{Output Initialization}).
 
 @vindex %ACTIVE_ICONS
 @vindex %BUTTONS_NAME
@@ -20275,7 +20285,7 @@
 The keys of this hash are element labels (@pxref{Elements informations}).  
 The value is the text associated with the element label in the about text.
 In the default case, the element of the hash are defined dynamically in 
-that the @code{init_out} function reference (@pxref{Output initialization}).
+that the @code{init_out} function reference (@pxref{Output Initialization}).
 
 
 @item %BUTTONS_EXAMPLE
@@ -20401,7 +20411,7 @@
 The number associated with a section.
 @item doc_nr
 A number incremented whenever a new file should begin, based on how the 
-document is split (@pxref{Splitting output}).
+document is split (@pxref{Splitting Output}).
 @item text
 The element text.
 @item name
@@ -20752,7 +20762,7 @@
 
 @table @samp
 @item args
address@hidden hash args}
address@hidden Hash Args}
 The value associated is a reference on an array.  Each element of the array
 defines how the arguments (separated by @samp{,} in the texinfo code) for 
 the @@-command should be 
@@ -20865,7 +20875,7 @@
 @var{args} is a reference on an array contening the command arguments 
 formatted according to the same conventions than with the reference hash style
 (provided the value associated with the @@-command is a hash reference with a
address@hidden key as described in @ref{Reference hash args}).
address@hidden key as described in @ref{Reference Hash Args}).
 If @var{$text} is split in paragraphs each paragraph is passed through
 the function, and @var{$no_close} is true if it is not the last paragraph,
 while @var{$no_open} is true if it is not the first paragraph.
@@ -21613,7 +21623,7 @@
 @end deftypefn
 
 @item multitable
address@hidden formatting}
address@hidden Formatting}
 The multitable elements formatting is controlled by the functions associated
 with two function references.  One for a cell, and the other for a row.
 
@@ -21638,15 +21648,14 @@
 function reference. @var{$item_command}, @var{\@@columnfractions}, 
 @var{\@@prototype_row}, @var{\@@prototype_lengths}
 and @var{$column_number} are the same than in the function reference above.
-
 @end deftypefn
+
 @end table
 
-In the default case, this function is interlinked with 
address@hidden (@pxref{Customizing generalized block command opening})
-and @code{@@multitable} formatting
-since a stack of possible nested 
-multitables is kept to know the cell number.
+By default, this function is interlinked with
address@hidden (@pxref{Init File General Block Commands})
+and @code{@@multitable} formatting since a stack of possibly nested
+multitables is stored in order to know the cell number.
 
 
 @node Whole table and list formatting
@@ -24425,7 +24434,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.295 2010/08/25 18:49:36 karl Exp $
+$Id: texinfo.txi,v 1.296 2010/08/26 00:49:36 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}
@@ -24504,7 +24513,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.295 2010/08/25 18:49:36 karl Exp $
address@hidden $Id: texinfo.txi,v 1.296 2010/08/26 00:49:36 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi