A.25 Naming conventions (LilyPond Notation Reference)

[ << Notation manual tables ]	[Top][Contents][Index]	[ Cheat sheet >> ]
[ < Paper variables ]	[ Up : Notation manual tables ]	[ Predefined type predicates > ]

Naming conventions are used so that it is easier to keep the nature of an object in mind.

Object/property type	Naming convention	Examples
Keywords	`aaaa`	`\score`, `\addlyrics`
Music functions and shortcuts	`aaaa` or `aaaaAaaaAaaa`	`\time`, `\stemUp`
Markup functions	`aaaa` or `aaaa-aaaa-aaaa`	`\bold`, `\with-dimensions`
Paper variables	`aaaa` or `aaaa-aaaa-aaaa`	`indent`, `page-breaking`
Music expressions	`Aaaa` or `AaaaAaaaAaaa`	`NoteEvent`, `SequentialMusic`
Music classes	`aaaa` or `aaaa-aaaa-aaaa`	`note-event`, `rhythmic-event`
Music properties	`aaaa` or `aaaa-aaaa-aaaa`	`force-accidental`, `iterator-ctor`
Contexts	`Aaaa` or `AaaaAaaaAaaa`	`Staff`, `GrandStaff`
Context properties	`aaaa` or `aaaaAaaaAaaa`	`stanza`, `instrumentName`
Engravers	`Aaaa_engraver` or `Aaaa_aaaa_aaaa_engraver`	`Clef_engraver`, `Note_heads_engraver`
Layout Objects	`Aaaa` or `AaaaAaaaAaaa`	`Slur`, `NoteHead`
Layout Object Properties	`aaa` or `aaa-aaa-aaa`	`direction`, `beam-thickness`
Interfaces	`aaa-aaa-interface`	`grob-interface`, `break-aligned-interface`
Scheme functions defined in Guile	`aaaa` or `aaaa-aaaa-aaaa`	`map`, `for-each`
Scheme functions defined in LilyPond	`ly:aaaa` or `ly:aaaa-aaaa-aaaa` or `aaaa` or `aaaa-aaaa-aaaa` ¹¹	`ly:round-filled-box`, `music-map`

For historical reasons, some but not all of the functions defined by LilyPond start with the ly: prefix.