[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: Add index entries in Pod sections
|
From: |
Patrice Dumas |
|
Subject: |
branch master updated: Add index entries in Pod sections |
|
Date: |
Fri, 18 Feb 2022 17:54:36 -0500 |
This is an automated email from the git hooks/post-receive script.
pertusus pushed a commit to branch master
in repository texinfo.
The following commit(s) were added to refs/heads/master by this push:
new 5e1ded75b5 Add index entries in Pod sections
5e1ded75b5 is described below
commit 5e1ded75b5659134f1301c874b1aa005854dd656
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Fri Feb 18 23:54:02 2022 +0100
Add index entries in Pod sections
---
tp/Texinfo/Convert/NodeNameNormalization.pm | 2 ++
tp/Texinfo/Convert/Texinfo.pm | 1 +
tp/Texinfo/Convert/Text.pm | 4 +++
tp/Texinfo/Convert/Unicode.pm | 9 ++++++-
tp/Texinfo/Convert/Utils.pm | 8 +++++-
tp/Texinfo/ParserNonXS.pm | 40 +++++++++++++++++++++++------
tp/Texinfo/Report.pm | 30 ++++++++++++----------
tp/Texinfo/Structuring.pm | 22 ++++++++++++++++
tp/Texinfo/Transformations.pm | 30 ++++++++++++++--------
tp/Texinfo/Translations.pm | 1 +
10 files changed, 114 insertions(+), 33 deletions(-)
diff --git a/tp/Texinfo/Convert/NodeNameNormalization.pm
b/tp/Texinfo/Convert/NodeNameNormalization.pm
index 7d78a24a75..1b3639e99b 100644
--- a/tp/Texinfo/Convert/NodeNameNormalization.pm
+++ b/tp/Texinfo/Convert/NodeNameNormalization.pm
@@ -395,6 +395,7 @@ normalized node names.
=over
=item $normalized = normalize_node($tree)
+X<C<normalize_node>>
The Texinfo I<$tree> is returned as a string, normalized as described in the
Texinfo manual for HTML Xref.
@@ -404,6 +405,7 @@ The result will be poor for Texinfo trees which are not
@-command arguments
C<@node> or block commands.
=item $transliterated = transliterate_texinfo($tree, $no_unidecode)
+X<C<transliterate_texinfo>>
The Texinfo I<$tree> is returned as a string, with non ascii letters
transliterated as ascii, but otherwise similar with C<normalize_node>
diff --git a/tp/Texinfo/Convert/Texinfo.pm b/tp/Texinfo/Convert/Texinfo.pm
index 44ef52554b..461626e375 100644
--- a/tp/Texinfo/Convert/Texinfo.pm
+++ b/tp/Texinfo/Convert/Texinfo.pm
@@ -267,6 +267,7 @@ and C<@value> are expanded, and some invalid code is
discarded.
=over
=item $texinfo_text = convert_to_texinfo($tree)
+X<C<convert_to_texinfo>>
Converts the Texinfo tree I<$tree> to Texinfo code.
diff --git a/tp/Texinfo/Convert/Text.pm b/tp/Texinfo/Convert/Text.pm
index f3b44083f1..065030878d 100644
--- a/tp/Texinfo/Convert/Text.pm
+++ b/tp/Texinfo/Convert/Text.pm
@@ -852,6 +852,7 @@ output strings translation or error handling.
=over
=item $result = convert_to_text($tree, $options)
+X<C<convert_to_text>>
Convert a Texinfo tree to simple text. I<$options> is a hash reference of
options. The converter is very simple, and has almost no internal state
besides
@@ -906,6 +907,7 @@ C<tex>), and if the corresponding value is set, the format
is expanded.
=back
=item $result_accent_text = ascii_accent($text, $accent_command)
+X<C<ascii_accent>>
I<$text> is the text appearing within an accent command. I<$accent_command>
should be a Texinfo tree element corresponding to an accent command taking
@@ -913,6 +915,7 @@ an argument. The function returns a transliteration of the
accented
character.
=item $result_accent_text = ascii_accent_fallback($converter, $text,
$accent_command)
+X<C<ascii_accent_fallback>>
Same as C<ascii_accent> but with an additional first argument
converter, which is in ignored, but needed if this function is to
@@ -920,6 +923,7 @@ be in argument of functions that need a fallback for accents
conversion.
=item $accents_text = text_accents($accents, $encoding, $set_case)
+X<C<text_accents>>
I<$accents> is an accent command that may contain other nested accent
commands. The function will format the whole stack of nested accent
diff --git a/tp/Texinfo/Convert/Unicode.pm b/tp/Texinfo/Convert/Unicode.pm
index 28c4bde526..1a5c070564 100644
--- a/tp/Texinfo/Convert/Unicode.pm
+++ b/tp/Texinfo/Convert/Unicode.pm
@@ -1617,6 +1617,7 @@ actual conversion is done by Perl, not by the module.
=over
=item $result = brace_no_arg_command($command_name, $encoding)
+X<C<brace_no_arg_command>>
Return the Unicode representation of a command with brace and no argument
I<$command_name> (like C<@bullet{}>, C<@aa{}> or C<@guilsinglleft{}>),
@@ -1624,6 +1625,7 @@ or C<undef> if there the Unicode representation cannot be
converted to encoding
I<$encoding>.
=item $possible_conversion = check_unicode_point_conversion($arg,
$output_debug)
+X<C<check_unicode_point_conversion>>
Check that it is possible to output actual UTF-8 binary bytes
corresponding to the Unicode code point string I<$arg> (such as
@@ -1635,6 +1637,7 @@ Returns 1 if the conversion is possible and can be
attempted,
0 otherwise.
=item $result = encoded_accents($converter, $text, $stack, $encoding,
$format_accent, $set_case)
+X<C<encoded_accents>>
I<$encoding> is the encoding the accented characters should be encoded to. If
I<$encoding> not set, I<$result> is set to C<undef>. Nested accents and
@@ -1657,12 +1660,14 @@ If I<$set_case> is positive, the result is upper-cased,
while if it is negative,
the result is lower-cased.
=item $width = string_width($string)
+X<C<string_width>>
Return the string width, taking into account the fact that some characters
have a zero width (like composing accents) while some have a width of 2
(most chinese characters, for example).
=item $result = unicode_accent($text, $accent_command)
+X<C<unicode_accent>>
I<$text> is the text appearing within an accent command. I<$accent_command>
should be a Texinfo tree element corresponding to an accent command taking
@@ -1670,6 +1675,7 @@ an argument. The function returns the Unicode
representation of the accented
character.
=item $is_decoded = unicode_point_decoded_in_encoding($encoding,
$unicode_point)
+X<C<unicode_point_decoded_in_encoding>>
Return true if the I<$unicode_point> will be encoded in the encoding
I<$encoding>. The I<$unicode_point> should be specified as a four letter
@@ -1678,7 +1684,8 @@ string describing an hexadecimal number with letters in
upper case
If the encoding is not supported in Texinfo, the result will always be false.
-=item $result = unicode_text ($text, $in_code)
+=item $result = unicode_text($text, $in_code)
+X<C<unicode_text>>
Return I<$text> with dashes and quotes corresponding, for example to C<---> or
C<'>, represented as Unicode code points. If I<$in_code> is set, the text is
diff --git a/tp/Texinfo/Convert/Utils.pm b/tp/Texinfo/Convert/Utils.pm
index bc79df3abb..cffd54c890 100644
--- a/tp/Texinfo/Convert/Utils.pm
+++ b/tp/Texinfo/Convert/Utils.pm
@@ -337,6 +337,7 @@ On strings translations, see L<Texinfo::Translations>.
=over
=item $arguments = definition_arguments_content($element)
+X<C<definition_arguments_content>>
I<$element> should be a C<@def*> Texinfo tree element. Texinfo elements
on the @-command line corresponding to arguments in the function
@@ -346,6 +347,7 @@ on the @-command line. If there is no argument,
I<$arguments>
will be C<undef>.
=item $tree = definition_category($converter, $def_line)
+X<C<definition_category>>
The I<$converter> argument may be undef. I<$def_line> is a
C<def_line> texinfo tree container. This function
@@ -355,10 +357,12 @@ If I<$converter> is not defined, the resulting string
won't be
translated.
=item $tree = expand_today($converter)
+X<C<expand_today>>
Expand today's date, as a texinfo tree with translations.
=item $tree = expand_verbatiminclude($registrar, $configuration_information,
$verbatiminclude)
+X<C<expand_verbatiminclude>>
The I<$registrar> argument may be undef. I<$verbatiminclude> is a
C<@verbatiminclude> tree element. This function returns a
@@ -367,6 +371,7 @@ reading it. If I<$registrar> is not defined, errors
messages are
not registered.
=item (\@contents, \@accent_commands) =
find_innermost_accent_contents($element)
+X<C<find_innermost_accent_contents>>
I<$element> should be an accent command Texinfo tree element. Returns
an array reference containing the innermost accent command contents,
@@ -374,7 +379,8 @@ normally a text element with one or two letter, and an
array reference
containing the accent commands nested in I<$element> (including
I<$element>).
-=item $result = numbered_heading ($converter, $heading_element, $heading_text,
$do_number)
+=item $result = numbered_heading($converter, $heading_element, $heading_text,
$do_number)
+X<C<numbered_heading>>
The I<$converter> argument may be undef. I<$heading_element> is
a heading command tree element. I<$heading_text> is the already
diff --git a/tp/Texinfo/ParserNonXS.pm b/tp/Texinfo/ParserNonXS.pm
index 83959afe6d..918ff154ad 100644
--- a/tp/Texinfo/ParserNonXS.pm
+++ b/tp/Texinfo/ParserNonXS.pm
@@ -542,6 +542,12 @@ foreach my $canonical_encoding ('us-ascii', 'utf-8',
'iso-8859-1',
$canonical_texinfo_encodings{$canonical_encoding} = 1;
}
+# Taking an encoding name $ENCODING as argument, the function returns
+# $canonical_texinfo_encoding: the corresponding canonical Texinfo encoding,
+# as described in the Texinfo manual (or undef);
+# $perl_encoding: an encoding name suitable for perl;
+# $canonical_output_encoding: an encoding name suitable for most
+# output formats, especially HTML.
sub _encoding_alias($)
{
my $encoding = shift;
@@ -6030,9 +6036,9 @@ Texinfo to other formats. There is no promise of API
stability.
=head1 DESCRIPTION
Texinfo::Parser will parse Texinfo text into a Perl tree. In one pass
-it expands user-defined @-commands, conditionals (@ifset, @ifinfo...)
-and @value and constructs the tree. Some extra information is gathered
-while doing the tree: for example, the block command associated with @end,
+it expands user-defined @-commands, conditionals (C<@ifset>, C<@ifinfo>...)
+and C<@value> and constructs the tree. Some extra information is gathered
+while doing the tree: for example, the block command associated with C<@end>,
the number of rows in a multitable, or the node associated with a section.
=head1 METHODS
@@ -6048,6 +6054,8 @@ The following method is used to construct a new
C<Texinfo::Parser> object:
=over
=item $parser = Texinfo::Parser::parser($options);
+X<C<Texinfo::Parser::parser>>
+X<Parser initialization>
This method creates a new parser. The options may be provided as a hash
reference.
@@ -6143,6 +6151,7 @@ to use only what is in common, so document only what is
in common.
=over
=item $tree = parse_texi_line($parser, $text, $first_line_number)
+X<C<parse_texi_line>>
This function is used to parse a short fragment of Texinfo code.
@@ -6173,7 +6182,8 @@ to use only what is in common, so document only what is
in common.
=end comment
-=item $tree = parse_texi_piece ($parser, $text, $first_line_number)
+=item $tree = parse_texi_piece($parser, $text, $first_line_number)
+X<C<parse_texi_piece>>
This function is used to parse Texinfo fragments.
@@ -6200,11 +6210,12 @@ The XS parser implements only part of the arguments and
allows only a
restricted set of arguments types compared to the Perl parser. We want users
to use only what is in common, so document only what is in common.
-=item $tree = parse_texi_text ($parser, $text, $line_numbers_specification,
$file_name, $macro_name, $fixed_line_number)
+=item $tree = parse_texi_text($parser, $text, $line_numbers_specification,
$file_name, $macro_name, $fixed_line_number)
=end comment
-=item $tree = parse_texi_text ($parser, $text, $first_line_number)
+=item $tree = parse_texi_text($parser, $text, $first_line_number)
+X<C<parse_texi_text>>
This function is used to parse a text as a whole document.
@@ -6226,6 +6237,7 @@ of a macro.
=end comment
=item $tree = parse_texi_file($parser, $file_name)
+X<C<parse_texi_file>>
The file with name I<$file_name> is considered to be a Texinfo file and
is parsed into a tree.
@@ -6235,14 +6247,15 @@ undef is returned if the file couldn't be read.
=back
The errors collected during the tree parsing are registered in a
-C<Texinfo::Report> object. This object is available with
+L<Texinfo::Report> object. This object is available with
C<registered_errors>. The errors registered in the C<Texinfo::Report>
object are available through the C<errors> method. This method is
-described in L<errors|Texinfo::Report/($error_warnings_list, $error_count) =
errors ($registrar)>.
+described in L<Texinfo::Report::errors|Texinfo::Report/($error_warnings_list,
$error_count) = errors($registrar)>.
=over
=item $registrar = registered_errors($parser)
+X<C<registered_errors>>
I<$registrar> is a L<Texinfo::Report> object in which the errors
and warnings encountered while parsing are registered. If a I<registrar>
@@ -6261,6 +6274,7 @@ Some global information is available through
C<global_information>
=over
=item $info = global_information($parser)
+X<C<global_information>>
The I<$info> returned is a hash reference. The possible keys are
@@ -6294,6 +6308,7 @@ available through C<global_commands_information>
=over
=item $commands = global_commands_information($parser)
+X<C<global_commands_information>>
I<$commands> is an hash reference. The keys are @-command names. The
associated values are array references containing all the corresponding
@@ -6310,6 +6325,7 @@ the association with @-commands is available through
C<labels_information>:
=over
=item $labels_information, $targets_list, $nodes_list =
labels_information($parser)
+X<C<labels_information>>
I<$labels_information> is a hash reference whose keys are normalized
labels, and the associated value is the corresponding @-command.
@@ -6326,6 +6342,7 @@ This information is available through the method
C<floats_information>.
=over
=item $float_types = floats_information($parser)
+X<C<floats_information>>
I<$float_types> is a hash reference whose keys are normalized float
types (the first float argument, or the C<@listoffloats> argument).
@@ -6340,6 +6357,7 @@ or floats within the document are also available:
=over
=item $internal_references_array = internal_references_information($parser);
+X<C<internal_references_information>>
The function returns a list of cross-reference commands referring to
the same document.
@@ -6352,6 +6370,7 @@ also available through the C<indices_information> method.
=over
=item indices_information
+X<C<indices_information>>
$index_names = indices_information($parser);
@@ -6538,6 +6557,8 @@ C<@raisesections>.
=head1 TEXINFO TREE
+X<Texinfo tree elements>
+
A Texinfo tree element (called element because node is overloaded in
the Texinfo world) is an hash reference. There are three main categories
of tree element. Tree elements associated with an @-command have a
@@ -6572,6 +6593,8 @@ can do:
=head2 Element keys
+X<Texinfo tree element structure>
+
=over
=item cmdname
@@ -7003,6 +7026,7 @@ is in I<row_prototype>.
=back
=head2 Information available in the extra key
+X<Texinfo tree element extra key>
=head3 Extra keys available for more than one @-command
diff --git a/tp/Texinfo/Report.pm b/tp/Texinfo/Report.pm
index 833403a138..439766f8d9 100644
--- a/tp/Texinfo/Report.pm
+++ b/tp/Texinfo/Report.pm
@@ -244,8 +244,8 @@ Texinfo to other formats. There is no promise of API
stability.
=head1 DESCRIPTION
The Texinfo::Report module helps with error handling. It is
-used by the Texinfo modules Texinfo::Parser and
-Texinfo::Convert::Converter. To use this module, either create
+used by the Texinfo modules L<Texinfo::Parser> and
+L<Texinfo::Convert::Converter>. To use this module, either create
a new Texinfo::Report object or initialize another object
such as to be able to call Texinfo::Report methods. In any
case, C<Texinfo::Report::new()> is called to setup the module.
@@ -266,6 +266,7 @@ methods allow registering errors and warnings.
=item my $registrar = Texinfo::Report::new()
=item $converter->Texinfo::Report::new()
+X<C<Texinfo::Report::new>>
If called without argument, a Texinfo::Report object is initialized and
returned. This is how the module is used in the Texinfo Parsers, as
@@ -275,7 +276,8 @@ If called on a C<$converter>, the C<$converter> is
initialized itself
such as to be able to call Texinfo::Report methods. It is how it is
used in the Converters.
-=item ($error_warnings_list, $error_count) = errors ($registrar)
+=item ($error_warnings_list, $error_count) = errors($registrar)
+X<C<errors>>
This function returns as I<$error_count> the count of errors since
calling C<new>. The I<$error_warnings_list> is an array of hash references
@@ -315,20 +317,23 @@ the error or warning.
=item $registrar->line_warn($text, $configuration_information, $line_nr)
=item $registrar->line_error($text, $configuration_information, $line_nr)
+X<C<line_warn>>
+X<C<line_error>>
Register a warning or an error. The I<$text> is the text of the
error or warning. The I<$configuration_information> object gives
some information that can modify the messages or their delivery.
The optional I<$line_nr> holds the information on the error or
-warning location. It is associated with the I<line_nr> key of
-Texinfo tree elements as described in L<Texinfo::Parser/line_nr>
-for the @-commands. The I<$line_nr> structure is described
-in L<errors|/($error_warnings_list, $error_count) = errors ($registrar)>
-above.
+warning location. The I<$line_nr> structure corresponds to
+the I<line_nr> key of Texinfo tree elements as described
+in L<Texinfo::Parser/line_nr>, and is normally obtained from Texinfo
+elements I<line_nr> keys.
=item $registrar->document_warn($configuration_information, $text)
=item $registrar->document_error($configuration_information, $text)
+X<C<document_warn>>
+X<C<document_error>>
Register a document-wide error or warning. I<$text> is the error or
warning message. The I<$configuration_information> object gives
@@ -336,13 +341,12 @@ some information that can modify the messages or their
delivery.
=item $registrar->file_line_warn($text, $file, $line_nr)
-Register the warning message I<$text> for file I<$file>, with, optionally
-the line I<$line_nr> in the file.
-
=item $registrar->file_line_error($text, $file, $line_nr)
+X<C<file_line_warn>>
+X<C<file_line_error>>
-Register the error message I<$text> for file I<$file>, with, optionally
-the line I<$line_nr> in the file.
+Register the error or warning message I<$text> for file I<$file>, with,
+optionally the line I<$line_nr> in the file.
=back
diff --git a/tp/Texinfo/Structuring.pm b/tp/Texinfo/Structuring.pm
index 6eaa853d1e..5a3c60e87a 100644
--- a/tp/Texinfo/Structuring.pm
+++ b/tp/Texinfo/Structuring.pm
@@ -1788,6 +1788,7 @@ information, labels or refs are obtained from a parser,
see L<Texinfo::Parser>.
=over
=item associate_internal_references($registrar, $configuration_information,
$parser_information, $labels, $refs)
+X<C<associate_internal_references>>
Verify that internal references (C<@ref> and similar without
fourth of fifth argument) have an associated node, anchor or float.
@@ -1796,6 +1797,7 @@ element to the associated labeled tree element. Register
errors
in I<$registrar>.
=item check_nodes_are_referenced($registrar, $configuration_information,
$nodes_list, $top_node, $labels, $refs)
+X<C<check_nodes_are_referenced>>
Check that all the nodes are referenced (in menu, @*ref or node direction).
Register errors in I<$registrar>.
@@ -1804,12 +1806,14 @@ Should be called after C<complete_node_tree_with_menus>
in order to
have the autogenerated menus available.
=item complete_node_tree_with_menus($registrar, $configuration_information,
$nodes_list, $top_node)
+X<C<complete_node_tree_with_menus>>
Complete nodes directions with menu directions. Check consistency
of menus, sectionning and nodes direction structures.
Register errors in I<$registrar>.
=item elements_directions($configuration_information, $labels, $tree_units)
+X<C<elements_directions>>
Directions are set up for the tree unit elements in the array reference
I<$tree_units> given in argument. The corresponding hash is in
@@ -1875,6 +1879,7 @@ The next top level element.
=back
=item elements_file_directions($tree_units)
+X<C<elements_file_directions>>
In the directions reference described above for C<elements_directions>, sets
the I<PrevFile> and I<NextFile> directions to the elements in previous and
@@ -1888,12 +1893,14 @@ the file of each element.
The API for association of pages/elements to files is not defined yet.
=item @nodes_list = get_node_node_childs_from_sectioning($node)
+X<C<get_node_node_childs_from_sectioning>>
I<$node> is a node tree element. Find the node I<$node> children based
on the sectioning structure. For the node associated with C<@top>
sectioning command, the sections associated with parts are considered.
=item $entry_key = index_entry_sort_string($main_entry, $entry_tree_element,
$sortas, $options)
+X<C<index_entry_sort_string>>
Return a string suitable as a sort string, for index entries.
The index entry processed is I<$entry_tree_element>, and can be a
@@ -1905,6 +1912,7 @@ the generation of the sort string, typically obtained from
L<setup_index_entry_keys_formatting|/$option =
setup_index_entry_keys_formatting($configuration_information)>.
=item $merged_entries = merge_indices($index_names)
+X<C<merge_indices>>
Using information returned by L<Texinfo::Parser/indices_information>,
a structure holding all the index entries by index name is returned,
@@ -1916,22 +1924,26 @@ keys are the index names and values arrays of index
entry structures
described in details in L<Texinfo::Parser/index_entries>.
=item $new_block = new_block_command($content, $parent, $command_name)
+X<C<new_block_command>>
Returns the texinfo tree corresponding to a block command named
I<$command_name> with contents I<$content> and parent in tree I<$parent>.
=item $new_menu = new_complete_node_menu($node, $use_sections)
+X<C<new_complete_node_menu>>
Returns a texinfo tree menu for node I<$node>, pointing to the children
of the node obtained with the sectioning structure. If I<$use_sections>
is set, use section names instead of node names in menu.
=item $entry = new_node_menu_entry($node, $use_sections)
+X<C<new_node_menu_entry>>
Returns the texinfo tree corresponding to a single menu entry pointing to
I<$node>. If I<$use_sections> is set, use the section name instead of node
name.
=item $top_node = nodes_tree($registrar, $configuration_information,
$parser_information, $nodes_list, $labels)
+X<C<nodes_tree>>
Goes through nodes and set directions. Returns the top
node. Register errors in I<$registrar>.
@@ -1951,18 +1963,21 @@ Up, next and previous directions for the node.
=back
=item number_floats($float_information)
+X<C<number_floats>>
Number the floats as described in the Texinfo manual. Sets
the I<number> key in the C<structure> hash of the float
tree elements.
=item $command_name = section_level_adjusted_command_name($element)
+X<C<section_level_adjusted_command_name>>
Return the sectioning command name corresponding to the sectioning
element I<$element>, adjusted in order to take into account raised
and lowered sections, when needed.
=item $sections_root, $sections_list = sectioning_structure($registrar,
$configuration_information, $tree)
+X<C<sectioning_structure>>
This function goes through the tree and gather information on
the document structure for sectioning commands. It returns I<$sections_root>
@@ -2008,6 +2023,7 @@ account C<@part> elements.
=back
=item set_menus_node_directions($registrar, $configuration_information,
$parser_information, $global_commands, $nodes_list, $labels);
+X<C<set_menus_node_directions>>
Goes through menu and set directions. Register errors in I<$registrar>.
@@ -2030,10 +2046,12 @@ Up, next and previous directions as set in menus.
=back
=item $option = setup_index_entry_keys_formatting($configuration_information)
+X<C<setup_index_entry_keys_formatting>>
Return options for conversion of Texinfo to text relevant for index keys
sorting.
=item ($index_entries_sorted, $index_entries_sort_strings) =
sort_indices($registrar, $configuration_information, $merged_index_entries,
$sort_by_letter)
+X<C<sort_indices>>
If I<$sort_by_letter> is set, sort by letter, otherwise sort all
entries together. In both cases, a hash reference with index names
@@ -2053,6 +2071,7 @@ entries with the strings that were used to sort them.
Register errors in I<$registrar>.
=item $tree_units = split_by_node($tree)
+X<C<split_by_node>>
Returns a reference array of tree units where a node is associated to
the following sectioning commands. Sectioning commands without nodes
@@ -2079,6 +2098,7 @@ The node command associated with the element.
=back
=item $tree_units = split_by_section($tree)
+X<C<split_by_section>>
Similarly with C<split_by_node>, returns an array of tree units. This time,
lone nodes are associated with the previous sections and lone sections
@@ -2088,6 +2108,7 @@ The C<structure> and C<extra> hash keys set are the same,
except that I<unit_com
the sectioning command associated with the element.
=item $pages = split_pages($tree_units, $split)
+X<C<split_pages>>
The tree units from the array reference argument have an extra
I<first_in_page> value set in the C<structure> hash reference to
@@ -2115,6 +2136,7 @@ No splitting, only one page is returned, holding all the
tree units.
=back
=item warn_non_empty_parts($registrar, $configuration_information,
$global_commands)
+X<C<warn_non_empty_parts>>
Register a warning in I<$registrar> for each C<@part> that is not empty
in I<$global_commands> information (typically obtained by calling
diff --git a/tp/Texinfo/Transformations.pm b/tp/Texinfo/Transformations.pm
index ad52c3c56e..6d0cf8c383 100644
--- a/tp/Texinfo/Transformations.pm
+++ b/tp/Texinfo/Transformations.pm
@@ -866,7 +866,8 @@ No method is exported in the default case.
=over
-=item complete_tree_nodes_menus ($tree, $add_section_names_in_entries)
+=item complete_tree_nodes_menus($tree, $add_section_names_in_entries)
+X<C<complete_tree_nodes_menus>>
Add menu entries or whole menus for nodes associated with sections,
based on the sectioning tree. If the optional
@@ -874,7 +875,8 @@ C<$add_section_names_in_entries> argument is set, a menu
entry
name is added using the section name. This function should be
called after L<sectioning_structure|Texinfo::Structuring/$sections_root,
$sections_list = sectioning_structure($registrar, $configuration_information,
$tree)>.
-=item complete_tree_nodes_missing_menu ($tree, $use_section_names_in_entries)
+=item complete_tree_nodes_missing_menu($tree, $use_section_names_in_entries)
+X<C<complete_tree_nodes_missing_menu>>
Add whole menus for nodes associated with sections and without menu,
based on the sectioning tree. If the optional
@@ -882,7 +884,8 @@ C<$add_section_names_in_entries> argument is set, a menu
entry
name is added using the section name. This function should be
called after L<sectioning_structure|Texinfo::Structuring/$sections_root,
$sections_list = sectioning_structure($registrar, $configuration_information,
$tree)>.
-=item ($root_content, $added_sections) = fill_gaps_in_sectioning ($tree)
+=item ($root_content, $added_sections) = fill_gaps_in_sectioning($tree)
+X<C<fill_gaps_in_sectioning>>
This function adds empty C<@unnumbered> and similar commands in a tree
to fill gaps in sectioning. This may be used, for example, when converting
@@ -895,7 +898,8 @@ If the sectioning commands are lowered or raised (with
C<@raisesections>,
C<@lowersection>) the tree may be modified with C<@raisesections> or
C<@lowersection> added to some tree elements.
-=item ($root_content, $added_nodes) = insert_nodes_for_sectioning_commands
($tree, $nodes_list, $targets_list, $labels)
+=item ($root_content, $added_nodes) =
insert_nodes_for_sectioning_commands($tree, $nodes_list, $targets_list, $labels)
+X<C<insert_nodes_for_sectioning_commands>>
Insert nodes for sectioning commands without node in C<$tree>.
Add nodes to the labels used as targets for references C<$labels>
@@ -905,9 +909,11 @@ An array reference is returned, containing the root
contents
with added nodes, as well as an array reference containing the
added nodes.
-=item menu_to_simple_menu ($menu)
+=item menu_to_simple_menu($menu)
-=item set_menus_to_simple_menu ($nodes_list)
+=item set_menus_to_simple_menu($nodes_list)
+X<C<menu_to_simple_menu>>
+X<C<set_menus_to_simple_menu>>
C<menu_to_simple_menu> transforms the tree of a menu tree element.
C<set_menus_to_simple_menu> calls C<menu_to_simple_menu> for all the
@@ -917,13 +923,15 @@ A simple menu has no I<menu_comment>, I<menu_entry> or
I<menu_entry_description>
container anymore, their content are merged directly in the menu in
I<preformatted> container.
-=item $detailmenu = new_master_menu ($translations, $labels)
+=item $detailmenu = new_master_menu($translations, $labels)
+X<C<new_master_menu>>
Returns a detailmenu tree element formatted as a master node.
I<$translations>, if defined, should be a L<Texinfo::Translations> object and
should also hold configuration information.
-=item protect_hashchar_at_line_beginning ($registrar,
$configuration_information, $tree)
+=item protect_hashchar_at_line_beginning($registrar,
$configuration_information, $tree)
+X<C<protect_hashchar_at_line_beginning>>
Protect hash (#) character at the beginning of line such that they would not be
considered as lines to be processed by the CPP processor. The I<$registrar>
@@ -935,7 +943,8 @@ C<get_conf()>. If both I<$registrar> and
I<$configuration_information> are
defined they are used for error reporting in case an hash character could not
be protected because it appeared in a raw environment.
-=item $modified_tree reference_to_arg_in_tree ($tree)
+=item $modified_tree reference_to_arg_in_tree($tree)
+X<C<reference_to_arg_in_tree>>
Modify I<$tree> by converting reference @-commands to simple text using one of
the arguments. This transformation can be used, for example, to remove
@@ -943,7 +952,8 @@ reference @-command from constructed node names trees, as
node names cannot
contain reference @-command while there could be some in the tree used in input
for the node name tree.
-=item regenerate_master_menu ($translations, $labels)
+=item regenerate_master_menu($translations, $labels)
+X<C<regenerate_master_menu>>
Regenerate the Top node master menu, replacing the first detailmenu
in Top node menus or appending at the end of the Top node menu.
diff --git a/tp/Texinfo/Translations.pm b/tp/Texinfo/Translations.pm
index e0fea7ab6f..f7990b29c3 100644
--- a/tp/Texinfo/Translations.pm
+++ b/tp/Texinfo/Translations.pm
@@ -437,6 +437,7 @@ converted documents, and returns, in general, a texinfo
tree.
=over
=item $tree = $object->gdt($string, $replaced_substrings, $mode, $lang)
+X<C<gdt>>
The I<$string> is a string to be translated. In the default case,
the function returns a Texinfo tree, as the string is interpreted
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: Add index entries in Pod sections,
Patrice Dumas <=