[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[no subject]
|
From: |
Patrice Dumas |
|
Date: |
Sat, 23 Mar 2024 12:28:05 -0400 (EDT) |
branch: master
commit 95ba7f4364a3221c77f520e23ee415b49fb88920
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Mar 23 17:21:27 2024 +0100
* doc/texi2any_api.texi: corrections, add examples, move nodes.
---
ChangeLog | 4 +
doc/texi2any_api.texi | 395 ++++++++++++++++++++++++++++----------------------
2 files changed, 226 insertions(+), 173 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 96fed20f80..6863276a08 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2024-03-23 Patrice Dumas <pertusus@free.fr>
+
+ * doc/texi2any_api.texi: corrections, add examples, move nodes.
+
2024-03-19 Patrice Dumas <pertusus@free.fr>
* doc/texi2any_api.texi: move "Command Tree Element Opening Functions"
diff --git a/doc/texi2any_api.texi b/doc/texi2any_api.texi
index 465103e762..a45572f92a 100644
--- a/doc/texi2any_api.texi
+++ b/doc/texi2any_api.texi
@@ -456,7 +456,7 @@ not very different from simple textual configuration
information.
@cindex Expansion contexts, for init files
@cindex Contexts for expansion in init files
-Output formatting simple customization need to be specified especially
+Output formatting simple customization needs to be specified especially
for different formatting contexts. There are five expansion contexts of
interest:
@@ -597,7 +597,7 @@ The specification of @@-command argument uppercasing can be
changed with
@var{$value} sets or unsets uppercasing of argument.
@end defun
-For example, to prevent @code{@@sc} argument from being upper-cased and set
+For example, to prevent @code{@@sc} argument from being uppercased and set
@code{@@var} argument to be uppercased:
@example
@@ -1101,6 +1101,12 @@ Texinfo @@-commands (@samp{accesskey}, @samp{rel} and
@samp{example}).
for any context.
@end defun
+For example, to set the @samp{Up} button string to be translated
+as @samp{Higher}, use:
+@example
+texinfo_register_direction_string_info('Up', 'button', undef, 'Higher');
+@end example
+
@node Simple Navigation Panel Customization
@section Simple Navigation Panel Customization
@@ -1368,11 +1374,11 @@ is a continuation of the previous registered message.
To report a warning or an error in element conversion, use
@code{converter_line_warn} or @code{converter_line_error}
-@defun @var{$converter}->converter_line_error ($text, $location_info,
$continuation)
-@defunx @var{$converter}->converter_line_warn ($text, $location_info,
$continuation)
+@defun @var{$converter}->converter_line_error ($text, \%location_info,
$continuation)
+@defunx @var{$converter}->converter_line_warn ($text, \%location_info,
$continuation)
Register a warning or an error. @var{$text} is the text of the
-error or warning. The @var{$location_info} holds the information on the
-error or warning location. The @var{$location_info} reference on hash may be
+error or warning. The @var{\%location_info} holds the information on the
+error or warning location. The @var{\%location_info} reference on hash may be
obtained from Texinfo elements @code{source_info} keys.
The optional @var{$continuation} argument, if set, conveys that the message
@@ -1549,7 +1555,7 @@ if (defined($encoding)) @{
@}
@end example
-More information on perl and encodings in
+More information on Perl and encodings in
@uref{https://perldoc.perl.org/perlunifaq, perlunifaq}.
@@ -1744,7 +1750,7 @@ should return the target (@var{$target}).
The element corresponding to the label can be found with @code{label_command}
if the label corresponds to an internal reference
-(@pxref{Commands Texts Labels and Files}):
+(@pxref{Target Tree Element Link}):
@example
my $element;
$element = $converter->label_command($normalized)
@@ -1882,7 +1888,7 @@ Called after some gathering of global information on the
document,
such as titles, copying comment and document description, which
require some conversion of Texinfo, right before the main output processing.
At that point most of the information available from the converter is set
-(@pxref{Conversion General Information}).
+(@pxref{Converter General Information}).
@item finish
Called after output generation is finished.
@@ -2011,7 +2017,7 @@ $description = $converter->close_html_lone_element(
@subsection Substituting Non Breaking Space
A non-breaking code should be inserted using the @code{non_breaking_space}
-information, taken from the general information (@pxref{Conversion General
+information, taken from the general information (@pxref{Converter General
Information}), using @code{get_info}:
@example
my $non_breaking_space = $converter->get_info('non_breaking_space');
@@ -2030,110 +2036,8 @@ Substitute @code{ } according to customization
variables values.
@end deftypefun
-@node Getting Conversion Context and Other Information
-@section Getting Conversion Context and Other Information
-
-Conversion to HTML often requires knowing the formating context (@pxref{Init
-File Expansion Contexts}) and benefits from general information on conversion.
-
-
-@node Conversion in String Context
-@subsection Conversion in String Context
-
-Conversion and formatting functions should check if in string
-context to avoid using HTML elements in formatting when in string context.
-@xref{Init File Expansion Contexts}.
-
-To determine if in string context, the functions is @code{in_string}:
-
-@deftypefun {@var{$in_string} =} @var{$converter}->in_string ()
-Return true if in string context.
-@end deftypefun
-
-Example of use:
-
-@example
-if ($converter->in_string()) @{
- return "$mail_string ($text)";
-@} else @{
- return $converter->html_attribute_class('a', [$cmdname])
- ." href=\"mailto:$mail_string\";>$text</a>";
-@}
-@end example
-
-
-@node Conversion in Preformatted Context
-@subsection Conversion in Preformatted Context
-
-Conversion and formatting functions should test if in preformatted
-context to convert accordingly. @xref{Init File Expansion Contexts}.
-
-To determine if in preformatted context, the functions is
-@code{in_preformatted_context}:
-
-@deftypefun {@var{$in_preformatted} =}
@var{$converter}->in_preformatted_context ()
-Return true if in preformatted context.
-@end deftypefun
-
-Another function tells if within a preformatted command:
-@deftypefun {@var{$inside_preformatted} =}
@var{$converter}->inside_preformatted ()
-Return true if within a preformatted block command such as
-@code{@@preformatted}, @code{@@format}.
-
-It is not exactly the same as preformatted context, for instance menu comments
-are in preformatted context even if not in a preformatted block command.
-@end deftypefun
-
-If in preformatted context, it is possible to get preformatted @@-commands and
-preformatted types nesting with @code{preformatted_classes_stack}:
-
-@deftypefun {@var{\@@preformatted_nesting} =}
@var{$converter}->preformatted_classes_stack ()
-Returns an reference on an array containing the block preformatted @@-commands
-such as @code{@@example}, @code{@@display} or @code{@@menu} names without
-the leading @@ and the HTML attribute class preformatted container names,
-in order of appearance.
-@end deftypefun
-
-The @code{%Texinfo::Commands::preformatted_code_commands}
-hash can be used to determine if a preformatted command is to be formatted
-as code (@pxref{Texinfo::Commands %preformatted_code_commands,,,
-texi2any_internals}).
-
-@example
-my $pre_classes = $converter->preformatted_classes_stack();
-foreach my $pre_class (@@$pre_classes) @{
- if ($Texinfo::Commands::preformatted_code_commands@{$pre_class@}) @{
- $result = '<code>' .$result. '</code>';
- last;
- @}
-@}
-@end example
-
-@xref{Simple Customization of Containers} on customizing containers
-preformatted class.
-
-
-@node Alignment and Multiple Expansion Contexts
-@subsection Alignment and Multiple Expansion Contexts
-
-To get the text filling and alignement context, determined by
@code{@@flushleft}
-or @code{@@center}, use @code{in_align}:
-
-@deftypefun {@var{$align_context} =} @var{$converter}->in_align ()
-If the alignment context is the default alignement context, return
@code{undef}.
-Otherwise, returns the command name of the alignment context.
-@end deftypefun
-
-To determine if the conversion is in a context converted multiple times,
-use @code{in_multi_expanded}:
-@deftypefun {@var{$multi_expanded_context_information} =}
@var{$converter}->in_multi_expanded ()
-Return a string representing the multiple expanded context, or @code{undef} if
-not in a multiple expanded context.
-@end deftypefun
-
-
-@node Conversion General Information
-@subsection Conversion General Information
+@node Converter General Information
+@section Converter General Information
Some general information is available from the converter. This information
should not change during conversion.
@@ -2142,6 +2046,7 @@ To determine if an output format such as @samp{html} or
@samp{tex}
is expanded (@pxref{Conditional Commands,,, texinfo, Texinfo}), use
@code{is_format_expanded}:
+@anchor{@code{is_format_expanded}}
@deftypefun {@var{$is_format_expanded} =} @var{$converter}->is_format_expanded
(@var{$format})
Return true if format @var{$format} is expanded, according to
command-line and init file information.
@@ -2212,6 +2117,9 @@ hash reference with format names as key and a true value
as value if
the format is expanded, according to command-line and init file
information.
+@code{expanded_formats} information should be consistent with
+@code{is_format_expanded} call result (@pxref{@code{is_format_expanded}}).
+
@item jslicenses
An hash reference with categories of javascript used in the document
as keys. The corresponding values are also hashes with file names
@@ -2231,7 +2139,7 @@ HTML line break element, based on @samp{<br>}, also
taking into account
Non breaking space, can be @samp{ }, but also a non breaking
space character or the corresponding numeric entity based on
@code{OUTPUT_CHARACTERS} and @code{USE_NUMERIC_ENTITY} customization variables
-values.
+values. @xref{Substituting Non Breaking Space}.
@item paragraph_symbol
Paragraph symbol, can be @samp{¶}, but also the corresponding numeric
entity
@@ -2265,8 +2173,91 @@ and @code{USE_TITLEPAGE_FOR_TITLE} customization
variables in the default case.
getting information on CSS.
-@node Dynamic Converter Formatting Information
-@subsection Dynamic Converter Formatting Information
+@node Getting Conversion Context
+@section Getting Conversion Context
+
+Some dynamically generated information should be used from the converter,
+in particular the expansion context (@pxref{Init File Expansion Contexts}).
+
+
+@node Conversion in String Context
+@subsection Conversion in String Context
+
+Conversion and formatting functions should check if in string
+context to avoid using HTML elements in formatting when in string context.
+@xref{Init File Expansion Contexts}.
+
+To determine if in string context, the functions is @code{in_string}:
+
+@deftypefun {@var{$in_string} =} @var{$converter}->in_string ()
+Return true if in string context.
+@end deftypefun
+
+Example of use:
+
+@example
+if ($converter->in_string()) @{
+ return "$mail_string ($text)";
+@} else @{
+ return $converter->html_attribute_class('a', [$cmdname])
+ ." href=\"mailto:$mail_string\";>$text</a>";
+@}
+@end example
+
+
+@node Conversion in Preformatted Context
+@subsection Conversion in Preformatted Context
+
+Conversion and formatting functions should test if in preformatted
+context to convert accordingly. @xref{Init File Expansion Contexts}.
+
+To determine if in preformatted context, the functions is
+@code{in_preformatted_context}:
+
+@deftypefun {@var{$in_preformatted} =}
@var{$converter}->in_preformatted_context ()
+Return true if in preformatted context.
+@end deftypefun
+
+Another function tells if within a preformatted command:
+@deftypefun {@var{$inside_preformatted} =}
@var{$converter}->inside_preformatted ()
+Return true if within a preformatted block command such as
+@code{@@preformatted}, @code{@@format}.
+
+It is not exactly the same as preformatted context, for instance menu comments
+are in preformatted context even if not in a preformatted block command.
+@end deftypefun
+
+If in preformatted context, it is possible to get preformatted @@-commands and
+preformatted types nesting with @code{preformatted_classes_stack}:
+
+@deftypefun {@var{\@@preformatted_nesting} =}
@var{$converter}->preformatted_classes_stack ()
+Returns an reference on an array containing the block preformatted @@-commands
+such as @code{@@example}, @code{@@display} or @code{@@menu} names without
+the leading @@ and the HTML attribute class preformatted container names,
+in order of appearance.
+@end deftypefun
+
+The @code{%Texinfo::Commands::preformatted_code_commands}
+hash can be used to determine if a preformatted command is to be formatted
+as code (@pxref{Texinfo::Commands %preformatted_code_commands,,,
+texi2any_internals}).
+
+@example
+my $pre_classes = $converter->preformatted_classes_stack();
+foreach my $pre_class (@@$pre_classes) @{
+ if ($Texinfo::Commands::preformatted_code_commands@{$pre_class@}) @{
+ $result = '<code>' .$result. '</code>';
+ last;
+ @}
+@}
+@end example
+
+@xref{Simple Customization of Containers} on customizing containers
+preformatted class.
+
+
+@node Other Dynamic Information
+@subsection Other Dynamic Information
To get the current output unit being converted, use @code{current_output_unit}:
@deftypefun {@var{$output_unit} =} @var{$converter}->current_output_unit ()
@@ -2280,6 +2271,21 @@ use @code{current_filename}:
Return the file name of the current output unit being converted.
@end deftypefun
+To get the text filling and alignement context, determined by
@code{@@flushleft}
+or @code{@@center}, use @code{in_align}:
+
+@deftypefun {@var{$align_context} =} @var{$converter}->in_align ()
+If the alignment context is the default alignement context, return
@code{undef}.
+Otherwise, returns the command name of the alignment context.
+@end deftypefun
+
+To determine if the conversion is in a context converted multiple times,
+use @code{in_multi_expanded}:
+@deftypefun {@var{$multi_expanded_context_information} =}
@var{$converter}->in_multi_expanded ()
+Return a string representing the multiple expanded context, or @code{undef} if
+not in a multiple expanded context.
+@end deftypefun
+
To get the current paragraph and preformatted number, use
@code{paragraph_number}
or @code{preformatted_number}:
@@ -2474,12 +2480,12 @@ The following is incorrect:
push @@@{$element->@{'contents'@}@}, @{'text' => ' my added text'@};
@end example
-Nodes and sectioning elements hold information on the document
-structure (@pxref{Texinfo::Structuring METHODS,,,texi2any_internals}).
-
@cindex Document structure
-The following keys of the @code{extra} elements hash can be interesting:
+Nodes and sectioning elements hold information on the document
+structure (@pxref{Texinfo::Structuring METHODS,,,texi2any_internals}).
+For example, the following keys of the @code{extra} sectioning elements hash
+can be interesting in several user-defined formatting and conversion functions:
@table @code
@item section_childs
@@ -2502,9 +2508,18 @@ documentation, in particular a list of types and of
information in the elements
@node Output Units in User Defined Functions
@subsection Output Units in User Defined Functions
-Both normal output units and special units are formatted (@pxref{Output
-Units}). The output units hold information on the document
-structure (@pxref{Texinfo::Structuring METHODS,,,texi2any_internals}).
+Some information is available only in output units. Finding an output unit
+and using the information associated to the output unit hash reference keys
+may be needed in user-defined conversion functions.
+
+Both normal and special output units (@pxref{Output Units}) can be obtained as
+output units conversion function arguments (@pxref{Output Units Conversion
+Functions}). The current output unit being processed is also available as
+@code{$converter->current_output_unit()} (@pxref{Other Dynamic Information}).
+Root command (@code{@@node} or sectioning command) @code{associated_unit} key
+value points to the associated output unit. Lastly
+@code{get_element_root_command_element} may be used to get the the output
+unit associated to an element
(@pxref{@code{get_element_root_command_element}}).
The following keys of output unit hashes can be interesting:
@@ -2549,6 +2564,8 @@ The variety of the special output unit.
For special units only. @xref{Special Units Varieties}.
@end table
+@pxref{Texinfo::Structuring METHODS,,,texi2any_internals} for more
+on document structure information held by output units.
@node Customization and Use of Formatting Functions
@chapter Customization and Use of Formatting Functions
@@ -2570,10 +2587,9 @@ Most formatting functions are specific, with specific
arguments,
and a specific item formatted. They can be called for HTML
formatting and may also be customized.
-User defined functions associated with
-the formatting of special output units body (@pxref{Output Units})
-are handled separately (@pxref{Customizing Footnotes, Tables of Contents and
-About}).
+User defined functions associated with the formatting of special output units
+body (@pxref{Output Units}) can be considered as formatting functions, but are
+registered especially (@pxref{Special Unit Body Formatting Functions}).
The formatting functions are often called from functions that can be
replaced by user-defined functions, therefore these functions may
@@ -2655,8 +2671,7 @@ to the element the user sees the anchor on.
@end deftypefn
This function reference can be called for @code{@@node} and sectioning
-commands, heading commands, normal output units, special output units and
-title @@-commands.
+commands, heading commands, special output units and title @@-commands.
A formatted headings is, in the default case, like
@code{<h2>@var{$input_text}</h2>}
for a @var{$level} 2 heading.
@@ -2965,8 +2980,8 @@ $converter->register_opened_section_level($level,
"</div>\n");
@end example
-@node Commands Texts Labels and Files
-@subsection Tree Elements Customization Commands Texts, Labels and Files
+@node Target Tree Element Link
+@subsection Target Tree Element Link
User-defined code in functions replacing default conversion functions for
@code{@@xref} and similar @@-commands output, @code{@@menu}, @code{@@node},
@@ -3013,13 +3028,13 @@ Tree elements not associated to a label are obtained
each differently.
For example, elements associated to index entries can be obtained using the
Texinfo parsed document index entries with
@code{$converter->get_info('document')->indices_information()}
-(@pxref{Conversion General Information}), or through sorted indices
+(@pxref{Converter General Information}), or through sorted indices
information (@pxref{Specific Formatting for Indices}). Footnote elements
can be obtained through the @code{@@footnote} conversion function,
and can also be passed to footnote formatting functions
(@pxref{Customizing Footnotes}). Floats elements in @code{@@listoffloats}
can be obtained from
@code{$converter->get_info('document')->floats_information()}
-(@pxref{Conversion General Information}).
+(@pxref{Converter General Information}).
To get the identifier, file name and href of tree elements that may be used
as link target, use @code{command_id}, @code{command_filename} and
@code{command_href}:
@@ -3076,13 +3091,64 @@ If @var{$no_number} is set, return a Texinfo elements
tree representing text
without a chapter number being included.
@end deftypefun
-To get the top level element and the output unit associated to any
-Texinfo tree element, use @code{get_element_root_command_element}:
+To obtain the top level command element associated with a footnote,
+float or index entry target element, use @code{command_root_element_command}:
+
+@deftypefun {@var{\%top_level_element} =}
@var{$converter}->command_root_element_command @
+ (@var{\%target_element})
+Return the top level element, either a @code{@@node} or a sectioning element
+@var{\%target_element} is in.
+@end deftypefun
+
+This is used in indices formatting to link to index entry
+associated sectioning element in addition to linking to the index entry
+location. For example:
+@example
+my $target_element = $index_entry->@{'entry_element'@};
+my $entry_href = $converter->command_href($target_element);
+my $entry_text = $converter->convert_tree($target_element);
+my $entry_link = "<a href=\"$entry_href\">$entry_text</a>";
+
+my $associated_command
+ = $converter->command_root_element_command($target_element);
+if ($associated_command) @{
+@group
+ my $associated_command_href
+ = $converter->command_href($associated_command);
+ my $associated_command_text
+ = $converter->command_text($associated_command);
+
+ if (defined($associated_command_href)) @{
+ $entry_root_link
+ = "<a href=\"$associated_command_href\">"
+ ."$associated_command_text</a>";
+@end group
+@} elsif (defined($associated_command_text)) @{
+ $entry_root_link = $associated_command_text;
+@} else @{
+ $entry_root_link = '';
+@}
+
+my $formatted_entry = "<td><tr>$entry_link</tr>"
+ ."<tr>$entry_root_link</tr></td>\n";
+@end example
+
+To get the node element associated with a target element, use
+@code{command_node}:
+
+@deftypefun {@var{\%node_element} =} @var{$converter}->command_node
(@var{\%target_element})
+Return the node element associated with @var{\%target_element}.
+@end deftypefun
+
+For elements that are not target elements, use
+@code{get_element_root_command_element} to get the root level Perl tree
+element and the output unit containing the element:
+
+@anchor{@code{get_element_root_command_element}}
@deftypefun {@var{\%top_level_element}, @var{\%output_unit} =}
@var{$converter}->get_element_root_command_element (@var{\%element})
Return the top level element and output unit a Texinfo tree
-@var{\%element} is in (@pxref{Texinfo Tree Elements in User Defined
-Functions}). Both the top level element and the output unit may be
+@var{\%element} is in. Both the top level element and the output unit may be
undefined, depending on how the converter is called and on the Texinfo tree.
The top level element returned is also determined by the customization variable
@code{USE_NODES}. If @code{USE_NODES} is set the @code{@@node} is preferred,
@@ -3098,22 +3164,6 @@ my ($output_unit, $root_command)
my $index_element_id = $converter->command_id($root_command);
@end example
-To obtain the top level command element associated with the target element,
-either a @code{@@node} or a sectioning element, use
-@code{command_root_element_command}:
-
-@deftypefun {@var{\%top_level_element} =}
@var{$converter}->command_root_element_command @
- (@var{\%target_element})
-Return the top level element @var{\%target_element} is in.
-@end deftypefun
-
-To get the node element associated with the target element, use
-@code{command_node}:
-
-@deftypefun {@var{\%node_element} =} @var{$converter}->command_node
(@var{\%target_element})
-Return the node element associated with @var{\%target_element}.
-@end deftypefun
-
@node Specific Formatting for Indices
@subsection Specific Formatting for Indices
@@ -3123,11 +3173,11 @@ function for @code{@@printindex} (@pxref{Command Tree
Element Conversion
Functions}). The Texinfo parsed document index entries information directly
obtained from the Texinfo manual parsing is available through
@code{$converter->get_info('document')->indices_information()}
-(@pxref{Conversion General Information}). Sorted index entries, which are
+(@pxref{Converter General Information}). Sorted index entries, which are
usually used for index formatting are available through
@code{get_converter_indices_sorted_by_letter}:
-@deftypefun {@var{$sorted_index_entries} = }
@var{$converter}->get_converter_indices_sorted_by_letter ()
+@deftypefun {@var{\%sorted_index_entries} = }
@var{$converter}->get_converter_indices_sorted_by_letter ()
Returns index entries sorted by index and letter.
This function should be called each time sorted indices are needed,
in case the sorting depends on the @code{@@documentlanguage} value.
@@ -3296,7 +3346,7 @@ text container elements to get text to prepend to their
content
@node Text Tree Elements Conversion
@subsection Text Tree Elements Conversion
-Tree elements hodling text are converted by the function reference registered
+Tree elements holding text are converted by the function reference registered
for the @code{text} type conversion irrespective of the actual tree
element type. For example, a tree element with type
@code{spaces_before_paragraph} and text and a tree element without type but
@@ -3324,8 +3374,8 @@ sub my_convert_text($$$)
texinfo_register_type_formatting ('text', \&my_convert_text);
@end example
-The @var{$type} free conversion function argument allows to know the
-actual type of the converted element.
+The @var{$type} free conversion function argument is the
+actual type of the converted element (can be @code{undef}).
Formatting of text requires to use informative functions on specific
contexts only relevant for text. User defined functions should convert
@@ -3753,7 +3803,7 @@ string. @var{$translation_context} is an optional
translation context
that limits the search of the translated string to that context
(@pxref{Contexts,,,gettext,GNU gettext tools}).
-The result returned is a perl Texinfo tree for @code{cdt} and @code{pcdt}
+The result returned is a Perl Texinfo tree for @code{cdt} and @code{pcdt}
and a string for @code{cdt_string}. With @code{cdt_string} the substitutions
may only be strings.
@@ -3762,7 +3812,7 @@ and is the first argument.
@end deftypefun
With @code{cdt} and @code{pcdt}, when the string is expanded as Texinfo, and
-converted to a Texinfo tree in perl, the arguments are substituted; for
+converted to a Texinfo tree in Perl, the arguments are substituted; for
example, @samp{@{arg_name@}} is replaced by the corresponding actual argument,
which should be a Texinfo tree element. With @code{cdt_string}, the string
should already be converted, the arguments are substituted as strings; for
@@ -4087,14 +4137,13 @@ appears in the document. @var{$number_in_doc} is the
number of the footnote
in the document. @var{$footnote_location_filename} is the filename of
the output unit of the footnote in the document. If the footnote appears
in a region that is expanded multiple times, the information on the expansion
-is @var{$multi_expanded_region} (@pxref{Dynamic Converter Formatting
-Information}).
+is @var{$multi_expanded_region} (@pxref{Other Dynamic Information}).
@end defun
@code{register_footnote} is normally called in the @code{@@footnote}
@@-command conversion function reference. The default conversion function
also call @code{command_href} to link to the location where the footnote
-text will be expanded (@pxref{Commands Texts Labels and Files}).
+text will be expanded (@pxref{Target Tree Element Link}).
@deftypefun {@var{\@@pending_footnotes_information} =}
@var{$converter}->get_pending_footnotes ()
Returns in @var{\@@pending_footnotes_information} the information gathered
@@ -4157,7 +4206,7 @@ target identifier if set. @var{$target_filename} is an
optional file name
that overrides the file name href part if set.
@end deftypefun
-@xref{Commands Texts Labels and Files} to get
+@xref{Target Tree Element Link} to get
link information for the location where footnote text is output.
@@ -4237,9 +4286,9 @@ Texinfo tree element conversion, and not as a special
element body formatting.
formatting happens, for links.
In the default function, structuring information is used
-to format the table of contents (@pxref{Conversion General Information}),
+to format the table of contents (@pxref{Converter General Information}),
and @code{command_contents_href} and @code{command_href}
-(@pxref{Commands Texts Labels and Files})
+(@pxref{Target Tree Element Link})
are used for links. If @var{$filename} is unset, the current file name
is used, using @code{$converter->get_info('current_filename')}.
@@ -4703,10 +4752,10 @@ The following function references give full control
over the
page header formatting done at the top of each HTML output file.
@deftypefn {Function Reference} @var{$file_begin} format_begin_file @
- (@var{$converter}, @var{$filename}, @var{\%tree_unit_element})
+ (@var{$converter}, @var{$filename}, @var{\%output_unit})
@cindex @code{<body>} tag, outputting
@var{$filename} is the name of the file output.
-@var{\%tree_unit_element} is the first output unit of the file.
+@var{\%output_unit} is the first output unit of the file.
This function should print the page header, in HTML,
including the @code{<body>} element.
@end deftypefn
@@ -4733,9 +4782,9 @@ The @code{format_end_file} function reference give full
control over the page
footer formatting done at the bottom of each HTML output file.
@deftypefn {Function Reference} @var{$file_end} format_end_file @
- (@var{$converter}, @var{$filename}, @var{\%tree_unit_element})
+ (@var{$converter}, @var{$filename}, @var{\%output_unit})
@var{$filename} is the name of the file output.
-@var{\%tree_unit_element} is the last output unit of the file.
+@var{\%output_unit} is the last output unit of the file.
@cindex @code{</body>} tag, outputting
This function should print the page footer, including
the @code{</body>} element.
@@ -4793,7 +4842,7 @@ otherwise output a simple title based on
@code{simpletitle}.
Returns the formatted ``title page'' text.
In the default case, the @code{@@titlepage} is used if found in global
information,
-otherwise @code{simpletitle} is used (@pxref{Conversion General Information}).
+otherwise @code{simpletitle} is used (@pxref{Converter General Information}).
@end deftypefn
@@ -4944,7 +4993,7 @@ Returns the content of the node redirection file.
@node Specific Functions for Specific Elements
@appendix Specific Functions for Specific Elements
-Links on Texinfo perl modules functions or descriptions of functions that can
+Links on Texinfo Perl modules functions or descriptions of functions that can
be used for specific elements formatting:
@table @asis