summaryrefslogtreecommitdiff
path: root/macros/texinfo/texinfo/doc/tp_api/api_includes
diff options
context:
space:
mode:
Diffstat (limited to 'macros/texinfo/texinfo/doc/tp_api/api_includes')
-rw-r--r--macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Common.texi5
-rw-r--r--macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Converter.texi4
-rw-r--r--macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Text.texi2
-rw-r--r--macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Parser.texi9
-rw-r--r--macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Structuring.texi46
5 files changed, 50 insertions, 16 deletions
diff --git a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Common.texi b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Common.texi
index 772afd7522..b667125c0d 100644
--- a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Common.texi
+++ b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Common.texi
@@ -164,6 +164,11 @@ as @code{@@macro}, @code{@@verbatim} or @code{@@ignore}.
@@-commands associated with raw output format, like @code{@@html}, or
@code{@@docbook}.
+@item %math_commands
+@anchor{Texinfo::Common %math_commands}
+
+@@-commands which contains math, like @code{@@math} or @code{@@displaymath}.
+
@item %texinfo_output_formats
@anchor{Texinfo::Common %texinfo_output_formats}
diff --git a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Converter.texi b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Converter.texi
index 6bc88b1215..fdb452a6f6 100644
--- a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Converter.texi
+++ b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Converter.texi
@@ -245,8 +245,8 @@ Patrice Dumas, <pertusus@@free.fr>
Hey! @strong{The above document had some coding errors, which are explained below:}
@table @asis
-@item Around line 1727:
-@anchor{Texinfo::Convert::Converter Around line 1727:}
+@item Around line 1713:
+@anchor{Texinfo::Convert::Converter Around line 1713:}
'=item' outside of any '=over'
diff --git a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Text.texi b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Text.texi
index 595cbf916e..5f6f4365d1 100644
--- a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Text.texi
+++ b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Convert-Text.texi
@@ -100,7 +100,7 @@ translation, as the converter object is also supposed to be a
@anchor{Texinfo::Convert::Text expanded_formats_hash}
A reference on a hash. The keys should be format names (like @code{html},
-@code{tex}), and if thecorresponding value is set, the format is expanded.
+@code{tex}), and if the corresponding value is set, the format is expanded.
@end table
diff --git a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Parser.texi b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Parser.texi
index 332281ba6f..3d9037cf9b 100644
--- a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Parser.texi
+++ b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Parser.texi
@@ -113,10 +113,11 @@ Default on.
Maximal number of nested user-defined macro calls. Default is 100000.
-@item SHOW_MENU
-@anchor{Texinfo::Parser SHOW_MENU}
+@item FORMAT_MENU
+@anchor{Texinfo::Parser FORMAT_MENU}
-If false, no menu-related errors are reported. Default is true.
+Possible values are 'nomenu', 'menu' and 'sectiontoc'. Only report
+menu-related errors for 'menu'.
@end table
@@ -133,7 +134,7 @@ For all those functions, if the @emph{$parser} argument is undef, a new
parser object is generated to parse the line. Otherwise the parser given
as an argument is used to parse into a tree.
-When @code{parse_texi_text} is used, the resulting tree is rooted at
+When @code{parse_texi_line} is used, the resulting tree is rooted at
a @code{root_line} type container. Otherwise, the resulting tree should be
rooted at a @code{text_root} type container if it does not contain nodes or
sections, at a @code{document_root} type container otherwise.
diff --git a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Structuring.texi b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Structuring.texi
index f15808f7da..2df3e39bca 100644
--- a/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Structuring.texi
+++ b/macros/texinfo/texinfo/doc/tp_api/api_includes/Texinfo-Structuring.texi
@@ -25,7 +25,9 @@ Texinfo::Structuring - information on Texinfo::Parser tree
elements_file_directions);
# $tree is a Texinfo document tree. $parser is a Texinfo::Parser object.
my $sections_root = sectioning_structure ($parser, $tree);
+ set_menus_node_directions($parser);
my $top_node = nodes_tree($parser);
+ complete_node_tree_with_menus($parser, $top_node);
number_floats($parser->floats_information());
associate_internal_references($parser);
my $elements;
@@ -59,9 +61,12 @@ Texinfo::Structuring - information on Texinfo::Parser tree
Texinfo::Structuring first allows to collect informations on a Texinfo tree.
In most case, it also requires a parser object to do that job. Thanks to
@code{sectioning_structure} the hierarchy of sectioning commands is determined.
-The node and menus tree is analysed with @code{nodes_tree}. Floats get their
-standard numbering with @code{number_floats} and internal references are matched
-up with nodes, floats or anchors with @code{associate_internal_references}.
+The directions implied by menus are determined with
+@code{set_menus_node_directions}. The node tree is analysed with @code{nodes_tree}.
+Nodes directions are completed with menu directions with
+@code{complete_node_tree_with_menus}. Floats get their standard numbering with
+@code{number_floats} and internal references are matched up with nodes, floats or
+anchors with @code{associate_internal_references}.
It is also possible to group the top-level contents of the tree, which consist
in nodes and sectioning commands into elements that group together a node and
@@ -148,13 +153,10 @@ account @code{@@part} elements.
@end table
-@item my $top_node = nodes_tree($parser)
-@anchor{Texinfo::Structuring my $top_node = nodes_tree($parser)}
+@item set_menus_node_directions($parser)
+@anchor{Texinfo::Structuring set_menus_node_directions($parser)}
-Goes through menu and nodes and set directions. Returns the top
-node.
-
-This functions sets:
+Goes through menu and set directions.
@table @asis
@item menu_child
@@ -176,6 +178,20 @@ Up, next and previous directions as set in menus.
@item node_up
@anchor{Texinfo::Structuring node_up}
+@end table
+
+@item my $top_node = nodes_tree($parser)
+@anchor{Texinfo::Structuring my $top_node = nodes_tree($parser)}
+
+Goes through nodes and set directions. Returns the top
+node.
+
+This functions sets:
+
+@table @asis
+@item node_up
+@anchor{Texinfo::Structuring node_up 1}
+
@item node_prev
@anchor{Texinfo::Structuring node_prev}
@@ -186,6 +202,13 @@ Up, next and previous directions for the node.
@end table
+@item complete_node_tree_with_menus($parser, $top_node)
+@anchor{Texinfo::Structuring complete_node_tree_with_menus($parser@comma{} $top_node)}
+
+Complete nodes directions with menu directions. Check consistency
+of menus, sectionning and nodes direction structures. Check that
+all the nodes are referenced (in menu, @@*ref or node direction).
+
@item number_floats($float_information)
@anchor{Texinfo::Structuring number_floats($float_information)}
@@ -368,6 +391,11 @@ In the directions reference described above for @code{elements_directions}, sets
the @emph{PrevFile} and @code{NextFile} directions to the elements in previous and
following files.
+It also sets @code{FirstInFile*} directions for all the elements by using
+the directions of the first element in file. So, for example,
+@code{FirstInFileNodeNext} is the next node of the first element in
+the file of each element.
+
The API for association of pages/elements to files is not defined yet.
@item $merged_entries = merge_indices($index_names)