1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2014 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 (alternativeRestores ,symbol-list? "Timing variables that are
64 restored to their value at the end of the first alternative in
65 subsequent alternatives.")
66 (associatedVoice ,string? "Name of the context (see
67 @code{associatedVoiceType} for its type, usually @code{Voice}) that
68 has the melody for this @code{Lyrics} line.")
69 (associatedVoiceType ,symbol? "Type of the context that has the
70 melody for this @code{Lyrics} line.")
71 (autoAccidentals ,list? "List of different ways to typeset an
74 For determining when to print an accidental, several different rules
75 are tried. The rule that gives the highest number of accidentals is
78 Each entry in the list is either a symbol or a procedure.
83 The symbol is the name of the context in which the following rules are to be
84 applied. For example, if @var{context} is @rinternals{Score} then all
85 staves share accidentals, and if @var{context} is @rinternals{Staff} then
86 all voices in the same staff share accidentals, but staves do not.
89 The procedure represents an accidental rule to be applied to the previously
92 The procedure takes the following arguments:
97 The current context to which the rule should be applied.
100 The pitch of the note to be evaluated.
103 The current bar number.
106 The current measure position.
110 The procedure returns a pair of booleans. The first states whether an extra
111 natural should be added. The second states whether an accidental should be
112 printed. @code{(#t . #f)} does not make sense.
115 (autoBeamCheck ,procedure? "A procedure taking three
116 arguments, @var{context}, @var{dir} [start/@/stop (-1 or 1)], and
117 @var{test} [shortest note in the beam]. A non-@code{#f} return value
118 starts or stops the auto beam.")
119 (autoBeaming ,boolean? "If set to true then beams are generated
121 (autoCautionaries ,list? "List similar to @code{autoAccidentals},
122 but it controls cautionary accidentals rather than normal ones. Both
123 lists are tried, and the one giving the most accidentals wins. In
124 case of draw, a normal accidental is typeset.")
125 (automaticBars ,boolean? "If set to false then bar lines will not
126 be printed automatically; they must be explicitly created with a
127 @code{\\bar} command. Unlike the @code{\\cadenzaOn} keyword, measures
128 are still counted. Bar line generation will resume according to that
129 count if this property is unset.")
132 (barAlways ,boolean? "If set to true a bar line is drawn after
134 (barCheckSynchronize ,boolean? "If true then reset
135 @code{measurePosition} when finding a bar check.")
136 (barNumberFormatter ,procedure? "A procedure that takes a bar
137 number, measure position, and alternative number and returns a markup
138 of the bar number to print.")
139 (barNumberVisibility ,procedure? "A procedure that takes a bar
140 number and a measure position and returns whether the corresponding
141 bar number should be printed. Note that the actual print-out of
142 bar numbers is controlled with the @code{break-visibility} property.
144 The following procedures are predefined:
147 @item all-bar-numbers-visible
148 Enable bar numbers for all bars, including the first one and broken
149 bars (which get bar numbers in parentheses).
151 @item first-bar-number-invisible
152 Enable bar numbers for all bars (including broken bars) except the
153 first one. If the first bar is broken, it doesn't get a bar number
156 @item first-bar-number-invisible-save-broken-bars
157 Enable bar numbers for all bars (including broken bars) except the
158 first one. A broken first bar gets a bar number.
160 @item first-bar-number-invisible-and-no-parenthesized-bar-numbers
161 Enable bar numbers for all bars except the first bar and broken bars.
164 @item (every-nth-bar-number-visible @var{n})
165 Assuming @var{n} is value@tie{}2, for example, this enables bar numbers
166 for bars 2, 4, 6, etc.
168 @item (modulo-bar-number-visible @var{n} @var{m})
169 If bar numbers 1, 4, 7, etc., should be enabled, @var{n}@tie{}(the modulo)
170 must be set to@tie{}3 and @var{m}@tie{}(the division remainder) to@tie{}1.
173 (baseMoment ,ly:moment? "Smallest unit of time that will stand on its
174 own as a subdivided section.")
175 (bassFigureFormatFunction ,procedure? "A procedure that is
176 called to produce the formatting for a @code{BassFigure} grob. It
177 takes a list of @code{BassFigureEvent}s, a context, and the grob to
179 (bassStaffProperties ,list? "An alist of property settings to
180 apply for the down staff of @code{PianoStaff}. Used by
181 @code{\\autochange}.")
182 (beamExceptions ,list? "An alist of exceptions to autobeam rules
183 that normally end on beats.")
184 (beamHalfMeasure ,boolean? "Whether to allow a beam to begin
185 halfway through the measure in triple time, which could look like 6/8.")
186 (beatStructure ,list? "List of @code{baseMoment}s that are combined
189 (chordChanges ,boolean? "Only show changes in chords scheme?")
190 (chordNameExceptions ,list? "An alist of chord exceptions.
191 Contains @code{(@var{chord} . @var{markup})} entries.")
192 (chordNameExceptionsFull ,list? "An alist of full chord
193 exceptions. Contains @code{(@var{chord} . @var{markup})} entries.")
194 (chordNameExceptionsPartial ,list? "An alist of partial chord
195 exceptions. Contains @code{(@var{chord} . (@var{prefix-markup}
196 @var{suffix-markup}))} entries.")
197 (chordNameFunction ,procedure? "The function that converts lists
198 of pitches to chord names.")
199 (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
200 (chordNameSeparator ,markup? "The markup object used to
201 separate parts of a chord name.")
202 (slashChordSeparator ,markup? "The markup object used to separate
203 a chord name from its root note in case of inversions or slash
205 (chordNoteNamer ,procedure? "A function that converts from a pitch
206 object to a text markup. Used for single pitches.")
207 (chordPrefixSpacer ,number? "The space added between the root
208 symbol and the prefix of a chord name.")
209 (chordRootNamer ,procedure? "A function that converts from a pitch
210 object to a text markup. Used for chords.")
211 (clefGlyph ,string? "Name of the symbol within the music font.")
212 (clefTransposition ,integer? "Add this much extra transposition.
213 Values of 7 and -7 are common.")
214 (clefTranspositionFormatter ,procedure? "A procedure that takes the
215 Transposition number as a string and the style as a symbol and returns a
217 (clefTranspositionStyle ,symbol? "Determines the way the ClefModifier
218 grob is displayed. Possible values are @samp{default}, @samp{parenthesized}
219 and @samp{bracketed}.")
220 (clefPosition ,number? "Where should the center of the clef
221 symbol go, measured in half staff spaces from the center of the
223 (completionBusy ,boolean? "Whether a completion-note head is playing.")
224 (completionFactor ,rational-or-procedure?
225 "When @code{Completion_heads_engraver} and
226 @code{Completion_rest_engraver} need to split a note or rest with a
227 scaled duration, such as @code{c2*3}, this specifies the scale factor
228 to use for the newly-split notes and rests created by the engraver.
230 If @code{#f}, the completion engraver uses the scale-factor of
231 each duration being split.
233 If set to a callback procedure, that procedure is called with the
234 context of the completion engraver, and the duration to be split.")
235 (completionUnit ,ly:moment? "Sub-bar unit of completion.")
236 (connectArpeggios ,boolean? "If set, connect arpeggios across
238 (countPercentRepeats ,boolean? "If set, produce counters for
240 (createKeyOnClefChange ,boolean? "Print a key signature whenever
241 the clef is changed.")
242 (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
243 Should be set for staves.")
244 (crescendoSpanner ,symbol? "The type of spanner to be used for
245 crescendi. Available values are @samp{hairpin} and @samp{text}. If unset,
246 a hairpin crescendo is used.")
247 (crescendoText ,markup? "The text to print at start of non-hairpin
248 crescendo, i.e., @samp{cresc.}.")
249 (cueClefGlyph ,string? "Name of the symbol within the music font.")
250 (cueClefTransposition ,integer? "Add this much extra transposition.
251 Values of 7 and -7 are common.")
252 (cueClefTranspositionFormatter ,procedure? "A procedure that
253 takes the Transposition number as a string and the style as a symbol
254 and returns a markup.")
255 (cueClefTranspositionStyle ,symbol? "Determines the way the ClefModifier
256 grob is displayed. Possible values are @samp{default}, @samp{parenthesized}
257 and @samp{bracketed}.")
258 (cueClefPosition ,number? "Where should the center of the clef
259 symbol go, measured in half staff spaces from the center of the
261 (currentBarNumber ,integer? "Contains the current barnumber.
262 This property is incremented at every bar line.")
265 (decrescendoSpanner ,symbol? "The type of spanner to be used for
266 decrescendi. Available values are @samp{hairpin} and @samp{text}. If
267 unset, a hairpin decrescendo is used.")
268 (decrescendoText ,markup? "The text to print at start of
269 non-hairpin decrescendo, i.e., @samp{dim.}.")
270 (defaultBarType ,string? "Set the default type of bar line. See
271 @code{whichBar} for information on available bar types.
273 This variable is read by @rinternals{Timing_translator} at
274 @rinternals{Score} level.")
275 (defaultStrings ,list? "A list of strings to use in calculating
276 frets for tablatures and fretboards if no strings are provided in
277 the notes for the current moment.")
278 (doubleRepeatSegnoType ,string? "Set the default bar line for
279 the combinations double repeat with segno. Default is @samp{:|.S.|:}.")
280 (doubleRepeatType ,string? "Set the default bar line for double
282 (doubleSlurs ,boolean? "If set, two slurs are created for every
283 slurred note, one above and one below the chord.")
284 (drumPitchTable ,hash-table? "A table mapping percussion
285 instruments (symbols) to pitches.")
286 (drumStyleTable ,hash-table? "A hash table which maps drums to
287 layout settings. Predefined values: @samp{drums-style},
288 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style}, and
289 @samp{percussion-style}.
291 The layout style is a hash table, containing the drum-pitches (e.g.,
292 the symbol @samp{hihat}) as keys, and a list
293 @code{(@var{notehead-style} @var{script} @var{vertical-position})} as
296 (endRepeatSegnoType ,string? "Set the default bar line for the
297 combinations ending of repeat with segno. Default is @samp{:|.S}.")
298 (endRepeatType ,string? "Set the default bar line for the ending
300 (explicitClefVisibility ,vector? "@samp{break-visibility}
301 function for clef changes.")
302 (explicitCueClefVisibility ,vector? "@samp{break-visibility}
303 function for cue clef changes.")
304 (explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
305 function for explicit key changes. @samp{\\override} of the
306 @code{break-visibility} property will set the visibility for
307 normal (i.e., at the start of the line) key signatures.")
308 (extendersOverRests ,boolean? "Whether to continue extenders as
310 (extraNatural ,boolean? "Whether to typeset an extra natural sign
311 before accidentals that reduce the effect of a previous alteration.")
314 (figuredBassAlterationDirection ,ly:dir? "Where to put alterations
315 relative to the main figure.")
316 (figuredBassCenterContinuations ,boolean? "Whether to vertically
317 center pairs of extender lines. This does not work with three or more
319 (figuredBassFormatter ,procedure? "A routine generating a markup
321 (figuredBassPlusDirection ,ly:dir? "Where to put plus signs
322 relative to the main figure.")
323 (fingeringOrientations ,list? "A list of symbols, containing
324 @samp{left}, @samp{right}, @samp{up} and/@/or @samp{down}. This list
325 determines where fingerings are put relative to the chord being
327 (firstClef ,boolean? "If true, create a new clef when starting a
329 (followVoice ,boolean? "If set, note heads are tracked across
330 staff switches by a thin line.")
331 (fontSize ,number? "The relative size of all grobs in a context.")
332 (forbidBreak ,boolean? "If set to @code{#t}, prevent a line break
334 (forceClef ,boolean? "Show clef symbol, even if it has not
335 changed. Only active for the first clef after the property is set, not
336 for the full staff.")
337 (fretLabels ,list? "A list of strings or Scheme-formatted markups
338 containing, in the correct order, the labels to be used for lettered
339 frets in tablature.")
342 (glissandoMap ,list? "A map in the form of
343 '((source1 . target1) (source2 . target2) (sourcen . targetn))
344 showing the glissandi to be drawn for note columns.
345 The value '() will default to
346 '((0 . 0) (1 . 1) (n . n)),
347 where n is the minimal number of note-heads in
348 the two note columns between which the glissandi occur.")
349 (gridInterval ,ly:moment? "Interval for which to generate
353 (handleNegativeFrets ,symbol? "How the automatic fret calculator
354 should handle calculated negative frets. Values include @code{'ignore},
355 to leave them out of the diagram completely, @code{'include}, to include
356 them as calculated, and @code{'recalculate}, to ignore the specified
357 string and find a string where they will fit with a positive fret number.")
358 (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
360 (harmonicDots ,boolean? "If set, harmonic notes in dotted chords get
362 (highStringOne ,boolean? "Whether the first string is the string
363 with highest pitch on the instrument. This used by the automatic
364 string selector for tablature notation.")
367 (ignoreBarChecks ,boolean? "Ignore bar checks.")
368 (ignoreFiguredBassRest ,boolean? "Don't swallow rest events.")
369 (ignoreMelismata ,boolean? "Ignore melismata for this
370 @rinternals{Lyrics} line.")
371 (implicitBassFigures ,list? "A list of bass figures that are not
372 printed as numbers, but only as extender lines.")
373 (implicitTimeSignatureVisibility ,vector? "break visibility for
374 the default time signature.")
375 (includeGraceNotes ,boolean? "Do not ignore grace notes for
376 @rinternals{Lyrics}.")
377 (instrumentCueName ,markup? "The name to print if another
378 instrument is to be taken.")
379 (instrumentEqualizer ,procedure? "A function taking a
380 string (instrument name), and returning a @code{(@var{min} . @var{max})}
381 pair of numbers for the loudness range of the instrument.")
382 (instrumentName ,markup? "The name to print left of a staff. The
383 @code{instrumentName} property labels the staff in the first system, and
384 the @code{shortInstrumentName} property labels following lines.")
385 (instrumentTransposition ,ly:pitch? "Define the transposition of
386 the instrument. Its value is the pitch that sounds when the instrument
387 plays written middle C. This is used to transpose the MIDI output,
388 and @code{\\quote}s.")
389 (internalBarNumber ,integer? "Contains the current barnumber.
390 This property is used for internal timekeeping, among others by the
391 @code{Accidental_engraver}.")
394 (keepAliveInterfaces ,list? "A list of symbols, signifying grob
395 interfaces that are worth keeping a staff with @code{remove-empty} set
397 (keyAlterationOrder ,list? "An alist that defines in what order
398 alterations should be printed. The format is
399 @code{(@var{step} . @var{alter})},
400 where @var{step} is a number from 0 to@tie{}6 and
401 @var{alter} from -2 (sharp) to 2 (flat).")
402 (keyAlterations ,list? "The current key signature. This is an alist
403 containing @code{(@var{step} . @var{alter})} or
404 @code{((@var{octave} . @var{step}) . @var{alter})}, where @var{step}
405 is a number in the range 0 to@tie{}6 and @var{alter} a fraction,
406 denoting alteration. For alterations, use symbols, e.g.
407 @code{keyAlterations = #`((6 . ,FLAT))}.")
410 (lyricMelismaAlignment ,number? "Alignment to use for a melisma syllable.")
413 (majorSevenSymbol ,markup? "How should the major 7th be formatted
415 (markFormatter ,procedure? "A procedure taking as arguments the
416 context and the rehearsal mark. It should return the formatted mark as
418 (maximumFretStretch ,number? "Don't allocate frets further than
419 this from specified frets.")
420 (measureLength ,ly:moment? "Length of one measure in the current
422 (measurePosition ,ly:moment? "How much of the current measure have
423 we had. This can be set manually to create incomplete measures.")
424 (melismaBusyProperties ,list? "A list of properties (symbols) to
425 determine whether a melisma is playing. Setting this property will
426 influence how lyrics are aligned to notes. For example, if set to
427 @code{'(melismaBusy beamMelismaBusy)}, only manual melismata and
428 manual beams are considered. Possible values include
429 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
430 @code{beamMelismaBusy}.")
431 (metronomeMarkFormatter ,procedure? "How to produce a metronome
432 markup. Called with two arguments: a @code{TempoChangeEvent} and context.")
433 (middleCClefPosition ,number? "The position of the middle C,
434 as determined only by the clef. This can be calculated by looking at
435 @code{clefPosition} and @code{clefGlyph}.")
436 (middleCCuePosition ,number? "The position of the middle C,
437 as determined only by the clef of the cue notes. This can be calculated by
438 looking at @code{cueClefPosition} and @code{cueClefGlyph}.")
439 (middleCOffset ,number? "The offset of
440 middle C from the position given by @code{middleCClefPosition} This
441 is used for ottava brackets.")
442 (middleCPosition ,number? "The place of the middle C, measured in
443 half staff-spaces. Usually determined by looking at
444 @code{middleCClefPosition} and @code{middleCOffset}.")
445 (midiInstrument ,string? "Name of the MIDI instrument to use.")
446 (midiMergeUnisons ,boolean? "If true, output only one MIDI note-on
447 event when notes with the same pitch, in the same MIDI-file track, overlap.")
448 (midiMaximumVolume ,number? "Analogous to
449 @code{midiMinimumVolume}.")
450 (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
451 Ranges from 0 to@tie{}1.")
452 (midiChannelMapping ,symbol? "How to map MIDI channels: per
453 @code{staff} (default), @code{instrument} or @code{voice}.")
454 (midiBalance ,number? "Stereo balance for the MIDI channel
455 associated with the current context. Ranges from@tie{}@w{-1} to@tie{}1,
456 where the values@tie{}@w{-1} (@code{#LEFT}),@tie{}0 (@code{#CENTER})
457 and@tie{}1 (@code{#RIGHT}) correspond to leftmost emphasis, center
458 balance, and rightmost emphasis, respectively.")
459 (midiPanPosition ,number? "Pan position for the MIDI channel
460 associated with the current context. Ranges from@tie{}@w{-1} to@tie{}1,
461 where the values@tie{}@w{-1} (@code{#LEFT}),@tie{}0 (@code{#CENTER})
462 and@tie{}1 (@code{#RIGHT}) correspond to hard left, center, and hard
463 right, respectively.")
464 (midiExpression ,number? "Expression control for the MIDI
465 channel associated with the current context. Ranges from 0
466 to@tie{}1 (0=off,@tie{}1=full effect).")
467 (midiReverbLevel ,number? "Reverb effect level for the MIDI
468 channel associated with the current context. Ranges from 0
469 to@tie{}1 (0=off,@tie{}1=full effect).")
470 (midiChorusLevel ,number? "Chorus effect level for the MIDI
471 channel associated with the current context. Ranges from 0
472 to@tie{}1 (0=off,@tie{}1=full effect).")
473 (minimumFret ,number? "The tablature auto string-selecting
474 mechanism selects the highest string with a fret at least
475 @code{minimumFret}.")
476 (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a
477 page turn to be allowed.")
478 (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
479 repeated section for a page turn to be allowed within that section.")
481 (minorChordModifier ,markup? "Markup displayed following the root
484 (noChordSymbol ,markup? "Markup to be displayed for rests in a
485 ChordNames context.")
486 (noteToFretFunction ,procedure? "Convert list of notes and list of
487 defined strings to full list of strings and fret numbers.
488 Parameters: The context, a list of note events, a list of
489 tabstring events, and the fretboard grob if a fretboard is desired.")
492 (ottavation ,markup? "If set, the text for an ottava spanner.
493 Changing this creates a new text spanner.")
494 (output ,ly:music-output? "The output produced by a score-level
495 translator during music interpretation.")
498 (partCombineTextsOnNote ,boolean? "Print part-combine texts only on
499 the next note rather than immediately on rests or skips.")
500 (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
501 (pedalSostenutoStyle ,symbol? "See @code{pedalSustainStyle}.")
502 (pedalSustainStrings ,list? "A list of strings to print for
503 sustain-pedal. Format is @code{(@var{up} @var{updown} @var{down})},
504 where each of the three is the string to print when this is done with
506 (pedalSustainStyle ,symbol? "A symbol that indicates how to print
507 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
508 (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
509 (pedalUnaCordaStyle ,symbol? "See @code{pedalSustainStyle}.")
510 (predefinedDiagramTable ,hash-table? "The hash table of predefined
511 fret diagrams to use in FretBoards.")
512 (printKeyCancellation ,boolean? "Print restoration alterations
513 before a key signature change.")
514 (printOctaveNames ,boolean? "Print octave marks for the
515 @code{NoteNames} context.")
516 (printPartCombineTexts ,boolean? "Set @q{Solo} and @q{A due} texts
517 in the part combiner?")
518 (proportionalNotationDuration ,ly:moment? "Global override for
519 shortest-playing duration. This is used for switching on proportional
523 (rehearsalMark ,integer? "The last rehearsal mark printed.")
524 (repeatCommands ,list? "This property is a list of commands
525 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
526 @code{#f}. @code{'end-repeat} is also accepted as a command.")
527 (repeatCountVisibility ,procedure? "A procedure taking as
528 arguments an integer and context, returning whether the corresponding
529 percent repeat number should be printed when @code{countPercentRepeats}
531 (restCompletionBusy ,boolean? "Signal whether a completion-rest is active.")
532 (restNumberThreshold ,number? "If a multimeasure rest has more
533 measures than this, a number is printed.")
534 (restrainOpenStrings ,boolean? "Exclude open strings from the
535 automatic fret calculator.")
537 (searchForVoice ,boolean? "Signal whether a search should be made
538 of all contexts in the context hierarchy for a voice to provide rhythms
540 (segnoType ,string? "Set the default bar line for a requested segno.
541 Default is @samp{S}.")
542 (shapeNoteStyles ,vector? "Vector of symbols, listing style for
543 each note head relative to the tonic (qv.) of the scale.")
544 (shortInstrumentName ,markup? "See @code{instrumentName}.")
545 (shortVocalName ,markup? "Name of a vocal line, short version.")
546 (skipBars ,boolean? "If set to true, then skip the empty bars
547 that are produced by multimeasure notes and rests. These bars will
548 not appear on the printed output. If not set (the default),
549 multimeasure notes and rests expand into their full length, printing
550 the appropriate number of empty bars so that synchronization with other
556 \\set Score.skipBars= ##t
560 (skipTypesetting ,boolean? "If true, no typesetting is done,
561 speeding up the interpretation phase. Useful for debugging large
563 (soloIIText ,markup? "The text for the start of a solo for
564 voice @q{two} when part-combining.")
565 (soloText ,markup? "The text for the start of a solo when
567 (squashedPosition ,integer? "Vertical position of squashing for
568 @rinternals{Pitch_squash_engraver}.")
569 (staffLineLayoutFunction ,procedure? "Layout of staff lines,
570 @code{traditional}, or @code{semitone}.")
571 (magnifyStaffValue ,positive? "The most recent value set with
572 @code{\\magnifyStaff}.")
573 (stanza ,markup? "Stanza @q{number} to print before the start of a
574 verse. Use in @code{Lyrics} context.")
575 (startRepeatSegnoType ,string? "Set the default bar line for the
576 combinations beginning of repeat with segno. Default is @samp{S.|:}.")
577 (startRepeatType ,string? "Set the default bar line for the beginning
579 (stemLeftBeamCount ,integer? "Specify the number of beams to draw
580 on the left side of the next note. Overrides automatic beaming. The
581 value is only used once, and then it is erased.")
582 (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
583 (strictBeatBeaming ,boolean? "Should partial beams reflect the
584 beat structure even if it causes flags to hang out?")
585 (stringNumberOrientations ,list? "See
586 @code{fingeringOrientations}.")
587 (stringOneTopmost ,boolean? "Whether the first string is
588 printed on the top line of the tablature.")
589 (stringTunings ,list? "The tablature strings tuning. It is a list
590 of the pitches of each string (starting with the lowest numbered
592 (strokeFingerOrientations ,list? "See
593 @code{fingeringOrientations}.")
594 (subdivideBeams ,boolean? "If set, multiple beams will be
595 subdivided at @code{baseMoment} positions by only drawing one beam over the beat.")
596 (suggestAccidentals ,boolean? "If set, accidentals are typeset as
597 cautionary suggestions over the note.")
598 (systemStartDelimiter ,symbol? "Which grob to make for the start
599 of the system/@/staff? Set to @code{SystemStartBrace},
600 @code{SystemStartBracket} or @code{SystemStartBar}.")
601 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating
602 the nesting of a start delimiters.")
605 (tablatureFormat ,procedure? "A function formatting a tablature
606 note head. Called with three arguments: context, string number and,
607 fret number. It returns the text as a markup.")
608 (tabStaffLineLayoutFunction ,procedure? "A function determining the
609 staff position of a tablature note head. Called with two arguments:
610 the context and the string.")
611 (tempoHideNote ,boolean? "Hide the note = count in tempo marks.")
612 (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
614 (tieWaitForNote ,boolean? "If true, tied notes do not have to
615 follow each other directly. This can be used for writing out
617 (timeSignatureFraction ,fraction? "A pair of numbers,
618 signifying the time signature. For example, @code{'(4 . 4)} is a
619 4/4 time signature.")
620 (timeSignatureSettings ,cheap-list? "A nested alist of settings for
621 time signatures. Contains elements for various time signatures. The
622 element for each time signature contains entries for @code{baseMoment},
623 @code{beatStructure}, and @code{beamExceptions}.")
624 (timing ,boolean? "Keep administration of measure length,
625 position, bar number, etc.? Switch off for cadenzas.")
626 (tonic ,ly:pitch? "The tonic of the current scale.")
627 (topLevelAlignment ,boolean? "If true, the @var{Vertical_align_engraver}
628 will create a @var{VerticalAlignment}; otherwise, it will create a
630 (trebleStaffProperties ,list? "An alist of property settings to
631 apply for the up staff of @code{PianoStaff}. Used by
632 @code{\\autochange}.")
633 (tupletFullLength ,boolean? "If set, the tuplet is printed up to
634 the start of the next note.")
635 (tupletFullLengthNote ,boolean? "If set, end at the next note,
636 otherwise end on the matter (time signatures, etc.) before the note.")
637 (tupletSpannerDuration ,ly:moment? "Normally, a tuplet bracket is
638 as wide as the @code{\\times} expression that gave rise to it. By
639 setting this property, you can make brackets last shorter.
643 \\set tupletSpannerDuration = #(ly:make-moment 1 4)
644 \\times 2/3 @{ c8 c c c c c @}
649 (useBassFigureExtenders ,boolean? "Whether to use extender lines
650 for repeated bass figures.")
652 (vocalName ,markup? "Name of a vocal line.")
653 (voltaSpannerDuration ,ly:moment? "This specifies the maximum
654 duration to use for the brackets printed for @code{\\alternative}.
655 This can be used to shrink the length of brackets in the situation
656 where one alternative is very large.")
659 (whichBar ,string? "This property is read to determine what type
660 of bar line to create.
665 \\set Staff.whichBar = \".|:\"
669 This will create a start-repeat bar in this staff only. Valid values
670 are described in @file{scm/bar-line.scm}.")
674 (define-public all-internal-translation-properties
677 (set-object-property! (car x) 'internal-translation #t)
678 (apply translator-property-description x))
682 (associatedVoiceContext ,ly:context? "The context object of the
683 @code{Voice} that has the melody for this @code{Lyrics}.")
686 (barCheckLastFail ,ly:moment? "Where in the measure did the last
688 (beamMelismaBusy ,boolean? "Signal if a beam is present.")
689 (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
690 @var{grob})} cons cells. This is for internal (C++) use only. This
691 property contains the grobs which are still busy (e.g. note heads,
695 (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
696 current breakable (clef, key signature, etc.) items.")
697 (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
698 non-breakable items (note heads, lyrics, etc.).")
701 (dynamicAbsoluteVolumeFunction ,procedure? "A procedure that takes
702 one argument, the text value of a dynamic event, and returns the absolute
703 volume of that dynamic event.")
706 (finalizations ,list? "A list of expressions to evaluate before
707 proceeding to next time step. This is an internal variable.")
710 (graceSettings ,list? "Overrides for grace notes. This property
711 should be manipulated through the @code{add-grace-property} function.")
714 (hasAxisGroup ,boolean? "True if the current context is contained
716 (hasStaffSpacing ,boolean? "True if the current
717 @code{CommandColumn} contains items that will affect spacing.")
720 (lastChord ,markup? "Last chord, used for detecting chord changes.")
721 (lastKeyAlterations ,list? "Last key signature before a key
723 (localAlterations ,list? "The key signature at this point in the
724 measure. The format is the same as for @code{keyAlterations}, but can
725 also contain @code{((@var{octave} . @var{name}) . (@var{alter}
726 @var{barnumber} . @var{measureposition}))} pairs.")
729 (melismaBusy ,boolean? "Signifies whether a melisma is active.
730 This can be used to signal melismas on top of those automatically
734 (quotedCueEventTypes ,list? "A list of symbols, representing the
735 event types that should be duplicated for @code{\\cueDuring} commands.")
736 (quotedEventTypes ,list? "A list of symbols, representing the
737 event types that should be duplicated for @code{\\quoteDuring} commands.
738 This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
742 (rootSystem ,ly:grob? "The System object.")
745 (scriptDefinitions ,list? "The description of scripts. This is
746 used by the @code{Script_engraver} for typesetting note-superscripts
747 and subscripts. See @file{scm/@/script.scm} for more information.")
748 (slurMelismaBusy ,boolean? "Signal if a slur is present.")
749 (stavesFound ,grob-list? "A list of all staff-symbols found.")
752 (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
755 (define-public all-translation-properties
756 (append all-user-translation-properties
757 all-internal-translation-properties))
759 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
761 (define-public default-melisma-properties
762 '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy))