[ << Documentation work ] | [Top][Contents] | [ Website work >> ] |
[ < Documentation files ] | [ Up : Texinfo introduction and usage policy ] | [ LilyPond formatting > ] |
5.4.3 Sectioning commands
The Notation Reference uses section headings at four, occasionally five, levels.
level section command 1 @chapter
2 @section
3 @subsection
4 @unnumberedsubsubsec
5 @subsubsubheading
The first three levels are numbered in HTML, the last two are not. A numbered section corresponds to a single HTML page in the split HTML documents.
The first four levels always have accompanying @node
commands so they can be referenced; they are also included in the
table of contents in HTML.
Most of the manual is written at level 4 under headings created with
@node Foo @unnumberedsubsubsec Foo
Level 3 subsections are created with
@node Foo @subsection Foo
Level 4 headings and menus5 must be preceded by level 3 headings and menus, and so on for level 3 and level 2. If this is not what is wanted, please use:
@subsubsubheading Foo
Leave two blank lines above a @node
; this makes it easier
to find sections in Texinfo code.
Do not use any @
-commands within a @node
. They
may be used for any @sub...
sections or headings, however.
not: @node @code{Foo} Bar @subsection @code{Foo} Bar but instead: @node Foo Bar @subsection @code{Foo} Bar
No punctuation may be used in the node names. If the heading text uses punctuation (in particular, colons and commas) simply leave this out of the node name and menu.
@menu * Foo Bar:: @end menu @node Foo Bar @subsection Foo: Bar
Backslashes must not be used in node names either.
@menu * Set and unset @end menu @node Set and unset @subsection @code{\set} and @code{\unset}
With the exception of @
-commands, \
-commands and
punctuation, the section name should match the node name exactly.
Sectioning commands (@node
and @section
) must not
appear inside an @ignore
… @end ignore
block. Separate those commands with a space, i.e.,
‘@n ode’.
Nodes must be included inside a
@menu * foo:: * bar:: @end menu
construct. These can be constructed automatically, see Regenerating menus.
Footnotes
(5)
A menu is a
@menu
… @end menu
block that holds node
names of all subsections of a section.
[ << Documentation work ] | [Top][Contents] | [ Website work >> ] |
[ < Documentation files ] | [ Up : Texinfo introduction and usage policy ] | [ LilyPond formatting > ] |