texinfo ChangeLog doc/texinfo.txi

[Karl Berry]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       10/08/13 23:33:24

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        (Init File Global Information): edit

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1105&r2=1.1106
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.286&r2=1.287

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1105
retrieving revision 1.1106
diff -u -b -r1.1105 -r1.1106
--- ChangeLog   13 Aug 2010 00:21:02 -0000      1.1105
+++ ChangeLog   13 Aug 2010 23:33:24 -0000      1.1106
@@ -1,3 +1,7 @@
+2010-08-13  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (Init File Global Information): edit.
+
 2010-08-12  Karl Berry  <address@hidden>
 
        * doc/texinfo.txi (Loading Init Files),

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.286
retrieving revision 1.287
diff -u -b -r1.286 -r1.287
--- doc/texinfo.txi     13 Aug 2010 00:21:02 -0000      1.286
+++ doc/texinfo.txi     13 Aug 2010 23:33:24 -0000      1.287
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.286 2010/08/13 00:21:02 karl Exp $
address@hidden $Id: texinfo.txi,v 1.287 2010/08/13 23:33:24 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.
 
@@ -10170,6 +10170,7 @@
 index into a concept index, all the function names are printed in the
 @code{@@code} font as you would address@hidden
 
+
 @node synindex
 @subsection @code{@@synindex}
 @findex synindex
@@ -18812,6 +18813,9 @@
 @node Init File Global Information
 @subsection Init File: Global Information
 
address@hidden Init files, and global information
address@hidden Global information, in init files
+
 @c @ignore
 @c FIXME those are still undocumented
 @c 'split_level' 
@@ -18824,41 +18828,49 @@
 @c %hyphenation
 @c @end ignore
 
-For title related @@-commands, like @code{@@title}, @code{@@titlefont},
address@hidden@@author}, @code{@@top} some information is available, with 
diverse 
-formatting.
address@hidden@@author} and @code{@@subtitle} are multiline title related 
commands,
-since they may appear more than once.  Multiline title related commands
-are associated with strings that are constructed by concatenating all
-the command occurences.  They are also associated with arrays, and the
-name of the arrays is constructed by prepending a @samp{s} to the command
-name, like @code{authors}.
-
-Some information is also deduced from the title commands. @dfn{simpletitle}
-which is simply @code{@@settitle} or @code{@@shorttitlepage}, and 
address@hidden which is constructed by trying all the title related commands
-including @code{@@top} and @code{@@titlefont} in the top element.
-
-The information associated with @code{@@top}, 
address@hidden@@title}, @code{@@settitle},
address@hidden@@shorttitlepage}, @code{@@author}, @code{@@subtitle}, 
address@hidden and @code{fulltitle} are associated
-with the following keys in the @code{%Texi2HTML::THISDOC} hash, where
address@hidden is the title @@-command:
+For title-related @@-commands, such as @code{@@title},
address@hidden@@titlefont}, @code{@@author}, and @code{@@top}, some
+information is available, with diverse formatting.
+
address@hidden@@author} and @code{@@subtitle} are multiline title-related
+commands, since they may appear more than once.  Multiline
+title-related commands are associated with strings that are
+constructed by concatenating all the command occurences.  They are
+also associated with arrays, and the name of the arrays is constructed
+by appending a @samp{s} to the command name, as in @code{authors}.
+
+Some information is also deduced from the title commands:
address@hidden reflects @code{@@settitle} vs.\
address@hidden@@shorttitlepage}, and @dfn{fulltitle} is constructed by trying
+all the title-related commands, including @code{@@top} and
address@hidden@@titlefont}, in the top element.
+
address@hidden Texi2HTML::THISDOC
+The information associated with @code{@@top}, @code{@@title},
address@hidden@@settitle}, @code{@@shorttitlepage}, @code{@@author},
address@hidden@@subtitle}, @code{simpletitle} and @code{fulltitle} are
+associated with the following keys in the @code{%Texi2HTML::THISDOC}
+hash, where @var{command} is the title @@-command:
 
 @table @code
 @item @var{command}
 The corresponding text formatted.
+
 @item @var{command}_texi
 The original Texinfo code.
+
 @item @var{command}_line_nr
-An opaque structure corresponding with the line where the @@-comand appeared.
-Not available for @code{@@titlefont}, multiline title related commands
-and deduced informations.
+An opaque structure corresponding with the line where the @@-comand
+appeared.  Not available for @code{@@titlefont}, multiline
+title-related commands and derived information.
+
 @item @var{command}_no_texi
 The text formatted as simple plain text.
+
 @item @var{command}_simple_format
-The text formatted as a string without formatting elements (@pxref{Four 
contexts}).
+The text formatted as a string without formatting elements
+(@pxref{Four contexts}).
+
 @end table
 
 For multiline commands, the following array references are associated
@@ -18867,108 +18879,145 @@
 
 @table @code
 @item @var{command}s
-Reference on an array containing all lines set by @code{@@@var{command}}, 
-formatted.
+Reference to an array containing all lines set by
address@hidden@@@var{command}}, formatted.
+
 @item @var{command}s_texi 
-Reference on an array containing all the original Texinfo lines.
+Reference to an array containing all the original Texinfo lines.
+
 @item @var{command}s_line_nr
-Reference on an array of opaque structures corresponding with the 
-line where the @@-comand lines appeared.
+Reference to an array of opaque structures corresponding with the 
+line where the @@-command lines appeared.
+
 @end table
 
-The @code{%Texi2HTML::THISDOC} hash holds other global informations:
+The @code{%Texi2HTML::THISDOC} hash holds other global information.
+Here are some entries related to the command-line processing:
 
 @table @code
address@hidden copying_comment
-Text appearing in @code{@@copying} with all the texinfo commands removed,
-put in comments.
address@hidden dircategory_texi
-The Texinfo dircategory argument.
address@hidden dircategory
-Formatted dircategory argument.
address@hidden program
-The name of the command generating the output.
address@hidden program_and_version
-The name and version of the command generating the output.
address@hidden program_homepage
-Homepage of the command generating the output.
address@hidden destination_directory
+Destination directory for the output files.
+
 @item file_base_name
-base name of the texinfo manual file.
+Base name of the Texinfo input file.
+
 @item filename
-This is a reference on a hash that holds the filenames for special elements.
-These files may not be used in certain cases, for example the @code{toc}
-element file name may not be relevant if table of contents is not output 
-separately.
-The keys are
+This is a reference to a hash that holds the filenames for special
+elements.  These files may not be used in certain cases, for example
+the @code{toc} element file name may not be relevant if table of
+contents is not output separately.  The keys are:
+
 @table @code
 @item doc
-the document file if not split, if split should be the top element file. 
+If not split, the document file; if split, the top element file.
+
 @item top
 Top element file name.
+
 @item toc 
 Table of contents element file name.
+
 @item stoc
-Overview (also called short table of contents) element file name.
+Overview (a.k.a.@: short table of contents) element file name.
+
 @item about
 About element file name.
+
 @item foot
 Footnotes element file name.
+
 @item frame
 Main frame file.
+
 @item toc_frame
 Table of contents frame file name.
+
 @end table
+
address@hidden input_directory
+Path to the directory containing the Texinfo input file being processed.
+
 @item input_file_name
-Name of the Texinfo manual file given on the command line.
+Name of the Texinfo input file as given on the command line.
+
 @item input_file_number
-Number of the Texinfo manual file given on the command line being
-processed.
address@hidden input_directory
-Path to the directory containing the Texinfo manual being processed.
address@hidden destination_directory
-Destination directory for the resulting files.
address@hidden toc_file
-The file name of the table of contents.
+Number of the Texinfo input file from the command line which is
+currently being processed.
+
address@hidden program
+The name of the command generating the output.
+
address@hidden program_and_version
+The name and version of the command generating the output.
+
address@hidden program_homepage
+Home page of the command generating the output.
+
address@hidden table
+
+Here are entries for various global document information:
+
address@hidden @code
address@hidden copying_comment
+Text appearing in @code{@@copying} with all the Texinfo commands
+put into comments (@pxref{copying,,@code{@@copying}}).
+
address@hidden css_import_lines
+Reference to an array containing the @code{@@import} lines of
address@hidden files (@pxref{HTML CSS}).
+
address@hidden css_rule_lines
+Reference to an array containing the normal lines of @acronym{CSS}
+files.
+
address@hidden dircategory_texi
+The Texinfo @code{@@dircategory} argument (@pxref{Installing Dir Entries}).
+
address@hidden dircategory
+The formatted @code{@@dircategory} argument.
+
address@hidden inline_contents
+A reference to a hash containing two keys, one for each type of table
+of contents: @code{contents} and @code{shortcontents}.  Each
+associated value is a reference to an array containg the lines
+resulting from formatting the respective type of table of contents,
+including a heading and a reference.
+
 @item stoc_file
 The file name of the Overview (short table of contents).
address@hidden inline_contents
-A reference on a hash containing two key, one for each type of table
-of contents:
address@hidden @code
address@hidden contents
-The associated value is a 
-reference on an array containg the line resulting from formatting
-the table of contents, including a heading and a reference.
address@hidden shortcontents
-The associated value is a 
-reference on an array containg the line resulting from formatting
-the short table of contents, including a heading and a reference.
+
address@hidden toc_file
+The file name of the table of contents.
+
 @end table
+
+Finally, here are index-related entries:
+
address@hidden @code
address@hidden defindex 
address@hidden defcodeindex
+References to arrays holding the corresponding @@-command 
+arguments.
+
address@hidden merged_index 
+Reference to a hash whose keys are the index names merged in
+the values.
+
 @item index_letters_array
 @itemx index_entries_array
 @itemx index_entries_region_array
 @itemx index_entries
 @itemx indices_numbers
 @itemx indices
-references on hashes holding informations about the index entries
+References to hashes holding information about the index entries
 and whole indices.
address@hidden defindex 
address@hidden defcodeindex
-References on array holding the corresponding @@-command 
-arguments
+
 @item synindex
 @itemx syncodeindex
-Reference on arrays containing array reference with two elements, 
-the two arguments of the @@-command.
address@hidden merged_index 
-reference on a hash whose keys are the index names merged in
-the values.
address@hidden css_import_lines
-reference on an array containing the @code{@@import} lines of 
address@hidden files. @xref{HTML CSS}.
address@hidden css_rule_lines
-reference on an array containing the normal lines of 
address@hidden files. @xref{HTML CSS}.
+Reference to arrays containing array references with two elements, 
+the two arguments of @code{@@synindex}
+(@pxref{synindex,,@code{@@synindex}}).
+
 @end table
 
 
@@ -24317,7 +24366,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.286 2010/08/13 00:21:02 karl Exp $
+$Id: texinfo.txi,v 1.287 2010/08/13 23:33:24 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}
@@ -24396,7 +24445,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.286 2010/08/13 00:21:02 karl Exp $
address@hidden $Id: texinfo.txi,v 1.287 2010/08/13 23:33:24 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi