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