LilyPond Contributor's Guide: 5.3.7 Other text concerns

[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Miscellany ]		[ Up : Texinfo introduction and usage policy ]	[ Documentation policy > ]

References must occur at the end of a sentence, for more information see the texinfo manual. Ideally this should also be the final sentence of a paragraph, but this is not required. Any link in a doc section must be duplicated in the @seealso section at the bottom.

Introducing examples must be done with

. (i.e. finish the previous sentence/paragraph)
: (i.e. `in this example:')
, (i.e. `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.
Colon usage
1. To introduce lists
2. When beginning a quote: “So, he said,...”.
  This usage is rarer. Americans often just use a comma.
3. When adding a defining example at the end of a sentence.
Non-ASCII characters which are in utf-8 should be directly used; this is, don’t say ‘Ba@ss{}tuba’ but ‘Baßtuba’. This ensures that all such characters appear in all output formats.

[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Miscellany ]		[ Up : Texinfo introduction and usage policy ]	[ Documentation policy > ]