Next: , Previous: Objects and interfaces, Up: Tweaking basics


4.1.3 Naming conventions of objects and properties

We met some object naming conventions previously, in Contexts and engravers. Here for reference is a list of the most common object and property types together with the conventions for naming them and a couple of examples of some real names. We have used ‘A’ to stand for any capitalized alphabetic character and ‘aaa’ to stand for any number of lower-case alphabetic characters. Other characters are used verbatim.

Object/property type Naming convention Examples
Contexts Aaaa or AaaaAaaaAaaa Staff, GrandStaff
Layout Objects Aaaa or AaaaAaaaAaaa Slur, NoteHead
Engravers Aaaa_aaa_engraver Clef_engraver, Note_heads_engraver
Interfaces aaa-aaa-interface grob-interface, break-aligned-interface
Context Properties aaa or aaaAaaaAaaa alignAboveContext, skipBars
Layout Object Properties aaa or aaa-aaa-aaa direction, beam-thickness

As we shall see shortly, the properties of different types of object are modified by different commands, so it is useful to be able to recognize the type of object from the names of its properties.

This page is for LilyPond-2.11.58 (development-branch).

Report errors to http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs.

Your suggestions for the documentation are welcome.

Other languages: espaƱol.