1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2012 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 (additionalPitchPrefix ,string? "Text with which to prefix
49 additional pitches within a chord name.")
50 (alignAboveContext ,string? "Where to insert newly created context in
52 (alignBassFigureAccidentals ,boolean? "If true, then the accidentals
53 are aligned in bass figure context.")
54 (alignBelowContext ,string? "Where to insert newly created context in
56 (alternativeNumberingStyle ,symbol? "The style of an alternative's bar
57 numbers. Can be @code{numbers} for going back to the same number or
58 @code{numbers-with-letters} for going back to the same number with letter
59 suffixes. No setting will not go back in measure-number time.")
60 (associatedVoice ,string? "Name of the @code{Voice} that has the
61 melody for this @code{Lyrics} line.")
62 (autoAccidentals ,list? "List of different ways to typeset an
65 For determining when to print an accidental, several different rules
66 are tried. The rule that gives the highest number of accidentals is
69 Each entry in the list is either a symbol or a procedure.
74 The symbol is the name of the context in which the following rules are to be
75 applied. For example, if @var{context} is @rinternals{Score} then all
76 staves share accidentals, and if @var{context} is @rinternals{Staff} then
77 all voices in the same staff share accidentals, but staves do not.
80 The procedure represents an accidental rule to be applied to the previously
83 The procedure takes the following arguments:
88 The current context to which the rule should be applied.
91 The pitch of the note to be evaluated.
94 The current bar number.
97 The current measure position.
101 The procedure returns a pair of booleans. The first states whether an extra
102 natural should be added. The second states whether an accidental should be
103 printed. @code{(#t . #f)} does not make sense.
106 (autoBeamCheck ,procedure? "A procedure taking three
107 arguments, @var{context}, @var{dir} [start/@/stop (-1 or 1)], and
108 @var{test} [shortest note in the beam]. A non-@code{#f} return value
109 starts or stops the auto beam.")
110 (autoBeaming ,boolean? "If set to true then beams are generated
112 (autoCautionaries ,list? "List similar to @code{autoAccidentals},
113 but it controls cautionary accidentals rather than normal ones. Both
114 lists are tried, and the one giving the most accidentals wins. In
115 case of draw, a normal accidental is typeset.")
116 (automaticBars ,boolean? "If set to false then bar lines will not
117 be printed automatically; they must be explicitly created with a
118 @code{\\bar} command. Unlike the @code{\\cadenzaOn} keyword, measures
119 are still counted. Bar line generation will resume according to that
120 count if this property is unset.")
123 (barAlways ,boolean? "If set to true a bar line is drawn after
125 (barCheckSynchronize ,boolean? "If true then reset
126 @code{measurePosition} when finding a bar check.")
127 (barNumberFormatter ,procedure? "A procedure that takes a bar
128 number, measure position, and alternative number and returns a markup
129 of the bar number to print.")
130 (barNumberVisibility ,procedure? "A procedure that takes a bar
131 number and a measure position and returns whether the corresponding
132 bar number should be printed.")
133 (baseMoment ,ly:moment? "Smallest unit of time that will stand on its
134 own as a subdivided section.")
135 (bassFigureFormatFunction ,procedure? "A procedure that is
136 called to produce the formatting for a @code{BassFigure} grob. It
137 takes a list of @code{BassFigureEvent}s, a context, and the grob to
139 (bassStaffProperties ,list? "An alist of property settings to
140 apply for the down staff of @code{PianoStaff}. Used by
141 @code{\\autochange}.")
142 (beamExceptions ,list? "An alist of exceptions to autobeam rules
143 that normally end on beats.")
144 (beamHalfMeasure ,boolean? "Allow a half measure of eighth notes to
145 be beamed together in 3/4 time?")
146 (beamWholeMeasure ,boolean? "Allow a whole measure of eighth notes
147 to be beamed together in 3/4 time?")
148 (beatStructure ,list? "List of @code{baseMoment}s that are combined
151 (chordChanges ,boolean? "Only show changes in chords scheme?")
152 (chordNameExceptions ,list? "An alist of chord exceptions.
153 Contains @code{(@var{chord} . @var{markup})} entries.")
154 (chordNameExceptionsFull ,list? "An alist of full chord
155 exceptions. Contains @code{(@var{chord} . @var{markup})} entries.")
156 (chordNameExceptionsPartial ,list? "An alist of partial chord
157 exceptions. Contains @code{(@var{chord} . (@var{prefix-markup}
158 @var{suffix-markup}))} entries.")
159 (chordNameFunction ,procedure? "The function that converts lists
160 of pitches to chord names.")
161 (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
162 (chordNameSeparator ,markup? "The markup object used to
163 separate parts of a chord name.")
164 (slashChordSeparator ,markup? "The markup object used to separate
165 a chord name from its root note in case of inversions or slash
167 (chordNoteNamer ,procedure? "A function that converts from a pitch
168 object to a text markup. Used for single pitches.")
169 (chordPrefixSpacer ,number? "The space added between the root
170 symbol and the prefix of a chord name.")
171 (chordRootNamer ,procedure? "A function that converts from a pitch
172 object to a text markup. Used for chords.")
173 (clefGlyph ,string? "Name of the symbol within the music font.")
174 (clefOctavation ,integer? "Add this much extra octavation.
175 Values of 7 and -7 are common.")
176 (clefPosition ,number? "Where should the center of the clef
177 symbol go, measured in half staff spaces from the center of the
179 (completionBusy ,boolean? "Whether a completion-note head is playing.")
180 (completionUnit ,ly:moment? "Sub-bar unit of completion.")
181 (connectArpeggios ,boolean? "If set, connect arpeggios across
183 (countPercentRepeats ,boolean? "If set, produce counters for
185 (createKeyOnClefChange ,boolean? "Print a key signature whenever
186 the clef is changed.")
187 (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
188 Should be set for staves.")
189 (crescendoSpanner ,symbol? "The type of spanner to be used for
190 crescendi. Available values are @samp{hairpin} and @samp{text}. If unset,
191 a hairpin crescendo is used.")
192 (crescendoText ,markup? "The text to print at start of non-hairpin
193 crescendo, i.e., @samp{cresc.}.")
194 (cueClefGlyph ,string? "Name of the symbol within the music font.")
195 (cueClefOctavation ,integer? "Add this much extra octavation.
196 Values of 7 and -7 are common.")
197 (cueClefPosition ,number? "Where should the center of the clef
198 symbol go, measured in half staff spaces from the center of the
200 (currentBarNumber ,integer? "Contains the current barnumber.
201 This property is incremented at every bar line.")
204 (decrescendoSpanner ,symbol? "The type of spanner to be used for
205 decrescendi. Available values are @samp{hairpin} and @samp{text}. If
206 unset, a hairpin decrescendo is used.")
207 (decrescendoText ,markup? "The text to print at start of
208 non-hairpin decrescendo, i.e., @samp{dim.}.")
209 (defaultBarType ,string? "Set the default type of bar line. See
210 @code{whichBar} for information on available bar types.
212 This variable is read by @rinternals{Timing_translator} at
213 @rinternals{Score} level.")
214 (defaultStrings ,list? "A list of strings to use in calculating
215 frets for tablatures and fretboards if no strings are provided in
216 the notes for the current moment.")
217 (doubleRepeatType ,string? "Set the default bar line for double
219 (doubleSlurs ,boolean? "If set, two slurs are created for every
220 slurred note, one above and one below the chord.")
221 (drumPitchTable ,hash-table? "A table mapping percussion
222 instruments (symbols) to pitches.")
223 (drumStyleTable ,hash-table? "A hash table which maps drums to
224 layout settings. Predefined values: @samp{drums-style},
225 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style}, and
226 @samp{percussion-style}.
228 The layout style is a hash table, containing the drum-pitches (e.g.,
229 the symbol @samp{hihat}) as keys, and a list
230 @code{(@var{notehead-style} @var{script} @var{vertical-position})} as
233 (endRepeatType ,string? "Set the default bar line for the ending
235 (explicitClefVisibility ,vector? "@samp{break-visibility}
236 function for clef changes.")
237 (explicitCueClefVisibility ,vector? "@samp{break-visibility}
238 function for cue clef changes.")
239 (explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
240 function for explicit key changes. @samp{\\override} of the
241 @code{break-visibility} property will set the visibility for normal
242 (i.e., at the start of the line) key signatures.")
243 (extendersOverRests ,boolean? "Whether to continue extenders as
245 (extraNatural ,boolean? "Whether to typeset an extra natural sign
246 before accidentals that reduce the effect of a previous alteration.")
249 (figuredBassAlterationDirection ,ly:dir? "Where to put alterations
250 relative to the main figure.")
251 (figuredBassCenterContinuations ,boolean? "Whether to vertically
252 center pairs of extender lines. This does not work with three or more
254 (figuredBassFormatter ,procedure? "A routine generating a markup
256 (figuredBassPlusDirection ,ly:dir? "Where to put plus signs
257 relative to the main figure.")
258 (fingeringOrientations ,list? "A list of symbols, containing
259 @samp{left}, @samp{right}, @samp{up} and/@/or @samp{down}. This list
260 determines where fingerings are put relative to the chord being
262 (firstClef ,boolean? "If true, create a new clef when starting a
264 (followVoice ,boolean? "If set, note heads are tracked across
265 staff switches by a thin line.")
266 (fontSize ,number? "The relative size of all grobs in a context.")
267 (forbidBreak ,boolean? "If set to @code{#t}, prevent a line break
269 (forceClef ,boolean? "Show clef symbol, even if it has not
270 changed. Only active for the first clef after the property is set, not
271 for the full staff.")
272 (fretLabels ,list? "A list of strings or Scheme-formatted markups
273 containing, in the correct order, the labels to be used for lettered
274 frets in tablature.")
277 (glissandoMap ,list? "A map in the form of '((source1 . target1)
278 (source2 . target2) (sourcen . targetn)) showing the glissandi to
279 be drawn for note columns. The value '() will default to '((0 . 0)
280 (1 . 1) (n . n)), where n is the minimal number of note-heads in
281 the two note columns between which the glissandi occur.")
282 (gridInterval ,ly:moment? "Interval for which to generate
286 (handleNegativeFrets ,symbol? "How the automatic fret calculator
287 should handle calculated negative frets. Values include @code{'ignore},
288 to leave them out of the diagram completely, @code{'include}, to include
289 them as calculated, and @code{'recalculate}, to ignore the specified
290 string and find a string where they will fit with a positive fret number.")
291 (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
293 (harmonicDots ,boolean? "If set, harmonic notes in dotted chords get
295 (highStringOne ,boolean? "Whether the first string is the string
296 with highest pitch on the instrument. This used by the automatic
297 string selector for tablature notation.")
300 (ignoreBarChecks ,boolean? "Ignore bar checks.")
301 (ignoreFiguredBassRest ,boolean? "Don't swallow rest events.")
302 (ignoreMelismata ,boolean? "Ignore melismata for this
303 @rinternals{Lyrics} line.")
304 (implicitBassFigures ,list? "A list of bass figures that are not
305 printed as numbers, but only as extender lines.")
306 (implicitTimeSignatureVisibility ,vector? "break visibility for
307 the default time signature.")
308 (includeGraceNotes ,boolean? "Do not ignore grace notes for
309 @rinternals{Lyrics}.")
310 (instrumentCueName ,markup? "The name to print if another
311 instrument is to be taken.")
312 (instrumentEqualizer ,procedure? "A function taking a string
313 (instrument name), and returning a @code{(@var{min} . @var{max})} pair
314 of numbers for the loudness range of the instrument.")
315 (instrumentName ,markup? "The name to print left of a staff. The
316 @code{instrumentName} property labels the staff in the first system, and
317 the @code{shortInstrumentName} property labels following lines.")
318 ;; the definition is reversed wrt traditional transposition
319 ;; otherwise \transpose { \transposition .. } won't work
320 (instrumentTransposition ,ly:pitch? "Define the transposition of
321 the instrument. Its value is the pitch that sounds like middle@tie{}C.
322 This is used to transpose the MIDI output, and @code{\\quote}s.")
323 (internalBarNumber ,integer? "Contains the current barnumber.
324 This property is used for internal timekeeping, among others by the
325 @code{Accidental_engraver}.")
328 (keepAliveInterfaces ,list? "A list of symbols, signifying grob
329 interfaces that are worth keeping a staff with @code{remove-empty} set
331 (keyAlterationOrder ,list? "An alist that defines in what order
332 alterations should be printed. The format is @code{(@var{step}
333 . @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and
334 @var{alter} from -2 (sharp) to 2 (flat).")
335 (keySignature ,list? "The current key signature. This is an alist
336 containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} .
337 @var{step}) . @var{alter})}, where @var{step} is a number in the range
338 0 to@tie{}6 and @var{alter} a fraction, denoting alteration. For
339 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.")
342 (lyricMelismaAlignment ,number? "Alignment to use for a melisma syllable.")
345 (majorSevenSymbol ,markup? "How should the major 7th be formatted
347 (markFormatter ,procedure? "A procedure taking as arguments the
348 context and the rehearsal mark. It should return the formatted mark as
350 (maximumFretStretch ,number? "Don't allocate frets further than
351 this from specified frets.")
352 (measureLength ,ly:moment? "Length of one measure in the current
354 (measurePosition ,ly:moment? "How much of the current measure have
355 we had. This can be set manually to create incomplete measures.")
356 (melismaBusyProperties ,list? "A list of properties (symbols) to
357 determine whether a melisma is playing. Setting this property will
358 influence how lyrics are aligned to notes. For example, if set to
359 @code{'(melismaBusy beamMelismaBusy)}, only manual melismata and
360 manual beams are considered. Possible values include
361 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
362 @code{beamMelismaBusy}.")
363 (metronomeMarkFormatter ,procedure? "How to produce a metronome
364 markup. Called with two arguments: a @code{TempoChangeEvent} and context.")
365 (middleCClefPosition ,number? "The position of the middle C,
366 as determined only by the clef. This can be calculated by looking at
367 @code{clefPosition} and @code{clefGlyph}.")
368 (middleCCuePosition ,number? "The position of the middle C,
369 as determined only by the clef of the cue notes. This can be calculated by
370 looking at @code{cueClefPosition} and @code{cueClefGlyph}.")
371 (middleCOffset ,number? "The offset of
372 middle C from the position given by @code{middleCClefPosition} This
373 is used for ottava brackets.")
374 (middleCPosition ,number? "The place of the middle C, measured in
375 half staff-spaces. Usually determined by looking at
376 @code{middleCClefPosition} and @code{middleCOffset}.")
377 (midiInstrument ,string? "Name of the MIDI instrument to use.")
378 (midiMergeUnisons ,boolean? "If true, output only one MIDI note-on
379 event when notes with the same pitch, in the same MIDI-file track, overlap.")
380 (midiMaximumVolume ,number? "Analogous to
381 @code{midiMinimumVolume}.")
382 (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
383 Ranges from 0 to@tie{}1.")
384 (midiChannelMapping ,symbol? "How to map MIDI channels: per @code{instrument} (default), @code{staff} or @code{voice}.")
385 (minimumFret ,number? "The tablature auto string-selecting
386 mechanism selects the highest string with a fret at least
387 @code{minimumFret}.")
388 (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a
389 page turn to be allowed.")
390 (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
391 repeated section for a page turn to be allowed within that section.")
393 (minorChordModifier ,markup? "Markup displayed following the root
396 (noChordSymbol ,markup? "Markup to be displayed for rests in a
397 ChordNames context.")
398 (noteToFretFunction ,procedure? "Convert list of notes and list of
399 defined strings to full list of strings and fret numbers.
400 Parameters: The context, a list of note events, a list of
401 tabstring events, and the fretboard grob if a fretboard is desired.")
404 (ottavation ,markup? "If set, the text for an ottava spanner.
405 Changing this creates a new text spanner.")
406 (output ,ly:music-output? "The output produced by a score-level
407 translator during music interpretation.")
410 (partCombineTextsOnNote ,boolean? "Print part-combine texts only on
411 the next note rather than immediately on rests or skips.")
412 (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
413 (pedalSostenutoStyle ,symbol? "See @code{pedalSustainStyle}.")
414 (pedalSustainStrings ,list? "A list of strings to print for
415 sustain-pedal. Format is @code{(@var{up} @var{updown} @var{down})},
416 where each of the three is the string to print when this is done with
418 (pedalSustainStyle ,symbol? "A symbol that indicates how to print
419 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
420 (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
421 (pedalUnaCordaStyle ,symbol? "See @code{pedalSustainStyle}.")
422 (predefinedDiagramTable ,hash-table? "The hash table of predefined
423 fret diagrams to use in FretBoards.")
424 (printKeyCancellation ,boolean? "Print restoration alterations
425 before a key signature change.")
426 (printOctaveNames ,boolean? "Print octave marks for the
427 @code{NoteNames} context.")
428 (printPartCombineTexts ,boolean? "Set @q{Solo} and @q{A due} texts
429 in the part combiner?")
430 (proportionalNotationDuration ,ly:moment? "Global override for
431 shortest-playing duration. This is used for switching on proportional
435 (rehearsalMark ,integer? "The last rehearsal mark printed.")
436 (repeatCommands ,list? "This property is a list of commands
437 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
438 @code{#f}. @code{'end-repeat} is also accepted as a command.")
439 (repeatCountVisibility ,procedure? "A procedure taking as
440 arguments an integer and context, returning whether the corresponding
441 percent repeat number should be printed when @code{countPercentRepeats}
443 (restCompletionBusy ,boolean? "Signal whether a completion-rest is active.")
444 (restNumberThreshold ,number? "If a multimeasure rest has more
445 measures than this, a number is printed.")
446 (restrainOpenStrings ,boolean? "Exclude open strings from the
447 automatic fret calculator.")
449 (searchForVoice ,boolean? "Signal whether a search should be made
450 of all contexts in the context hierarchy for a voice to provide rhythms
452 (shapeNoteStyles ,vector? "Vector of symbols, listing style for
453 each note head relative to the tonic (qv.) of the scale.")
454 (shortInstrumentName ,markup? "See @code{instrumentName}.")
455 (shortVocalName ,markup? "Name of a vocal line, short version.")
456 (skipBars ,boolean? "If set to true, then skip the empty bars
457 that are produced by multimeasure notes and rests. These bars will
458 not appear on the printed output. If not set (the default),
459 multimeasure notes and rests expand into their full length, printing
460 the appropriate number of empty bars so that synchronization with other
466 \\set Score.skipBars= ##t
470 (skipTypesetting ,boolean? "If true, no typesetting is done,
471 speeding up the interpretation phase. Useful for debugging large
473 (soloIIText ,markup? "The text for the start of a solo for
474 voice @q{two} when part-combining.")
475 (soloText ,markup? "The text for the start of a solo when
477 (squashedPosition ,integer? "Vertical position of squashing for
478 @rinternals{Pitch_squash_engraver}.")
479 (staffLineLayoutFunction ,procedure? "Layout of staff lines,
480 @code{traditional}, or @code{semitone}.")
481 (stanza ,markup? "Stanza @q{number} to print before the start of a
482 verse. Use in @code{Lyrics} context.")
483 (startRepeatType ,string? "Set the default bar line for the beginning
485 (stemLeftBeamCount ,integer? "Specify the number of beams to draw
486 on the left side of the next note. Overrides automatic beaming. The
487 value is only used once, and then it is erased.")
488 (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
489 (strictBeatBeaming ,boolean? "Should partial beams reflect the
490 beat structure even if it causes flags to hang out?")
491 (stringNumberOrientations ,list? "See
492 @code{fingeringOrientations}.")
493 (stringOneTopmost ,boolean? "Whether the first string is
494 printed on the top line of the tablature.")
495 (stringTunings ,list? "The tablature strings tuning. It is a list
496 of the pitches of each string (starting with the lowest numbered
498 (strokeFingerOrientations ,list? "See
499 @code{fingeringOrientations}.")
500 (subdivideBeams ,boolean? "If set, multiple beams will be
501 subdivided at @code{baseMoment} positions by only drawing one beam over the beat.")
502 (suggestAccidentals ,boolean? "If set, accidentals are typeset as
503 cautionary suggestions over the note.")
504 (systemStartDelimiter ,symbol? "Which grob to make for the start
505 of the system/@/staff? Set to @code{SystemStartBrace},
506 @code{SystemStartBracket} or @code{SystemStartBar}.")
507 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating
508 the nesting of a start delimiters.")
511 (tablatureFormat ,procedure? "A function formatting a tablature
512 note head. Called with three arguments: context, string number and,
513 fret number. It returns the text as a markup.")
514 (tabStaffLineLayoutFunction ,procedure? "A function determining the
515 staff position of a tablature note head. Called with two arguments:
516 the context and the string.")
517 (tempoHideNote ,boolean? "Hide the note = count in tempo marks.")
518 (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
520 (tieWaitForNote ,boolean? "If true, tied notes do not have to
521 follow each other directly. This can be used for writing out
523 (timeSignatureFraction ,fraction? "A pair of numbers,
524 signifying the time signature. For example, @code{'(4 . 4)} is a
525 4/4 time signature.")
526 (timeSignatureSettings ,cheap-list? "A nested alist of settings for
527 time signatures. Contains elements for various time signatures. The
528 element for each time signature contains entries for @code{baseMoment},
529 @code{beatStructure}, and @code{beamExceptions}.")
530 (timing ,boolean? "Keep administration of measure length,
531 position, bar number, etc.? Switch off for cadenzas.")
532 (tonic ,ly:pitch? "The tonic of the current scale.")
533 (topLevelAlignment ,boolean? "If true, the @var{Vertical_align_engraver}
534 will create a @var{VerticalAlignment}; otherwise, it will create a
536 (trebleStaffProperties ,list? "An alist of property settings to
537 apply for the up staff of @code{PianoStaff}. Used by
538 @code{\\autochange}.")
539 (tremoloFlags ,integer? "The number of tremolo flags to add if no
540 number is specified.")
541 (tupletFullLength ,boolean? "If set, the tuplet is printed up to
542 the start of the next note.")
543 (tupletFullLengthNote ,boolean? "If set, end at the next note,
544 otherwise end on the matter (time signatures, etc.) before the note.")
545 (tupletSpannerDuration ,ly:moment? "Normally, a tuplet bracket is
546 as wide as the @code{\\times} expression that gave rise to it. By
547 setting this property, you can make brackets last shorter.
551 \\set tupletSpannerDuration = #(ly:make-moment 1 4)
552 \\times 2/3 @{ c8 c c c c c @}
557 (useBassFigureExtenders ,boolean? "Whether to use extender lines
558 for repeated bass figures.")
560 (vocalName ,markup? "Name of a vocal line.")
561 (voltaSpannerDuration ,ly:moment? "This specifies the maximum
562 duration to use for the brackets printed for @code{\\alternative}.
563 This can be used to shrink the length of brackets in the situation
564 where one alternative is very large.")
567 (whichBar ,string? "This property is read to determine what type
568 of bar line to create.
573 \\set Staff.whichBar = \"|:\"
577 This will create a start-repeat bar in this staff only. Valid values
578 are described in @rinternals{bar-line-interface}.")
582 (define-public all-internal-translation-properties
585 (set-object-property! (car x) 'internal-translation #t)
586 (apply translator-property-description x))
589 (EventClasses ,cheap-list? "The initial list of event classes.")
591 (associatedVoiceContext ,ly:context? "The context object of the
592 @code{Voice} that has the melody for this @code{Lyrics}.")
595 (barCheckLastFail ,ly:moment? "Where in the measure did the last
597 (beamMelismaBusy ,boolean? "Signal if a beam is present.")
598 (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
599 @var{grob})} cons cells. This is for internal (C++) use only. This
600 property contains the grobs which are still busy (e.g. note heads,
604 (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
605 current breakable (clef, key signature, etc.) items.")
606 (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
607 non-breakable items (note heads, lyrics, etc.).")
610 (dynamicAbsoluteVolumeFunction ,procedure? "A procedure that takes
611 one argument, the text value of a dynamic event, and returns the absolute
612 volume of that dynamic event.")
615 (finalizations ,list? "A list of expressions to evaluate before
616 proceeding to next time step. This is an internal variable.")
619 (graceSettings ,list? "Overrides for grace notes. This property
620 should be manipulated through the @code{add-grace-property} function.")
623 (hasStaffSpacing ,boolean? "True if the current
624 @code{CommandColumn} contains items that will affect spacing.")
627 (lastKeySignature ,list? "Last key signature before a key
629 (localKeySignature ,list? "The key signature at this point in the
630 measure. The format is the same as for @code{keySignature}, but can
631 also contain @code{((@var{octave} . @var{name}) . (@var{alter}
632 @var{barnumber} . @var{measureposition}))} pairs.")
635 (melismaBusy ,boolean? "Signifies whether a melisma is active.
636 This can be used to signal melismas on top of those automatically
640 (quotedCueEventTypes ,list? "A list of symbols, representing the
641 event types that should be duplicated for @code{\\cueDuring} commands.")
642 (quotedEventTypes ,list? "A list of symbols, representing the
643 event types that should be duplicated for @code{\\quoteDuring} commands.
644 This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
648 (rootSystem ,ly:grob? "The System object.")
651 (scriptDefinitions ,list? "The description of scripts. This is
652 used by the @code{Script_engraver} for typesetting note-superscripts
653 and subscripts. See @file{scm/@/script.scm} for more information.")
654 (slurMelismaBusy ,boolean? "Signal if a slur is present.")
655 (stavesFound ,grob-list? "A list of all staff-symbols found.")
658 (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
661 (define-public all-translation-properties
662 (append all-user-translation-properties
663 all-internal-translation-properties))
665 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
667 (define-public default-melisma-properties
668 '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy))