Most of the manual operates at the
@node Foo
- @unnumberedsubsubsec Foo
+ @subsubsection Foo
level. Sections are created with
@node Foo
@subsection Foo
* Use two spaces for indentation in lilypond examples. (no tabs)
+* All text strings should be prefaced with #. LilyPond does not
+ strictly require this, but it is helpful to get users accustomed
+ to this scheme construct. ie
+ \set Staff.instrumentName = #"cello"
+
* If possible, only write one bar per line. The notes on each
- line should be an independent line.
+ line should be an independent line -- tweaks should occur on
+ their own line if possible.
Bad:
\override textscript #'padding = #3 c1^"hi"
Good:
required. Any link in a doc section must be duplicated in the
@seealso section at the bottom.
-* Introducing examples may be done with
+* Introducing examples must be done with
. (ie finish the previous sentence/paragaph)
: (ie `in this example:')
, (ie `may add foo with the blah construct,')
+ The old "sentence runs directly into the example" method is not
+ allowed any more.
* Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
this is, don't say `Ba@ss{}tuba' but `Baßtuba'. This ensures that
all such characters appear in all output formats.
-* Don't use a @ref{link to another section} in the middle of a
- sentence. It looks ok in HTML, moderately bad in PDF, and
- utterly horrible in INFO. Instead, reword the sentence so that
- users are encouraged to see @ref{link to another section}.
- (at the end of the sentence)
-
-