1 ;;;; define-context-properties.scm -- part of backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 (define-public all-translation-properties '())
11 (define (translator-property-description symbol type? description)
15 (string? description)))
16 (throw 'init-format-error))
19 (if (not (equal? #f (object-property symbol 'translation-doc)))
20 (ly:error (_ "symbol ~S redefined" symbol)))
22 (set-object-property! symbol 'translation-type? type?)
23 (set-object-property! symbol 'translation-doc description)
24 (set! all-translation-properties (cons symbol all-translation-properties))
28 (define-public all-user-translation-properties
31 (apply translator-property-description x))
36 (aDueText ,markup? "Text to print at a unisono passage.")
37 (alignAboveContext ,string? "Where to insert newly created context in
39 (alignBassFigureAccidentals ,boolean? "If true, then the accidentals
40 are aligned in bass figure context.")
41 (alignBelowContext ,string? "Where to insert newly created context in
43 (associatedVoice ,string? "Name of the @code{Voice} that has the
44 melody for this @code{Lyrics} line.")
45 (autoAccidentals ,list? "List of different ways to typeset an
48 For determining when to print an accidental, several different rules
49 are tried. The rule that gives the highest number of accidentals is
52 Each entry in the list is either a symbol or a procedure.
57 The symbol is the name of the context in which the following rules are to be
58 applied. For example, if @var{context} is @rinternals{Score} then all
59 staves share accidentals, and if @var{context} is @rinternals{Staff} then
60 all voices in the same staff share accidentals, but staves do not.
63 The procedure represents an accidental rule to be applied to the previously
66 The procedure takes the following arguments:
71 The current context to which the rule should be applied.
74 The pitch of the note to be evaluated.
77 The current bar number.
80 The current measure position.
84 The procedure returns a pair of booleans. The first states whether an extra
85 natural should be added. The second states whether an accidental should be
86 printed. @code{(#t . #f)} does not make sense.
89 (autoBeamCheck ,procedure? "A procedure taking three
90 arguments, @var{context}, @var{dir} [start/stop (-1 or 1)], and
91 @var{test} [shortest note in the beam]. A non-@code{#f} return value
92 starts or stops the auto beam.")
93 (autoBeaming ,boolean? "If set to true then beams are generated
95 (autoBeamSettings ,list? "Specifies when automatically generated
96 beams should begin and end. See @ruser{Setting automatic beam
97 behavior} for more information.")
98 (autoCautionaries ,list? "List similar to @code{autoAccidentals},
99 but it controls cautionary accidentals rather than normal ones. Both
100 lists are tried, and the one giving the most accidentals wins. In
101 case of draw, a normal accidental is typeset.")
102 (automaticBars ,boolean? "If set to false then bar lines will not
103 be printed automatically; they must be explicitly created with a
104 @code{\\bar} command. Unlike the @code{\\cadenzaOn} keyword, measures
105 are still counted. Bar line generation will resume according to that
106 count if this property is unset.")
109 (barAlways ,boolean? "If set to true a bar line is drawn after
111 (barCheckSynchronize ,boolean? "If true then reset
112 @code{measurePosition} when finding a bar check.")
113 (barNumberVisibility ,procedure? "A Procedure that takes an
114 integer and returns whether the corresponding bar number should be
116 (bassFigureFormatFunction ,procedure? "A procedure that is
117 called to produce the formatting for a @code{BassFigure} grob. It
118 takes a list of @code{BassFigureEvent}s, a context, and the grob to
120 (bassStaffProperties ,list? "An alist of property settings to
121 apply for the down staff of @code{PianoStaff}. Used by
122 @code{\\autochange}.")
123 (beatGrouping ,list? "A list of beatgroups, e.g., in 5/8 time
125 (beatLength ,ly:moment? "The length of one beat in this time
129 (chordChanges ,boolean? "Only show changes in chords scheme?")
130 (chordNameExceptions ,list? "An alist of chord exceptions.
131 Contains @code{(@var{chord} . @var{markup})} entries.")
132 (chordNameExceptionsFull ,list? "An alist of full chord
133 exceptions. Contains @code{(@var{chord} . @var{markup})} entries.")
134 (chordNameExceptionsPartial ,list? "An alist of partial chord
135 exceptions. Contains @code{(@var{chord} . (@var{prefix-markup}
136 @var{suffix-markup}))} entries.")
137 (chordNameFunction ,procedure? "The function that converts lists
138 of pitches to chord names.")
139 (chordNameSeparator ,markup? "The markup object used to
140 separate parts of a chord name.")
141 (chordNoteNamer ,procedure? "A function that converts from a pitch
142 object to a text markup. Used for single pitches.")
143 (chordPrefixSpacer ,number? "The space added between the root
144 symbol and the prefix of a chord name.")
145 (chordRootNamer ,procedure? "A function that converts from a pitch
146 object to a text markup. Used for chords.")
147 (clefGlyph ,string? "Name of the symbol within the music font.")
148 (clefOctavation ,integer? "Add this much extra octavation.
149 Values of 7 and -7 are common.")
150 (clefPosition ,number? "Where should the center of the clef
151 symbol go, measured in half staff spaces from the center of the
153 (completionBusy ,boolean? "Whether a completion-note head is playing.")
154 (connectArpeggios ,boolean? "If set, connect arpeggios across
156 (countPercentRepeats ,boolean? "If set, produce counters for
158 (createKeyOnClefChange ,boolean? "Print a key signature whenever
159 the clef is changed.")
160 (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
161 Should be set for staves.")
162 (crescendoSpanner ,symbol? "The type of spanner to be used for
163 crescendi. Available values are @samp{hairpin} and @samp{text}. If unset,
164 a hairpin crescendo is used.")
165 (crescendoText ,markup? "The text to print at start of non-hairpin
166 crescendo, i.e., @samp{cresc.}.")
167 (currentBarNumber ,integer? "Contains the current barnumber.
168 This property is incremented at every bar line.")
171 (decrescendoSpanner ,symbol? "The type of spanner to be used for
172 decrescendi. Available values are @samp{hairpin} and @samp{text}. If
173 unset, a hairpin decrescendo is used.")
174 (decrescendoText ,markup? "The text to print at start of
175 non-hairpin decrescendo, i.e., @samp{dim.}.")
176 (defaultBarType ,string? "Set the default type of bar line. See
177 @code{whichBar} for information on available bar types.
179 This variable is read by @rinternals{Timing_translator} at
180 @rinternals{Score} level.")
181 (doubleRepeatType ,string? "Set the default bar line for double
183 (doubleSlurs ,boolean? "If set, two slurs are created for every
184 slurred note, one above and one below the chord.")
185 (drumPitchTable ,hash-table? "A table mapping percussion
186 instruments (symbols) to pitches.")
187 (drumStyleTable ,hash-table? "A hash table which maps drums to
188 layout settings. Predefined values: @samp{drums-style},
189 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style}, and
190 @samp{percussion-style}.
192 The layout style is a hash table, containing the drum-pitches (e.g.,
193 the symbol @samp{hihat}) as keys, and a list
194 @code{(@var{notehead-style} @var{script} @var{vertical-position})} as
198 (explicitClefVisibility ,vector? "@samp{break-visibility}
199 function for clef changes.")
200 (explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
201 function for explicit key changes. @samp{\\override} of the
202 @code{break-visibility} property will set the visibility for normal
203 (i.e., at the start of the line) key signatures.")
204 (extendersOverRests ,boolean? "Whether to continue extenders as
206 (extraNatural ,boolean? "Whether to typeset an extra natural sign
207 before accidentals changing from a non-natural to another
211 (figuredBassAlterationDirection ,ly:dir? "Where to put alterations
212 relative to the main figure.")
213 (figuredBassCenterContinuations ,boolean? "Whether to vertically
214 center pairs of extender lines. This does not work with three or more
216 (figuredBassFormatter ,procedure? "A routine generating a markup
218 (figuredBassPlusDirection ,ly:dir? "Where to put plus signs
219 relative to the main figure.")
220 (fingeringOrientations ,list? "A list of symbols, containing
221 @samp{left}, @samp{right}, @samp{up} and/or @samp{down}. This list
222 determines where fingerings are put relative to the chord being
224 (firstClef ,boolean? "If true, create a new clef when starting a
226 (followVoice ,boolean? "If set, note heads are tracked across
227 staff switches by a thin line.")
228 (fontSize ,number? "The relative size of all grobs in a context.")
229 (forbidBreak ,boolean? "If set to @code{##t}, prevent a line break
231 (forceClef ,boolean? "Show clef symbol, even if it has not
232 changed. Only active for the first clef after the property is set, not
233 for the full staff.")
236 (gridInterval ,ly:moment? "Interval for which to generate
240 (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
242 (harmonicDots ,boolean? "If set, harmonic notes in dotted chords get
244 (highStringOne ,boolean? "Whether the first string is the string
245 with highest pitch on the instrument. This used by the automatic
246 string selector for tablature notation.")
249 (ignoreBarChecks ,boolean? "Ignore bar checks.")
250 (ignoreFiguredBassRest ,boolean? "Don't swallow rest events.")
251 (ignoreMelismata ,boolean? "Ignore melismata for this
252 @rinternals{Lyrics} line.")
253 (implicitBassFigures ,list? "A list of bass figures that are not
254 printed as numbers, but only as extender lines.")
255 (implicitTimeSignatureVisibility ,vector? "break visibility for
256 the default time signature.")
257 (instrumentCueName ,markup? "The name to print if another
258 instrument is to be taken.")
259 (instrumentEqualizer ,procedure? "A function taking a string
260 (instrument name), and returning a @code{(@var{min} . @var{max})} pair
261 of numbers for the loudness range of the instrument.")
262 (instrumentName ,markup? "The name to print left of a staff. The
263 @code{instrument} property labels the staff in the first system, and
264 the @code{instr} property labels following lines.")
265 ;; the definition is reversed wrt traditional transposition
266 ;; otherwise \transpose { \transposition .. } won't work
267 (instrumentTransposition ,ly:pitch? "Define the transposition of
268 the instrument. Its value is the pitch that sounds like middle@tie{}C.
269 This is used to transpose the MIDI output, and @code{\\quote}s.")
270 (internalBarNumber ,integer? "Contains the current barnumber.
271 This property is used for internal timekeeping, among others by the
272 @code{Accidental_engraver}.")
275 (keepAliveInterfaces ,list? "A list of symbols, signifying grob
276 interfaces that are worth keeping a staff with @code{remove-empty} set
278 (keyAlterationOrder ,list? "An alist that defines in what order
279 alterations should be printed. The format is @code{(@var{step}
280 . @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and
281 @var{alter} from -2 (sharp) to 2 (flat).")
282 (keySignature ,list? "The current key signature. This is an alist
283 containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} .
284 @var{step}) . @var{alter})}, where @var{step} is a number in the range
285 0 to@tie{}6 and @var{alter} a fraction, denoting alteration. For
286 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.")
289 (lyricMelismaAlignment ,ly:dir? "Alignment to use for a melisma syllable.")
292 (majorSevenSymbol ,markup? "How should the major 7th be formatted
294 (markFormatter ,procedure? "A procedure taking as arguments the
295 context and the rehearsal mark. It should return the formatted mark as
297 (maximumFretStretch ,number? "Don't allocate frets further than
298 this from specified frets.")
299 (measureLength ,ly:moment? "Length of one measure in the current
301 (measurePosition ,ly:moment? "How much of the current measure have
302 we had. This can be set manually to create incomplete measures.")
303 (melismaBusyProperties ,list? "A list of properties (symbols) to
304 determine whether a melisma is playing. Setting this property will
305 influence how lyrics are aligned to notes. For example, if set to
306 @code{#'(melismaBusy beamMelismaBusy)}, only manual melismata and
307 manual beams are considered. Possible values include
308 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
309 @code{beamMelismaBusy}.")
310 (metronomeMarkFormatter ,procedure? "How to produce a metronome
311 markup. Called with four arguments: text, duration, count and context.")
312 (middleCClefPosition ,number? "The position of the middle C,
313 as determined only by the clef. This can be calculated by looking at
314 @code{clefPosition} and @code{clefGlyph}.")
315 (middleCOffset ,number? "The offset of
316 middle C from the position given by @code{middleCClefPosition} This
317 is used for ottava brackets.")
318 (middleCPosition ,number? "The place of the middle C, measured in
319 half staff-spaces. Usually determined by looking at
320 @code{middleCClefPosition} and @code{middleCOffset}.")
321 (midiInstrument ,string? "Name of the MIDI instrument to use.")
322 (midiMaximumVolume ,number? "Analogous to
323 @code{midiMinimumVolume}.")
324 (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
325 Ranges from 0 to@tie{}1.")
326 (minimumFret ,number? "The tablature auto string-selecting
327 mechanism selects the highest string with a fret at least
328 @code{minimumFret}.")
329 (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a
330 page turn to be allowed.")
331 (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
332 repeated section for a page turn to be allowed within that section.")
335 (noChordSymbol ,markup? "Markup to be displayed for rests in a
336 ChordNames context.")
337 (noteToFretFunction ,procedure? "How to produce a fret diagram.
338 Parameters: A list of note events and a list of tabstring events.")
341 (ottavation ,markup? "If set, the text for an ottava spanner.
342 Changing this creates a new text spanner.")
343 (output ,ly:music-output? "The output produced by a score-level
344 translator during music interpretation.")
347 (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
348 (pedalSostenutoStyle ,symbol? "See @code{pedalSustainStyle}.")
349 (pedalSustainStrings ,list? "A list of strings to print for
350 sustain-pedal. Format is @code{(@var{up} @var{updown} @var{down})},
351 where each of the three is the string to print when this is done with
353 (pedalSustainStyle ,symbol? "A symbol that indicates how to print
354 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
355 (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
356 (pedalUnaCordaStyle ,symbol? "See @code{pedalSustainStyle}.")
357 (predefinedDiagramTable ,hash-table? "The hash table of predefined
358 fret diagrams to use in FretBoards.")
359 (printKeyCancellation ,boolean? "Print restoration alterations
360 before a key signature change.")
361 (printOctaveNames ,boolean? "Print octave marks for the
362 @code{NoteNames} context.")
363 (printPartCombineTexts ,boolean? "Set @q{Solo} and @q{A due} texts
364 in the part combiner?")
365 (proportionalNotationDuration ,ly:moment? "Global override for
366 shortest-playing duration. This is used for switching on proportional
370 (recordEventSequence ,procedure? "When
371 @code{Recording_group_engraver} is in this context, then upon
372 termination of the context, this function is called with current
373 context and a list of music objects. The list of contains entries with
374 start times, music objects and whether they are processed in this
376 (rehearsalMark ,integer? "The last rehearsal mark printed.")
377 (repeatCommands ,list? "This property is a list of commands
378 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
379 @code{#f}. @code{'end-repeat} is also accepted as a command.")
380 (repeatCountVisibility ,procedure? "A procedure taking as
381 arguments an integer and context, returning whether the corresponding
382 percent repeat number should be printed when @code{countPercentRepeats}
384 (restNumberThreshold ,number? "If a multimeasure rest has more
385 measures than this, a number is printed.")
388 (shapeNoteStyles ,vector? "Vector of symbols, listing style for
389 each note head relative to the tonic (qv.) of the scale.")
390 (shortInstrumentName ,markup? "See @code{instrument}.")
391 (shortVocalName ,markup? "Name of a vocal line, short version.")
392 (skipBars ,boolean? "If set to true, then skip the empty bars
393 that are produced by multimeasure notes and rests. These bars will
394 not appear on the printed output. If not set (the default),
395 multimeasure notes and rests expand into their full length, printing
396 the appropriate number of empty bars so that synchronization with other
402 \\set Score.skipBars= ##t
406 (skipTypesetting ,boolean? "If true, no typesetting is done,
407 speeding up the interpretation phase. Useful for debugging large
409 (soloIIText ,markup? "The text for the start of a solo for
410 voice @q{two} when part-combining.")
411 (soloText ,markup? "The text for the start of a solo when
413 (squashedPosition ,integer? "Vertical position of squashing for
414 @rinternals{Pitch_squash_engraver}.")
415 (staffLineLayoutFunction ,procedure? "Layout of staff lines,
416 @code{traditional}, or @code{semitone}.")
417 (stanza ,markup? "Stanza @q{number} to print before the start of a
418 verse. Use in @code{Lyrics} context.")
419 (stemLeftBeamCount ,integer? "Specify the number of beams to draw
420 on the left side of the next note. Overrides automatic beaming. The
421 value is only used once, and then it is erased.")
422 (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
423 (stringNumberOrientations ,list? "See
424 @code{fingeringOrientations}.")
425 (stringOneTopmost ,boolean? "Whether the first string is
426 printed on the top line of the tablature.")
427 (stringTunings ,list? "The tablature strings tuning. It is a list
428 of the pitch (in semitones) of each string (starting with the lower
430 (strokeFingerOrientations ,list? "See
431 @code{fingeringOrientations}.")
432 (subdivideBeams ,boolean? "If set, multiple beams will be
433 subdivided at beat positions by only drawing one beam over the beat.")
434 (suggestAccidentals ,boolean? "If set, accidentals are typeset as
435 cautionary suggestions over the note.")
436 (systemStartDelimiter ,symbol? "Which grob to make for the start
437 of the system/staff? Set to @code{SystemStartBrace},
438 @code{SystemStartBracket} or @code{SystemStartBar}.")
439 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating
440 the nesting of a start delimiters.")
443 (tablatureFormat ,procedure? "A function formatting a tablature
444 note head. Called with three arguments: string number, context and event.
445 It returns the text as a string.")
446 (tempoHideNote ,boolean? "Hide the note=count in tempo marks.")
447 (tempoText ,markup? "Text for tempo marks.")
448 (tempoUnitCount ,number? "Count for specifying tempo.")
449 (tempoUnitDuration ,ly:duration? "Unit for specifying tempo.")
450 (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
452 (tieWaitForNote ,boolean? "If true, tied notes do not have to
453 follow each other directly. This can be used for writing out
455 (timeSignatureFraction ,number-pair? "A pair of numbers,
456 signifying the time signature. For example, @code{#'(4 . 4)} is a
457 4/4 time signature.")
458 (timing ,boolean? "Keep administration of measure length,
459 position, bar number, etc.? Switch off for cadenzas.")
460 (tonic ,ly:pitch? "The tonic of the current scale.")
461 (topLevelAlignment ,boolean? "If true, the @var{Vertical_align_engraver}
462 will create a @var{VerticalAlignment}; otherwise, it will create a
464 (trebleStaffProperties ,list? "An alist of property settings to
465 apply for the up staff of @code{PianoStaff}. Used by
466 @code{\\autochange}.")
467 (tremoloFlags ,integer? "The number of tremolo flags to add if no
468 number is specified.")
469 (tupletFullLength ,boolean? "If set, the tuplet is printed up to
470 the start of the next note.")
471 (tupletFullLengthNote ,boolean? "If set, end at the next note,
472 otherwise end on the matter (time signatures, etc.) before the note.")
473 (tupletSpannerDuration ,ly:moment? "Normally, a tuplet bracket is
474 as wide as the @code{\\times} expression that gave rise to it. By
475 setting this property, you can make brackets last shorter.
479 \\set tupletSpannerDuration = #(ly:make-moment 1 4)
480 \\times 2/3 @{ c8 c c c c c @}
485 (useBassFigureExtenders ,boolean? "Whether to use extender lines
486 for repeated bass figures.")
488 (verticallySpacedContexts ,list? "List of symbols, containing
489 context names whose vertical axis groups should be taken into account
490 for vertical spacing of systems.")
491 (vocalName ,markup? "Name of a vocal line.")
492 (voltaSpannerDuration ,ly:moment? "This specifies the maximum
493 duration to use for the brackets printed for @code{\\alternative}.
494 This can be used to shrink the length of brackets in the situation
495 where one alternative is very large.")
498 (whichBar ,string? "This property is read to determine what type
499 of bar line to create.
504 \\set Staff.whichBar = \"|:\"
508 This will create a start-repeat bar in this staff only. Valid values
509 are described in @rinternals{bar-line-interface}.")
513 (define-public all-internal-translation-properties
516 (set-object-property! (car x) 'internal-translation #t)
517 (apply translator-property-description x))
521 (associatedVoiceContext ,ly:context? "The context object of the
522 @code{Voice} that has the melody for this @code{Lyrics}.")
525 (barCheckLastFail ,ly:moment? "Where in the measure did the last
527 (beamMelismaBusy ,boolean? "Signal if a beam is present.")
528 (breakableSeparationItem ,ly:grob? "The breakable items in this
529 time step, for this staff.")
530 (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
531 @var{GROB})} cons cells. This is for internal (C++) use only. This
532 property contains the grobs which are still busy (e.g. note heads,
536 (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
537 current breakable (clef, key signature, etc.) items.")
538 (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
539 non-breakable items (note heads, lyrics, etc.).")
542 (dynamicAbsoluteVolumeFunction ,procedure? "A procedure that takes
543 one argument, the text value of a dynamic event, and returns the absolute
544 volume of that dynamic event.")
547 (finalizations ,list? "A list of expressions to evaluate before
548 proceeding to next time step. This is an internal variable.")
551 (graceSettings ,list? "Overrides for grace notes. This property
552 should be manipulated through the @code{add-grace-property} function.")
555 (hasStaffSpacing ,boolean? "True if the current
556 @code{CommandColumn} contains items that will affect spacing.")
559 (instrumentSupport ,grob-list? "A list of grobs to attach the
560 instrument name to.")
563 (lastKeySignature ,list? "Last key signature before a key
565 (localKeySignature ,list? "The key signature at this point in the
566 measure. The format is the same as for @code{keySignature}, but can
567 also contain @code{((@var{octave} . @var{name}) . (@var{alter}
568 @var{barnumber} . @var{measureposition}))} pairs.")
571 (melismaBusy ,boolean? "Signifies whether a melisma is active.
572 This can be used to signal melismas on top of those automatically
576 (originalMiddleCPosition ,integer? "Used for temporary overriding
577 middle@tie{}C in octavation brackets.")
580 (quotedEventTypes ,list? "A list of symbols, representing the
581 event types that should be duplicated for @code{\\quote} commands.")
582 ; (quotes ,hash-table? "A hash table, mapping names to
583 ;@code{music-event} vectors.")
586 (rootSystem ,ly:grob? "The System object.")
589 (scriptDefinitions ,list? "The description of scripts. This is
590 used by the @code{Script_engraver} for typesetting note-superscripts
591 and subscripts. See @file{scm/script.scm} for more information.")
592 (slurMelismaBusy ,boolean? "Signal if a slur is present.")
593 (stavesFound ,grob-list? "A list of all staff-symbols found.")
596 (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
599 (define-public all-translation-properties
600 (append all-user-translation-properties
601 all-internal-translation-properties))
603 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
605 (define-public default-melisma-properties
606 '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy))