[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Checking cross-references ]		[  Up : Documentation policy ]	[ Technical writing style > ]

5.4.4 General writing

• Do not forget to create @cindex entries for new sections of text. Enter commands with @funindex, i.e.

  @cindex pitches, writing in different octaves
  @funindex \relative
  

  Do not bother with the @code{} (they are added automatically). These items are added to both the command index and the unified index. Both index commands should go in front of the actual material.

• @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][Index][ ? ]			[ Website work >> ]
[ < Checking cross-references ]		[  Up : Documentation policy ]	[ Technical writing style > ]

<< Back to Documentation Index

LilyPond — Contributor’s Guide v2.18.2 (stable-branch).