manpagez: man pages & more
info texinfo
Home | html | info | man
[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [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 (see section @unnumbered, @appendix: Chapters with Other Labeling).

The @top node is conventionally wrapped in an @ifnottex conditional so that it will not appear in TeX output (see section Conditionally Visible Text). 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 (see section Raise/lower Sections: @raisesections and @lowersections).


This document was generated on October 2, 2013 using texi2html 5.0.

© manpagez.com 2000-2017
Individual documents may contain additional copyright information.