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? "Whether to allow a beam to begin
145 halfway through the measure in triple time, which could look like 6/8.")
146 (beatStructure ,list? "List of @code{baseMoment}s that are combined
149 (chordChanges ,boolean? "Only show changes in chords scheme?")
150 (chordNameExceptions ,list? "An alist of chord exceptions.
151 Contains @code{(@var{chord} . @var{markup})} entries.")
152 (chordNameExceptionsFull ,list? "An alist of full chord
153 exceptions. Contains @code{(@var{chord} . @var{markup})} entries.")
154 (chordNameExceptionsPartial ,list? "An alist of partial chord
155 exceptions. Contains @code{(@var{chord} . (@var{prefix-markup}
156 @var{suffix-markup}))} entries.")
157 (chordNameFunction ,procedure? "The function that converts lists
158 of pitches to chord names.")
159 (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
160 (chordNameSeparator ,markup? "The markup object used to
161 separate parts of a chord name.")
162 (slashChordSeparator ,markup? "The markup object used to separate
163 a chord name from its root note in case of inversions or slash
165 (chordNoteNamer ,procedure? "A function that converts from a pitch
166 object to a text markup. Used for single pitches.")
167 (chordPrefixSpacer ,number? "The space added between the root
168 symbol and the prefix of a chord name.")
169 (chordRootNamer ,procedure? "A function that converts from a pitch
170 object to a text markup. Used for chords.")
171 (clefGlyph ,string? "Name of the symbol within the music font.")
172 (clefOctavation ,integer? "Add this much extra octavation.
173 Values of 7 and -7 are common.")
174 (clefPosition ,number? "Where should the center of the clef
175 symbol go, measured in half staff spaces from the center of the
177 (completionBusy ,boolean? "Whether a completion-note head is playing.")
178 (completionUnit ,ly:moment? "Sub-bar unit of completion.")
179 (connectArpeggios ,boolean? "If set, connect arpeggios across
181 (countPercentRepeats ,boolean? "If set, produce counters for
183 (createKeyOnClefChange ,boolean? "Print a key signature whenever
184 the clef is changed.")
185 (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
186 Should be set for staves.")
187 (crescendoSpanner ,symbol? "The type of spanner to be used for
188 crescendi. Available values are @samp{hairpin} and @samp{text}. If unset,
189 a hairpin crescendo is used.")
190 (crescendoText ,markup? "The text to print at start of non-hairpin
191 crescendo, i.e., @samp{cresc.}.")
192 (cueClefGlyph ,string? "Name of the symbol within the music font.")
193 (cueClefOctavation ,integer? "Add this much extra octavation.
194 Values of 7 and -7 are common.")
195 (cueClefPosition ,number? "Where should the center of the clef
196 symbol go, measured in half staff spaces from the center of the
198 (currentBarNumber ,integer? "Contains the current barnumber.
199 This property is incremented at every bar line.")
202 (decrescendoSpanner ,symbol? "The type of spanner to be used for
203 decrescendi. Available values are @samp{hairpin} and @samp{text}. If
204 unset, a hairpin decrescendo is used.")
205 (decrescendoText ,markup? "The text to print at start of
206 non-hairpin decrescendo, i.e., @samp{dim.}.")
207 (defaultBarType ,string? "Set the default type of bar line. See
208 @code{whichBar} for information on available bar types.
210 This variable is read by @rinternals{Timing_translator} at
211 @rinternals{Score} level.")
212 (defaultStrings ,list? "A list of strings to use in calculating
213 frets for tablatures and fretboards if no strings are provided in
214 the notes for the current moment.")
215 (doubleRepeatSegnoType ,string? "Set the default bar line for
216 the combinations double repeat with segno. Default is @samp{:|.S.|:}.")
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 (endRepeatSegnoType ,string? "Set the default bar line for the
234 combinations ending of repeat with segno. Default is @samp{:|.S}.")
235 (endRepeatType ,string? "Set the default bar line for the ending
237 (explicitClefVisibility ,vector? "@samp{break-visibility}
238 function for clef changes.")
239 (explicitCueClefVisibility ,vector? "@samp{break-visibility}
240 function for cue clef changes.")
241 (explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
242 function for explicit key changes. @samp{\\override} of the
243 @code{break-visibility} property will set the visibility for normal
244 (i.e., at the start of the line) key signatures.")
245 (extendersOverRests ,boolean? "Whether to continue extenders as
247 (extraNatural ,boolean? "Whether to typeset an extra natural sign
248 before accidentals that reduce the effect of a previous alteration.")
251 (figuredBassAlterationDirection ,ly:dir? "Where to put alterations
252 relative to the main figure.")
253 (figuredBassCenterContinuations ,boolean? "Whether to vertically
254 center pairs of extender lines. This does not work with three or more
256 (figuredBassFormatter ,procedure? "A routine generating a markup
258 (figuredBassPlusDirection ,ly:dir? "Where to put plus signs
259 relative to the main figure.")
260 (fingeringOrientations ,list? "A list of symbols, containing
261 @samp{left}, @samp{right}, @samp{up} and/@/or @samp{down}. This list
262 determines where fingerings are put relative to the chord being
264 (firstClef ,boolean? "If true, create a new clef when starting a
266 (followVoice ,boolean? "If set, note heads are tracked across
267 staff switches by a thin line.")
268 (fontSize ,number? "The relative size of all grobs in a context.")
269 (forbidBreak ,boolean? "If set to @code{#t}, prevent a line break
271 (forceClef ,boolean? "Show clef symbol, even if it has not
272 changed. Only active for the first clef after the property is set, not
273 for the full staff.")
274 (fretLabels ,list? "A list of strings or Scheme-formatted markups
275 containing, in the correct order, the labels to be used for lettered
276 frets in tablature.")
279 (glissandoMap ,list? "A map in the form of '((source1 . target1)
280 (source2 . target2) (sourcen . targetn)) showing the glissandi to
281 be drawn for note columns. The value '() will default to '((0 . 0)
282 (1 . 1) (n . n)), where n is the minimal number of note-heads in
283 the two note columns between which the glissandi occur.")
284 (gridInterval ,ly:moment? "Interval for which to generate
288 (handleNegativeFrets ,symbol? "How the automatic fret calculator
289 should handle calculated negative frets. Values include @code{'ignore},
290 to leave them out of the diagram completely, @code{'include}, to include
291 them as calculated, and @code{'recalculate}, to ignore the specified
292 string and find a string where they will fit with a positive fret number.")
293 (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
295 (harmonicDots ,boolean? "If set, harmonic notes in dotted chords get
297 (highStringOne ,boolean? "Whether the first string is the string
298 with highest pitch on the instrument. This used by the automatic
299 string selector for tablature notation.")
302 (ignoreBarChecks ,boolean? "Ignore bar checks.")
303 (ignoreFiguredBassRest ,boolean? "Don't swallow rest events.")
304 (ignoreMelismata ,boolean? "Ignore melismata for this
305 @rinternals{Lyrics} line.")
306 (implicitBassFigures ,list? "A list of bass figures that are not
307 printed as numbers, but only as extender lines.")
308 (implicitTimeSignatureVisibility ,vector? "break visibility for
309 the default time signature.")
310 (includeGraceNotes ,boolean? "Do not ignore grace notes for
311 @rinternals{Lyrics}.")
312 (instrumentCueName ,markup? "The name to print if another
313 instrument is to be taken.")
314 (instrumentEqualizer ,procedure? "A function taking a string
315 (instrument name), and returning a @code{(@var{min} . @var{max})} pair
316 of numbers for the loudness range of the instrument.")
317 (instrumentName ,markup? "The name to print left of a staff. The
318 @code{instrumentName} property labels the staff in the first system, and
319 the @code{shortInstrumentName} property labels following lines.")
320 ;; the definition is reversed wrt traditional transposition
321 ;; otherwise \transpose { \transposition .. } won't work
322 (instrumentTransposition ,ly:pitch? "Define the transposition of
323 the instrument. Its value is the pitch that sounds like middle@tie{}C.
324 This is used to transpose the MIDI output, and @code{\\quote}s.")
325 (internalBarNumber ,integer? "Contains the current barnumber.
326 This property is used for internal timekeeping, among others by the
327 @code{Accidental_engraver}.")
330 (keepAliveInterfaces ,list? "A list of symbols, signifying grob
331 interfaces that are worth keeping a staff with @code{remove-empty} set
333 (keyAlterationOrder ,list? "An alist that defines in what order
334 alterations should be printed. The format is @code{(@var{step}
335 . @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and
336 @var{alter} from -2 (sharp) to 2 (flat).")
337 (keySignature ,list? "The current key signature. This is an alist
338 containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} .
339 @var{step}) . @var{alter})}, where @var{step} is a number in the range
340 0 to@tie{}6 and @var{alter} a fraction, denoting alteration. For
341 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.")
344 (lyricMelismaAlignment ,number? "Alignment to use for a melisma syllable.")
347 (majorSevenSymbol ,markup? "How should the major 7th be formatted
349 (markFormatter ,procedure? "A procedure taking as arguments the
350 context and the rehearsal mark. It should return the formatted mark as
352 (maximumFretStretch ,number? "Don't allocate frets further than
353 this from specified frets.")
354 (measureLength ,ly:moment? "Length of one measure in the current
356 (measurePosition ,ly:moment? "How much of the current measure have
357 we had. This can be set manually to create incomplete measures.")
358 (melismaBusyProperties ,list? "A list of properties (symbols) to
359 determine whether a melisma is playing. Setting this property will
360 influence how lyrics are aligned to notes. For example, if set to
361 @code{'(melismaBusy beamMelismaBusy)}, only manual melismata and
362 manual beams are considered. Possible values include
363 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
364 @code{beamMelismaBusy}.")
365 (metronomeMarkFormatter ,procedure? "How to produce a metronome
366 markup. Called with two arguments: a @code{TempoChangeEvent} and context.")
367 (middleCClefPosition ,number? "The position of the middle C,
368 as determined only by the clef. This can be calculated by looking at
369 @code{clefPosition} and @code{clefGlyph}.")
370 (middleCCuePosition ,number? "The position of the middle C,
371 as determined only by the clef of the cue notes. This can be calculated by
372 looking at @code{cueClefPosition} and @code{cueClefGlyph}.")
373 (middleCOffset ,number? "The offset of
374 middle C from the position given by @code{middleCClefPosition} This
375 is used for ottava brackets.")
376 (middleCPosition ,number? "The place of the middle C, measured in
377 half staff-spaces. Usually determined by looking at
378 @code{middleCClefPosition} and @code{middleCOffset}.")
379 (midiInstrument ,string? "Name of the MIDI instrument to use.")
380 (midiMergeUnisons ,boolean? "If true, output only one MIDI note-on
381 event when notes with the same pitch, in the same MIDI-file track, overlap.")
382 (midiMaximumVolume ,number? "Analogous to
383 @code{midiMinimumVolume}.")
384 (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
385 Ranges from 0 to@tie{}1.")
386 (midiChannelMapping ,symbol? "How to map MIDI channels: per @code{instrument} (default), @code{staff} or @code{voice}.")
387 (minimumFret ,number? "The tablature auto string-selecting
388 mechanism selects the highest string with a fret at least
389 @code{minimumFret}.")
390 (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a
391 page turn to be allowed.")
392 (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
393 repeated section for a page turn to be allowed within that section.")
395 (minorChordModifier ,markup? "Markup displayed following the root
398 (noChordSymbol ,markup? "Markup to be displayed for rests in a
399 ChordNames context.")
400 (noteToFretFunction ,procedure? "Convert list of notes and list of
401 defined strings to full list of strings and fret numbers.
402 Parameters: The context, a list of note events, a list of
403 tabstring events, and the fretboard grob if a fretboard is desired.")
406 (ottavation ,markup? "If set, the text for an ottava spanner.
407 Changing this creates a new text spanner.")
408 (output ,ly:music-output? "The output produced by a score-level
409 translator during music interpretation.")
412 (partCombineTextsOnNote ,boolean? "Print part-combine texts only on
413 the next note rather than immediately on rests or skips.")
414 (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
415 (pedalSostenutoStyle ,symbol? "See @code{pedalSustainStyle}.")
416 (pedalSustainStrings ,list? "A list of strings to print for
417 sustain-pedal. Format is @code{(@var{up} @var{updown} @var{down})},
418 where each of the three is the string to print when this is done with
420 (pedalSustainStyle ,symbol? "A symbol that indicates how to print
421 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
422 (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
423 (pedalUnaCordaStyle ,symbol? "See @code{pedalSustainStyle}.")
424 (predefinedDiagramTable ,hash-table? "The hash table of predefined
425 fret diagrams to use in FretBoards.")
426 (printKeyCancellation ,boolean? "Print restoration alterations
427 before a key signature change.")
428 (printOctaveNames ,boolean? "Print octave marks for the
429 @code{NoteNames} context.")
430 (printPartCombineTexts ,boolean? "Set @q{Solo} and @q{A due} texts
431 in the part combiner?")
432 (proportionalNotationDuration ,ly:moment? "Global override for
433 shortest-playing duration. This is used for switching on proportional
437 (rehearsalMark ,integer? "The last rehearsal mark printed.")
438 (repeatCommands ,list? "This property is a list of commands
439 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
440 @code{#f}. @code{'end-repeat} is also accepted as a command.")
441 (repeatCountVisibility ,procedure? "A procedure taking as
442 arguments an integer and context, returning whether the corresponding
443 percent repeat number should be printed when @code{countPercentRepeats}
445 (restCompletionBusy ,boolean? "Signal whether a completion-rest is active.")
446 (restNumberThreshold ,number? "If a multimeasure rest has more
447 measures than this, a number is printed.")
448 (restrainOpenStrings ,boolean? "Exclude open strings from the
449 automatic fret calculator.")
451 (searchForVoice ,boolean? "Signal whether a search should be made
452 of all contexts in the context hierarchy for a voice to provide rhythms
454 (segnoType ,string? "Set the default bar line for a requested segno.
455 Default is @samp{S}.")
456 (shapeNoteStyles ,vector? "Vector of symbols, listing style for
457 each note head relative to the tonic (qv.) of the scale.")
458 (shortInstrumentName ,markup? "See @code{instrumentName}.")
459 (shortVocalName ,markup? "Name of a vocal line, short version.")
460 (skipBars ,boolean? "If set to true, then skip the empty bars
461 that are produced by multimeasure notes and rests. These bars will
462 not appear on the printed output. If not set (the default),
463 multimeasure notes and rests expand into their full length, printing
464 the appropriate number of empty bars so that synchronization with other
470 \\set Score.skipBars= ##t
474 (skipTypesetting ,boolean? "If true, no typesetting is done,
475 speeding up the interpretation phase. Useful for debugging large
477 (soloIIText ,markup? "The text for the start of a solo for
478 voice @q{two} when part-combining.")
479 (soloText ,markup? "The text for the start of a solo when
481 (squashedPosition ,integer? "Vertical position of squashing for
482 @rinternals{Pitch_squash_engraver}.")
483 (staffLineLayoutFunction ,procedure? "Layout of staff lines,
484 @code{traditional}, or @code{semitone}.")
485 (stanza ,markup? "Stanza @q{number} to print before the start of a
486 verse. Use in @code{Lyrics} context.")
487 (startRepeatSegnoType ,string? "Set the default bar line for the
488 combinations beginning of repeat with segno. Default is @samp{S.|:}.")
489 (startRepeatType ,string? "Set the default bar line for the beginning
491 (stemLeftBeamCount ,integer? "Specify the number of beams to draw
492 on the left side of the next note. Overrides automatic beaming. The
493 value is only used once, and then it is erased.")
494 (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
495 (strictBeatBeaming ,boolean? "Should partial beams reflect the
496 beat structure even if it causes flags to hang out?")
497 (stringNumberOrientations ,list? "See
498 @code{fingeringOrientations}.")
499 (stringOneTopmost ,boolean? "Whether the first string is
500 printed on the top line of the tablature.")
501 (stringTunings ,list? "The tablature strings tuning. It is a list
502 of the pitches of each string (starting with the lowest numbered
504 (strokeFingerOrientations ,list? "See
505 @code{fingeringOrientations}.")
506 (subdivideBeams ,boolean? "If set, multiple beams will be
507 subdivided at @code{baseMoment} positions by only drawing one beam over the beat.")
508 (suggestAccidentals ,boolean? "If set, accidentals are typeset as
509 cautionary suggestions over the note.")
510 (systemStartDelimiter ,symbol? "Which grob to make for the start
511 of the system/@/staff? Set to @code{SystemStartBrace},
512 @code{SystemStartBracket} or @code{SystemStartBar}.")
513 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating
514 the nesting of a start delimiters.")
517 (tablatureFormat ,procedure? "A function formatting a tablature
518 note head. Called with three arguments: context, string number and,
519 fret number. It returns the text as a markup.")
520 (tabStaffLineLayoutFunction ,procedure? "A function determining the
521 staff position of a tablature note head. Called with two arguments:
522 the context and the string.")
523 (tempoHideNote ,boolean? "Hide the note = count in tempo marks.")
524 (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
526 (tieWaitForNote ,boolean? "If true, tied notes do not have to
527 follow each other directly. This can be used for writing out
529 (timeSignatureFraction ,fraction? "A pair of numbers,
530 signifying the time signature. For example, @code{'(4 . 4)} is a
531 4/4 time signature.")
532 (timeSignatureSettings ,cheap-list? "A nested alist of settings for
533 time signatures. Contains elements for various time signatures. The
534 element for each time signature contains entries for @code{baseMoment},
535 @code{beatStructure}, and @code{beamExceptions}.")
536 (timing ,boolean? "Keep administration of measure length,
537 position, bar number, etc.? Switch off for cadenzas.")
538 (tonic ,ly:pitch? "The tonic of the current scale.")
539 (topLevelAlignment ,boolean? "If true, the @var{Vertical_align_engraver}
540 will create a @var{VerticalAlignment}; otherwise, it will create a
542 (trebleStaffProperties ,list? "An alist of property settings to
543 apply for the up staff of @code{PianoStaff}. Used by
544 @code{\\autochange}.")
545 (tremoloFlags ,integer? "The number of tremolo flags to add if no
546 number is specified.")
547 (tupletFullLength ,boolean? "If set, the tuplet is printed up to
548 the start of the next note.")
549 (tupletFullLengthNote ,boolean? "If set, end at the next note,
550 otherwise end on the matter (time signatures, etc.) before the note.")
551 (tupletSpannerDuration ,ly:moment? "Normally, a tuplet bracket is
552 as wide as the @code{\\times} expression that gave rise to it. By
553 setting this property, you can make brackets last shorter.
557 \\set tupletSpannerDuration = #(ly:make-moment 1 4)
558 \\times 2/3 @{ c8 c c c c c @}
563 (useBassFigureExtenders ,boolean? "Whether to use extender lines
564 for repeated bass figures.")
566 (vocalName ,markup? "Name of a vocal line.")
567 (voltaSpannerDuration ,ly:moment? "This specifies the maximum
568 duration to use for the brackets printed for @code{\\alternative}.
569 This can be used to shrink the length of brackets in the situation
570 where one alternative is very large.")
573 (whichBar ,string? "This property is read to determine what type
574 of bar line to create.
579 \\set Staff.whichBar = \".|:\"
583 This will create a start-repeat bar in this staff only. Valid values
584 are described in @rinternals{bar-line-interface}.")
588 (define-public all-internal-translation-properties
591 (set-object-property! (car x) 'internal-translation #t)
592 (apply translator-property-description x))
595 (EventClasses ,cheap-list? "The initial list of event classes.")
597 (associatedVoiceContext ,ly:context? "The context object of the
598 @code{Voice} that has the melody for this @code{Lyrics}.")
601 (barCheckLastFail ,ly:moment? "Where in the measure did the last
603 (beamMelismaBusy ,boolean? "Signal if a beam is present.")
604 (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
605 @var{grob})} cons cells. This is for internal (C++) use only. This
606 property contains the grobs which are still busy (e.g. note heads,
610 (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
611 current breakable (clef, key signature, etc.) items.")
612 (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
613 non-breakable items (note heads, lyrics, etc.).")
616 (dynamicAbsoluteVolumeFunction ,procedure? "A procedure that takes
617 one argument, the text value of a dynamic event, and returns the absolute
618 volume of that dynamic event.")
621 (finalizations ,list? "A list of expressions to evaluate before
622 proceeding to next time step. This is an internal variable.")
625 (graceSettings ,list? "Overrides for grace notes. This property
626 should be manipulated through the @code{add-grace-property} function.")
629 (hasStaffSpacing ,boolean? "True if the current
630 @code{CommandColumn} contains items that will affect spacing.")
633 (lastKeySignature ,list? "Last key signature before a key
635 (localKeySignature ,list? "The key signature at this point in the
636 measure. The format is the same as for @code{keySignature}, but can
637 also contain @code{((@var{octave} . @var{name}) . (@var{alter}
638 @var{barnumber} . @var{measureposition}))} pairs.")
641 (melismaBusy ,boolean? "Signifies whether a melisma is active.
642 This can be used to signal melismas on top of those automatically
646 (quotedCueEventTypes ,list? "A list of symbols, representing the
647 event types that should be duplicated for @code{\\cueDuring} commands.")
648 (quotedEventTypes ,list? "A list of symbols, representing the
649 event types that should be duplicated for @code{\\quoteDuring} commands.
650 This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
654 (rootSystem ,ly:grob? "The System object.")
657 (scriptDefinitions ,list? "The description of scripts. This is
658 used by the @code{Script_engraver} for typesetting note-superscripts
659 and subscripts. See @file{scm/@/script.scm} for more information.")
660 (slurMelismaBusy ,boolean? "Signal if a slur is present.")
661 (stavesFound ,grob-list? "A list of all staff-symbols found.")
664 (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
667 (define-public all-translation-properties
668 (append all-user-translation-properties
669 all-internal-translation-properties))
671 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
673 (define-public default-melisma-properties
674 '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy))