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

[Karl Berry]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       10/11/01 20:20:57

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

Log message:
        (Customizing HTML Footnotes): rename+edit

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1170&r2=1.1171
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.339&r2=1.340
http://cvs.savannah.gnu.org/viewcvs/texinfo/util/htmlxref.cnf?cvsroot=texinfo&r1=1.27&r2=1.28

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1170
retrieving revision 1.1171
diff -u -b -r1.1170 -r1.1171
--- ChangeLog   31 Oct 2010 18:31:32 -0000      1.1170
+++ ChangeLog   1 Nov 2010 20:20:55 -0000       1.1171
@@ -1,3 +1,7 @@
+2010-11-01  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (Customizing HTML Footnotes): rename+edit.
+
 2010-10-31  Karl Berry  <address@hidden>
 
        * doc/texinfo.txi (HTML Customization for Internal References):

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.339
retrieving revision 1.340
diff -u -b -r1.339 -r1.340
--- doc/texinfo.txi     31 Oct 2010 18:31:33 -0000      1.339
+++ doc/texinfo.txi     1 Nov 2010 20:20:56 -0000       1.340
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.339 2010/10/31 18:31:33 karl Exp $
address@hidden $Id: texinfo.txi,v 1.340 2010/11/01 20:20:56 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.
 
@@ -18521,9 +18521,10 @@
 * Customizing HTML Page Layout::   Customizing page headers, footers, sections.
 * Customizing Special Elements::      The top, toc, about, etc., elements.
 * Customizing Output-Related Names::  File names and target names.
-* Customizing HTML Headings::
-* Customizing HTML Basic Commands::
-* Customizing HTML References::
+* Customizing HTML Headings::       Sectioning commands.
+* Customizing HTML Basic Commands:: Commands with no arguments, images, etc.
+* Customizing HTML References::     @code{@@xref}, external node pointers, etc.
+* Customizing HTML Footnotes::
 * Block commands formatting::
 * Paragraph and preformatted region::
 * Lists tables and definitions formatting::
@@ -20244,7 +20245,7 @@
 
 The following sections describe the details for each special element
 except footnotes, which are formatted when the @code{@@footnote}
-command is expanded (@pxref{Footnotes formatting}).
+command is expanded (@pxref{Customizing HTML Footnotes}).
 
 @menu
 * Top Element Customization::
@@ -21512,7 +21513,6 @@
 @menu 
 * Internal: HTML Customization for Internal References.
 * External: HTML Customization for External References.
-* Footnotes formatting::
 @end menu
 
 
@@ -21633,68 +21633,97 @@
 @end deftypefn
 
 
address@hidden Footnotes formatting
address@hidden Customizing the footnotes formatting
address@hidden Customizing HTML Footnotes
address@hidden Customizing HTML Footnotes
 
-Each footnote is associated with a footnote entry.  Several footnote entries
-are grouped in a footnote section.  When a footnote appears, two things must
-be formatted: in the main text the place where the footnote appear
-and the footnote text. 
-
-It is possible to replace the footnote with some text before formatting the
-footnote. The following function reference, if not undef is used:
-
address@hidden {Function Reference} $added_text footnote_texi $footnote_text 
\%state \@@command_stack
address@hidden is the footnote text.
address@hidden holds informations about the context at the footnote
-place in the main document.  For example, 
address@hidden>@{'outside_document'@}} or @code{\%state->@{'multiple_pass'@}}
-could be used.
address@hidden@@command_stack} is an array containing the commands enclosing
-the footnote.
address@hidden Customizing HTML footnotes
address@hidden Footnotes, customizing HTML
+
+Each footnote is associated with a footnote entry.  Several footnote
+entries are grouped in a footnote section.  When a footnote appears,
+two things must be formatted: the footnote text, and the place in the
+main text where the footnote marker appears.
+
+It is possible to replace the footnote with other text before
+formatting the footnote. The following function reference
+is used for this if it is defined:
+
address@hidden {Function Reference} $added_text footnote_texi $footnote_text @
+           \%state \@@command_stack
address@hidden @var
address@hidden $footnote_text
+The footnote text.
+
address@hidden \%state
+Hash referencing with information about the context of the footnote
+location in the main document.  Specifically, the entries
address@hidden>@{'outside_document'@}} or
address@hidden>@{'multiple_pass'@}} can be used.
+
address@hidden \@@command_stack
+Array reference containing the commands enclosing the footnote.
address@hidden table
+
+This function should return new formatted text for the footnote.
 @end deftypefn
 
+Two functions, with corresponding function references, control the
+formatting of the footnotes:
 
address@hidden {Function Reference} {(\@@lines $doc_text)} foot_line_and_ref @
+           $number_in_doc $number_in_page $footnote_id $place_id @
+           $document_file $footnote_file \@@lines \%state 
address@hidden @var
address@hidden $number_in_doc
+The footnote number counted through the whole document, 
 
-Two functions, with corresponding function references control the formatting
-of the footnotes:
address@hidden $number_in_page
+The footnote number counted on the current page.
 
address@hidden {Function Reference} {(\@@lines $text_for_document)} 
foot_line_and_ref $number_in_doc $number_in_page $footnote_id $place_id 
$document_file $footnote_file \@@lines \%state
address@hidden is the footnote number in the whole document, 
address@hidden is the footnote number in the current page.
address@hidden is an identifier for the footnote in the footnote text
-which should be used to make target for references to that footnote,
-while @var{$place_id} is an identifier for the location of the footnote
-in the main document.  Similarly, @var{$document_file} is the file name
-of the file containing the text where the footnote appears in the main 
-document, while @var{$footnote_file} is the file name of the file where 
-the footnote text appears. 
-
address@hidden@@lines} is a reference on an array containing the footnote text
-lines, allready formatted.
-And @var{\%state} holds informations about the context at the footnote
-place in the main document.  As usual the most usefull entry is 
address@hidden which is true if the footnote appears in a preformatted 
-context. 
-
-This function returns a reference on an array, @var{\@@lines} containing
-the updated footnote text for the footnote entry, and @var{$text_for_document},
-the text appearing at the footnote place in the main document, linking
-to the footnote entry.
address@hidden $footnote_id
+An identifier for the footnote text, which should be used to make the
+target for references to the footnote.
+
address@hidden $place_id
+Identifier for the location of the footnote in the main document.
+
address@hidden $document_file
+Name of the file containing the text where the footnote appears in the
+main document
+
address@hidden $footnote_file
+Name of the file where the footnote text appears.
+
address@hidden \@@lines
+Array reference containing the footnote text lines, formatted.
+
address@hidden \%state
+Information about the context at the footnote location in the main
+document.  As usual, the most useful entry is @code{preformatted},
+which is true if the footnote appears in a preformatted context.
address@hidden table
+
+The function should return a list of two elements: an array reference
+(@var{\@@lines}) containing the updated footnote text for the footnote
+entry, and a string (@var{$doc_text}), for the text to appear at the
+location of the footnote in the main document, i.e., linking to the
+footnote entry.
 @end deftypefn
 
 The following function is only used when footnotes are at the bottom
-of a page and the document is split.  For customization of the
-footnotes page in case they are on a separated page or section,
address@hidden Layout of Special Elements}.  The footnotes location
-is determined by @code{footnotestyle}.
+of a page and the document is split.  For customization in the case
+when footnotes are on a separate page or section, @pxref{Customizing
+Layout of Special Elements}.  The footnote location is determined by
address@hidden (@pxref{Footnote Styles}).
 
 @deffn {Function Reference} foot_section \@@footnotes_lines
-This function formats a group of footnotes.  @var{\@@footnotes_lines} is a
-reference on an array holding the lines of all the footnote entries
-formatted as explained above.  This function modifies the reference.
+This function formats a group of footnotes.  @var{\@@footnotes_lines}
+is an array reference holding the lines of all the footnote entries
+formatted as explained above.  The function should modify the
+reference.
 @end deffn
 
+
 @node Block commands formatting
 @section Block commands formatting
 
@@ -24927,7 +24956,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.339 2010/10/31 18:31:33 karl Exp $
+$Id: texinfo.txi,v 1.340 2010/11/01 20:20:56 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}
@@ -25006,7 +25035,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.339 2010/10/31 18:31:33 karl Exp $
address@hidden $Id: texinfo.txi,v 1.340 2010/11/01 20:20:56 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.27
retrieving revision 1.28
diff -u -b -r1.27 -r1.28
--- util/htmlxref.cnf   31 Oct 2010 18:31:33 -0000      1.27
+++ util/htmlxref.cnf   1 Nov 2010 20:20:57 -0000       1.28
@@ -1,6 +1,6 @@
 # htmlxref.cnf - reference file for Texinfo files on the web.
 
-htmlxrefversion=2010-10-31.18; # UTC
+htmlxrefversion=2010-11-01.16; # UTC
 
 # Copyright 2010 Free Software Foundation, Inc.
 # 
@@ -321,6 +321,9 @@
 
 ocrad          mono    ${GS}/ocrad/manual/ocrad_manual.html
 
+parted         mono    ${GS}/parted/manual/parted.html
+parted         node    ${GS}/parted/manual/html_node/
+
 pascal         mono    http://www.gnu-pascal.de/gpc/
 
 pspp           mono    ${GS}/pspp/manual/pspp.html