texinfo ChangeLog doc/texinfo.txi util/htmlxref...

[Karl Berry]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       10/10/25 16:26:36

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 
        util           : htmlxref.cnf 

Log message:
        (HTML Customization for {Anchors,Images}): rename+edit; alphabetization 
fixes in Command List

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1163&r2=1.1164
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.332&r2=1.333
http://cvs.savannah.gnu.org/viewcvs/texinfo/util/htmlxref.cnf?cvsroot=texinfo&r1=1.21&r2=1.22

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1163
retrieving revision 1.1164
diff -u -b -r1.1163 -r1.1164
--- ChangeLog   24 Oct 2010 22:52:51 -0000      1.1163
+++ ChangeLog   25 Oct 2010 16:26:35 -0000      1.1164
@@ -1,3 +1,11 @@
+2010-10-24  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (Command List): alphabetization fixes.
+       Report from Christophe Jarry, 23 Oct 2010 17:45:54.
+       
+       (HTML Customization for Anchors, HTML Customization for Images):
+       rename+edit.
+
 2010-10-24  Patrice Dumas  <address@hidden>
 
        * texi2html/texi2html.pl (%index_names): remove the 'prefixes' key, 

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.332
retrieving revision 1.333
diff -u -b -r1.332 -r1.333
--- doc/texinfo.txi     15 Oct 2010 18:36:16 -0000      1.332
+++ doc/texinfo.txi     25 Oct 2010 16:26:35 -0000      1.333
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.332 2010/10/15 18:36:16 karl Exp $
address@hidden $Id: texinfo.txi,v 1.333 2010/10/25 16:26:35 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.
 
@@ -5352,6 +5352,7 @@
 feature, for that group of nodes.  In those cases, you will need to
 explicitly specify all pointers.
 
+
 @node anchor
 @section @code{@@anchor}: Defining Arbitrary Cross-reference Targets
 
@@ -11380,23 +11381,22 @@
 
 @table @asis
 @item @result{}
address@hidden@@address@hidden@}} points to the result of an address@hidden
address@hidden@@address@hidden@}} points to the result of an expression.
 
 @item @expansion{}
address@hidden@@address@hidden@}} shows the results of a macro address@hidden
address@hidden@@address@hidden@}} shows the results of a macro expansion.
 
 @item @print{}
address@hidden@@address@hidden@}} indicates printed address@hidden
address@hidden@@address@hidden@}} indicates printed output.
 
 @item @error{}
address@hidden@@address@hidden@}} indicates that the following text is an error
address@hidden
address@hidden@@address@hidden@}} indicates that the following text is an error 
message.
 
 @item @equiv{}
address@hidden@@address@hidden@}} indicates the exact equivalence of two 
address@hidden
address@hidden@@address@hidden@}} indicates the exact equivalence of two forms.
 
 @item @point{}
address@hidden@@address@hidden@}} shows the location of address@hidden
address@hidden@@address@hidden@}} shows the location of point.
 @end table
 
 @menu
@@ -20854,19 +20854,20 @@
 Texinfo commands used within the running text.
 
 @menu
-* Argless: Customizing HTML for Commands Without Arguments.
-* @@-Colon: Customizing HTML After @@-Colon.
-* Simple: Customizing HTML for Simple Commands.
-* Formatting special simple commands::
+* Argless: HTML Customization for Commands Without Arguments.
+* @@-Colon: HTML Customization After @@-Colon.
+* Simple: HTML Customization for Simple Commands.
+* Anchors: HTML Customization for Anchors.
+* Images: HTML Customization for Images.
 * Formatting characters and text::
 * Formatting of simple line commands::
 @end menu
 
 
address@hidden Customizing HTML for Commands Without Arguments
address@hidden Customizing HTML for Commands Without Arguments
address@hidden HTML Customization for Commands Without Arguments
address@hidden HTML Customization for Commands Without Arguments
 
address@hidden Customizing HTML for commands without arguments
address@hidden HTML customization for commands without arguments
 @cindex Commands without arguments, customizing HTML for
 @cindex Insertion commands, customizing HTML for
 
@@ -20939,10 +20940,10 @@
 @end deftypefn
 
 
address@hidden Customizing HTML After @@-Colon
address@hidden Customizing HTML After @@-Colon
address@hidden HTML Customization After @@-Colon
address@hidden HTML Customization After @@-Colon
 
address@hidden Customizing HTML after @code{@@:}
address@hidden HTML customization after @code{@@:}
 @cindex Punctuation after @code{@@:}, customizing HTML for
 @cindex Sentence punctuation, customizing HTML for
 
@@ -20965,10 +20966,10 @@
 @end deftypefn
 
 
address@hidden Customizing HTML for Simple Commands
address@hidden Customizing HTML for Simple Commands
address@hidden HTML Customization for Simple Commands
address@hidden HTML Customization for Simple Commands
 
address@hidden Customizing HTML for simple commands
address@hidden HTML customization for simple commands
 @cindex Simple commands, customizing HTML for
 @cindex Style commands, customizing HTML for
 @cindex Accent commands, customizing HTML for
@@ -21177,8 +21178,8 @@
 @cindex Custom interface for simple HTML customization
 @cindex Interface for simple HTML customization, custom
 
-If you don't like the hash interface described in the previous
-section, it is possible to change how the ``simple'' Texinfo commands
+If the hash interface described in the previous section does not
+suffice, it is possible to change how the ``simple'' Texinfo commands
 are processed by redefining the following function reference:
 
 @deftypefn {Function Reference} $resulting_text style $style $command $text @
@@ -21216,85 +21217,129 @@
 @end deftypefn
 
 
address@hidden Formatting special simple commands
address@hidden Formatting of anchors, images and spaces
address@hidden HTML Customization for Anchors
address@hidden HTML Customization for Anchors
 
-The formatting of special simple commands is controlled by functions.  To
-customize the output, the corresponding function references should be
-redefined. All these functions return a formatted text.
address@hidden HTML customization for anchors
address@hidden Anchors, customizing HTML for
 
-The formatting of anchors is controlled by @code{$anchor_label}.
+The HTML formatting of anchors (@pxref{anchor,, @code{@@anchor}}) is
+controlled by functions.  To customize the output, the function
+reference @code{$anchor_label} should be redefined.  The function
+should return the formatted text.
 
 @deftypefn {Function Reference} $anchor_label anchor_label $identifier $anchor
address@hidden is the anchor identifier, @var{$anchor} is the @code{@@anchor}
-argument.
address@hidden is the anchor identifier, and @var{$anchor} is the
address@hidden@@anchor} argument.
 @end deftypefn
 
-In the default case, it uses a function reference,  @code{$anchor}
- that can do
-a reference target or link. It is especially relevant for @acronym{HTML}
-but can be used in other formats, it is a rather common element
-of different formats.
address@hidden {Function Reference} $anchor anchor $identifier $href $text 
$attributes
-If @var{$identifier} is not empty, this value should be used to create
-a target for links (typically associated with a name or id 
-attribute in @acronym{HTML}).
-The @var{$href} argument specifies a hpertextual reference which should be
-used to link to a target.
-In case both @var{$identifier} and  @var{$href} are given the text produced
-should be both a target for @var{$identifier} and a link to @var{$href}.
address@hidden is the text to be displayed. 
address@hidden are additional attributes.
-It should be reasonable to assume that the attributes are for a @code{<a>}
address@hidden element. 
+By default, this uses a function reference, @code{$anchor}, which can
+do a reference target or link. This is especially relevant for HTML
+but can potentially be used in other formats, since it is a rather
+common element among output formats.
+
address@hidden {Function Reference} $anchor anchor @
+           $identifier $href $text $attributes
+If @var{$identifier} is not empty, its value should be used to create
+a target for links (typically associated with a name or id attribute
+in HTML).  The @var{$href} argument specifies a hypertext reference
+which should be used to link to a target.  If both @var{$identifier}
+and @var{$href} are given, the text produced should be both a target
+for @var{$identifier} and a link to @var{$href}.  @var{$text} is the
+text to be displayed.  @var{$attributes} are additional attributes for
+an @code{<a>} HTML element.
 @end deftypefn
 
+
address@hidden HTML Customization for Images
address@hidden HTML Customization for Images
+
address@hidden HTML customization for images
address@hidden Images, customizing HTML for
+
 @vindex @@IMAGE_EXTENSIONS
-To customize the images produced by @code{@@image}, the first possibility 
-is to modify the @code{@@IMAGE_EXTENSIONS} array, which holds a list of 
-filename extensions for image files. It is also possible to redefine
-the function used to determine the filename of the image:
-
address@hidden {Function Reference} $filename image_files $basename $extension 
$texi_base $texi_extension
address@hidden is the first @code{@@image} argument, @var{$extension}
-is the corresponding @code{@@image} argument, both are formatted.  
-Similarly @var{$texi_base} is the first @code{@@image} argument 
-without formatting, and @var{$texi_extension} is the extension, unformatted.
-This function reference 
-should return an array of array references, each array reference holding
-a formatted and an unformatted image filenames without path that the main 
-program should look for.
address@hidden deftypefn
-
-Last, it is possible to control 
-the formatting of @code{@@image} by redefining:
address@hidden {Function Reference} $image image $file_path $basename 
$preformatted $file_name $alt_text $width $height $raw_alt $extension 
$working_dir $file_relative_path $in_paragraph \@@file_locations 
$base_simple_format $extension_simple_format $file_name_simple_format $line_nr
address@hidden is the image file name with the path from the output directory
-to the source manual directory prepended, @var{$basename}  
-the file name without extension (the first @code{@@image} argument). 
address@hidden is true if the image 
-appears in preformatted text.  @var{$file_name} is the file name without path 
-but with extension. @var{$alt_text} is the alternate text, it may be 
-undefined. @var{$width} and @var{$height} are the corresponding arguments 
-of @code{@@image}, @var{$raw_alt} is the unmodified alt argument of 
address@hidden@@image} and @var{$extension} holds the corresponding 
address@hidden@@image} argument.
address@hidden is the path to working dir relative to the output
-directory. @var{$file_relative_path} is the file name relative to the 
address@hidden
address@hidden is true if in paragraphs.
address@hidden@@file_locations} is a reference on an array which itself holds a 
reference on an 
-array with 3 elements: the file name array reference as returned by 
@code{image_files},
-the image location if it was found, or undef, and the file name formatted using
-a simple formatting in string context.
address@hidden is the @var{$basename} formatted with a simple format.
address@hidden is the @var{$extension} formatted with a simple format.
address@hidden is the @var{$file_name} formatted with a simple format.
address@hidden
-is an opaque structure containing the information about the line number of the 
-@@-command. 
+To customize the images produced by @code{@@image} (@pxref{Images}),
+the first possibility is to modify the @code{@@IMAGE_EXTENSIONS}
+array, which holds a list of filename extensions for image files.
+
+Second, it is also possible to redefine the function used to determine
+the filename of the image:
+
address@hidden {Function Reference} $filename image_files @
+           $basename $extension $texi_base $texi_extension
address@hidden is the first @code{@@image} argument, and
address@hidden is the corresponding @code{@@image} argument; both
+are formatted.  @var{$texi_base} is the first @code{@@image} argument
+and @var{$texi_extension} is the extension, unformatted.  This
+function reference should return an array of array references, each
+holding both formatted and unformatted image filenames without any path
+for which the main program should look.
address@hidden deftypefn
+
+Third, it is possible to control the formatting of @code{@@image} by
+redefining this:
+
address@hidden {Function Reference} $image image $file_path $basename @
+           $preformatted $file_name $alt_text $width $height $raw_alt @
+           $extension $working_dir $file_relative_path $in_paragraph @
+           \@@file_locations $base_simple_format @
+           $extension_simple_format $file_name_simple_format $line_nr
address@hidden @var
address@hidden $file_path
+The image file name with the path from the output directory to the
+source manual directory prepended.
+
address@hidden $basename
+The file name without extension---the first argument to the
address@hidden@@image} command.
+
address@hidden $preformatted
+True if the image appears in preformatted text.
+
address@hidden $file_name
+The file name without path but with extension.
+
address@hidden $alt_text
+The alternate text, possibly undefined.
+
address@hidden $width
address@hidden $height
+The corresponding @code{@@image} arguments.
+
address@hidden $raw_alt
+The unmodified alternate-text @code{@@image} argument.
+
address@hidden $extension
+The corresponding @code{@@image} argument.
+
address@hidden $working_dir
+Path to the working directory relative to the output directory.
+
address@hidden $file_relative_path
+The file name relative to @var{$working_dir}.
+
address@hidden $in_paragraph
+True if within a paragraph.
+
address@hidden \@@file_locations
+Array reference holding another array reference with 3 elements: the
+file name array reference as returned by @code{image_files}; the image
+location if it was found, or undef; and the file name formatted using
+simple formatting in string context.
+
address@hidden $base_simple_format
address@hidden $extension_simple_format
address@hidden $file_name_simple_format
+The corresponding arguments formatted using simple formatting in
+string context.
+
address@hidden $line_nr
+An opaque structure containing the information about the line number
+of the @@-command.
address@hidden table
 @end deftypefn
 
+
 The formatting of @code{@@sp} is controlled by:
 @deftypefn {Function Reference} $sp sp $number $preformatted
 @var{$number} is the numeric argument of @code{@@sp}.
@@ -21314,7 +21359,7 @@
 reference on an array containing the simply fomatted explanation lines, 
 @var{$explanation_text} is the explanation text formatted,
 @var{$explanation_simply_formatted} is the explanation formatted in 
-a string context, enabling in @acronym{HTML} (or @acronym{XML}) the 
explanation 
+a string context, enabling in HTML (or @acronym{XML}) the explanation 
 to be in an attribute.
 @end deftypefn
 
@@ -21346,11 +21391,11 @@
 In the default case the @samp{---}, @samp{--}, @samp{``} and @samp{''}
 constructs are expanded if needed and the text is upper-cased if in 
 @code{@@sc}. Special characters (@samp{&}, @samp{"},
address@hidden<} and @samp{>} in @acronym{HTML}) are protected if needed. 
address@hidden<} and @samp{>} in HTML) are protected if needed. 
 @end deftypefn
 
 Some characters are special, for example we have  @samp{&}, @samp{"}, 
address@hidden<} and @samp{>} in @acronym{HTML}. In some cases some
address@hidden<} and @samp{>} in HTML. In some cases some
 pieces of text don't go through the above function, but still 
 needs to be protected to appear in text.
 This is done by the function associated with the function reference
@@ -21581,7 +21626,7 @@
 The @code{end} should lead to the end of the 
 formatted output.
 @item class
-The @acronym{HTML} class.  If not defined, the command name.
+The HTML class.  If not defined, the command name.
 @item pre_style
 The preformatted style. If not defined the corresponding @acronym{CSS} style
 is used.
@@ -22380,7 +22425,7 @@
 @deftypefn {Function Reference} $target index_entry_label $identifier 
$preformatted $entry $index_name $index_command $texi_entry $formatted_entry 
$in_region_not_in_output \%index_entry
 @var{$identifier} should be used to create
 a target for links (typically associated with a name or id 
-attribute in @acronym{HTML}).
+attribute in HTML).
 @var{$preformatted} is true if the index entry appeared in preformatted text.
 @var{$entry} is the index entry with all the @@-commands removed.
 @var{$index_name} is the index name, @var{$command} is the index command which
@@ -23103,6 +23148,14 @@
 Highlight the name of a book or other reference that has no companion
 Info file.  @xref{cite, , @code{@@cite}}.
 
address@hidden @@clear @var{flag}
+Unset @var{flag}, preventing the Texinfo formatting commands from
+formatting text between subsequent pairs of @code{@@ifset @var{flag}}
+and @code{@@end ifset} commands, and preventing
address@hidden@@address@hidden@address@hidden from expanding to the value to 
which
address@hidden is set.
address@hidden clear value, , @code{@@set} @code{@@clear} @code{@@value}}.
+
 @item @@address@hidden@}
 Represent a single ``click'' in a GUI.  Used within
 @code{@@clicksequence}.  @xref{Click Sequences}.
@@ -23115,14 +23168,6 @@
 @code{@@arrow}.  The usual following empty braces on @@@var{cmd} are
 omitted.  @xref{Click Sequences}.
 
address@hidden @@clear @var{flag}
-Unset @var{flag}, preventing the Texinfo formatting commands from
-formatting text between subsequent pairs of @code{@@ifset @var{flag}}
-and @code{@@end ifset} commands, and preventing
address@hidden@@address@hidden@address@hidden from expanding to the value to 
which
address@hidden is set.
address@hidden clear value, , @code{@@set} @code{@@clear} @code{@@value}}.
-
 @item @@address@hidden@address@hidden
 Indicate an expression, a syntactically complete token of a program,
 or a program name.  Unquoted in Info output.  @xref{code, ,
@@ -23364,10 +23409,6 @@
 Ends @var{environment}, as in @samp{@@end example}.  @xref{Formatting
 Commands,,@@-commands}.
 
address@hidden @@address@hidden@address@hidden
-Indicate an environment variable name, such as @env{PATH}.
address@hidden,, @code{@@env}}.
-
 @item @@address@hidden@}
 Generate an end-of-sentence ellipsis, like this: @enddots{}
 @xref{dots,,@code{@@address@hidden@}}}.
@@ -23378,18 +23419,22 @@
 @code{@@end enumerate}.  @xref{enumerate, ,
 @code{@@enumerate}}.
 
address@hidden @@address@hidden@address@hidden
+Indicate an environment variable name, such as @env{PATH}.
address@hidden,, @code{@@env}}.
+
 @item @@address@hidden@}
 Indicate to the reader the exact equivalence of two forms with a
 glyph: @address@hidden  @xref{Equivalence}.
 
address@hidden @@address@hidden@}
-Generate the Euro currency sign.
address@hidden,,@code{@@address@hidden@}}}.
-
 @item @@address@hidden@}
 Indicate to the reader with a glyph that the following text is
 an error message: @address@hidden  @xref{Error Glyph}.
 
address@hidden @@address@hidden@}
+Generate the Euro currency sign.
address@hidden,,@code{@@address@hidden@}}}.
+
 @item  @@evenfooting address@hidden @@| address@hidden @@| address@hidden
 @itemx @@evenheading address@hidden @@| address@hidden @@| address@hidden
 Specify page footings resp.@: headings for even-numbered (left-hand)
@@ -24757,7 +24802,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.332 2010/10/15 18:36:16 karl Exp $
+$Id: texinfo.txi,v 1.333 2010/10/25 16:26:35 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}
@@ -24836,7 +24881,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.332 2010/10/15 18:36:16 karl Exp $
address@hidden $Id: texinfo.txi,v 1.333 2010/10/25 16:26:35 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi

Index: util/htmlxref.cnf
===================================================================
RCS file: /sources/texinfo/texinfo/util/htmlxref.cnf,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -b -r1.21 -r1.22
--- util/htmlxref.cnf   15 Oct 2010 18:36:17 -0000      1.21
+++ util/htmlxref.cnf   25 Oct 2010 16:26:36 -0000      1.22
@@ -1,6 +1,6 @@
 # htmlxref.cnf - reference file for Texinfo files on the web.
 
-htmlxrefversion=2010-10-15.17; # UTC
+htmlxrefversion=2010-10-25.15; # UTC
 
 # Copyright 2010 Free Software Foundation, Inc.
 # 
@@ -194,6 +194,9 @@
 
 global         mono    ${GS}/global/manual/global.html
 
+gmp            mono    ${GS}/gmp/manual/html_mono/gmp.html
+gmp            node    ${GS}/gmp/manual/html_node/
+
 gnu-arch       node    ${GS}/gnu-arch/tutorial/
 
 gnu-crypt      node    ${GS}/gnu-crypto/manual/
@@ -217,9 +220,18 @@
 
 gnuschool      mono    ${GS}/gnuschool/gnuschool.html
 
+gnutls         mono    ${GS}/gnutls/manual/gnutls.html
+gnutls         node    ${GS}/gnutls/manual/html_node/
+
 gperf          mono    ${GS}/gperf/manual/gperf.html
 gperf          node    ${GS}/gperf/manual/html_node/
 
+gsasl          mono    ${GS}/gsasl/manual/gsasl.html
+gsasl          node    ${GS}/gsasl/manual/html_node/
+
+gss            mono    ${GS}/gss/manual/gss.html
+gss            node    ${GS}/gss/manual/html_node/
+
 gtypist                mono    ${GS}/gtypist/doc/
 
 guile          mono    ${GS}/guile/manual/guile.html