[ << Documentation work ] | [Top][Contents][Index][ ? ] | [ Website work >> ] | ||
[ < Documentation files ] | [ Up : Texinfo introduction and usage policy ] | [ LilyPond formatting > ] |
5.3.3 Sectioning commands
The Notation Reference uses section headings at four, occasionally five, levels.
- Level 1: @chapter
- Level 2: @section
- Level 3: @subsection
- Level 4: @unnumberedsubsubsec
- Level 5: @subsubsubheading
The first three levels are numbered in html, the last two are not. Numbered sections correspond to a single html page in the split html documents.
The first four levels always have accompanying nodes so they can be referenced and are also included in the ToC 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
-
Please leave two blank lines above a
@node
; this makes it easier to find sections in texinfo. -
Do not use any
@
commands for 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
-
With the exception of
@
commands, the section name must match the node name exactly. - No commas may be used in the node names.
-
If a heading is desired without creating a
@node
, please use:@subsubsubheading Foo
-
Sectioning commands (
@node
and@section
) must not appear inside an@ignore
. Separate those commands with a space, ie@n
ode
.
Nodes must be included inside a
@menu * foo:: * bar:: @end menu
construct. These are easily constructed with automatic tools; see Scripts to ease doc work.
[ << Documentation work ] | [Top][Contents][Index][ ? ] | [ Website work >> ] | ||
[ < Documentation files ] | [ Up : Texinfo introduction and usage policy ] | [ LilyPond formatting > ] |