[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[no subject]
|
From: |
Patrice Dumas |
|
Date: |
Fri, 12 Aug 2022 03:27:46 -0400 (EDT) |
branch: master
commit ce868360e5d4ee6e35c2f9a7419329e181f28310
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Fri Aug 12 00:47:30 2022 +0200
texinfo/doc/customization_api.texi: add @var{} in @deftype*
---
doc/customization_api.texi | 304 +++++++++++++++++++++++----------------------
1 file changed, 154 insertions(+), 150 deletions(-)
diff --git a/doc/customization_api.texi b/doc/customization_api.texi
index cb29d76db7..744e96425b 100644
--- a/doc/customization_api.texi
+++ b/doc/customization_api.texi
@@ -623,8 +623,8 @@ that element.
The function used are @code{css_get_info} to get information and
@code{css_add_info} to modify:
-@defun $converter->css_get_info ($specification, $css_info)
-@defunx $converter->css_add_info ($specification, $css_info, $css_style)
+@defun @var{$converter}->css_get_info ($specification, $css_info)
+@defunx @var{$converter}->css_add_info ($specification, $css_info, $css_style)
Those functions can only be used on a converter @var{$converter}, from
functions registered and called with a converter. @var{$specification} is
@@ -1136,7 +1136,7 @@ to a hash and @code{\&function} for a reference on a
function.
To illustrate these conventions, here is the prototype for the
function associated with @samp{format_thing}:
-@deftypefn {Function Reference} $text format_thing ($arg1 \@@arg2)
+@deftypefn {Function Reference} @var{$text} format_thing (@var{$arg1},
@var{\@@arg2})
A function reference associated with @samp{format_thing} has a first argument
@var{$arg1}, a second argument a reference to an array @var{\@@arg2}, and
returns the formatted text @var{$text}.
@@ -1167,7 +1167,7 @@ There is no reason to use that function often, as the
converter
already goes through the tree calling reference functions to convert
the elements, but it can be interesting in some cases.
-@deftypefun $converted_text $converter->convert_tree (\%element, $explanation)
+@deftypefun @var{$converted_text} @var{$converter}->convert_tree
(@var{\%element}, @var{$explanation})
@var{\%element} is a Texinfo tree element. @var{$explanation} is
optional, it is a string explaining why the function was called, to help
in case of debugging. The function returns @var{\%element} converted.
@@ -1188,8 +1188,8 @@ For such cases, the function is
@code{convert_tree_new_formatting_context} which sets the context
appropriately.
@code{convert_tree_new_formatting_context} ultimately calls
@code{convert_tree}.
-@deftypefun $converted_text $converter->convert_tree_new_formatting_context @
- (\%element, $context, $multiple_pass,
$global_context)
+@deftypefun @var{$converted_text}
@var{$converter}->convert_tree_new_formatting_context @
+ (@var{\%element}, @var{$context}, @var{$multiple_pass},
@var{$global_context})
@var{\%element} is a Texinfo tree element. @var{$context} is an optional
string describing the new context to be setup to format out of the main
conversion flow. If not defined, the conversion is done in the main document
@@ -1220,7 +1220,7 @@ the default code can be used in practice.
The subroutine @code{gdt}, from the @code{Texinfo::Translations} module
is used for translated strings:
-@deftypefun $translated_tree $converter->gdt ($string, \%variables_hash)
+@deftypefun @var{$translated_tree} @var{$converter}->gdt (@var{$string},
@var{\%variables_hash})
@var{$string} is the string to be translated, @var{\%variables_hash}
is a hash reference holding the variable parts of the translated
string. The result returned is a perl Texinfo tree.
@@ -1280,8 +1280,8 @@ of @code{Texinfo::Report} through a converter object
To report a warning or an error not specific of an element conversion,
use @code{document_warn} or @code{document_error}:
-@defun $converter->document_error ($text, $converter)
-@defunx $converter->document_warn ($text, $converter)
+@defun @var{$converter}->document_error ($text, $converter)
+@defunx @var{$converter}->document_warn ($text, $converter)
Register a document-wide error or warning. @var{$text} is the error
or warning message. The @var{$converter} object should be given
as the second argument.
@@ -1289,8 +1289,8 @@ as the second argument.
To report a warning or an error in element conversion, use
@code{line_warn} or @code{line_error}
-@defun $converter->line_error ($text, $converter, $location_info)
-@defunx $converter->line_warn ($text, $converter, $location_info)
+@defun @var{$converter}->line_error ($text, $converter, $location_info)
+@defunx @var{$converter}->line_warn ($text, $converter, $location_info)
Register a warning or an error. @var{$text} is the text of the
error or warning. The @var{$converter} object should be given
as the second argument. The optional
@@ -1395,7 +1395,7 @@ or the opening of a file require binary strings.
To encode file names consistently with file name encoding used in the
conversion to
HTML, there is a function @code{encoded_output_file_name}:
-@deftypefun {$encoded_name, $encoding} $converter->encoded_output_file_name
($character_string_name)
+@deftypefun {(@var{$encoded_name}, @var{$encoding})}
@var{$converter}->encoded_output_file_name (@var{$character_string_name})
Encode @var{$character_string_name} in the same way as other file name are
encoded in the converter, based on @code{DOC_ENCODING_FOR_OUTPUT_FILE_NAME},
and @code{LOCALE_OUTPUT_FILE_NAME_ENCODING} or on input file encoding
@@ -1535,7 +1535,7 @@ used in functions, but should be used out of functions in
init files
To get the value of a variable in a converter @code{$converter},
the function is @code{get_conf}:
-@defun $converter->get_conf ($variable_name)
+@defun @var{$converter}->get_conf ($variable_name)
@var{$variable_name} is the name of the variable; its value in the converter
@var{$converter} (possibly @code{undef}) is returned.
@end defun
@@ -1549,7 +1549,7 @@ my $footnotestyle = $converter->get_conf('footnotestyle');
To set a variable in a converter @code{$converter},
the function is @code{set_conf}:
-@defun $converter->set_conf ($variable_name, $variable_value)
+@defun @var{$converter}->set_conf ($variable_name, $variable_value)
@var{$variable_name} is the name of the variable; its value in the converter
@var{$converter} is set to @var{$variable_value}. The @var{$variable_name}
value will not be overidden if it was set from the command line or from an init
@@ -1568,7 +1568,7 @@ expected behaviour, in particular when the values are set
from the document.
In the rare cases when overriding the customization would be needed, the
@code{force_conf} functions can be used:
-@defun $converter->force_conf ($variable_name, $variable_value)
+@defun @var{$converter}->force_conf ($variable_name, $variable_value)
@var{$variable_name} is the name of the variable; its value in the converter
@var{$converter} is set to @var{$variable_value}, overriding any previous
value.
@end defun
@@ -1583,14 +1583,14 @@ 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}:
-@deftypefun $is_format_expanded $converter->is_format_expanded ($format)
+@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.
@end deftypefun
The main method to get information from the converter is @code{get_info}:
-@defun $converter->get_info ($info)
+@defun @var{$converter}->get_info ($info)
Return information on @var{$info}.
@end defun
@@ -1759,8 +1759,8 @@ Two function references registered with
@code{texinfo_register_file_id_setting_f
enable further customization. The first,
@code{node_file_name} is used to customize the nodes files names.
-@deftypefn {Function Reference} $node_file node_file_name ($converter, @
- \%node_element, $file_name)
+@deftypefn {Function Reference} @var{$node_file} node_file_name
(@var{$converter}, @
+ @var{\%node_element}, @var{$file_name})
@var{$converter} is a converter object. @var{\%node_element} is the Texinfo
tree
element corresponding to the @code{@@node}. @var{$file_name} is the node file
name that has been already set. The function should return the node file name
@@ -1772,8 +1772,8 @@ customize the file names associated with each element
unit, and the name of
the file associated with the special elements (@pxref{Output Element
Units}).
-@deftypefn {Function Reference} $file tree_unit_file_name ($converter, @
- \%unit_element, $file_name)
+@deftypefn {Function Reference} @var{$file} tree_unit_file_name
(@var{$converter}, @
+ @var{\%unit_element}, @var{$file_name})
@var{$converter} is a converter object. @var{\%unit_element} is the Texinfo
element corresponding to the unit element. @var{$file_name} is the file
name that has been already set. The function should return the file name for
@@ -1807,8 +1807,8 @@ described here.
The following function reference is for target items (nodes, anchors,
floats):
-@deftypefn {Function Reference} {$target} label_target_name @
- ($converter, \%label_info, $default_target)
+@deftypefn {Function Reference} @var{$target} label_target_name @
+ (@var{$converter}, @var{\%label_info}, @var{$default_target})
@var{$converter} is a converter object. @var{\%label_info} is a hash
reference containing a @code{normalized} key with value the
normalized node name, a @code{node_content} key with value a reference on an
@@ -1822,9 +1822,9 @@ targets for the sectioning command in table of contents
and in short table
of contents are needed. The following function reference is for sectioning
command related
target and file name:
-@deftypefn {Function Reference} {($target, $target_contents,
$target_shortcontents, $file)} @
- sectioning_command_target_name ($converter, \%section_element,
$default_target, @
- $default_target_contents, $default_target_shortcontents, $file_name)
+@deftypefn {Function Reference} {(@var{$target}, @var{$target_contents},
@var{$target_shortcontents}, @var{$file})} @
+ sectioning_command_target_name (@var{$converter}, @var{\%section_element},
@var{$default_target}, @
+ @var{$default_target_contents}, @var{$default_target_shortcontents},
@var{$file_name})
@var{$converter} is a converter object. @var{\%section_element} is the Texinfo
element corresponding to the sectioning command.
@@ -1843,8 +1843,8 @@ the sectioning element (@var{$file}).
For special element units (@pxref{Output Element Units}), the function
reference is:
-@deftypefn {Function Reference} {($target, $file)}
special_element_target_file_name @
- ($converter, \%element, $default_target, $file_name)
+@deftypefn {Function Reference} {(@var{$target}, @var{$file})}
special_element_target_file_name @
+ (@var{$converter}, @var{\%element}, @var{$default_target},
@var{$file_name})
@var{$converter} is a converter object. @var{\%element} is the Texinfo
element corresponding to the special element unit. @var{$default_target} is the
target that has been already set, and @var{$file_name} is the
@@ -1908,8 +1908,8 @@ within a priority class the order is the order of calling
The call of the user defined functions is:
-@deftypefn {Function Reference} {$status} stage_handler @
- ($converter, \%tree, $stage)
+@deftypefn {Function Reference} @var{$status} stage_handler @
+ (@var{$converter}, @var{\%tree}, @var{$stage})
@var{$converter} is a converter object. @var{\%tree} is the Texinfo
tree root element. @var{$stage} is the current stage.
@@ -1964,8 +1964,8 @@ with @code{texinfo_register_command_opening}:
The call of the user defined functions is:
-@deftypefn {Function Reference} {$text} command_open @
- ($converter, $command_name, \%element)
+@deftypefn {Function Reference} @var{$text} command_open @
+ (@var{$converter}, @var{$command_name}, @var{\%element})
@var{$converter} is a converter object. @var{$command_name}
is the @@-command name without the @@. @var{\%element} is the Texinfo
element.
@@ -1976,7 +1976,7 @@ The @var{$text} returned is prepended to the formatting
of the
It is possible to have access to the default opening function reference.
The function used is:
-@deftypefun \&default_command_open $converter->default_command_open
($command_name)
+@deftypefun @var{\&default_command_open}
@var{$converter}->default_command_open (@var{$command_name})
@var{$command_name} is the @@-command name without the @@. Returns the
default opening function reference for @var{$command_name}, or undef if there
is none.
@end deftypefun
@@ -1995,8 +1995,8 @@ arguments and contents have been formatted, are
registered with
@end defun
The call of the user defined functions is:
-@deftypefn {Function Reference} {$text} command_conversion @
- ($converter, $command_name, \%element, \@@args, $content)
+@deftypefn {Function Reference} @var{$text} command_conversion @
+ (@var{$converter}, @var{$command_name}, @var{\%element},
@var{\@@args}, @var{$content})
@var{$converter} is a converter object. @var{$command_name}
is the @@-command name without the @@. @var{\%element} is the Texinfo
element.
@@ -2061,7 +2061,7 @@ The @var{$text} returned is the result of the @@-command
conversion.
To call a conversion function from user defined code, the function reference
should first be retrieved using @code{command_conversion}:
-@deftypefun \&command_conversion $converter->command_conversion ($command_name)
+@deftypefun @var{\&command_conversion} @var{$converter}->command_conversion
(@var{$command_name})
@var{$command_name} is the @@-command name without the @@. Returns the
conversion function reference for @var{$command_name}, or undef if there is
none,
which should only be the case for @@-commands ignored in HTML not defined by
the user.
@@ -2077,7 +2077,7 @@ passing arguments that may correspond to another
@@-command:
It is possible to have access to the default conversion function reference.
The function used is:
-@deftypefun \&default_command_conversion
$converter->default_command_conversion ($command_name)
+@deftypefun @var{\&default_command_conversion}
@var{$converter}->default_command_conversion (@var{$command_name})
@var{$command_name} is the @@-command name without the @@. Returns the
default conversion function reference for @var{$command_name}, or undef if
there is none,
which should only be the case for @@-commands ignored in HTML.
@@ -2098,8 +2098,8 @@ with @code{texinfo_register_type_opening}:
The call of the user defined functions is:
-@deftypefn {Function Reference} {$text} type_open ($converter, @
- $type, \%element)
+@deftypefn {Function Reference} @var{$text} type_open (@var{$converter}, @
+ @var{$type}, @var{\%element})
@var{$converter} is a converter object. @var{$type} is the element type.
@var{\%element} is the Texinfo
element.
@@ -2110,7 +2110,7 @@ type container.
It is possible to have access to the default opening function reference.
The function used is:
-@deftypefun \&default_type_open $converter->default_type_open ($type)
+@deftypefun @var{\&default_type_open} @var{$converter}->default_type_open
(@var{$type})
@var{$command_name} is the element type. Returns the
default opening function reference for @var{$type}, or undef if there is none.
@end deftypefun
@@ -2131,8 +2131,8 @@ function is called after conversion of the content.
The call of the user defined functions is:
-@deftypefn {Function Reference} {$text} type_conversion ($converter, @
- $type, \%element, $content)
+@deftypefn {Function Reference} @var{$text} type_conversion (@var{$converter},
@
+ @var{$type}, @var{\%element}, @var{$content})
@var{$converter} is a converter object. @var{$type} is the element type.
@var{\%element} is the Texinfo element. @var{$content} is text for elements
associated with text, or the formatted contents for other elements.
@@ -2144,7 +2144,7 @@ The @var{$text} returned is the result of the @@-command
conversion.
To call a conversion function from user defined code, the function reference
should first be retrieved using @code{type_conversion}:
-@deftypefun \&command_conversion $converter->type_conversion ($type)
+@deftypefun @var{\&type_conversion} @var{$converter}->type_conversion
(@var{$type})
@var{$type} is the element type. Returns the
conversion function reference for @var{$type}, or undef if there is none,
which should only be the case for types ignored in HTML not defined by the
user.
@@ -2153,7 +2153,7 @@ which should only be the case for types ignored in HTML
not defined by the user.
It is possible to have access to the default conversion function reference.
The function used is:
-@deftypefun \&default_type_conversion $converter->default_type_conversion
($command_name)
+@deftypefun @var{\&default_type_conversion}
@var{$converter}->default_type_conversion (@var{$type})
@var{$type} is the element type. Returns the
default conversion function reference for @var{$type}, or undef if there is
none,
which should only be the case for types ignored in HTML.
@@ -2191,7 +2191,7 @@ function. @var{\&handler} is the user defined function
reference.
To call a formatting function from user defined code, the
function reference should first be retrieved using @code{formatting_function}:
-@deftypefun \&formatting_function $converter->formatting_function ($formatted)
+@deftypefun @var{\&formatting_function} @var{$converter}->formatting_function
(@var{$formatted})
@var{$formatted} is a string describing the formatting
function. Returns the associated formatting function reference.
@end deftypefun
@@ -2199,7 +2199,7 @@ function. Returns the associated formatting function
reference.
It is possible to have access to the default formatting function reference.
The function used is:
-@deftypefun \&default_formatting_function
$converter->default_formatting_function ($formatted)
+@deftypefun @var{\&default_formatting_function}
@var{$converter}->default_formatting_function (@var{$formatted})
@var{$formatted} is a string describing the formatting
function. Returns the default formatting function reference.
@end deftypefun
@@ -2238,8 +2238,8 @@ function reference.
@end defun
The call of the user defined functions is:
-@deftypefn {Function Reference} {$text} special_element_body ($converter, @
- $special_element_variety, \%element)
+@deftypefn {Function Reference} @var{$text} special_element_body
(@var{$converter}, @
+ @var{$special_element_variety},
@var{\%element})
@var{$converter} is a converter object. @var{$special_element_variety} is the
element variety. @var{\%element} is the Texinfo element.
@@ -2250,8 +2250,8 @@ To call a special element body formatting function from
user defined code, the
function reference should first be retrieved using
@code{special_element_body_formatting}:
-@deftypefun \&special_element_body_formatting
$converter->special_element_body_formatting @
- ($special_element_variety)
+@deftypefun @var{\&special_element_body_formatting}
@var{$converter}->special_element_body_formatting @
+ (@var{$special_element_variety})
@var{$special_element_variety} is the special element variety. Returns the
conversion function reference for @var{$variety}, or undef if there is none,
which should not happen for the special elements described in this manual.
@@ -2267,8 +2267,9 @@ my $footnotes_element_body
It is possible to have access to the default conversion function reference.
The function used is:
-@deftypefun \&default_special_element_body_formatting
$converter->defaults_special_element_body_formatting @
- ($special_element_variety)
+@deftypefun @var{\&default_special_element_body_formatting} @
+ @var{$converter}->defaults_special_element_body_formatting @
+ (@var{$special_element_variety})
@var{$special_element_variety} is the special element variety. Returns the
default conversion function reference for @var{$special_element_variety}, or
@code{undef} if there is none, which should not happen for the special elements
@@ -2296,8 +2297,8 @@ to have information correctly registered in the converter.
Opening an HTML element with one or more classes should always be done through
@code{html_attribute_class}:
-@deftypefun $element_open $converter->html_attribute_class ($html_element, @
- \@@classes)
+@deftypefun @var{$element_open} @var{$converter}->html_attribute_class @
+ (@var{$html_element}, @var{\@@classes})
Formats the beginning of an HTML element @var{$html_element}. @var{\@@classes}
is the list of classes for this element. The element opening returned does not
include the end of element symbol @samp{>} such that it is possible to add
@@ -2331,7 +2332,8 @@ HTML elements with an opening element, but no closing
element,
such as @code{<img>} or @code{<link>} should be closed by calling
@code{close_html_lone_element}:
-@deftypefun $html_element $converter->close_html_lone_element ($html_element)
+@deftypefun @var{$html_element} @var{$converter}->close_html_lone_element @
+ (@var{$html_element})
Close the @var{$html_element}, which can contain attributes, by prepending
@samp{>} or @samp{/>} depending on the @code{USE_XML_SYNTAX} customization
variable value.
@@ -2352,8 +2354,8 @@ the corresponding text should be in a call to
@code{substitute_html_non_breaking
to take into account @code{ENABLE_ENCODING} and @code{USE_NUMERIC_ENTITY}
customization variables:
-@deftypefun $substituted_text $converter->substitute_html_non_breaking_space @
- ($formatted_text)
+@deftypefun @var{$substituted_text}
@var{$converter}->substitute_html_non_breaking_space @
+ (@var{$formatted_text})
Substitute @code{ } according to customization variables values.
@end deftypefun
@@ -2370,7 +2372,7 @@ context to avoid using HTML elements in formatting when
in string context.
To determine if in string context, the functions is @code{in_string}:
-@deftypefun $in_string $converter->in_string ()
+@deftypefun @var{$in_string} @var{$converter}->in_string ()
Return true if in string context.
@end deftypefun
@@ -2394,14 +2396,14 @@ context to convert accordingly. @xref{Init File
Expansion Contexts}.
To determine if in preformatted context, the functions is
@code{in_preformatted}:
-@deftypefun $in_preformatted $converter->in_preformatted ()
+@deftypefun @var{$in_preformatted} @var{$converter}->in_preformatted ()
Return true if in preformatted context.
@end deftypefun
If in preformatted context, it is possible to get preformatted @@-commands and
preformatted types nesting with @code{preformatted_classes_stack}:
-@deftypefun @@preformatted_nesting $converter->preformatted_classes_stack ()
+@deftypefun @var{@@preformatted_nesting}
@var{$converter}->preformatted_classes_stack ()
Returns 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.
@@ -2436,18 +2438,19 @@ Each context is associated with a function:
@table @emph
@item code
-@deftypefun $in_code $converter->in_code ()
+@deftypefun @var{$in_code} @var{$converter}->in_code ()
Return true if in code context. @xref{Init File Expansion Contexts}.
@end deftypefun
@item math
-@deftypefun $in_math $converter->in_math ()
+@deftypefun @var{$in_math} @var{$converter}->in_math ()
Return true if in math context. @xref{Init File Expansion Contexts}.
@end deftypefun
@item raw
-@deftypefun $in_raw $converter->in_raw ()
+
+@deftypefun @var{$in_raw} @var{$converter}->in_raw ()
Return true if in raw format, in @code{@@inlineraw} or in @code{@@html}.
In such a context, text should be kept as is and special HTML characters should
not be protected.
@@ -2455,20 +2458,20 @@ not be protected.
@item verbatim
-@deftypefun $in_verbatim $converter->in_verbatim ()
+@deftypefun @var{$in_verbatim} @var{$converter}->in_verbatim ()
Return true if in verbatim context, corresponding to @code{@@verb} and
@code{@@verbatim}.
In general, HTML characters should be protected in this context.
@end deftypefun
@item upper-case
-@deftypefun $in_upper_case $converter->in_upper_case ()
+@deftypefun @var{$in_upper_case} @var{$converter}->in_upper_case ()
Return true if in upper-case context, corresponding to @code{@@sc}.
@end deftypefun
@item non-breakable space
-@deftypefun $in_non_breakable_space $converter->in_non_breakable_space ()
+@deftypefun @var{$in_non_breakable_space}
@var{$converter}->in_non_breakable_space ()
Return true if in non-breakable space context, corresponding to @code{@@w}.
@end deftypefun
@end table
@@ -2490,8 +2493,8 @@ All the functions take a converter object as their first
argument.
Called for an active direction, if @code{ICONS} is set, when formatting
the navigation panel (@pxref{Simple Navigation Panel Customization}).
-@deftypefn {Function Reference} {$text} format_button_icon_img @
- ($converter, $button, $icon, $name)
+@deftypefn {Function Reference} @var{$text} format_button_icon_img @
+ (@var{$converter}, @var{$button}, @var{$icon}, @var{$name})
@var{$button} is a button name, typically obtained from the @code{BUTTONS_NAME}
customization variable hash using a direction as key (@pxref{Directions}).
@var{$icon} is an image file name to be used as icon. @var{$name} is the
@@ -2503,8 +2506,8 @@ Returns a formatted icon image.
@item format_comment
-@deftypefn {Function Reference} {$text} format_comment @
- ($converter, $input_text)
+@deftypefn {Function Reference} @var{$text} format_comment @
+ (@var{$converter}, @var{$input_text})
Return @var{$input_text} in a comment.
@end deftypefn
@@ -2513,8 +2516,8 @@ Texinfo::Convert::Converter::xml_comment,tp_api}
@item format_heading_text
-@deftypefn {Function Reference} {$text} format_heading_text @
- ($converter, $command_name, \@@classes, $input_text, $level, $id, \%element)
+@deftypefn {Function Reference} @var{$text} format_heading_text @
+ (@var{$converter}, @var{$command_name}, @var{\@@classes}, @var{$input_text},
@var{$level}, @var{$id}, @var{\%element})
Returns a heading formatted using @var{$input_text} as heading text,
@var{$level}
as heading level, @var{\@@classes} for a class attribute. @var{$command_name}
gives an information on the @@-command the heading is associated to and can be
@@ -2532,14 +2535,14 @@ for a @var{$level} 2 heading.
@item format_program_string
-@deftypefn {Function Reference} {$text} format_program_string ($converter)
+@deftypefn {Function Reference} @var{$text} format_program_string
(@var{$converter})
This function reference should return the formatted program
string.
@end deftypefn
@item format_protect_text
-@deftypefn {Function Reference} {$text} format_protect_text @
- ($converter, $input_text)
+@deftypefn {Function Reference} @var{$text} format_protect_text @
+ (@var{$converter}, @var{$input_text})
Return @var{$input_text} with HTML special characters and form feeds
protected.
@@ -2555,8 +2558,8 @@ Texinfo::Convert::Converter::xml_protect_text,tp_api}.
This function reference is called if there is not another HTML element to
add an identifier attribute to.
-@deftypefn {Function Reference} {$text} format_separate_anchor @
- ($converter, $id, $class)
+@deftypefn {Function Reference} @var{$text} format_separate_anchor @
+ (@var{$converter}, @var{$id}, @var{$class})
@var{id} is the identifier.
@var{$class} is an optional class to be used in an HTML class attribute.
@@ -2587,14 +2590,14 @@ preformatted containers and @@-comands such as
@code{@@abbr}, @code{@@footnote},
To get the current paragraph and preformatted number, use
@code{paragraph_number}
or @code{preformatted_number}:
-@deftypefun $number $converter->paragraph_number ()
-@deftypefunx $number $converter->preformatted_number ()
+@deftypefun @var{$number} @var{$converter}->paragraph_number ()
+@deftypefunx @var{$numbe}r @var{$converter}->preformatted_number ()
Return the current paragraph or preformatted container number in the
current formatting context.
@end deftypefun
To get the topmost block @@-command being converted, use
@code{top_block_command}:
-@deftypefun $command_name $converter->top_block_command ()
+@deftypefun @var{$command_name} @var{$converter}->top_block_command ()
Return the most recent block @@-command seen in the current formatting
context.
@end deftypefun
@@ -2602,22 +2605,22 @@ context.
To get the text filling and alignement context, determined by
@code{@@flushleft}
or @code{@@center}, use @code{in_align}:
-@deftypefun $align_context $converter->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 $multi_expanded_context_information $converter->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 location of an image file, use @code{html_image_file_location_name}:
-@deftypefun {($image_file, $image_basefile, $image_extension, $image_path,
$image_path_encoding)} @
- $converter->html_image_file_location_name ($command_name, \%element, \@@args)
+@deftypefun {(@var{$image_file}, @var{$image_basefile},
@var{$image_extension}, @var{$image_path}, @var{$image_path_encoding})} @
+ @var{$converter}->html_image_file_location_name (@var{$command_name},
@var{\%element}, @var{\@@args})
@var{$command_name}, @var{\%element} and @var{\@@args} should be the arguments
of an @code{@@image} @@-command formatting (@pxref{Command Tree Element
Conversion Functions}).
@@ -2654,7 +2657,7 @@ done in the sectioning commands conversion function only.
The function for registering opened section extent is
@code{register_opened_section_level}:
-@defun $converter->register_opened_section_level ($level, $closing_text)
+@defun @var{$converter}->register_opened_section_level ($level, $closing_text)
@var{$level} is the sectioning command level. It is typically
obtained with @code{section->@{'structure'@}->@{'section_level'@}}
(@pxref{Texinfo Tree Elements in User Defined Functions}).
@@ -2665,7 +2668,7 @@ section level @var{$level} is closed.
The function for closing registered section extents is
@code{close_registered_sections_level}:
-@deftypefun @@closing_texts $converter->close_registered_sections_level
($level)
+@deftypefun @var{@@closing_texts}
@var{$converter}->close_registered_sections_level (@var{$level})
@var{$level} is the sectioning command level. Opened section are closed
down to section level @var{$level}. The closing texts are returned in the
@var{@@closing_texts} array in order.
@@ -2696,7 +2699,7 @@ prepended in inline text containers.
Pending formatted content text is registered with
@code{register_pending_formatted_inline_content}:
-@defun $converter->register_pending_formatted_inline_content ($category,
$content)
+@defun @var{$converter}->register_pending_formatted_inline_content ($category,
$content)
@var{$content} is the formatted content to be registered and output
in the next inline container. @var{$category} is a indicator of the source
of the formatted inline content, mostly used to cancel registered content
@@ -2707,7 +2710,7 @@ Pending formatted content can (and should) be cancelled
when it is known that
there is no suitable inline container to be used to output the text. The
function is @code{cancel_pending_formatted_inline_content}:
-@deftypefun $cancelled_content
$converter->cancel_pending_formatted_inline_content ($category)
+@deftypefun @var{$cancelled_content}
@var{$converter}->cancel_pending_formatted_inline_content (@var{$category})
Cancel the first @var{$category} pending formatted content text found.
Returns @code{undef} if nothing was cancelled, and the cancelled
content otherwise.
@@ -2717,7 +2720,7 @@ Pending formatted content is gathered by calling
@code{get_pending_formatted_inl
In the default case, this is done in inline containers opening
code (@pxref{Type Tree Element Opening Functions}).
-@deftypefun $content $converter->get_pending_formatted_inline_content ()
+@deftypefun @var{$content}
@var{$converter}->get_pending_formatted_inline_content ()
Returns the concatenated pending content.
@end deftypefun
@@ -2732,11 +2735,11 @@ container opening code, right after
@code{get_associated_formatted_inline_content} is called in the inline
container conversion function (@pxref{Type Tree Element Conversion Functions}).
-@defun $converter->associate_pending_formatted_inline_content (\%element,
$content)
+@defun @var{$converter}->associate_pending_formatted_inline_content
(\%element, $content)
Associate @var{$content} to the Texinfo tree element @var{\%element}.
@end defun
-@deftypefun $content $converter->get_associated_formatted_inline_content
(\%element)
+@deftypefun @var{$content}
@var{$converter}->get_associated_formatted_inline_content (@var{\%element})
Get @var{$content} associated to the Texinfo tree element @var{\%element}.
@end deftypefun
@@ -2749,12 +2752,12 @@ for the file begin or end formatting,
@code{register_file_information} can be
used to associate information, and @code{get_file_information} to retrieve that
information.
-@defun $converter->register_file_information ($key, $value)
+@defun @var{$converter}->register_file_information ($key, $value)
Associate the current output file name file to the key @var{$key}, itself
associated to the value @var{$value}.
@end defun
-@deftypefun $value $converter->get_file_information ($key, $file_name)
+@deftypefun @var{$value} @var{$converter}->get_file_information (@var{$key},
@var{$file_name})
Return the value associated to the key @var{$key} and file name
@var{$file_name}.
@end deftypefun
@@ -2766,7 +2769,7 @@ For information shared among formatting functions without
involving the
converter, the function @code{shared_conversion_state} can be used both for
initialization of shared information and to share information:
-@deftypefun $reference $converter->shared_conversion_state ($name,
$initialization)
+@deftypefun @var{$reference} @var{$converter}->shared_conversion_state
(@var{$name}, @var{$initialization})
Return the reference @var{$reference} associated with @var{$name}.
@var{$initialization} is only read the first time @var{$name} is seen and sets
up the reference that will be reused afterwards. If @var{$initialization} is a
@@ -2808,23 +2811,23 @@ commands, index entries and footnotes are also
associated to targets.
To get the unique Texinfo tree element corresponding to a label, use
@code{label_command}:
-@deftypefun \%element $converter->label_command ($label)
+@deftypefun @var{\%element} @var{$converter}->label_command (@var{$label})
Return the element in the tree that @var{$label} refers to.
@end deftypefun
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}:
-@deftypefun $identifier $converter->command_id (\%target_element)
+@deftypefun @var{$identifier} @var{$converter}->command_id
(@var{\%target_element})
Returns the id specific of the @var{\%target_element} tree element.
@end deftypefun
-@deftypefun $file_name $converter->command_filename (\%target_element)
+@deftypefun @var{$file_name} @var{$converter}->command_filename
(@var{\%target_element})
Returns the file name of the @var{\%target_element} tree element.
@end deftypefun
-@deftypefun $href $converter->command_href (\%target_element,
$source_filename, @
- $source_command,
$specified_target)
+@deftypefun @var{$href} @var{$converter}->command_href
(@var{\%target_element}, @
+ @var{$source_filename}, @var{$source_command}, @var{$specified_target})
Return string for linking to @var{\%target_element} with @code{<a href>}.
@var{$source_filename} is the file the link comes from. If not set, the current
file name is used. @var{$source_command} is an optional argument, the
@@ -2836,7 +2839,7 @@ identifier if set.
To get the text of tree elements that may be used as link description, use
@code{command_text}:
-@deftypefun $result $converter->command_text (\%target_element, $type)
+@deftypefun @var{$result} @var{$converter}->command_text
(@var{\%target_element}, @var{$type})
Return the information to be used for a hyperlink to @var{\%target_element}.
The information returned depends on @var{$type}:
@@ -2860,15 +2863,15 @@ 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 \%top_level_element $converter->command_root_element_command @
- (\%target_element)
+@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 \%node_element $converter->command_node (\%target_element)
+@deftypefun @var{\%node_element} @var{$converter}->command_node
(@var{\%target_element})
Return the node element associated with @var{\%target_element}.
@end deftypefun
@@ -2879,7 +2882,7 @@ Return the node element associated with
@var{\%target_element}.
To get the id of a footnote in the main document, use
@code{footnote_location_target}:
-@deftypefun $target $converter->footnote_location_target (\%footnote_element)
+@deftypefun @var{$target} @var{$converter}->footnote_location_target
(@var{\%footnote_element})
Return the id for the location of the footnote @var{\%footnote_element}
in the main document (where the footnote number or symbol appears).
@end deftypefun
@@ -2887,8 +2890,8 @@ in the main document (where the footnote number or symbol
appears).
To get an href to link to a footnote location in the main document, use
@code{footnote_location_href}:
-@deftypefun $href $converter->footnote_location_href (\%footnote_element, @
- $source_filename, $specified_target, $target_filename)
+@deftypefun @var{$href} @var{$converter}->footnote_location_href
(@var{\%footnote_element}, @
+ @var{$source_filename}, @var{$specified_target}, @var{$target_filename})
Return string for linking to @var{\%footnote_element} location
in the main document with @code{<a href>}. @var{$source_filename} is the file
the link comes from. If not set, the current file name is used.
@@ -2904,8 +2907,8 @@ To get id and link href of sectioning commands in table
of contents
and short table of contents, use @code{command_contents_target} and
@code{command_contents_href}:
-@deftypefun $target $converter->command_contents_target (\%sectioning_element,
@
- $contents_or_shortcontents)
+@deftypefun @var{$target} @var{$converter}->command_contents_target @
+ (@var{\%sectioning_element}, @var{$contents_or_shortcontents})
Returns the id for the location of @var{\%sectioning_element} sectioning
element in the table of contents, if @var{$contents_or_shortcontents} is
@samp{contents}, or in the short table of contents, if
@@ -2913,8 +2916,8 @@ element in the table of contents, if
@var{$contents_or_shortcontents} is
@samp{summarycontents}.
@end deftypefun
-@deftypefun $href $converter->command_contents_href (\%sectioning_element, @
- $contents_or_shortcontents, $source_filename)
+@deftypefun @var{$href} @var{$converter}->command_contents_href @
+ (@var{\%sectioning_element}, @var{$contents_or_shortcontents},
@var{$source_filename})
Return string for linking to the @var{\%sectioning_element} sectioning element
location in the table of contents, if @var{$contents_or_shortcontents} is
@samp{contents} or in the short table of contents, if
@@ -2926,7 +2929,7 @@ from. If not set, the current file name is used.
To determine if a tree unit element is the top element, use
@code{element_is_tree_unit_top}:
-@deftypefun $is_tree_unit_top $converter->element_is_tree_unit_top (\%element)
+@deftypefun @var{$is_tree_unit_top} @var{$converter}->element_is_tree_unit_top
(@var{\%element})
Returns true if the @var{\%element} Texinfo tree element is the tree unit
Top element (@pxref{Output Element Units}) and is either associated with the
@code{@@top} sectioning command or with the @code{Top} @code{@@node}.
@@ -2935,8 +2938,8 @@ Top element (@pxref{Output Element Units}) and is either
associated with the
To get information on the special element variety associated with
an @@-command command name, use
@code{command_name_special_element_information}:
-@deftypefun {($special_element_variety, \%special_element, $class_base,
$special_element_direction)} @
- $converter->command_name_special_element_information ($command_name)
+@deftypefun {(@var{$special_element_variety}, @var{\%special_element},
@var{$class_base}, @var{$special_element_direction})} @
+ @var{$converter}->command_name_special_element_information
(@var{$command_name})
@var{$command_name} is an @@-command name without the leading @@.
If the @var{$command_name} is not associated with a special element, returns
@code{undef}. Otherwise, return the @var{$special_element_variety}
@@ -2959,7 +2962,7 @@ To get the Texinfo tree unit special element associated
with
a special element direction, such as @samp{About} or @samp{Contents},
use @code{special_direction_element}:
-@deftypefun \%special_element $converter->special_direction_element
($direction)
+@deftypefun @var{\%special_element}
@var{$converter}->special_direction_element (@var{$direction})
Return the special element associated with direction @var{$direction}, or
@code{undef} if the direction is not a special element direction or the special
element is not output.
@@ -2969,7 +2972,7 @@ To get the Texinfo tree unit element associated with
other global element
directions, such as @samp{Top} or @samp{Index}, use
@code{global_direction_element}:
-@deftypefun \%element $converter->global_target_elements_directions
($direction)
+@deftypefun @var{\%element}
@var{$converter}->global_target_elements_directions (@var{$direction})
Return the Texinfo tree unit element corresponding to direction
@var{$direction}, or @code{undef} if the direction is not a global direction.
@end deftypefun
@@ -2977,8 +2980,8 @@ Return the Texinfo tree unit element corresponding to
direction
To get link information for relative and global
directions, use @code{from_element_direction}:
-@deftypefun $result $converter->from_element_direction ($direction, $type, @
- $source_element, $source_filename)
+@deftypefun @var{$result} @var{$converter}->from_element_direction
(@var{$direction}, @var{$type}, @
+ @var{$source_element}, @var{$source_filename})
Return a string for linking to @var{$direction}, or the information
to be used for a hyperlink to @var{$direction}, depending on @var{$type}.
The possible values for @var{$type} are described in
@@ -3001,8 +3004,8 @@ whether a rule should be output.
To get information on tree elements unit counter in files, use
@code{count_elements_in_filename}:
-@deftypefun $count $converter->count_elements_in_filename ($specification, @
- $file_name)
+@deftypefun @var{$count} @var{$converter}->count_elements_in_filename @
+ (@var{$specification}, @var{$file_name})
Return tree unit element counter for @var{$file_name}, or @code{undef} if
the counter does not exist. The counter returned depends on
@var{$specification}:
@@ -3041,7 +3044,7 @@ functions formatting their argument elsewhere, two
functions are available:
@code{register_footnote} to be called where they appear in the document, and
@code{get_pending_footnotes} to be called where they are formatted.
-@defun $converter->register_footnote (\%element, $footnote_id, @
+@defun @var{$converter}->register_footnote (\%element, $footnote_id, @
$foot_in_doc_id, $number_in_doc, $footnote_location_filename,
$multi_expanded_region)
@var{\%element} is the footnote texinfo tree element. @var{$footnote_id} is the
identifier for the location where the footnote arguments are expanded.
@@ -3059,7 +3062,7 @@ Information}).
also call @code{command_href} to link to the location where the footnote
text will be expanded (@pxref{Target Commands Links@comma{} Texts and
Associated Commands}).
-@deftypefun {@@pending_footnotes_information}
$converter->get_pending_footnotes ()
+@deftypefun @var{@@pending_footnotes_information}
@var{$converter}->get_pending_footnotes ()
Returns in @var{@@pending_footnotes_information} the information gathered
in @code{register_footnote}. Each of the array element in
@var{@@pending_footnotes_information}
is an array reference containing the arguments of @code{register_footnote}
@@ -3070,8 +3073,8 @@ The formatting of footnotes content is done by the
@code{format_footnotes_sequence} formatting reference
(@pxref{Specific formating Functions}):
-@deftypefn {Function Reference} $footnotes_sequence format_footnotes_sequence @
- ($converter)
+@deftypefn {Function Reference} @var{$footnotes_sequence}
format_footnotes_sequence @
+ (@var{$converter})
Formats and returns the footnotes that need to be formatted. This function
normally calls @code{get_pending_footnotes}. The default function also calls
@code{footnote_location_href} (@pxref{Other Links@comma{} Headings and
@@ -3090,8 +3093,8 @@ there is only one tree unit element or no tree unit
element, the
pending footnotes need to be formatted. This function reference
can be replaced by a user defined function.
-@deftypefn {Function Reference} $footnotes_segment format_footnotes_segment @
- ($converter)
+@deftypefn {Function Reference} @var{$footnotes_segment}
format_footnotes_segment @
+ (@var{$converter})
Returns the footnotes formatted. In the default case, the function reference
calls @code{format_footnotes_sequence} and also sets up a header with
@code{format_heading_text} (@pxref{Basic Formatting Customization}), using the
@@ -3166,8 +3169,8 @@ Finally, the following function reference provides even
more control
over the table of contents and short table of contents formatting
reference:
-@deftypefn {Function Reference} $toc_result format_contents @
- ($converter, $command_name, \%element, $filename)
+@deftypefn {Function Reference} @var{$toc_result} format_contents @
+ (@var{$converter}, @var{$command_name}, @var{\%element}, @var{$filename})
@var{$command_name} is the @@-command name without leading @@, should be
@samp{contents}, @samp{shortcontents} or @samp{summarycontents}.
@var{\%element} is optional. It corresponds to the @var{$command_name} Texinfo
@@ -3256,8 +3259,8 @@ All the formatting functions take a converter object as
first argument.
The overall display of navigation panels is controlled via this
function reference, @code{format_navigation_header}:
-@deftypefn {Function Reference} $navigation_text format_navigation_header @
- ($converter, \@@buttons, $command_name, \%element)
+@deftypefn {Function Reference} @var{$navigation_text}
format_navigation_header @
+ (@var{$converter}, @var{\@@buttons}, @var{$command_name}, @var{\%element})
@var{\@@buttons} is an array reference holding the specification of
the buttons for the navigation panel
(@pxref{Simple Navigation Panel Customization}). @var{\%element} is the
@@ -3274,8 +3277,8 @@ The customization variable
@code{VERTICAL_HEAD_NAVIGATION} should be relevant.
The navigation panel display is controlled via @code{format_navigation_panel}:
-@deftypefn {Function Reference} $navigation_text format_navigation_panel @
- ($converter, \@@buttons, $command_name, \%element,
$vertical)
+@deftypefn {Function Reference} @var{$navigation_text} format_navigation_panel
@
+ (@var{$converter}, @var{\@@buttons}, @var{$command_name}, @var{\%element},
@var{$vertical})
@var{\@@buttons} is an array reference holding the specification of the buttons
for that navigation panel. @var{\%element} is the element in which the
navigation header is formatted. @var{$command_name} is the associated command
@@ -3290,8 +3293,8 @@ in the navigation panel can be formatted with a call to
The function reference @code{format_button} does the formatting of
one button:
-@deftypefn {Function Reference} $formatted_button format_button @
- ($converter, $button)
+@deftypefn {Function Reference} @var{$formatted_button} format_button @
+ (@var{$converter}, @var{$button})
@var{$button} holds the specification of the button (@pxref{Buttons Display}).
Returns the formatted result in @var{$formatted_button}.
@@ -3317,8 +3320,8 @@ All the formatting functions take a converter object as
first argument.
By default, the function associated with @code{format_element_header}
formats the header and navigation panel of a tree unit element.
-@deftypefn {Function Reference} $formatted_header format_element_header @
- ($converter, $command_name, \%element, \%tree_unit_element)
+@deftypefn {Function Reference} @var{$formatted_header} format_element_header @
+ (@var{$converter}, @var{$command_name}, @var{\%element},
@var{\%tree_unit_element})
@var{\%element} is the element in which the navigation header is formatted
(sectioning command, @code{@@node} or special element). @var{$command_name} is
the associated command name. It may be @code{undef} for special elements.
@@ -3338,8 +3341,8 @@ variables values and location in file.
Similarly, the function associated with @code{format_element_footer}
formats the footer and navigation panel of a tree unit element.
-@deftypefn {Function Reference} $formatted_footer format_element_footer @
- ($converter, $tree_unit_type, \%tree_unit_element, $content)
+@deftypefn {Function Reference} @var{$formatted_footer} format_element_footer @
+ (@var{$converter}, @var{$tree_unit_type}, @var{\%tree_unit_element},
@var{$content})
@var{\%tree_unit_element} is the tree unit element element in which the
navigation footer is formatted. @var{$tree_unit_type} is the associated type.
@var{$content} is the formatted element content.
@@ -3481,8 +3484,8 @@ may also be used to change the page header formatting.
The following function references give full control over the
page header formatting done at the top of each HTML output file.
-@deftypefn {Function Reference} $file_begin format_begin_file ($converter, @
- $filename, \%tree_unit_element)
+@deftypefn {Function Reference} @var{$file_begin} format_begin_file @
+ (@var{$converter}, @var{$filename}, @var{\%tree_unit_element})
@cindex @code{<body>} tag, outputting
@var{$filename} is the name of the file output.
@var{\%tree_unit_element} is the first tree unit element of the file.
@@ -3512,7 +3515,8 @@ Variables,,, texinfo, Texinfo}.
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} $file_end format_end_file ($converter,
$filename)
+@deftypefn {Function Reference} @var{$file_end} format_end_file @
+ (@var{$converter}, @var{$filename})
@var{$filename} is the name of the file output.
@cindex @code{</body>} tag, outputting
This function should print the page footer, including
@@ -3537,7 +3541,7 @@ is set in the default case. @xref{HTML Customization
Variables,,, texinfo, Texi
The following functions references provides full control on the title and
``title page'' formatting:
-@deftypefn {Function Reference} $title_titlepage format_title_titlepage
($converter)
+@deftypefn {Function Reference} @var{$title_titlepage} format_title_titlepage
(@var{$converter})
Returns the formatted title or ``title page'' text.
In the default case, return nothing if @code{SHOW_TITLE} is not set, return the
@@ -3545,7 +3549,7 @@ output of @code{format_titlepage} if
@code{USE_TITLEPAGE_FOR_TITLE} is set, and
otherwise output a simple title based on @code{simpletitle}.
@end deftypefn
-@deftypefn {Function Reference} $title_page format_titlepage ($converter)
+@deftypefn {Function Reference} @var{$title_page} format_titlepage
(@var{$converter})
Returns the formatted ``title page'' text.
In the default case, the @code{@@titlepage} is used if found in global
information,
@@ -3562,8 +3566,8 @@ The CSS @var{element}.@var{class} that appeared in a
file, gathered through
Opening}) are available through the @code{html_get_css_elements_classes}
function:
-@deftypefun @@css_element_classes $converter->html_get_css_elements_classes @
- ($file_name)
+@deftypefun @var{@@css_element_classes}
@var{$converter}->html_get_css_elements_classes @
+ (@var{$file_name})
Returns an array containing @code{element.class} pairs of elements and classes
appearing in @var{$file_name}.
@end deftypefun
@@ -3571,8 +3575,8 @@ appearing in @var{$file_name}.
It is possible to change completely how CSS lines are generated
by redefining the following function reference:
-@deftypefn {Function Reference} $css_lines format_css_lines ($converter, @
- $file_name)
+@deftypefn {Function Reference} @var{$css_lines} format_css_lines @
+ (@var{$converter}, @var{$file_name})
This function returns the CSS lines and @code{<script>} HTML element
for @var{$file_name}.
@@ -3592,8 +3596,8 @@ Node redirection pages are output if @code{NODE_FILES} is
set (@pxref{Invoking
It is possible to change completely how node redirection pages
are generated by redefining the following function reference:
-@deftypefn {Function Reference} $node_redirection_file_content @
- format_node_redirection_page ($converter, \%element)
+@deftypefn {Function Reference} @var{$node_redirection_file_content} @
+ format_node_redirection_page (@var{$converter}, @var{\%element})
@var{\%element} is a node element needing a redirection page. A redirection
page is needed if the node file name is not the file name expected for
HTML cross manual references (@pxref{HTML Xref,,, texinfo, Texinfo}).
@@ -3672,8 +3676,8 @@
Texinfo::Structuring::section_level_adjusted_command_name, tp_api}.
the argument is some Texinfo code, @code{html_convert_css_string_for_list_mark}
can be used to convert that argument to text usable in CSS style
specifications.
-@deftypefun $text_for_css $converter->html_convert_css_string_for_list_mark @
- (\%element, $explanation)
+@deftypefun @var{$text_for_css}
@var{$converter}->html_convert_css_string_for_list_mark @
+ (@var{\%element}, @var{$explanation})
@var{\%element} is the Texinfo element that is converted to CSS text.
In general, it is @code{$itemize->@{'args'@}->[0]}, with @code{$itemize} an
@code{@@itemize}
Texinfo tree element. @var{$explanation} is an optional string describing
what is