2 (define-public all-translation-properties '())
4 (define (translator-property-description symbol type? description)
5 (if (not (equal? #f (object-property symbol 'translation-doc)))
7 (ly:warn (string-append "Redefining " (symbol->string symbol) "\n"))
11 (set-object-property! symbol 'translation-type? type?)
12 (set-object-property! symbol 'translation-doc description)
13 (set! all-translation-properties (cons symbol all-translation-properties))
18 (translator-property-description 'extraVerticalExtent
19 number-pair? "extra vertical extent, same format as MinimumVerticalExtent")
20 (translator-property-description 'minimumVerticalExtent number-pair?
21 "minimum vertical extent, same format as VerticalExtent")
22 (translator-property-description 'verticalExtent number-pair?
23 "hard coded vertical extent.
24 The format is a pair of dimensions, for example, this sets the sizes
25 of a staff to 10 (5+5) staffspaces high.
28 property Staff.verticalExtent = #(-5.0 . 5.0)
31 VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are
32 predefined in all relevant contexts to @code{#f}, so they will not
35 Note that these VerticalExtents can only operate on vertical groups,
36 and therefore only work in contexts which contain an
37 @code{Axis_group_engraver}.
40 (translator-property-description
41 'acknowledgeHashTable vector?
42 "Internal variable: store interface to engraver smob table for current context. Don't mess with this."
45 (translator-property-description 'acceptHashTable vector? "Internal
46 variable: store table with MusicName to Engraver entries.")
47 (translator-property-description 'aDueText string? "text for begin of a due")
48 (translator-property-description 'associatedVoice string? "Name of the Voice that has the melody for this LyricsVoice.")
49 (translator-property-description 'autoBeamSettings list? "
50 Specifies when automatically generated beams should begin and end. The elements have the format:
54 function shortest-duration-in-beam time-signature
58 function = begin or end
59 shortest-duration-in-beam = numerator denominator; eg: 1 16
60 time-signature = numerator denominator, eg: 4 4
62 unspecified or wildcard entries for duration or time-signature
65 The user can override beam begin or end time by pushing a wildcard entries
66 '(begin * * * *) or '(end * * * *) resp., eg:
68 property Voice.autoBeamSettings push #'(end * * * *) = #(ly:make-moment 1 4)
72 ((end * * 3 2) . ,(ly:make-moment 1 2))
73 ((end 1 16 3 2) . ,(ly:make-moment 1 4))
74 ((end 1 32 3 2) . ,(ly:make-moment 1 8))
80 (translator-property-description 'autoAccidentals list? "List of
81 different ways to typeset an accidental. All algorithms in the list
82 are tried, and the one returning the most accidentals is used.
83 Each entry is either a symbol containg a context name or a name-value
84 pair containing an algorithm-description.
85 The list must begin with a symbol (context name).
86 The symbols denote in which context THE FOLLOWING algorithms (until next symbol)
87 will be interpreted. All notes in the interpretation context will share accidentals.
88 The contexts must be stated in order, innermost first.
92 This is the default algorithm. Accidentals are typeset if the note changes
93 the accidental of that note in that octave. Accidentals lasts to the end of the measure
94 and then as many measures as specified in the value. I.e. 1 means to the end
95 of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.
97 Accidentals are typeset if the note is different from
98 the previous note on the same pitch in any octave. The value has same meaning as in
103 (translator-property-description 'autoCautionaries list? "List similar to
104 autoAccidentals, but it controls cautionary accidentals rather than
105 normal ones. Both lists are tried, and the one giving the most accidentals
106 wins. In case of draw, a normal accidental is typeset.
109 (translator-property-description 'automaticPhrasing boolean? " If set,
110 the @ref{Lyric_phrasing_engraver} will match note heads of context
111 called Voice X to syllables from LyricsVoice called
112 X-<something>. This feature is turned on by default. See the example
113 file @file{lyrics-multi-stanza.ly}.
116 (translator-property-description 'automaticMelismata boolean? " If
117 set, \\addlyrics will assume that beams, slurs and ties signal
118 melismata, and align lyrics accordingly.
121 (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
123 (translator-property-description 'barCheckSynchronize boolean? "If
124 true then reset measurePosition when finding a barcheck. Turn off when
125 using barchecks in polyphonic music.")
126 (translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
127 automatically; they must be explicitly created with @code{bar}
128 keywords. Unlike with the @code{cadenza} keyword, measures are
129 still counted. Bar generation will resume according to that
130 count if this property is set to zero.
132 (translator-property-description 'barNumberVisibility procedure? "Procedure that takes an int and returns whether the corresponding bar number should be printed")
133 (translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
134 (translator-property-description 'beatLength ly:moment? "The length of one beat in this time signature.")
135 (translator-property-description 'breakAlignOrder list? "Defines the order in which
136 prefatory matter (clefs, key signatures) appears, eg. this puts the
137 key signatures after the bar lines:
140 \\property Score.breakAlignOrder = #'(
150 (translator-property-description 'busyGrobs list? "
151 a queue of (END-MOMENT . GROB) conses. This is for internal (C++) use only.
152 Use at your own risk. This property contains the grobs for which END-MOMENT >= NOW.
154 (translator-property-description 'centralCPosition number? "Place of the central C. Usually determined by looking at clefPosition and clefGlyph.")
155 (translator-property-description
156 'changeMoment moment-pair?
157 "duration that voices are examined for differences, when
158 part-combining. Usually unset or zero when combining threads into one
159 voice, and 1 (or the duration of one measure) when combining voices
162 (translator-property-description 'chordChanges boolean? "Only show changes in chords scheme?")
163 (translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
164 (translator-property-description 'clefOctavation integer? "Add
165 this much extra octavation. Values of 7 and -7 are common.")
166 (translator-property-description 'clefPosition number? "Where should the center of the symbol go?")
167 (translator-property-description 'combineParts boolean? "try to combine parts?")
168 (translator-property-description 'connectArpeggios boolean? " If
169 set, connect all arpeggios that are found. In this way, you can make
170 arpeggios that cross staves.
172 (translator-property-description 'createKeyOnClefChange boolean? "Print a key signature whenever the clef is changed.")
173 (translator-property-description 'crescendoText markup? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}")
174 (translator-property-description 'crescendoSpanner symbol? "Type of spanner to be used for crescendi. One of: @samp{hairpin}, @samp{line}, @samp{dashed-line}, @samp{dotted-line}. If unset, hairpin type is used.")
175 (translator-property-description 'decrescendoText markup? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}")
176 (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
179 (translator-property-description 'currentCommandColumn ly:grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
180 (translator-property-description 'currentMusicalColumn ly:grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
181 (translator-property-description 'defaultBarType string? "Sets the default type of bar line. Available bar types: [FIXME];
183 This variable is typically read at Score level, so overriding
184 Staff.defaultBarType will have no effect.
187 (translator-property-description 'devNullThread symbol? "User control of Thread_devnull_engraver: one of
190 Behave in normal way: remove one set of grobs when in unisolo.
192 Remove any grob that comes along.
197 (translator-property-description 'devNullVoice symbol? "User control of Voice_devnull_engraver: one of
200 Behave in normal way: remove spanners when in unisolo.
202 Remove any spanners that come along.
207 (translator-property-description 'decrescendoSpanner symbol? "Type of spanner to be used for decrescendi. One of: @samp{hairpin}, @samp{line}, @samp{dashed-line}, @samp{dotted-line}. If unset, hairpin type is used.")
209 (translator-property-description 'dynamicAbsoluteVolumeFunction procedure? "
212 (translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
216 (translator-property-description 'explicitKeySignatureVisibility
217 procedure? "visibility-lambda function for explicit Key changes;
218 \override of #'break-visibility will set the visibility for normal
219 (ie. at the start of the line) key signatures.")
221 (translator-property-description 'extraNatural boolean? "Whether to typeset an
222 extra natural sign before accidentals changing from a non-natural to
226 (translator-property-description 'finalizations list? "List of expressions to evaluate before proceeding to next time step. Internal variable.")
227 (translator-property-description 'followVoice boolean?
228 "if set, note heads are tracked across staff switches by a thin line")
229 (translator-property-description 'fontSize integer?
230 "Used to set the relative size of all grobs
231 in a context. This is done using the @code{Font_size_engraver}.")
233 (translator-property-description 'forceClef boolean? "Show clef symbol, even if it hasn't changed. Only active for the first clef after the property is set, not for the full staff.")
234 (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
235 (translator-property-description 'graceAlignPosition ly:dir? "put the grace note before or after the main note?")
236 (translator-property-description 'highStringOne boolean? "Whether the 1st string is the string with
237 highest pitch on the instrument (used by the automatic string selector).")
238 (translator-property-description 'instr markup? "see @code{instrument}")
239 (translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
240 @cindex Instrument_name_engraver
242 added to the Staff translator, then the @code{instrument} property
243 is used to label the first line of the staff and the @code{instr}
244 property is used to label subsequent lines. If the
245 @code{midiInstrument} property is not set, then @code{instrument}
246 is used to determine the instrument for MIDI output.")
248 (translator-property-description 'instrumentEqualizer procedure? "[DOCUMENT-ME]")
249 (translator-property-description 'instrumentSupport list? "
250 list of grobs to attach instrument name to.
252 (translator-property-description 'keyAccidentalOrder list? "
253 Alist that defines in what order alterations should be printed.
254 The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from -1, 1.
256 (translator-property-description 'keySignature list? "The current key signature. This is an alist containing (NAME . ALTER) or ((OCTAVE . NAME) . ALTER) or ((OCTAVE . NAME) . (ALTER . BARNUMBER)) pairs, where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2. The optional barnumber contains the number of the measure of the accidental. FIXME: describe broken tie entries.")
258 (translator-property-description 'lastKeySignature list? "Last key
259 signature before a key signature change.")
261 (translator-property-description 'localKeySignature list? "the key
262 signature at this point in the measure. The format is the same as for keySignature. Is reset at every bar line."
264 (translator-property-description 'localKeySignatureChanges list? "Experimental.
266 (translator-property-description 'measureLength ly:moment? "Length of one
267 measure in the current time signature last?")
268 (translator-property-description 'measurePosition ly:moment? " How much
269 of the current measure (measured in whole notes) have we had. This
270 can be set manually to create incomplete measures (anacrusis, upbeat),
271 the start of the music.
273 (translator-property-description 'melismaBusy boolean? "Signifies
274 whether a melisma is active. This can be used to signal melismas on
275 top of those automatically detected. ")
276 (translator-property-description 'melismaEngraverBusy boolean? "See melismaBusy. This is set automatically.")
277 (translator-property-description 'midiInstrument string? "Name of the
278 MIDI instrument to use ")
279 (translator-property-description 'midiMinimumVolume number? "[DOCUMENT-ME]")
280 (translator-property-description 'midiMaximumVolume number? "[DOCUMENT-ME]")
281 (translator-property-description 'minimumFret number? "The tablature
282 auto string-selecting mechanism selects the highest string with a fret
283 not less than minimumFret")
284 (translator-property-description 'autoBeaming boolean? "If set to true
285 then beams are generated automatically.")
286 (translator-property-description 'noDirection boolean? "Don't set directions by a2-engraver when part-combining.")
287 (translator-property-description 'oneBeat ly:moment? " How long does one beat in the current time signature last?")
288 (translator-property-description 'othersolo boolean? "FIXME")
289 (translator-property-description 'pedalSustainStrings list? "List of string to print for sustain-pedal. Format is
290 (UP UPDOWN DOWN), where each of the three is the string to print when
291 this is done with the pedal.")
292 (translator-property-description 'pedalUnaCordaStrings list? "see pedalSustainStrings.")
293 (translator-property-description 'pedalSostenutoStrings list? "see pedalSustainStrings.")
295 (translator-property-description 'phrasingPunctuation string? "")
296 (translator-property-description 'rehearsalMark number-or-string? "")
297 (translator-property-description 'regularSpacingDelta ly:moment? "TODO")
298 (translator-property-description 'repeatCommands list? "This property is read to find any command of the form (volta . X), where X is a string or #f")
299 (translator-property-description 'scriptDefinitions list? "
300 Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
303 (translator-property-description 'scriptHorizontal boolean? " Put
304 scripts left or right of note heads. Support for this is limited.
305 Accidentals will collide with scripts.
308 (translator-property-description 'skipBars boolean? " Set to true to
309 skip the empty bars that are produced by multimeasure notes and rests.
310 These bars will not appear on the printed output. If not set (the
311 default) multimeasure notes and rests expand into their full length,
312 printing the appropriate number of empty bars so that synchronization
313 with other voices is preserved.
317 @@lilypond[fragment,verbatim,center]
318 r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
324 (translator-property-description 'skipTypesetting boolean?
325 "When true, all no typesetting is done at
326 this moment, causing the interpretation phase to go a lot faster. This can
327 help with debugging large scores.")
328 (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.")
329 (translator-property-description 'solo boolean? "set if solo is detected by the part combiner.")
330 (translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?.")
331 (translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining.")
332 (translator-property-description 'soloText string? "text for begin of solo when part-combining.")
333 (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
334 (translator-property-description 'splitInterval number-pair? "part-combiner will separate its two voices (or threads) when interval between the two voices is contained in this range.")
335 (translator-property-description 'split-interval boolean? "set if part-combiner separated voices based on splitInterval.")
336 (translator-property-description 'squashedPosition integer? " Vertical position of
337 squashing for Pitch_squash_engraver.")
338 (translator-property-description 'stringOneTopmost boolean? "Whether the 1st string is printed on the
339 top line of the tablature.")
340 (translator-property-description 'stavesFound list? "list of all staff-symbols found.")
341 (translator-property-description 'stanza markup? "Stanza `number' to print at start of a verse. Use in LyricsVoice context.")
344 (translator-property-description 'stemLeftBeamCount integer? "
345 Specify the number of beams to draw on the left side of the next note.
346 Overrides automatic beaming. The value is only used once, and then it
349 (translator-property-description 'stemRightBeamCount integer? "idem, for the right side.")
351 (translator-property-description 'stz markup? "Abbreviated form for a stanza, see also Stanza property.")
352 (translator-property-description 'subdivideBeams boolean? "If set, multiple beams will be subdivided at beat
353 positions - by only drawing one beam over the beat.")
354 (translator-property-description 'systemStartDelimiter symbol? "Which grob to make for the start of the system/staff?")
355 (translator-property-description 'tablatureFormat procedure?
356 "Function formatting a tab notehead; it takes
357 a string number, a list of string tunings and Pitch object. It returns the text as a string.")
359 (translator-property-description 'textNonEmpty boolean? " If set
360 to true then text placed above or below the staff is not assumed to
361 have zero width. @code{\fatText} and @code{\emptyText} are predefined
364 (translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set.")
365 (translator-property-description 'timeSignatureFraction number-pair? "
366 pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
367 (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
368 Switch off for cadenzas.")
369 (translator-property-description 'transposing integer? "Transpose the MIDI output. Set this property to the number of half-steps to transpose by.")
370 (translator-property-description 'tremoloFlags integer? "Number of tremolo flags to add if none is specified.")
371 (translator-property-description 'tupletNumberFormatFunction procedure?
372 "Function taking a music as input, producing a string. This function is called to determine the text to print on a tuplet bracket.")
374 (translator-property-description 'tupletInvisible boolean? "
375 If set to true, tuplet bracket creation is switched off
376 entirely. This has the same effect as setting both
377 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
378 @code{#f}, but as this does not even create any grobs, this setting
379 uses less memory and time.")
380 (translator-property-description 'tupletSpannerDuration ly:moment? "
381 Normally a tuplet bracket is as wide as the
382 @code{ imes} expression that gave rise to it. By setting this
383 property, you can make brackets last shorter. Example
386 @@lilypond[verbatim,fragment]
387 context Voice imes 2/3 @{
388 property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
394 (translator-property-description 'unirhythm boolean? "set if unirhythm is detected by the part combiner.")
395 (translator-property-description 'unisilence boolean? "set if unisilence is detected by the part combiner.")
396 (translator-property-description 'unison boolean? "set if unisono is detected by the part combiner. .")
397 (translator-property-description 'verticalAlignmentChildCallback
398 procedure? "what callback to add to children of a vertical alignment.
399 It determines what alignment procedure is used on the alignment
401 (translator-property-description
402 'voltaOnThisStaff boolean?
403 "Normally, volta brackets are put only on the topmost staff. Setting this variable to true, will force a bracket to be on this staff as well.")
404 (translator-property-description 'voltaSpannerDuration ly:moment? "maximum duration of the volta bracket.
406 Set to a duration to control the size of the brackets printed by
407 @code{\\alternative}. It specifies the number of whole notes duration
408 to use for the brackets. This can be used to shrink the length of
409 brackets in the situation where one alternative is very large. It may
410 have odd effects if the specified duration is longer than the music
411 given in an @code{\\alternative}.
413 (translator-property-description 'whichBar string?
414 "This property is read to determine what type of barline to create.
418 \\property Staff.whichBar = \"|:\"
421 This will create a start-repeat bar in this staff only.
423 If not set explicitly (by property or @code{\bar}), this is set
424 according to values of @code{defaultBarType}, @code{barAlways},
425 @code{barNonAuto} and @code{measurePosition}.
427 Valid values are described in @ref{(lilypond-internals)bar-line-interface}.
430 (translator-property-description 'stringTunings list? "The tablature strings tuning. Must be a list of the different semitons pitch of each string (starting by the lower one).")