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