Next: , Up: Nodes   [Contents][Index]

4.1 Texinfo Document Structure

Nodes can contain menus, which contain the names of child nodes within the parent node; for example, a node corresponding to a chapter would have a menu of the sections in that chapter. The menus allow the user to move to the child nodes in a natural way in the online output.

In addition, nodes contain node pointers that name other nodes. The ‘Next’ and ‘Previous’ pointers form nodes at the same sectioning level into a chain. As you might imagine, the ‘Next’ pointer links to the next node, and the ‘Previous’ pointer links to the previous node. Thus, for example, all the nodes that are at the level of sections within a chapter are linked together, and the order in this chain is the same as the order of the children in the menu of the parent chapter. Each child node records the parent node name as its ‘Up’ pointer.

The Info and HTML output from makeinfo for each node includes links to the ‘Next’, ‘Previous’, and ‘Up’ nodes. The HTML also uses the accesskey attribute with the values ‘n’, ‘p’, and ‘u’ respectively. This allows people using web browsers to follow the navigation using (typically) M-letter, e.g., M-n for the ‘Next’ node, from anywhere within the node. Node pointers and menus provide structure for Info files just as chapters, sections, subsections, and the like provide structure for printed books. The two structures are theoretically distinct; in practice, however, the tree structure of printed books is essentially always used for the node and menu structure also, as this leads to a document which is easiest to follow. See Texinfo Document Structure.

Typically, the sectioning structure and the node structure are completely parallel, with one node for each chapter, section, etc., and with the nodes following the same hierarchical arrangement as the sectioning. Thus, if a node is at the logical level of a chapter, its child nodes are at the level of sections; similarly, the child nodes of sections are at the level of subsections.

Although it is technically possible to create Texinfo documents with only one structure or the other, or for the two structures not to be parallel, or for either the sectioning or node structure to be abnormally formed, etc., this is not at all recommended. To the best of our knowledge, all the Texinfo manuals currently in general use do follow the conventional parallel structure.

Next: , Up: Nodes   [Contents][Index]