[ << Documentation work ] | [Top][Contents] | [ Website work >> ] |
[ < Checking cross-references ] | [ Up : Documentation policy ] | [ Technical writing style > ] |
5.5.4 General writing
- Do not forget to create
@cindex
entries for new sections of text. Commands usually need a@funindex
entry, for example,@cindex pitches, writing in different octaves @funindex \relative
Do not add
@code{...}
around the@funindex
argument; this is handled internally. While@cindex
entries get added to the main index only,@funindex
entries are added to both the command index and the main index. Both index commands should go in front of the actual material (each on a separate line). -
@cindex
entries should not be capitalized, i.e.,@cindex time signature
is preferred instead of “Time signature”. Only use capital letters for musical terms which demand them, e.g., “D.S. al Fine”.
- For Scheme function index entries, only include the final part,
i.e.,
@funindex modern-voice-cautionary and NOT @funindex #(set-accidental-style modern-voice-cautionary)
- Use American spelling. LilyPond’s internal property names use this convention.
- Here is a list of preferred terms to be used:
- Simultaneous, NOT concurrent.
- Measure: the unit of music.
- Bar line: the symbol delimiting a measure, NOT barline.
- Note head, NOT notehead.
- Chord construct, NOT just chord (when referring to
<...>
). - Staff, NOT stave.
- Staves, NOT Staffs:
phrases such as
multiple @internalsref{Staff}s
should be rephrased to
multiple @internalsref{Staff} contexts
[ << Documentation work ] | [Top][Contents] | [ Website work >> ] |
[ < Checking cross-references ] | [ Up : Documentation policy ] | [ Technical writing style > ] |