Next: Heading Elements and Document Structure, Previous: Sectioning Commands Elements and Document Structure, Up: Tree Elements and Document Structure   [Contents][Index]

---

10.4.5.2 Node Elements and Document Structure ¶

The following keys of the extra node elements hash can be interesting in user-defined formatting and conversion functions:

normalized

Normalized node name. See HTML Xref in Texinfo.

Most of the information on document structure associated to a @node tree element is available in the node relations information associated to the node tree element. This is an hash reference obtained by calling converter_node_relations_of_node:

Function: \%node_relations = $converter->converter_node_relations_of_node (\%element) ¶

Return the node relations information associated to the node tree element \%element, or ‘undef’ if it cannot be found⁵.

The following keys are in node relations hash references:

element

The @node Texinfo tree element associated to the node relations.

associated_section

Sectioning command relations information corresponding to the sectioning command associated to the node.

associated_title_command

Sectioning command, heading command or @xrefname tree element following the node.

node_preceding_part

Part @-command relations information of the @part associated to the node.

menus

A list of menu tree elements found in the node.

node_directions

Hash reference with up, next and prev keys associated to the corresponding node relations directions.

node_description

Tree element holding a description of the node, either a @nodedescription or a @nodedescriptionblock.

node_long_description

Tree element holding a long description of the node, corresponding to a @nodedescriptionblock tree element.

Nodes relations can also be retrieved by calling $document->nodes_list() on the $document obtained through get_info (see Converter General Information).