texinfo ChangeLog doc/texinfo.txi

[Karl Berry]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       10/08/06 00:51:40

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        split up init file nodes

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1089&r2=1.1090
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.280&r2=1.281

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1089
retrieving revision 1.1090
diff -u -b -r1.1089 -r1.1090
--- ChangeLog   5 Aug 2010 00:09:05 -0000       1.1089
+++ ChangeLog   6 Aug 2010 00:51:39 -0000       1.1090
@@ -1,3 +1,9 @@
+2010-08-05  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (Loading Init Files),
+       (Init File Basics): shorten names.
+       (Init File Variables, Init File Variables): split off from Basics.
+
 2010-08-04  Karl Berry  <address@hidden>
 
        * doc/texinfo.txi (Setting and Getting Configuration Variables):

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.280
retrieving revision 1.281
diff -u -b -r1.280 -r1.281
--- doc/texinfo.txi     5 Aug 2010 13:53:54 -0000       1.280
+++ doc/texinfo.txi     6 Aug 2010 00:51:39 -0000       1.281
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.280 2010/08/05 13:53:54 karl Exp $
address@hidden $Id: texinfo.txi,v 1.281 2010/08/06 00:51:39 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.
 
@@ -654,8 +654,8 @@
 
 texi2any Output Customization
 
-* Loading Initialization Files::   Initialization files and their search paths.
-* Initialization File Basics::     General information on init files.
+* Loading Init Files::   Initialization files and their search paths.
+* Init File Basics::     General information on init files.
 * Output Elements::                The main unit of output documents.
 * Special elements::                  Customizing special elements text and 
                                       layout.
@@ -16045,7 +16045,7 @@
 below).  @var{path} can be a single directory, or a list of several
 directories separated by the usual path separator character (@samp{:}
 on GNU and Unix systems, @samp{;} on MS-DOS/MS-Windows).
address@hidden Initialization Files}.
address@hidden Init Files}.
 
 @item address@hidden
 @opindex --css-include
@@ -16191,8 +16191,7 @@
 for these customization files, but that is not enforced by anything;
 the @var{file} name is taken literally.  @option{--conf-dir} (see
 above) may be used to add to the list of directories in which these
-customization files are searched for.  @xref{Loading Initialization
-Files}.
+customization files are searched for.  @xref{Loading Init Files}.
 
 @item address@hidden
 @opindex address@hidden
@@ -18511,19 +18510,19 @@
 
 @cartouche
 @quotation Warning
-All of this information, with the exception of that about command-line
-options and search directories (@pxref{Loading Initialization Files})
-may become obsolete in a future Texinfo release.  Right now, the
-``API'' described in this chapter is immature, badly designed and
-incomplete, so we must keep open the possibility of incompatible,
-possibly major, changes.  Of course we try to avoid incompatible
-changes, but it is not a promise.
+All of this information, with the exception of command-line options
+and search directories (@pxref{Loading Init Files}), may become
+obsolete in a future Texinfo release.  Right now, the ``API''
+described in this chapter is immature, badly designed and incomplete,
+so we must keep open the possibility of incompatible, possibly major,
+changes.  Of course we try to avoid incompatible changes, but it is
+not a promise.
 @end quotation
 @end cartouche
 
 @menu
-* Loading Initialization Files::   Initialization files and their search paths.
-* Initialization File Basics::     General information on init files.
+* Loading Init Files::             Initialization files and their search paths.
+* Init File Basics::               General information on init files.
 * Output Elements::                The main unit of output documents.
 * Navigation panel customization::
 * Page layout customization::
@@ -18543,15 +18542,22 @@
 * Customizing CSS::
 @end menu
 
address@hidden Loading Initialization Files
address@hidden Loading initialization files and search paths
 
-It is possible to load initialization files to modify almost every
-aspect of output formatting.  The program loads initialization files
-named @file{Config} each time it is run.  Those files are looked for
-in the following directories (where @var{prog} is the name of the 
-program invoked on the command line, normally @code{makeinfo} 
-or @code{texi2any}):
address@hidden Loading Init Files
address@hidden Loading Initialization Files and Search Paths
+
address@hidden Loading init files
address@hidden Initialization files, loading
address@hidden Search paths, for initialization files
+
address@hidden Config @r{init files loaded}
+
+It is possible to load so-called @dfn{initialization files}, or
address@hidden files} for short, to modify almost every aspect of output
+formatting.  The program loads init files named @file{Config} each
+time it is run.  Those files are looked for in the following
+directories (where @var{prog} is the name of the program invoked on
+the command line, normally @code{makeinfo} or @code{texi2any}):
 
 @table @file
 @item ./
@@ -18570,8 +18576,9 @@
 
 All @file{Config} files found are used, in the above order. 
 
-The most common way to load an initialization file is with the
address@hidden option, explicitly specifying the file to be
address@hidden --init-file
+However, the most common way to load an initialization file is with
+the @option{--init-file} option, explicitly specifying the file to be
 loaded.  By default the following directories are searched, in the
 following order, where @var{prog} is the name of the program invoked
 on the command line (@command{makeinfo}, @command{texi2any}, etc.).
@@ -18604,35 +18611,66 @@
 @option{--conf-dir} option.
 
 
address@hidden Initialization File Basics
address@hidden Initialization File Basics
address@hidden Init File Basics
address@hidden Init File Basics
+
address@hidden Init file basics
address@hidden Perl, language for init files
+
+Init files are written in Perl, and by convention have extension
address@hidden  Several init files are included in the Texinfo
+distribution (some are crucial components of the program), and can
+serve as a good model for writing your own.  In particular, the
address@hidden file is used to set all the defaults for
+Texinfo.  Although it is large, it contains many useful examples of
+settings.  Smaller examples include @file{utf8.init},
address@hidden, and plenty more.
+
address@hidden
+* Init File Variables::  Configuration & other variables, function references.
+* Init File Namespaces:: @code{Texi2HTML::Config}, @code{Texi2HTML}, and 
@code{main}.
+* Setting and Getting Configuration Variables::
+* Init File Global Information::  Accessing the document title, etc.
+* Getting flag values::
+* Encodings::                 Setting the encodings.
+* Redefining functions::      Function redefinition is achieved with 
+                              redefinition of references on functions.
+* Three passes::              @command{texi2any} process texinfo in 3 passes.
+* Initializing and finalizing::    Preparing and finalizing the output.
+* Calling functions at different stages::
+* External formatting of commands::
+* Program string customization::
+* Customizing generalized block command opening:: 
+* Four contexts::             Four different contexts for command expansion: 
+                              normal text, preformatted text, strings and math.
+* Internationalization of Strings::
address@hidden menu
+
 
address@hidden Initialization file basics
address@hidden Perl, used for initialization files
address@hidden Init File Variables
address@hidden Init File Variables
 
-Initialization files are written in Perl, and by convention have
-extension @file{.init}.  Many initialization files are included in the
-Texinfo distribution, and can serve as a good model for writing your
-own.  In particular, the @file{texi2html.init} file is used to set all
-the defaults for Texinfo.  Although it is large, it contains many
-useful examples of settings.  Smaller examples include
address@hidden, @file{html32.init}, and plenty more.
address@hidden Initialization file variables
address@hidden Variables, in initialization files
 
 We divide the kinds of variables that can appear in initialization
 files into three general categories:
 
 @table @asis
 @item configuration variables
address@hidden Configuration variables
 Configuration variables are set and accessed through specific
 functions in initialization files (@pxref{makeinfo Configuration
-Variables})
+Variables}).
 
 @item scalars, lists and hashes
address@hidden Perl variables
 Normal Perl variables.  The order of loading of initialization files
 and of command-line options is important: later changes override
 earlier ones.
 
 @item function references
address@hidden Function references
 These allow dynamic redefinition of functions used to produce output.
 
 As such functions are defined by a reference name, we will always use
@@ -18665,46 +18703,36 @@
 @end example
 @end table
 
+Since the program can process more than one file on the command line,
+you must ensure that you properly initialize the variables used during
+formatting.  It is possible to call functions at different stages to
+help with that (@pxref{Calling functions at different stages}).
+
+
address@hidden Init File Namespaces
address@hidden Init File Namespaces
+
address@hidden Init file namespaces
address@hidden Namespaces, for init files
address@hidden Perl namespaces, for init files
+
 @vindex Texi2HTML::Config @r{namespace}
 Initialization file are loaded from the main program via a
 @code{require} call in the @code{Texi2HTML::Config} namespace. This
 means that the namespace of the main program and the namespace of
 initialization files are distinct, which minimizes the chance of a
-name clash.  The standard scalars, arrays and hashes are declared with
address@hidden vars}, so that it should be possible to use the @code{use
-strict} pragma in initialization files.
+name clash.  The program's own variables are declared with @code{use
+vars}, so that it should be possible to use the @code{use strict}
+pragma in initialization files.
 
 @vindex Texi2HTML @r{namespace}
 @vindex main @r{namespace}
 To avoid accidentally altering the variables in the @code{main}
-namespace, all the global variables which could be of use in the init
-files are available in the @code{Texi2HTML} namespace.  For
-convenience, the functions of the main program, however, are still in
-the @code{main} namespace.
+namespace, all the global variables which could be of use in init
+files are available in the @code{Texi2HTML} namespace.
 
-Since the program can process more than one file on the command line,
-you must ensure that you properly initialize the variables used during
-formatting.  It is possible to call functions at different stages to
-help with that (@pxref{Calling functions at different stages}).
-
address@hidden
-* Setting and Getting Configuration Variables::
-* Global informations::       Accessing global informations, like date, 
-                              address@hidden
-* Getting flag values::
-* Encodings::                 Setting the encodings.
-* Redefining functions::      Function redefinition is achieved with 
-                              redefinition of references on functions.
-* Three passes::              @command{texi2any} process texinfo in 3 passes.
-* Initializing and finalizing::    Preparing and finalizing the output.
-* Calling functions at different stages::
-* External formatting of commands::
-* Program string customization::
-* Customizing generalized block command opening:: 
-* Four contexts::             Four different contexts for command expansion: 
-                              normal text, preformatted text, strings and math.
-* Internationalization of Strings::
address@hidden menu
+The functions of the main program, however, are still in the
address@hidden namespace.
 
 
 @node Setting and Getting Configuration Variables
@@ -18771,8 +18799,8 @@
 variables and options}.
 
 
address@hidden Global informations
address@hidden Accessing global informations
address@hidden Init File Global Information
address@hidden Init File: Global Information
 
 @ignore
 FIXME those are still undocumented
@@ -24251,7 +24279,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.280 2010/08/05 13:53:54 karl Exp $
+$Id: texinfo.txi,v 1.281 2010/08/06 00:51:39 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}
@@ -24330,7 +24358,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.280 2010/08/05 13:53:54 karl Exp $
address@hidden $Id: texinfo.txi,v 1.281 2010/08/06 00:51:39 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi
@@ -25907,6 +25935,7 @@
 * Regular nodes:   Info Format Regular Nodes.
 @end menu
 
+
 @node Info Format Whole Manual
 @subsection Info Format: A Whole Manual