[ << Documentation work ] | [Top][Contents] | [ Website work >> ] |
[ < Sectioning commands ] | [ Up : Texinfo introduction and usage policy ] | [ LilyPond formatting > ] |
5.4.4 Menus
A Texinfo menu is a @menu
… @end menu
block that holds node names of all subsections of a section. By
default, such blocks are auto-generated while creating Info and
HTML output; in PDF output, they are not used. This means that it
is not necessary to create menus normally.
The auto-generated menus simply use node names (and display the
corresponding section names). If you want to add some description
to one or more menu entries, however, you have to create the
@menu
block manually, to be put at the end of the current
node, right before the first subsection node.
Assuming that the current section contains subsection node names ‘foo’, ‘bar’, and ‘baz’, the syntax is as follows.
@menu * foo:: A very long description of an extremely important topic. * bar:: * baz:: All you want to know about @code{baz}. @end menu
As can be seen, the description of a menu entry might contain
Texinfo commands, and it can be broken across multiple lines (in
Info mode, the formatting of the @menu
block is taken
directly).
In the LilyPond documentation, most top-level menus contain descriptions.