texinfo: @top Command

@node

First Node

Back to Software Index

6.1.5 The '@top' Sectioning Command
-----------------------------------

The '@top' command is a special sectioning command that you should only
use after an '@node Top' line at the beginning of a Texinfo file.  The
'@top' command tells the 'makeinfo' formatter which node is to be used
as the root of the node tree (needed if your manual uses implicit node
pointers).

  It produces the same sort of output as '@unnumbered' (Note:
@unnumbered @appendix).

  The '@top' node is conventionally wrapped in an '@ifnottex'
conditional so that it will not appear in TeX output (Note:
Conditionals).  Thus, in practice, a Top node usually looks like this:

     @ifnottex
     @node Top
     @top YOUR-MANUAL-TITLE

     VERY-HIGH-LEVEL-SUMMARY
     @end ifnottex

  '@top' is ignored when raising or lowering sections.  That is, it is
never lowered and nothing can be raised to it (Note: Raise/lower
sections).