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