1 ;;;; define-context-properties.scm -- part of backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 (define-public all-translation-properties '())
11 (define (translator-property-description symbol type? description)
12 (if (not (equal? #f (object-property symbol 'translation-doc)))
13 (ly:error (_ "symbol ~S redefined" symbol)))
15 (set-object-property! symbol 'translation-type? type?)
16 (set-object-property! symbol 'translation-doc description)
17 (set! all-translation-properties (cons symbol all-translation-properties))
20 (define-public all-user-translation-properties
23 (apply translator-property-description x))
28 (aDueText ,string? "Text to print at a unisono passage.")
29 (alignBelowContext ,string? "Where to insert newly created context in vertiical alignment.")
30 (alignAboveContext ,string? "Where to insert newly created context in vertiical alignment.")
31 (alignBassFigureAccidentals ,boolean?
32 "If true, then the accidentals are aligned in bass figure context.")
34 (allowBeamBreak ,boolean? "If true allow line breaks for beams over bar lines.")
35 (allowPageTurn ,pair? "In the form (moment-start . penalty). Allow a page turn
36 at the most recent breakpoint if it was after moment-start.")
37 (associatedVoice ,string? "Name of the
38 @code{Voice} that has the melody for this @code{Lyrics} line.")
39 (autoBeamSettings ,list? "Specifies
40 when automatically generated beams should begin and end.
41 See @usermanref{Setting automatic beam behavior} for more information.
43 (autoAccidentals ,list? "List of
44 different ways to typeset an accidental.
46 For determining when to print an accidental, several different rules
47 are tried. The rule that gives the highest number of accidentals is
48 used. Each rule consists of
53 In which context is the rule applied. For example, if
54 @var{context} is @internalsref{Score} then all staves share
55 accidentals, and if @var{context} is @internalsref{Staff} then all
56 voices in the same staff share accidentals, but staves do not.
59 Whether the accidental changes all octaves or only the current
60 octave. Valid choices are
64 This is the default algorithm. Accidentals are typeset if the note changes
65 the accidental of that note in that octave. Accidentals lasts to the end of the measure
66 and then as many measures as specified in the value. I.e. 1 means to the end
67 of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.
69 Accidentals are typeset if the note is different from
70 the previous note on the same pitch in any octave. The value has same meaning as in
76 Over how many bar lines the accidental lasts.
77 If @var{laziness} is @code{-1} then the accidental is forgotten
78 immediately, and if @var{laziness} is @code{#t} then the accidental
82 (autoBeamCheck ,procedure? "Procedure taking three
83 arguments, CONTEXT, DIR start/stop (-1 or 1) and TEST shortest
84 note in the beam. A non-#f return value starts or stops the auto beam.")
85 (autoBeaming ,boolean? "If set to true then beams are generated
88 (autoCautionaries ,list? "List similar to
89 @code{autoAccidentals}, but it controls cautionary accidentals rather than
90 normal ones. Both lists are tried, and the one giving the most accidentals
91 wins. In case of draw, a normal accidental is typeset.
93 (automaticBars ,boolean? " If set to true then bar lines will not be
94 printed automatically; they must be explicitly created with
95 @code{\\bar} command. Unlike the @code{\\cadenza} keyword, measures
96 are still counted. Bar generation will resume according to that count
97 if this property is unset.
100 (barAlways ,boolean? "If set to true a bar line is drawn after each
103 (barCheckSynchronize ,boolean? "If true then reset @code{measurePosition}
104 when finding a barcheck.")
106 (barNumberVisibility ,procedure? "Procedure that takes an int and
107 returns whether the corresponding bar number should be printed")
108 (bassStaffProperties ,list? "Alist of property settings to apply
109 for the down staff of PianoStaff. Used by @code{\\autochange}")
110 (trebleStaffProperties ,list? "Alist of property settings to apply
111 for the up staff of PianoStaff. Used by @code{\\autochange}")
113 (figuredBassFormatter ,procedure? "Routine generating a markup
115 (bassFigureFormatFunction ,procedure? "Procedure that is called
116 to produce the formatting for a @code{BassFigure} grob. It takes a
117 list of @code{BassFigureEvent}s, a context, and the grob to format.")
119 (beatLength ,ly:moment? "The length of one beat in this time signature.")
121 "List of beatgroups, e.g., in 5/8 time @code{'(2
126 (middleCPosition ,number? "Place of the middle C, measured in half
127 staff-spaces. Usually determined by looking at @code{clefPosition} and
130 (chordNameFunction ,procedure?
131 "The function that converts lists of pitches to chord names.")
132 (chordNoteNamer ,procedure?
133 "Function that converts from a pitch object to a text markup. Used for single pitches.")
134 (chordRootNamer ,procedure?
135 "Function that converts from a pitch object to a text markup. Used for chords.")
136 (chordNameExceptions ,list?
137 "An alist of chord exceptions.
138 Contains (@var{chord} . @var{markup}) entries.")
139 (chordNameExceptionsFull ,list?
140 "An alist of chord exceptions.
141 Contains (@var{chord} . @var{markup}) entries.")
142 (chordNameExceptionsPartial
144 "An alist of partial chord exceptions. Contains (@var{chord} . (@var{prefix-markup} @var{suffix-markup})) entries.")
146 (chordNameSeparator ,markup?
147 "The markup object used to separate
148 parts of a chord name.")
149 (chordPrefixSpacer ,number?
150 "The space added between the root symbol and the prefix
152 (chordChanges ,boolean? "Only show changes in chords scheme?")
153 (clefGlyph ,string? "Name of the symbol within the music font.")
154 (clefOctavation ,integer? "Add
155 this much extra octavation. Values of 7 and -7 are common.")
157 (clefPosition ,number? "Where should the center of the clef
158 symbol go, measured in half staff spaces from the center of the staff.")
160 (connectArpeggios ,boolean? " If set, connect arpeggios across
162 (countPercentRepeats ,boolean? "If set, produce counters for
164 (createKeyOnClefChange ,boolean? "Print a key signature whenever the clef is changed.")
165 (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
166 Should be set for staves.")
167 (crescendoText ,markup? "Text to print at start of non-hairpin crescendo, i.e.: @samp{cresc.}")
168 (crescendoSpanner ,symbol? "Type of spanner to be used for crescendi.
169 One of: @samp{hairpin}, @samp{line}, @samp{dashed-line},
170 @samp{dotted-line}. If unset, hairpin type is used.")
171 (decrescendoText ,markup? "Text to print at start of non-hairpin decrescendo, i.e.: @samp{dim.}")
173 (drumPitchTable ,hash-table? "A table mapping percussion
174 instruments (symbols) to pitches.")
176 (drumStyleTable ,hash-table? "A hash table containing mapping
177 drums to layout settings. Predefined values: @samp{drums-style},
178 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style} and
179 @samp{percussion-style}.
181 The layout style is a hash table, containing the drum-pitches (e.g. the
182 symbol @samp{hihat}) as key, and a list (@var{notehead-style}
183 @var{script} @var{vertical-position}) as values.
185 (currentBarNumber ,integer? "Contains the current barnumber. This property is incremented at
188 (defaultBarType ,string? "Sets the default type of bar line.
189 See @code{whichBar} for information on available bar types.
191 This variable is read by @internalsref{Timing_translator} at
192 @internalsref{Score} level.
195 (decrescendoSpanner ,symbol? "See @code{crescendoSpanner}.")
196 (doubleSlurs ,boolean?
197 "When set, two slurs are created for every slurred
198 note, one above and one below the chord.")
199 (explicitClefVisibility ,vector? "@samp{break-visibility} function for clef changes.")
201 (explicitKeySignatureVisibility ,vector?
202 "@samp{break-visibility} function for explicit key
203 changes. @samp{\\override} of the @code{break-visibility} property will set the
204 visibility for normal (i.e. at the start of the line) key signatures.")
206 (extraNatural ,boolean? "Whether to typeset an
207 extra natural sign before accidentals changing from a non-natural to
208 another non-natural.")
210 (extraVerticalExtent ,number-pair?
211 "extra vertical extent, same format as @var{minimumVerticalExtent}")
214 (figuredBassCenterContinuations ,boolean? "Whether to vertically center pairs of extender lines.")
215 (figuredBassPlusDirection ,ly:dir? "Where to put plus signs relative to the the main figure.")
217 (figuredBassAlterationDirection ,ly:dir? "Where to put
218 alterations relative to the main figure.")
219 (followVoice ,boolean? "If set, note heads are tracked across staff
220 switches by a thin line")
223 "The relative size of all grobs in a context. ")
225 (forbidBreak ,boolean? "If set to ##t, prevent a line break at this point.")
227 (fingeringOrientations ,list?
228 "List of symbols, containing
229 @samp{left}, @samp{right}, @samp{up} and/or @samp{down}. This list
230 determines where fingerings are put relative to the chord being
233 (firstClef ,boolean? "If true, create a new clef when starting a
235 (forceClef ,boolean? "Show clef symbol, even if it has not
236 changed. Only active for the first clef after the property is set, not
237 for the full staff.")
238 (gridInterval ,ly:moment?
239 "Interval for which to generate @ref{GridPoint}s")
241 (hairpinToBarline ,boolean? "If set, end a hairpin at the barline before the ending note.")
243 (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
245 (highStringOne ,boolean? "Whether the 1st string is the string with
246 highest pitch on the instrument. This used by the automatic string
247 selector for tab notation.")
249 (ignoreBarChecks ,boolean? "Ignore bar checks")
250 (ignoreMelismata ,boolean? "Ignore melismata for this @internalsref{Lyrics} line.")
252 (implicitBassFigures ,list? "List of bass figures that are not
253 printed as numbers, but only as extender lines.")
256 (instrumentCueName ,markup? "Name to print if another instrument is to be taken.")
257 (instrumentName ,markup? "The name to print left of a staff. The
258 @code{instrument} property labels the staff in the first system, and
259 the @code{instr} property labels following lines.")
260 (instrumentEqualizer ,procedure? "
261 Function taking a string (instrument name), and returning a (@var{min} . @var{max}) pair of numbers for the loudness range of the instrument.
263 (instrumentTransposition ,ly:pitch? "Defines the transposition of
264 the instrument. Its value is the pitch that sounds like middle C. This
265 is used to transpose the MIDI output, and @code{\\quote}s.")
267 (keepAliveInterfaces ,list? "List of symbols, signifying grob interfaces that
268 are worth keeping an staff with @code{remove-empty} set around for.")
269 (keyAlterationOrder ,list? " Alist that defines in what order
270 alterations should be printed. The format is (@var{step}
271 . @var{alter}), where @var{step} is from 0 .. 6 and @var{alter} from
272 -2 (sharp) and 2 (flat).
275 (keySignature ,list? "The current key signature. This is an alist
276 containing (@var{name} . @var{alter}) or ((@var{octave} . @var{name}) . @var{alter}).
277 where @var{name} is from 0.. 6 and
278 @var{alter} from -4 (double flat) to 4 (double sharp).
280 (majorSevenSymbol ,markup? "How should
281 the major 7th be formatted in a chord name?")
282 (markFormatter ,procedure? "Procedure
283 taking as arguments context and rehearsal mark. It should return the
284 formatted mark as a markup object.")
286 (measureLength ,ly:moment? "Length of one
287 measure in the current time signature.")
289 (measurePosition ,ly:moment? "How much of the current measure
290 have we had. This can be set manually to create incomplete
293 (melismaBusyProperties ,list? "List of properties (symbols) to
294 determine whether a melisma is playing. Setting this property will
295 influence how lyrics are aligned to notes. For example, if set to
296 @code{#'(melismaBusy beamMelismaBusy)}, only manual melismata and
297 manual beams are considered. Possible values include
298 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
299 @code{beamMelismaBusy}")
302 (metronomeMarkFormatter ,procedure? "How to produce a metronome
303 markup. Called with 2 arguments, event and context.")
304 (midiInstrument ,string? "Name of the MIDI instrument to use ")
305 (midiMinimumVolume ,number? "Sets the minimum loudness for MIDI. Ranges from 0 to 1.")
306 (midiMaximumVolume ,number? "Analogous to @code{midiMinimumVolume}.")
307 (minimumFret ,number? "The tablature auto string-selecting mechanism
308 selects the highest string with a fret at least @code{minimumFret}")
309 (minimumVerticalExtent ,number-pair? "minimum vertical extent, same
310 format as @var{verticalExtent}")
311 (output ,ly:music-output? "The output produced by a score-level translator during music interpretation")
312 (ottavation ,string? "If set, the text for an ottava spanner. Changing
313 this creates a new text spanner. ")
314 (pedalSustainStrings ,list? "List of string to print for
315 sustain-pedal. Format is (@var{up} @var{updown} @var{down}), where
316 each of the three is the string to print when this is done with the
318 (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
319 (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
320 (pedalSustainStyle ,symbol? "A symbol that indicates how to print
321 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
322 (pedalUnaCordaStyle ,symbol? "see @code{pedalSustainStyle}.")
323 (pedalSostenutoStyle ,symbol? "see @code{pedalSustainStyle}.")
324 (printKeyCancellation ,boolean? "Print restoration alterations before a key signature change. ")
325 (printPartCombineTexts ,boolean? "set Solo/A due texts in the part combiner?")
326 (printOctaveNames ,boolean? "Print octave marks for the NoteNames context.")
328 (proportionalNotationDuration ,ly:moment? "Global override for
329 shortest-playing duration. This is used for switching on proportional
331 (recordEventSequence ,procedure? "When Recording_group_engraver
332 is in this context, then upon termination of the context, this
333 function is called with current context and a list of music objects.
334 The list of contains entries with start times, music objects and
335 whether they are processed in this context.")
337 (rehearsalMark ,integer? "The last rehearsal mark printed.")
338 (repeatCommands ,list? "This property is read to find any command of the form @code{(volta . @var{x})}, where @var{x} is a string or @code{#f}")
339 (restNumberThreshold ,number?
340 "If a multimeasure rest has more measures
341 than this, a number is printed. ")
342 (shapeNoteStyles ,vector? "Vector of symbols, listing style for each note
343 head relative to the tonic (qv.) of the scale.")
344 (shortInstrumentName ,markup? "See @code{instrument}")
345 (shortVocalName ,markup? "Name of a vocal line, short version.")
346 (skipBars ,boolean? "If set to true, then
347 skip the empty bars that are produced by multimeasure notes and rests.
348 These bars will not appear on the printed output. If not set (the
349 default) multimeasure notes and rests expand into their full length,
350 printing the appropriate number of empty bars so that synchronization
351 with other voices is preserved.
357 \\set Score.skipBars= ##t
362 (skipTypesetting ,boolean?
363 "When true, all no typesetting is done, speeding
364 up the interpretation phase. This speeds up debugging large scores.")
365 (soloIIText ,string? "text for begin of solo for voice ``two'' when part-combining.")
366 (soloText ,string? "text for begin of solo when part-combining.")
367 (squashedPosition ,integer? " Vertical position of
368 squashing for @internalsref{Pitch_squash_engraver}.")
370 (stringNumberOrientations ,list? "See @code{fingeringOrientations}")
371 (stringOneTopmost ,boolean? "Whether the 1st string is printed on the
372 top line of the tablature.")
374 (stanza ,markup? "Stanza `number' to print before the start of a
375 verse. Use in Lyrics context.")
377 (stemLeftBeamCount ,integer? " Specify the number of beams to draw on
378 the left side of the next note. Overrides automatic beaming. The
379 value is only used once, and then it is erased.")
381 (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
383 (stringTunings ,list? "The tablature strings tuning. It is a list
384 of the pitch (in semitones) of each string (starting with the lower
387 (subdivideBeams ,boolean? "If set, multiple beams will be subdivided
388 at beat positions by only drawing one beam over the beat.")
389 (suggestAccidentals ,boolean? "If set, accidentals are typeset as cautionary suggestions over the note.")
391 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating the nesting of a start delimiters.")
393 (systemStartDelimiter ,symbol? "Which grob to make for the start of
394 the system/staff? Set to @code{SystemStartBrace},
395 @code{SystemStartBracket} or @code{SystemStartBar}.")
397 (tablatureFormat ,procedure? "Function formatting a tab note head; it
398 takes a string number, a list of string tunings and Pitch object. It
399 returns the text as a string.")
401 (tieWaitForNote ,boolean? "If true, tied notes do not have to follow each other directly.
402 This can be used for writing out arpeggios")
403 (timeSignatureFraction ,number-pair?
404 "pair of numbers, signifying the time
405 signature. For example @code{#'(4 . 4)} is a 4/4 time signature.")
407 (timing ,boolean? " Keep administration of measure length, position, bar number, etc?
408 Switch off for cadenzas.")
410 "The tonic of the current scale")
412 (tremoloFlags ,integer? "Number of tremolo flags to add if no
413 number is specified.")
415 (tupletFullLength ,boolean? "If set, the tuplet is printed up to
416 the start of the next note.")
417 (tupletFullLengthNote ,boolean? "If set, end at the next note, otherwise end on the matter (time sigs, etc.) before the note.")
418 (tupletSpannerDuration ,ly:moment? "
419 Normally a tuplet bracket is as wide as the
420 @code{\\times} expression that gave rise to it. By setting this
421 property, you can make brackets last shorter. Example
425 \\set tupletSpannerDuration = #(ly:make-moment 1 4)
426 \\times 2/3 @{ c8 c c c c c @}
431 (useBassFigureExtenders ,boolean? "Whether to use extender lines
432 for repeated bass figures")
434 (verticalExtent ,number-pair? "Hard coded vertical extent. The format
435 is a pair of dimensions, for example, this sets the sizes of a staff
436 to 10 (5+5) staff-spaces high.
439 \\set Staff.verticalExtent = #'(-5.0 . 5.0)
443 This does not work for Voice or any other context that doesn't form a
446 (verticallySpacedContexts ,list? "List of symbols, containing
447 context names whose vertical axis groups should be taken into account for
448 vertical spacing of systems.")
450 (vocalName ,markup? "Name of a vocal line.")
452 (voltaOnThisStaff ,boolean?
453 "Normally, volta brackets are put only on the
454 topmost staff. This variable overrides this behavior, when set to
455 @code{#t} or @code{#f}.")
457 (voltaSpannerDuration ,ly:moment? "This specifies the maximum duration
458 to use for the brackets printed for @code{\\alternative}. This can be
459 used to shrink the length of brackets in the situation where one
460 alternative is very large.")
464 "This property is read to determine what type of bar line to create.
468 \\set Staff.whichBar = \"|:\"
471 This will create a start-repeat bar in this staff only.
472 Valid values are described in @internalsref{bar-line-interface}.
476 (define-public all-internal-translation-properties
479 (set-object-property! (car x) 'internal-translation #t)
480 (apply translator-property-description x)
484 `((slurMelismaBusy ,boolean? "Signal if a slur is present.")
485 (originalCentralCPosition
487 "Used for temporary overriding middle C in octavation brackets. ")
488 (melismaBusy ,boolean? "Signifies
489 whether a melisma is active. This can be used to signal melismas on
490 top of those automatically detected. ")
491 (graceSettings ,list?
492 "Overrides for grace notes. This property should
493 be manipulated through the @code{add-grace-property} function.")
494 (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
495 current breakable (clef, key signature, etc.) items.")
496 (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
497 non-breakable items (note heads, lyrics, etc.).")
498 (breakableSeparationItem ,ly:grob?
499 "The breakable items in this time step,
502 (localKeySignature ,list? "the key signature at this point in the
503 measure. The format is the same as for keySignature, but can also
504 contain ((@var{octave} . @var{name}) . (@var{alter} . @var{barnumber}))
505 pairs. It is reset at every bar line.")
508 (localKeySignatureChanges ,list? "Experimental. [DOCME]")
510 (finalizations ,list? "List of expressions to evaluate before proceeding to next time step. Internal variable.")
511 (busyGrobs ,list? "a queue of (@var{end-moment} . @var{GROB})
512 conses. This is for internal (C++) use only. This property contains
513 the grobs which are still busy (e.g. note heads, spanners, etc.)
515 (barCheckLastFail ,ly:moment? "Where in the measure did the last barcheck fail?")
516 (associatedVoiceContext ,ly:context? "The context object of the Voice that has the melody for this Lyrics.")
517 (beamMelismaBusy ,boolean? "Signal if a beam is present.")
518 (dynamicAbsoluteVolumeFunction ,procedure? "[DOCUMENT-ME]")
520 (lastKeySignature ,list? "Last key signature before a key
522 (rootSystem ,ly:grob? "The System object")
523 (scriptDefinitions ,list? "Description of scripts. This is used by
524 Script_engraver for typesetting note-super/subscripts. See
525 @file{scm/script.scm} for more information
527 (quotedEventTypes ,list? "List of symbols, representing the
528 event types that should be duplicated for @code{\\quote} commands.")
530 ; (quotes ,hash-table? "Hash table, mapping names to music-event vectors.")
531 (stavesFound ,grob-list? "list of all staff-symbols found.")
532 (instrumentSupport ,grob-list? "list of grobs to attach instrument name
534 (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
537 (define-public all-translation-properties
538 (append all-user-translation-properties
539 all-internal-translation-properties))
541 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
543 (define-public default-melisma-properties '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy))