texinfo: Info Format Regular Nodes

Info Format General Layout

Info Format Local Variables

Back to Software Index

Info Format: Regular Nodes
--------------------------

Regular nodes look like this:

         <node> =
     ^_
     File: <fn>, Node: <id1>, (Next: <id2>, )? (Prev: <id3>, )? Up: <id4>

     <general text, until the next ^_ or end-of-file>

  The 'Next' and 'Prev' pointers are optional.  The 'Up' pointer may
technically also be absent, although this is most likely the case of a
wrongly-structured Info manual.  At least one space must be present
after each colon and comma, but any number of spaces are ignored.

  This <node> defines <id1> in file <fn>, which is typically just
'manualname' or perhaps 'manualname.info'.  Each of the other references
<id2>, <id3>, and <id4> must be defined with either 'Node' or 'Ref' in
the <tag table>.

  Conventionally the nodes are arranged to form a tree, but this is not
a requirement of the format.  Each pointer can refer to any defined
identifier.

  Identifiers cannot include periods, commas, colons or parentheses
(including @-commands which produce any of these); these can confuse
Info readers.  Note: Node Line Requirements.

  The <general text> of the node can include the special constructs
described next.