[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: Update POD
From: |
Patrice Dumas |
Subject: |
branch master updated: Update POD |
Date: |
Thu, 31 Oct 2024 17:05:54 -0400 |
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 764d110ef4 Update POD
764d110ef4 is described below
commit 764d110ef41d6a8bd1b85a02770d8f82bec95320
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Thu Oct 31 22:03:31 2024 +0100
Update POD
---
doc/tp_api/api_includes/Texinfo-Parser.texi | 29 ++++++++++++++++++-----------
tp/Texinfo/ParserNonXS.pm | 29 ++++++++++++++++++-----------
2 files changed, 36 insertions(+), 22 deletions(-)
diff --git a/doc/tp_api/api_includes/Texinfo-Parser.texi
b/doc/tp_api/api_includes/Texinfo-Parser.texi
index 96b309351e..257c7b7da2 100644
--- a/doc/tp_api/api_includes/Texinfo-Parser.texi
+++ b/doc/tp_api/api_includes/Texinfo-Parser.texi
@@ -978,7 +978,7 @@ The first argument normalized is in @emph{normalized}.
@@-commands that are targets for cross-references have a @emph{normalized} key
for
the normalized label, built as specified in the Texinfo documentation in the
-@emph{HTML Xref} node. There is also a @emph{node_content} key for an array
holding
+@emph{HTML Xref} node. There is also a @emph{node_content} key for an element
holding
the corresponding content.
@item @code{@@author}
@@ -1149,13 +1149,18 @@ with the element for the @@columnfractions command.
@item @code{@@node}
@anchor{Texinfo@asis{::}Parser @code{@@node}}
-Explicit directions labels information is in the @emph{line_arg}
-arguments @code{extra} node direction @code{@@node} arguments. They consist
-in a hash with the @emph{node_content} key for an array holding the
-corresponding content, a @emph{manual_content} key if there is an
-associated external manual name, and a @emph{normalized} key for the
-normalized label, built as specified in the @emph{HTML Xref}
-Texinfo documentation node.
+Explicit directions labels information are available in the @emph{line_arg}
+node directions arguments of @code{@@node}. Each @emph{line_arg} argument
element
+@code{extra} hash @emph{node_content} key value is an element holding the
+contents corresponding to the node name. There is also a
@emph{manual_content} key
+if there is an associated external manual name, and a @emph{normalized} key
for the
+normalized label, built as specified in the @emph{HTML Xref} Texinfo
documentation
+node.
+
+If you called @ref{Texinfo@asis{::}Structuring $nodes_list =
nodes_tree($document),, Texinfo::Structuring::nodes_tree},
+the @emph{node_directions} hash in the @code{@@node} element @code{extra}
associates
+@emph{up}, @emph{next} and @emph{prev} keys to the elements corresponding to
the node
+line directions.
An @emph{associated_section} key holds the tree element of the
sectioning command that follows the node. An @emph{node_preceding_part}
@@ -1195,9 +1200,9 @@ no sectioning command between the @code{@@part} and the
node.
@item @code{@@inforef}
@anchor{Texinfo@asis{::}Parser @code{@@inforef}}
-The node argument @emph{brace_arg} holds information on the label, like the one
-appearing in the @code{@@node} @emph{line_arg} explicit directions arguments
@code{extra}
-hash labels information.
+The @emph{brace_arg} corresponding to the node argument holds information on
+the label, with the same information in the @code{extra} hash as for the
+@code{@@node} @emph{line_arg} explicit directions arguments.
@item @code{row}
@anchor{Texinfo@asis{::}Parser @code{row} 1}
@@ -1213,6 +1218,8 @@ The part preceding the command is in
@emph{associated_part}.
If the level of the document was modified by @code{@@raisections}
or @code{@@lowersections}, the differential level is in @emph{level_modifier}.
+Other @code{extra} keys are set when you call @ref{Texinfo@asis{::}Structuring
$sections_list = sectioning_structure($document),,
Texinfo::Structuring::sectioning_structure}.
+
@item @code{untranslated_def_line_arg}
@anchor{Texinfo@asis{::}Parser @code{untranslated_def_line_arg} 1}
diff --git a/tp/Texinfo/ParserNonXS.pm b/tp/Texinfo/ParserNonXS.pm
index dc5312dfab..a7e6cd3b3c 100644
--- a/tp/Texinfo/ParserNonXS.pm
+++ b/tp/Texinfo/ParserNonXS.pm
@@ -9123,7 +9123,7 @@ The first argument normalized is in I<normalized>.
@-commands that are targets for cross-references have a I<normalized> key for
the normalized label, built as specified in the Texinfo documentation in the
-I<HTML Xref> node. There is also a I<node_content> key for an array holding
+I<HTML Xref> node. There is also a I<node_content> key for an element holding
the corresponding content.
=item C<@author>
@@ -9267,13 +9267,18 @@ with the element for the @columnfractions command.
=item C<@node>
-Explicit directions labels information is in the I<line_arg>
-arguments C<extra> node direction C<@node> arguments. They consist
-in a hash with the I<node_content> key for an array holding the
-corresponding content, a I<manual_content> key if there is an
-associated external manual name, and a I<normalized> key for the
-normalized label, built as specified in the I<HTML Xref>
-Texinfo documentation node.
+Explicit directions labels information are available in the I<line_arg>
+node directions arguments of C<@node>. Each I<line_arg> argument element
+C<extra> hash I<node_content> key value is an element holding the
+contents corresponding to the node name. There is also a I<manual_content> key
+if there is an associated external manual name, and a I<normalized> key for the
+normalized label, built as specified in the I<HTML Xref> Texinfo documentation
+node.
+
+If you called
L<Texinfo::Structuring::nodes_tree|Texinfo::Structuring/$nodes_list =
nodes_tree($document)>,
+the I<node_directions> hash in the C<@node> element C<extra> associates
+I<up>, I<next> and I<prev> keys to the elements corresponding to the node
+line directions.
An I<associated_section> key holds the tree element of the
sectioning command that follows the node. An I<node_preceding_part>
@@ -9307,9 +9312,9 @@ no sectioning command between the C<@part> and the node.
=item C<@inforef>
-The node argument I<brace_arg> holds information on the label, like the one
-appearing in the C<@node> I<line_arg> explicit directions arguments C<extra>
-hash labels information.
+The I<brace_arg> corresponding to the node argument holds information on
+the label, with the same information in the C<extra> hash as for the
+C<@node> I<line_arg> explicit directions arguments.
=item C<row>
@@ -9323,6 +9328,8 @@ The part preceding the command is in I<associated_part>.
If the level of the document was modified by C<@raisections>
or C<@lowersections>, the differential level is in I<level_modifier>.
+Other C<extra> keys are set when you call
L<Texinfo::Structuring::sectioning_structure|Texinfo::Structuring/$sections_list
= sectioning_structure($document)>.
+
=item C<untranslated_def_line_arg>
I<documentlanguage> holds the C<@documentlanguage> value.
- branch master updated: Update POD,
Patrice Dumas <=