[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: Update Parser POD documentation
|
From: |
Patrice Dumas |
|
Subject: |
branch master updated: Update Parser POD documentation |
|
Date: |
Sun, 11 Sep 2022 08:06:30 -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 ef35e8d133 Update Parser POD documentation
ef35e8d133 is described below
commit ef35e8d1339c7bf8827672a0a53e5c224e2bca19
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sun Sep 11 14:06:06 2022 +0200
Update Parser POD documentation
---
tp/Texinfo/ParserNonXS.pm | 177 +++++++++++++++++++++++-----------------------
1 file changed, 89 insertions(+), 88 deletions(-)
diff --git a/tp/Texinfo/ParserNonXS.pm b/tp/Texinfo/ParserNonXS.pm
index 52715be0a6..97e1ef4543 100644
--- a/tp/Texinfo/ParserNonXS.pm
+++ b/tp/Texinfo/ParserNonXS.pm
@@ -6260,8 +6260,9 @@ Texinfo to other formats. There is no promise of API
stability.
C<Texinfo::Parser> will parse Texinfo text into a Perl tree. In one pass
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.
+while doing the tree: for example, the C<@quotation> associated to an
C<@author>
+command, the number of cilumns in a multitable, or the node associated with a
+section.
=head1 METHODS
@@ -6546,7 +6547,7 @@ tree elements.
All the @-commands that have an associated label (so can be the
target of cross references) - C<@node>, C<@anchor> and C<@float> with
label - have a normalized name associated, constructed as described in the
-B<HTML Xref> node in the Texinfo manual. Those normalized labels and
+I<HTML Xref> node in the Texinfo documenation. Those normalized labels and
the association with @-commands is available through C<labels_information>:
=over
@@ -6746,7 +6747,7 @@ entered as
=item labels
A hash reference. Keys are normalized node names as described in the
-B<HTML Xref> node in the Texinfo manual. Instead of a node, it may also
+I<HTML Xref> node in the Texinfo manual. Instead of a node, it may also
be a float label or an anchor name. The value is the corresponding
@-command element in the tree.
@@ -7029,6 +7030,10 @@ and sectioning commands.
=over
+=item before_node_section
+
+Content before nodes and sectioning commands at the beginning of
C<document_root>.
+
=item document_root
=item root_line
@@ -7040,10 +7045,6 @@ root otherwise.
C<document_root> first content should be C<before_node_section>, then nodes and
sections @-commands elements, and also C<@bye> element.
-=item before_node_section
-
-Content before nodes and sectioning commands at the beginning of
C<document_root>.
-
=item preamble_before_beginning
This container holds everything appearing before the first content, including
@@ -7056,7 +7057,7 @@ This container holds everything that appears before
C<@setfilename>.
=item preamble_before_content
This container holds everything appearing before the first formatted content,
-corresponding to the I<preamble> in the Texinfo manual.
+corresponding to the I<preamble> in the Texinfo documentation.
=back
@@ -7067,19 +7068,10 @@ other elements appearing in their C<contents>.
=over
-=item paragraph
-
-A paragraph. The C<contents> of a paragraph (like other container
-elements for Texinfo content) are elements representing the contents of
-the paragraph in the order they occur, such as simple text elements
-without a C<cmdname> or C<type>, or @-command elements for commands
-appearing in the paragraph.
-
-=item preformatted
+=item before_item
-Texinfo code within a format that is not filled. Happens within some
-block commands like C<@example>, but also in menu (in menu descriptions,
-menu comments...).
+A container for content before the first C<@item> of block @-commands
+with items (C<@table>, C<@multitable>, C<@enumerate>...).
=item brace_command_arg
@@ -7110,30 +7102,48 @@ leads to
'args' => [{'type' => 'brace_command_arg',
'contents' => [{'text' => 'in code'}]}]}
-=item menu_entry
+=item bracketed
-=item menu_entry_leading_text
+This a special type containing content in brackets in the context
+where they are valid, in C<@math>.
-=item menu_entry_name
+=item bracketed_def_content
-=item menu_entry_separator
+Content in brackets on definition command lines.
-=item menu_entry_node
+=item bracketed_multitable_prototype
-=item menu_entry_description
+=item row_prototype
-A I<menu_entry> holds a full menu entry, like
+On C<@multitable> line, content in brackets is in
+I<bracketed_multitable_prototype>, text not in brackets
+is in I<row_prototype>.
- * node:: description.
+=item def_aggregate
-The different elements of the menu entry are directly in the
-I<menu_entry> C<args> array reference.
+Contains several elements that together are a single unit on a @def* line.
-I<menu_entry_leading_text> holds the star and following spaces.
-I<menu_entry_name> is the menu entry name (if present), I<menu_entry_node>
-corresponds to the node in the menu entry, I<menu_entry_separator> holds
-the text after the node and before the description, in most cases
-C<:: >. Lastly, I<menu_entry_description> is for the description.
+=item def_line
+
+=item def_item
+
+=item inter_def_item
+
+The I<def_line> type is either associated with a container within a
+definition command, or is the type of a definition command with a x
+form, like C<@deffnx>. It holds the definition line arguments.
+The container with type I<def_item> holds the definition text content.
+Content appearing before a definition command with a x form is in
+an I<inter_def_item> container.
+
+=item macro_name
+
+=item macro_arg
+
+Taken from C<@macro> definition and put in the C<args> key array of
+the macro, I<macro_name> is the type of the text fragment corresponding
+to the macro name, I<macro_arg> is the type of the text fragments
+corresponding to macro formal arguments.
=item menu_comment
@@ -7159,51 +7169,30 @@ and
will be in a I<menu_comment>.
-=item macro_name
-
-=item macro_arg
-
-Taken from C<@macro> definition and put in the C<args> key array of
-the macro, I<macro_name> is the type of the text fragment corresponding
-to the macro name, I<macro_arg> is the type of the text fragments
-corresponding to macro formal arguments.
-
-=item before_item
-
-A container for content before the first C<@item> of block @-commands
-with items (C<@table>, C<@multitable>, C<@enumerate>...).
-
-=item table_entry
+=item menu_entry
-=item table_term
+=item menu_entry_leading_text
-=item table_item
+=item menu_entry_name
-=item inter_item
+=item menu_entry_separator
-Those containers appear in C<@table>, C<@ftable> and C<@vtable>.
-A I<table_entry> container contains an entire row of the table.
-It contains a I<table_term> container, which holds all the C<@item> and
-C<@itemx> lines. This is followed by a I<table_item> container, which
-holds the content that is to go into the second column of the table.
+=item menu_entry_node
-If there is any content before an C<@itemx> (normally only comments,
-empty lines or maybe index entries are allowed), it will be in
-a container with type I<inter_item> at the same level of C<@item>
-and C<@itemx>, in a I<table_term>.
+=item menu_entry_description
-=item def_line
+A I<menu_entry> holds a full menu entry, like
-=item def_item
+ * node:: description.
-=item inter_def_item
+The different elements of the menu entry are directly in the
+I<menu_entry> C<args> array reference.
-The I<def_line> type is either associated with a container within a
-definition command, or is the type of a definition command with a x
-form, like C<@deffnx>. It holds the definition line arguments.
-The container with type I<def_item> holds the definition text content.
-Content appearing before a definition command with a x form is in
-an I<inter_def_item> container.
+I<menu_entry_leading_text> holds the star and following spaces.
+I<menu_entry_name> is the menu entry name (if present), I<menu_entry_node>
+corresponds to the node in the menu entry, I<menu_entry_separator> holds
+the text after the node and before the description, in most cases
+C<:: >. Lastly, I<menu_entry_description> is for the description.
=item multitable_head
@@ -7216,26 +7205,38 @@ with C<@headitem>, while I<multitable_body> contains
the rows associated
with C<@item>. A I<row> container contains the C<@item> and C<@tab>
forming a row.
-=item bracketed
+=item paragraph
-This a special type containing content in brackets in the context
-where they are valid, in C<@math>.
+A paragraph. The C<contents> of a paragraph (like other container
+elements for Texinfo content) are elements representing the contents of
+the paragraph in the order they occur, such as simple text elements
+without a C<cmdname> or C<type>, or @-command elements for commands
+appearing in the paragraph.
-=item bracketed_def_content
+=item preformatted
-Content in brackets on definition command lines.
+Texinfo code within a format that is not filled. Happens within some
+block commands like C<@example>, but also in menu (in menu descriptions,
+menu comments...).
-=item def_aggregate
+=item table_entry
-Contains several elements that together are a single unit on a @def* line.
+=item table_term
-=item bracketed_multitable_prototype
+=item table_item
-=item row_prototype
+=item inter_item
-On C<@multitable> line, content in brackets is in
-I<bracketed_multitable_prototype>, text not in brackets
-is in I<row_prototype>.
+Those containers appear in C<@table>, C<@ftable> and C<@vtable>.
+A I<table_entry> container contains an entire row of the table.
+It contains a I<table_term> container, which holds all the C<@item> and
+C<@itemx> lines. This is followed by a I<table_item> container, which
+holds the content that is to go into the second column of the table.
+
+If there is any content before an C<@itemx> (normally only comments,
+empty lines or maybe index entries are allowed), it will be in
+a container with type I<inter_item> at the same level of C<@item>
+and C<@itemx>, in a I<table_term>.
=back
@@ -7322,8 +7323,8 @@ The first argument normalized is in I<normalized>.
=item C<@float>
@-commands that are targets for cross-references have a I<normalized>
-key for the normalized label, built as specified in the Texinfo manual
-in the B<HTML Xref> node. There is also a I<node_content> key for
+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 the corresponding content.
C<@anchor> also has I<region> set to the special region name if
@@ -7475,8 +7476,8 @@ The arguments are in the I<nodes_manuals> array. Each
of the entries is a hash with a 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 Texinfo manual
-in the B<HTML Xref> node.
+key for the normalized label, built as specified in the I<HTML Xref>
+Texinfo documentation node.
An I<associated_section> key holds the tree element of the
sectioning command that follows the node. An I<node_preceding_part>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: Update Parser POD documentation,
Patrice Dumas <=