1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;;; GNU General Public License for more details.
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 (define-public all-translation-properties '())
22 (define (translator-property-description symbol type? description)
26 (string? description)))
27 (throw 'init-format-error))
30 (if (not (equal? #f (object-property symbol 'translation-doc)))
31 (ly:error (_ "symbol ~S redefined" symbol)))
33 (set-object-property! symbol 'translation-type? type?)
34 (set-object-property! symbol 'translation-doc description)
35 (set! all-translation-properties (cons symbol all-translation-properties))
39 (define-public all-user-translation-properties
42 (apply translator-property-description x))
47 (aDueText ,markup? "Text to print at a unisono passage.")
48 (alignAboveContext ,string? "Where to insert newly created context in
50 (alignBassFigureAccidentals ,boolean? "If true, then the accidentals
51 are aligned in bass figure context.")
52 (alignBelowContext ,string? "Where to insert newly created context in
54 (associatedVoice ,string? "Name of the @code{Voice} that has the
55 melody for this @code{Lyrics} line.")
56 (autoAccidentals ,list? "List of different ways to typeset an
59 For determining when to print an accidental, several different rules
60 are tried. The rule that gives the highest number of accidentals is
63 Each entry in the list is either a symbol or a procedure.
68 The symbol is the name of the context in which the following rules are to be
69 applied. For example, if @var{context} is @rinternals{Score} then all
70 staves share accidentals, and if @var{context} is @rinternals{Staff} then
71 all voices in the same staff share accidentals, but staves do not.
74 The procedure represents an accidental rule to be applied to the previously
77 The procedure takes the following arguments:
82 The current context to which the rule should be applied.
85 The pitch of the note to be evaluated.
88 The current bar number.
91 The current measure position.
95 The procedure returns a pair of booleans. The first states whether an extra
96 natural should be added. The second states whether an accidental should be
97 printed. @code{(#t . #f)} does not make sense.
100 (autoBeamCheck ,procedure? "A procedure taking three
101 arguments, @var{context}, @var{dir} [start/@/stop (-1 or 1)], and
102 @var{test} [shortest note in the beam]. A non-@code{#f} return value
103 starts or stops the auto beam.")
104 (autoBeaming ,boolean? "If set to true then beams are generated
106 (autoCautionaries ,list? "List similar to @code{autoAccidentals},
107 but it controls cautionary accidentals rather than normal ones. Both
108 lists are tried, and the one giving the most accidentals wins. In
109 case of draw, a normal accidental is typeset.")
110 (automaticBars ,boolean? "If set to false then bar lines will not
111 be printed automatically; they must be explicitly created with a
112 @code{\\bar} command. Unlike the @code{\\cadenzaOn} keyword, measures
113 are still counted. Bar line generation will resume according to that
114 count if this property is unset.")
117 (barAlways ,boolean? "If set to true a bar line is drawn after
119 (barCheckSynchronize ,boolean? "If true then reset
120 @code{measurePosition} when finding a bar check.")
121 (barNumberVisibility ,procedure? "A Procedure that takes an
122 integer and returns whether the corresponding bar number should be
124 (baseMoment ,ly:moment? "Smallest unit of time that will stand on its
125 own as a subdivided section.")
126 (bassFigureFormatFunction ,procedure? "A procedure that is
127 called to produce the formatting for a @code{BassFigure} grob. It
128 takes a list of @code{BassFigureEvent}s, a context, and the grob to
130 (bassStaffProperties ,list? "An alist of property settings to
131 apply for the down staff of @code{PianoStaff}. Used by
132 @code{\\autochange}.")
133 (beamExceptions ,list? "An alist of exceptions to autobeam rules
134 that normally end on beats.")
135 (beatStructure ,list? "List of @code{baseMoment}s that are combined
138 (chordChanges ,boolean? "Only show changes in chords scheme?")
139 (chordNameExceptions ,list? "An alist of chord exceptions.
140 Contains @code{(@var{chord} . @var{markup})} entries.")
141 (chordNameExceptionsFull ,list? "An alist of full chord
142 exceptions. Contains @code{(@var{chord} . @var{markup})} entries.")
143 (chordNameExceptionsPartial ,list? "An alist of partial chord
144 exceptions. Contains @code{(@var{chord} . (@var{prefix-markup}
145 @var{suffix-markup}))} entries.")
146 (chordNameFunction ,procedure? "The function that converts lists
147 of pitches to chord names.")
148 (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
149 (chordNameSeparator ,markup? "The markup object used to
150 separate parts of a chord name.")
151 (slashChordSeparator ,markup? "The markup object used to separate
152 a chord name from its root note in case of inversions or slash
154 (chordNoteNamer ,procedure? "A function that converts from a pitch
155 object to a text markup. Used for single pitches.")
156 (chordPrefixSpacer ,number? "The space added between the root
157 symbol and the prefix of a chord name.")
158 (chordRootNamer ,procedure? "A function that converts from a pitch
159 object to a text markup. Used for chords.")
160 (clefGlyph ,string? "Name of the symbol within the music font.")
161 (clefOctavation ,integer? "Add this much extra octavation.
162 Values of 7 and -7 are common.")
163 (clefPosition ,number? "Where should the center of the clef
164 symbol go, measured in half staff spaces from the center of the
166 (completionBusy ,boolean? "Whether a completion-note head is playing.")
167 (connectArpeggios ,boolean? "If set, connect arpeggios across
169 (countPercentRepeats ,boolean? "If set, produce counters for
171 (createKeyOnClefChange ,boolean? "Print a key signature whenever
172 the clef is changed.")
173 (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
174 Should be set for staves.")
175 (crescendoSpanner ,symbol? "The type of spanner to be used for
176 crescendi. Available values are @samp{hairpin} and @samp{text}. If unset,
177 a hairpin crescendo is used.")
178 (crescendoText ,markup? "The text to print at start of non-hairpin
179 crescendo, i.e., @samp{cresc.}.")
180 (cueClefGlyph ,string? "Name of the symbol within the music font.")
181 (cueClefOctavation ,integer? "Add this much extra octavation.
182 Values of 7 and -7 are common.")
183 (cueClefPosition ,number? "Where should the center of the clef
184 symbol go, measured in half staff spaces from the center of the
186 (currentBarNumber ,integer? "Contains the current barnumber.
187 This property is incremented at every bar line.")
190 (decrescendoSpanner ,symbol? "The type of spanner to be used for
191 decrescendi. Available values are @samp{hairpin} and @samp{text}. If
192 unset, a hairpin decrescendo is used.")
193 (decrescendoText ,markup? "The text to print at start of
194 non-hairpin decrescendo, i.e., @samp{dim.}.")
195 (defaultBarType ,string? "Set the default type of bar line. See
196 @code{whichBar} for information on available bar types.
198 This variable is read by @rinternals{Timing_translator} at
199 @rinternals{Score} level.")
200 (defaultStrings ,list? "A list of strings to use in calculating
201 frets for tablatures and fretboards if no strings are provided in
202 the notes for the current moment.")
203 (doubleRepeatType ,string? "Set the default bar line for double
205 (doubleSlurs ,boolean? "If set, two slurs are created for every
206 slurred note, one above and one below the chord.")
207 (drumPitchTable ,hash-table? "A table mapping percussion
208 instruments (symbols) to pitches.")
209 (drumStyleTable ,hash-table? "A hash table which maps drums to
210 layout settings. Predefined values: @samp{drums-style},
211 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style}, and
212 @samp{percussion-style}.
214 The layout style is a hash table, containing the drum-pitches (e.g.,
215 the symbol @samp{hihat}) as keys, and a list
216 @code{(@var{notehead-style} @var{script} @var{vertical-position})} as
220 (explicitClefVisibility ,vector? "@samp{break-visibility}
221 function for clef changes.")
222 (explicitCueClefVisibility ,vector? "@samp{break-visibility}
223 function for cue clef changes.")
224 (explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
225 function for explicit key changes. @samp{\\override} of the
226 @code{break-visibility} property will set the visibility for normal
227 (i.e., at the start of the line) key signatures.")
228 (extendersOverRests ,boolean? "Whether to continue extenders as
230 (extraNatural ,boolean? "Whether to typeset an extra natural sign
231 before accidentals that reduce the effect of a previous alteration.")
234 (figuredBassAlterationDirection ,ly:dir? "Where to put alterations
235 relative to the main figure.")
236 (figuredBassCenterContinuations ,boolean? "Whether to vertically
237 center pairs of extender lines. This does not work with three or more
239 (figuredBassFormatter ,procedure? "A routine generating a markup
241 (figuredBassPlusDirection ,ly:dir? "Where to put plus signs
242 relative to the main figure.")
243 (fingeringOrientations ,list? "A list of symbols, containing
244 @samp{left}, @samp{right}, @samp{up} and/@/or @samp{down}. This list
245 determines where fingerings are put relative to the chord being
247 (firstClef ,boolean? "If true, create a new clef when starting a
249 (followVoice ,boolean? "If set, note heads are tracked across
250 staff switches by a thin line.")
251 (fontSize ,number? "The relative size of all grobs in a context.")
252 (forbidBreak ,boolean? "If set to @code{#t}, prevent a line break
254 (forceClef ,boolean? "Show clef symbol, even if it has not
255 changed. Only active for the first clef after the property is set, not
256 for the full staff.")
257 (fretLabels ,list? "A list of strings or Scheme-formatted markups
258 containing, in the correct order, the labels to be used for lettered
259 frets in tablature.")
262 (glissandoMap ,list? "A map in the form of '((source1 . target1)
263 (source2 . target2) (sourcen . targetn)) showing the glissandi to
264 be drawn for note columns. The value '() will default to '((0 . 0)
265 (1 . 1) (n . n)), where n is the minimal number of note-heads in
266 the two note columns between which the glissandi occur.")
267 (gridInterval ,ly:moment? "Interval for which to generate
271 (handleNegativeFrets ,symbol? "How the automatic fret calculator
272 should handle calculated negative frets. Values include @code{'ignore},
273 to leave them out of the diagram completely, @code{'include}, to include
274 them as calculated, and @code{'recalculate}, to ignore the specified
275 string and find a string where they will fit with a positive fret number.")
276 (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
278 (harmonicDots ,boolean? "If set, harmonic notes in dotted chords get
280 (highStringOne ,boolean? "Whether the first string is the string
281 with highest pitch on the instrument. This used by the automatic
282 string selector for tablature notation.")
285 (ignoreBarChecks ,boolean? "Ignore bar checks.")
286 (ignoreFiguredBassRest ,boolean? "Don't swallow rest events.")
287 (ignoreMelismata ,boolean? "Ignore melismata for this
288 @rinternals{Lyrics} line.")
289 (implicitBassFigures ,list? "A list of bass figures that are not
290 printed as numbers, but only as extender lines.")
291 (implicitTimeSignatureVisibility ,vector? "break visibility for
292 the default time signature.")
293 (includeGraceNotes ,boolean? "Do not ignore grace notes for
294 @rinternals{Lyrics}.")
295 (instrumentCueName ,markup? "The name to print if another
296 instrument is to be taken.")
297 (instrumentEqualizer ,procedure? "A function taking a string
298 (instrument name), and returning a @code{(@var{min} . @var{max})} pair
299 of numbers for the loudness range of the instrument.")
300 (instrumentName ,markup? "The name to print left of a staff. The
301 @code{instrumentName} property labels the staff in the first system, and
302 the @code{shortInstrumentName} property labels following lines.")
303 ;; the definition is reversed wrt traditional transposition
304 ;; otherwise \transpose { \transposition .. } won't work
305 (instrumentTransposition ,ly:pitch? "Define the transposition of
306 the instrument. Its value is the pitch that sounds like middle@tie{}C.
307 This is used to transpose the MIDI output, and @code{\\quote}s.")
308 (internalBarNumber ,integer? "Contains the current barnumber.
309 This property is used for internal timekeeping, among others by the
310 @code{Accidental_engraver}.")
313 (keepAliveInterfaces ,list? "A list of symbols, signifying grob
314 interfaces that are worth keeping a staff with @code{remove-empty} set
316 (keyAlterationOrder ,list? "An alist that defines in what order
317 alterations should be printed. The format is @code{(@var{step}
318 . @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and
319 @var{alter} from -2 (sharp) to 2 (flat).")
320 (keySignature ,list? "The current key signature. This is an alist
321 containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} .
322 @var{step}) . @var{alter})}, where @var{step} is a number in the range
323 0 to@tie{}6 and @var{alter} a fraction, denoting alteration. For
324 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.")
327 (lyricMelismaAlignment ,number? "Alignment to use for a melisma syllable.")
330 (majorSevenSymbol ,markup? "How should the major 7th be formatted
332 (markFormatter ,procedure? "A procedure taking as arguments the
333 context and the rehearsal mark. It should return the formatted mark as
335 (maximumFretStretch ,number? "Don't allocate frets further than
336 this from specified frets.")
337 (measureLength ,ly:moment? "Length of one measure in the current
339 (measurePosition ,ly:moment? "How much of the current measure have
340 we had. This can be set manually to create incomplete measures.")
341 (melismaBusyProperties ,list? "A list of properties (symbols) to
342 determine whether a melisma is playing. Setting this property will
343 influence how lyrics are aligned to notes. For example, if set to
344 @code{'(melismaBusy beamMelismaBusy)}, only manual melismata and
345 manual beams are considered. Possible values include
346 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
347 @code{beamMelismaBusy}.")
348 (metronomeMarkFormatter ,procedure? "How to produce a metronome
349 markup. Called with two arguments: a @code{TempoChangeEvent} and context.")
350 (middleCClefPosition ,number? "The position of the middle C,
351 as determined only by the clef. This can be calculated by looking at
352 @code{clefPosition} and @code{clefGlyph}.")
353 (middleCCuePosition ,number? "The position of the middle C,
354 as determined only by the clef of the cue notes. This can be calculated by
355 looking at @code{cueClefPosition} and @code{cueClefGlyph}.")
356 (middleCOffset ,number? "The offset of
357 middle C from the position given by @code{middleCClefPosition} This
358 is used for ottava brackets.")
359 (middleCPosition ,number? "The place of the middle C, measured in
360 half staff-spaces. Usually determined by looking at
361 @code{middleCClefPosition} and @code{middleCOffset}.")
362 (midiInstrument ,string? "Name of the MIDI instrument to use.")
363 (midiMergeUnisons ,boolean? "If true, output only one MIDI note-on
364 event when notes with the same pitch, in the same MIDI-file track, overlap.")
365 (midiMaximumVolume ,number? "Analogous to
366 @code{midiMinimumVolume}.")
367 (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
368 Ranges from 0 to@tie{}1.")
369 (midiChannelMapping ,symbol? "How to map MIDI channels: per @code{instrument} (default), @code{staff} or @code{voice}.")
370 (minimumFret ,number? "The tablature auto string-selecting
371 mechanism selects the highest string with a fret at least
372 @code{minimumFret}.")
373 (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a
374 page turn to be allowed.")
375 (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
376 repeated section for a page turn to be allowed within that section.")
378 (minorChordModifier ,markup? "Markup displayed following the root
381 (noChordSymbol ,markup? "Markup to be displayed for rests in a
382 ChordNames context.")
383 (noteToFretFunction ,procedure? "Convert list of notes and list of
384 defined strings to full list of strings and fret numbers.
385 Parameters: The context, a list of note events, a list of
386 tabstring events, and the fretboard grob if a fretboard is desired.")
389 (ottavation ,markup? "If set, the text for an ottava spanner.
390 Changing this creates a new text spanner.")
391 (output ,ly:music-output? "The output produced by a score-level
392 translator during music interpretation.")
395 (partCombineTextsOnNote ,boolean? "Print part-combine texts only on
396 the next note rather than immediately on rests or skips.")
397 (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
398 (pedalSostenutoStyle ,symbol? "See @code{pedalSustainStyle}.")
399 (pedalSustainStrings ,list? "A list of strings to print for
400 sustain-pedal. Format is @code{(@var{up} @var{updown} @var{down})},
401 where each of the three is the string to print when this is done with
403 (pedalSustainStyle ,symbol? "A symbol that indicates how to print
404 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
405 (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
406 (pedalUnaCordaStyle ,symbol? "See @code{pedalSustainStyle}.")
407 (predefinedDiagramTable ,hash-table? "The hash table of predefined
408 fret diagrams to use in FretBoards.")
409 (printKeyCancellation ,boolean? "Print restoration alterations
410 before a key signature change.")
411 (printOctaveNames ,boolean? "Print octave marks for the
412 @code{NoteNames} context.")
413 (printPartCombineTexts ,boolean? "Set @q{Solo} and @q{A due} texts
414 in the part combiner?")
415 (proportionalNotationDuration ,ly:moment? "Global override for
416 shortest-playing duration. This is used for switching on proportional
420 (rehearsalMark ,integer? "The last rehearsal mark printed.")
421 (repeatCommands ,list? "This property is a list of commands
422 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
423 @code{#f}. @code{'end-repeat} is also accepted as a command.")
424 (repeatCountVisibility ,procedure? "A procedure taking as
425 arguments an integer and context, returning whether the corresponding
426 percent repeat number should be printed when @code{countPercentRepeats}
428 (restCompletionBusy ,boolean? "Signal whether a completion-rest is active.")
429 (restNumberThreshold ,number? "If a multimeasure rest has more
430 measures than this, a number is printed.")
432 (searchForVoice ,boolean? "Signal whether a search should be made
433 of all contexts in the context hierarchy for a voice to provide rhythms
435 (shapeNoteStyles ,vector? "Vector of symbols, listing style for
436 each note head relative to the tonic (qv.) of the scale.")
437 (shortInstrumentName ,markup? "See @code{instrumentName}.")
438 (shortVocalName ,markup? "Name of a vocal line, short version.")
439 (skipBars ,boolean? "If set to true, then skip the empty bars
440 that are produced by multimeasure notes and rests. These bars will
441 not appear on the printed output. If not set (the default),
442 multimeasure notes and rests expand into their full length, printing
443 the appropriate number of empty bars so that synchronization with other
449 \\set Score.skipBars= ##t
453 (skipTypesetting ,boolean? "If true, no typesetting is done,
454 speeding up the interpretation phase. Useful for debugging large
456 (soloIIText ,markup? "The text for the start of a solo for
457 voice @q{two} when part-combining.")
458 (soloText ,markup? "The text for the start of a solo when
460 (squashedPosition ,integer? "Vertical position of squashing for
461 @rinternals{Pitch_squash_engraver}.")
462 (staffLineLayoutFunction ,procedure? "Layout of staff lines,
463 @code{traditional}, or @code{semitone}.")
464 (stanza ,markup? "Stanza @q{number} to print before the start of a
465 verse. Use in @code{Lyrics} context.")
466 (stemLeftBeamCount ,integer? "Specify the number of beams to draw
467 on the left side of the next note. Overrides automatic beaming. The
468 value is only used once, and then it is erased.")
469 (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
470 (stringNumberOrientations ,list? "See
471 @code{fingeringOrientations}.")
472 (stringOneTopmost ,boolean? "Whether the first string is
473 printed on the top line of the tablature.")
474 (stringTunings ,list? "The tablature strings tuning. It is a list
475 of the pitches of each string (starting with the lowest numbered
477 (strokeFingerOrientations ,list? "See
478 @code{fingeringOrientations}.")
479 (subdivideBeams ,boolean? "If set, multiple beams will be
480 subdivided at @code{baseMoment} positions by only drawing one beam over the beat.")
481 (suggestAccidentals ,boolean? "If set, accidentals are typeset as
482 cautionary suggestions over the note.")
483 (systemStartDelimiter ,symbol? "Which grob to make for the start
484 of the system/@/staff? Set to @code{SystemStartBrace},
485 @code{SystemStartBracket} or @code{SystemStartBar}.")
486 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating
487 the nesting of a start delimiters.")
490 (tablatureFormat ,procedure? "A function formatting a tablature
491 note head. Called with three arguments: context, string number and,
492 fret number. It returns the text as a markup.")
493 (tabStaffLineLayoutFunction ,procedure? "A function determining the
494 staff position of a tablature note head. Called with two arguments:
495 the context and the string.")
496 (tempoHideNote ,boolean? "Hide the note = count in tempo marks.")
497 (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
499 (tieWaitForNote ,boolean? "If true, tied notes do not have to
500 follow each other directly. This can be used for writing out
502 (timeSignatureFraction ,fraction? "A pair of numbers,
503 signifying the time signature. For example, @code{'(4 . 4)} is a
504 4/4 time signature.")
505 (timeSignatureSettings ,cheap-list? "A nested alist of settings for
506 time signatures. Contains elements for various time signatures. The
507 element for each time signature contains entries for @code{baseMoment},
508 @code{beatStructure}, and @code{beamExceptions}.")
509 (timing ,boolean? "Keep administration of measure length,
510 position, bar number, etc.? Switch off for cadenzas.")
511 (tonic ,ly:pitch? "The tonic of the current scale.")
512 (topLevelAlignment ,boolean? "If true, the @var{Vertical_align_engraver}
513 will create a @var{VerticalAlignment}; otherwise, it will create a
515 (trebleStaffProperties ,list? "An alist of property settings to
516 apply for the up staff of @code{PianoStaff}. Used by
517 @code{\\autochange}.")
518 (tremoloFlags ,integer? "The number of tremolo flags to add if no
519 number is specified.")
520 (tupletFullLength ,boolean? "If set, the tuplet is printed up to
521 the start of the next note.")
522 (tupletFullLengthNote ,boolean? "If set, end at the next note,
523 otherwise end on the matter (time signatures, etc.) before the note.")
524 (tupletSpannerDuration ,ly:moment? "Normally, a tuplet bracket is
525 as wide as the @code{\\times} expression that gave rise to it. By
526 setting this property, you can make brackets last shorter.
530 \\set tupletSpannerDuration = #(ly:make-moment 1 4)
531 \\times 2/3 @{ c8 c c c c c @}
536 (useBassFigureExtenders ,boolean? "Whether to use extender lines
537 for repeated bass figures.")
539 (vocalName ,markup? "Name of a vocal line.")
540 (voltaSpannerDuration ,ly:moment? "This specifies the maximum
541 duration to use for the brackets printed for @code{\\alternative}.
542 This can be used to shrink the length of brackets in the situation
543 where one alternative is very large.")
546 (whichBar ,string? "This property is read to determine what type
547 of bar line to create.
552 \\set Staff.whichBar = \"|:\"
556 This will create a start-repeat bar in this staff only. Valid values
557 are described in @rinternals{bar-line-interface}.")
561 (define-public all-internal-translation-properties
564 (set-object-property! (car x) 'internal-translation #t)
565 (apply translator-property-description x))
569 (associatedVoiceContext ,ly:context? "The context object of the
570 @code{Voice} that has the melody for this @code{Lyrics}.")
573 (barCheckLastFail ,ly:moment? "Where in the measure did the last
575 (beamMelismaBusy ,boolean? "Signal if a beam is present.")
576 (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
577 @var{grob})} cons cells. This is for internal (C++) use only. This
578 property contains the grobs which are still busy (e.g. note heads,
582 (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
583 current breakable (clef, key signature, etc.) items.")
584 (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
585 non-breakable items (note heads, lyrics, etc.).")
588 (dynamicAbsoluteVolumeFunction ,procedure? "A procedure that takes
589 one argument, the text value of a dynamic event, and returns the absolute
590 volume of that dynamic event.")
593 (finalizations ,list? "A list of expressions to evaluate before
594 proceeding to next time step. This is an internal variable.")
597 (graceSettings ,list? "Overrides for grace notes. This property
598 should be manipulated through the @code{add-grace-property} function.")
601 (hasStaffSpacing ,boolean? "True if the current
602 @code{CommandColumn} contains items that will affect spacing.")
605 (lastKeySignature ,list? "Last key signature before a key
607 (localKeySignature ,list? "The key signature at this point in the
608 measure. The format is the same as for @code{keySignature}, but can
609 also contain @code{((@var{octave} . @var{name}) . (@var{alter}
610 @var{barnumber} . @var{measureposition}))} pairs.")
613 (melismaBusy ,boolean? "Signifies whether a melisma is active.
614 This can be used to signal melismas on top of those automatically
618 (quotedCueEventTypes ,list? "A list of symbols, representing the
619 event types that should be duplicated for @code{\\cueDuring} commands.")
620 (quotedEventTypes ,list? "A list of symbols, representing the
621 event types that should be duplicated for @code{\\quoteDuring} commands.
622 This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
626 (rootSystem ,ly:grob? "The System object.")
629 (scriptDefinitions ,list? "The description of scripts. This is
630 used by the @code{Script_engraver} for typesetting note-superscripts
631 and subscripts. See @file{scm/@/script.scm} for more information.")
632 (slurMelismaBusy ,boolean? "Signal if a slur is present.")
633 (stavesFound ,grob-list? "A list of all staff-symbols found.")
636 (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
639 (define-public all-translation-properties
640 (append all-user-translation-properties
641 all-internal-translation-properties))
643 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
645 (define-public default-melisma-properties
646 '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy))