texinfo ChangeLog doc/texinfo.txi

[Karl Berry]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       10/08/16 00:10:17

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        Init File {Encodings,Functions}: rename+edit

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1107&r2=1.1108
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.289&r2=1.290

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1107
retrieving revision 1.1108
diff -u -b -r1.1107 -r1.1108
--- ChangeLog   14 Aug 2010 23:59:35 -0000      1.1107
+++ ChangeLog   16 Aug 2010 00:10:16 -0000      1.1108
@@ -1,3 +1,8 @@
+2010-08-15  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (Init File Encodings),
+        (Init File Functions): rename+edit.
+
 2010-08-14  Karl Berry  <address@hidden>
 
        * doc/texinfo.txi (Init File Global Information): merge text

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.289
retrieving revision 1.290
diff -u -b -r1.289 -r1.290
--- doc/texinfo.txi     14 Aug 2010 23:59:35 -0000      1.289
+++ doc/texinfo.txi     16 Aug 2010 00:10:16 -0000      1.290
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.289 2010/08/14 23:59:35 karl Exp $
address@hidden $Id: texinfo.txi,v 1.290 2010/08/16 00:10:16 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.
 
@@ -18640,11 +18640,10 @@
 @menu
 * Init File Variables::  Configuration & other variables, function references.
 * 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.
-* Encodings::                 Setting the encodings.
-* Redefining functions::      Function redefinition is achieved with 
-                              redefinition of references on functions.
+* Init File Encodings::           Overriding input and output encodings.
 * Three passes::              @command{texi2any} process texinfo in 3 passes.
 * Initializing and finalizing::    Preparing and finalizing the output.
 * Calling functions at different stages::
@@ -18745,6 +18744,34 @@
 @code{main} namespace.
 
 
address@hidden Init File Functions
address@hidden Init File Functions
+
address@hidden Init file functions
address@hidden Functions, overriding in init files
address@hidden Overriding functions in init files
+To redefine a function you must replace the appropriate function
+reference with a reference to your function: write your function, give
+it a name you ensure is unique in the @code{Texi2HTML::Config}
+namespace, and then override the value of the function reference with
+your own.  When another function from the main program (or anywhere
+else) calls the reference, your function will be used.
+
+For example, the function reference to the function called when
+handling an anchor is called @code{$anchor}.  Thus, to override the
+corresponding function you could write:
+
address@hidden
+# define the function to do the work:
+sub my_anchor_fn @{
+# process arguments, return an html anchor
address@hidden
+
+# override the function reference:
+$anchor = \&my_anchor_fn;
address@hidden example
+
+
 @node Setting and Getting Configuration Variables
 @subsection Setting and Getting Configuration Variables
 
@@ -19028,72 +19055,47 @@
 flag name, and the value is the flag value.
 
 
address@hidden Encodings
address@hidden Setting the encodings
address@hidden Init File Encodings
address@hidden Init File Encodings
 
-There are four relevant encodings variables, they are autodetected
address@hidden Init file encodings
address@hidden Encodings, in init files
+
+There are four encoding-related variables, which are autodetected
 if not set:
address@hidden @code
+
address@hidden @code
 @item documentencoding
-This configuration variable may be set, if not defined, the encoding 
-appearing in @code{@@documentencoding} will be used.
+This configuration variable may be set, overriding any encoding
+set by @code{@@documentencoding} (@pxref{documentencoding,,
address@hidden@@documentencoding}}).
+
 @item IN_ENCODING
-The texinfo files encoding, may also be set.
-Otherwise, when @code{documentencoding}
-is set, @code{IN_ENCODING} is also set
-if the encoding is supported by perl.
address@hidden OUT_ENCODING
-The out files encoding.  If not set, the value of
address@hidden 
-or 
address@hidden
-is used if one of these variables is set.
+The encoding of the Texinfo files may be set independently with this
+variable.  If not, then when @code{documentencoding} is set,
address@hidden is also set if the encoding is supported by Perl.
+
 @item ENCODING_NAME
-The encoding advertized in out files.
-If unset the value of this variable is based on the
-other ENCODING values, and if they are all undefined, the variable
address@hidden is used. 
address@hidden table
+The encoding advertised in output files.  If not set, the value of
+this variable is based on the other ENCODING values, and if they are
+all undefined, the variable @code{DEFAULT_ENCODING} is used.
+
address@hidden OUT_ENCODING
+The encoding of the output files.  If not set, the value of
address@hidden or @code{IN_ENCODING} is used if one of these
+variables is set.
+
address@hidden vtable
+
+In general, the @code{documentencoding} and @code{IN_ENCODING} are set
+to the appropriate values with no need to override.
address@hidden is set according to @code{ENCODING_NAME}.  To
+force a given encoding for the output, it's best to set
address@hidden  The current default output encoding is UTF-8.
 
 The values for the encoding related variables are set in the default 
 @code{init_out} function reference (@pxref{Output initialization}).
 
-In general the @code{documentencoding} and @code{IN_ENCODING} are
-set to the right values. @code{OUT_ENCODING} is also rightly set
-according to @code{ENCODING_NAME}. 
-To force a given encoding for the output, the
address@hidden value may be set.  The current default output encoding
-is UTF-8. 
-
-
address@hidden Redefining functions
address@hidden Redefining functions in initialization files
-
-To redefine a function you must replace the corresponding funtion
-reference with a reference on your function. 
-Thus you should write your function, give it a name you
-are certain it is unique in the @code{Texi2HTML::Config} namespace,
-and override the value of the function reference with your own 
-function reference.  When another function from the main program
-(or from another functions of a initialization file) calls the reference,
-your function will be used. 
-
-For example the function
-reference corresponding with the function called when doing an
-anchor is called @code{$anchor}.  Thus if you want to override the
-corresponding function
-you could write:
-
address@hidden
-# override the function reference
-$anchor = \&my_own_function;
-
-# the function reference now refers to
-sub my_own_function @{
-# process arguments and return an html anchor
address@hidden
address@hidden example
-
 
 @node Three passes
 @subsection Three passes: macro expansion, document structure and output
@@ -19131,7 +19133,7 @@
 @code{%BUTTONS_GOTO} (@pxref{About text}) are initialized.
 Indeed the initialization of these variables is dependent upon 
 the document language selection.  Similarly the encoding variables are set
-based on the information now available (@pxref{Encodings}).
+based on the information now available (@pxref{Init File Encodings}).
 When generating HTML, aditionally, the @code{%NAVIGATION_TEXT}
 hash is initialized.
 
@@ -19165,6 +19167,7 @@
 These function references are mostly redundant with the handlers described 
 in @ref{Calling functions at different stages}.
 
+
 @node Calling functions at different stages
 @subsection Calling functions at different stages
 
@@ -19935,7 +19938,7 @@
 In the default case, the encoding name @code{ENCODING_NAME} is used.
 If the variable is not defined,
 it is automatically determined 
address@hidden
+(@pxref{Init File Encodings}).
 
 @vindex @@LINKS_BUTTONS
 @vindex %BUTTONS_REL
@@ -24365,7 +24368,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.289 2010/08/14 23:59:35 karl Exp $
+$Id: texinfo.txi,v 1.290 2010/08/16 00:10:16 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}
@@ -24444,7 +24447,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.289 2010/08/14 23:59:35 karl Exp $
address@hidden $Id: texinfo.txi,v 1.290 2010/08/16 00:10:16 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi