2 (define 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 'Generic_property_list list? "description of the conversion.
22 Defines names and types for generic properties. These are properties
23 than can be plugged into the backend directly. See the init file
24 @file{generic-property.scm} for details. For internal use only,
27 (translator-property-description 'MinimumVerticalExtent number-pair?
28 "minimum vertical extent, same format as VerticalExtent")
29 (translator-property-description 'VerticalExtent number-pair?
30 "hard coded vertical extent.
31 The format is a pair of dimensions, for example, this sets the sizes
32 of a staff to 10 (5+5) staffspaces high.
35 property Staff.VerticalExtent = #(-5.0 . 5.0)
38 VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are
39 predefined in all relevant contexts to @code{#f}, so they will not
42 Note that these VerticalExtents can only operate on vertical groups,
43 and therefore only work in contexts which contain an
44 @code{Axis_group_engraver}.
48 (translator-property-description 'aDueText string? "text for begin of a due")
49 (translator-property-description 'associatedVoice string? "Name of the Voice that has the melody for this LyricsVoice.")
50 (translator-property-description 'autoBeamSettings list? "
51 Specifies when automatically generated beams should begin and end. The elements have the format:
55 function shortest-duration-in-beam time-signature
59 function = begin or end
60 shortest-duration-in-beam = numerator denominator; eg: 1 16
61 time-signature = numerator denominator, eg: 4 4
63 unspecified or wildcard entries for duration or time-signature
66 The user can override beam begin or end time by pushing a wildcard entries
67 '(begin * * * *) or '(end * * * *) resp., eg:
69 property Voice.autoBeamSettings push #'(end * * * *) = #(make-moment 1 4)
73 ((end * * 3 2) . ,(make-moment 1 2))
74 ((end 1 16 3 2) . ,(make-moment 1 4))
75 ((end 1 32 3 2) . ,(make-moment 1 8))
81 (translator-property-description 'autoAccidentals list? "List of
82 different ways to typeset an accidental. All algorithms in the list
83 are tried, and the one returning the most accidentals is used.
86 @item same-octave: This is the default algorithm. Accidentals are
87 typeset if the note changes the accidental of that note in that octave.
88 @item any-octave: Accidentals are typeset if the note is different from
89 the previous note on the same pitch in any octave.
90 @item lazy-same-octave: Shows accidentals as if the key signature does
91 not get reset at every barline. This means that an alteration lasts until it is
92 changed - perhaps many measures later. See oneMeasureLazy, though.
93 @item lazy-any-octave: Yeah, you probably guessed that one.
97 (translator-property-description 'autoCautionaries list? "List similar to
98 autoAccidentals, but it controls cautionary accidentals rather than
99 normal ones. Both lists are tried, and the one giving the most accidentals
100 wins. In case of draw, a normal accidental is typeset.
103 (translator-property-description 'automaticPhrasing boolean? " If set,
104 the @ref{Lyric_phrasing_engraver} will match note heads of context
105 called Voice X to syllables from LyricsVoice called
106 X-<something>. This feature is turned on by default. See the example
107 file @file{lyrics-multi-stanza.ly}.
110 (translator-property-description 'automaticMelismata boolean? " If
111 set, \addlyrics will assume that beams, slurs and ties signal
112 melismata, and align lyrics accordingly.
115 (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
117 (translator-property-description 'barCheckNoSynchronize boolean? "If set, don't reset measurePosition when finding a bbarcheck. This
118 makes bar-checks for polyphonic music easier.")
119 (translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
120 automatically; they must be explicitly created with @code{bar}
121 keywords. Unlike with the @code{cadenza} keyword, measures are
122 still counted. Bar generation will resume according to that
123 count if this property is set to zero.
125 (translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
126 (translator-property-description 'beatLength moment? "The length of one beat in this time signature.")
127 (translator-property-description 'breakAlignOrder list? "Defines the order in which
128 prefatory matter (clefs, key signatures) appears, eg. this puts the
129 key signatures after the bar lines:
132 \\property Score.breakAlignOrder = #'(
142 (translator-property-description 'centralCPosition number? "Place of the central C. Usually determined by looking at clefPosition and clefGlyph.")
143 (translator-property-description 'changeMoment moment-pair? "duration that voices are examined for differences, when part-combining. Usually unset or zero when combining threads into one voice, and 1 (or the duration of one measure) when combining voices into one staff.")
144 (translator-property-description 'chordChanges boolean? "Only show changes in chords scheme?")
145 (translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
146 (translator-property-description 'clefOctavation integer? "Add
147 this much extra octavation. Values of 7 and -7 are common.")
148 (translator-property-description 'clefPosition number? "Where should the center of the symbol go?")
149 (translator-property-description 'combineParts boolean? "try to combine parts?")
150 (translator-property-description 'connectArpeggios boolean? " If
151 set, connect all arpeggios that are found. In this way, you can make
152 arpeggios that cross staves.
154 (translator-property-description 'createKeyOnClefChange boolean? "Print a key signature whenever the clef is changed.")
155 (translator-property-description 'crescendoText markup? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}")
156 (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.")
157 (translator-property-description 'decrescendoText markup? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}")
158 (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
161 (translator-property-description 'currentCommandColumn ly-grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
162 (translator-property-description 'currentMusicalColumn ly-grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
163 (translator-property-description 'defaultBarType string? "Sets the default type of bar line. Available bar types: [FIXME];
165 This variable is typically read at Score level, so overriding
166 Staff.defaultBarType will have no effect.
169 (translator-property-description 'devNullThread symbol? "User control of Thread_devnull_engraver: one of
172 Behave in normal way: remove one set of grobs when in unisolo.
174 Remove any grob that comes along.
179 (translator-property-description 'devNullVoice symbol? "User control of Voice_devnull_engraver: one of
182 Behave in normal way: remove spanners when in unisolo.
184 Remove any spanners that come along.
189 (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.")
191 (translator-property-description 'easyPlay boolean? "Copy note names into note head grob property")
193 (translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
195 (translator-property-description 'explicitKeySignatureVisibility
196 procedure? "visibility-lambda function for explicit Key changes;
197 \override of #'visibility-lambda will set the visibility for normal
198 (ie. at the start of the line) key signatures.")
200 (translator-property-description 'extraNatural boolean? "Whether to typeset an
201 extra natural sign before accidentals changing from a non-natural to
204 (translator-property-description 'followVoice boolean?
205 "if set, note heads are tracked across staff switches by a thin line")
206 (translator-property-description 'fontSize integer?
207 "Used to set the relative size of all grobs
208 in a context. This is done using the @code{Font_size_engraver}.")
210 (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.")
211 (translator-property-description 'forgetAccidentals boolean? "do
212 not set localKeySignature when a note alterated differently from
213 localKeySignature is found.
215 Causes accidentals to be printed at every note instead of
216 remembered for the duration of a measure.
218 (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
219 (translator-property-description 'graceAlignPosition dir? "put the grace note before or after the main note?")
220 (translator-property-description 'instr markup? "see @code{instrument}")
221 (translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
222 @cindex Instrument_name_engraver
224 added to the Staff translator, then the @code{instrument} property
225 is used to label the first line of the staff and the @code{instr}
226 property is used to label subsequent lines. If the
227 @code{midiInstrument} property is not set, then @code{instrument}
228 is used to determine the instrument for MIDI output.")
230 (translator-property-description 'instrumentEqualizer procedure? "[DOCUMENT-ME]")
232 (translator-property-description 'keyAccidentalOrder list? "
233 Alist that defines in what order alterations should be printed.
234 The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from -1, 1.
236 (translator-property-description 'keySignature list? "The current key signature. This is an alist containing (NAME . ALTER) or ((OCTAVE . NAME) . ALTER) pairs, where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2 ")
238 (translator-property-description 'lastKeySignature list? "Last key
239 signature before a key signature change.")
241 (translator-property-description 'lazyKeySignature list? "a lazy version of
242 localKeySignature, only being reset according to oneMeasureLazy."
244 (translator-property-description 'localKeySignature list? "the key
245 signature at this point in the measure. The format is the same as for keySignature. Is reset at every bar line."
248 (translator-property-description 'measureLength moment? "Length of one
249 measure in the current time signature last?")
250 (translator-property-description 'measurePosition moment? " How much
251 of the current measure (measured in whole notes) have we had. This
252 can be set manually to create incomplete measures (anacrusis, upbeat),
253 the start of the music.
255 (translator-property-description 'melismaBusy boolean? "Signifies
256 whether a melisma is active. This can be used to signal melismas on
257 top of those automatically detected. ")
258 (translator-property-description 'melismaEngraverBusy boolean? "See @ref{(lilypond)melismaBusy}. This is set automatically.")
259 (translator-property-description 'midiInstrument string? "Name of the
260 MIDI instrument to use ")
261 (translator-property-description 'noAutoBeaming boolean? "If set to true then beams are not generated automatically.
263 (translator-property-description 'noDirection boolean? "Don't set directions by a2-engraver when part-combining.")
264 (translator-property-description 'oneBeat moment? " How long does one beat in the current time signature last?")
265 (translator-property-description 'oneMeasureLazy boolean? "If false, the lazy
266 time-signature is never reset, causing lazy accidentals (see
267 autoAccidentals) to last until the next key change. If true, the lazy
268 key signature only last one measure longer than the normal one - accidentals
269 being reset at the end of the measure after the one in which they occur.
271 (translator-property-description 'pedalSustainStrings list? "List of string to print for sustain-pedal. Format is
272 (UP UPDOWN DOWN), where each of the three is the string to print when
273 this is done with the pedal.")
274 (translator-property-description 'pedalUnaCordaStrings string? "see pedalSustainStrings.")
275 (translator-property-description 'pedalSostenutoStrings string? "see pedalSustainStrings.")
277 (translator-property-description 'phrasingPunctuation string? "")
278 (translator-property-description 'rehearsalMark number-or-string? "")
279 (translator-property-description 'regularSpacingDelta moment? "TODO")
280 (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")
281 (translator-property-description 'scriptDefinitions list? "
282 Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
285 (translator-property-description 'scriptHorizontal boolean? " Put
286 scripts left or right of note heads. Support for this is limited.
287 Accidentals will collide with scripts.
290 (translator-property-description 'skipBars boolean? " Set to true to
291 skip the empty bars that are produced by multimeasure notes and rests.
292 These bars will not appear on the printed output. If not set (the
293 default) multimeasure notes and rests expand into their full length,
294 printing the appropriate number of empty bars so that synchronization
295 with other voices is preserved.
299 @@lilypond[fragment,verbatim,center]
300 r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
306 (translator-property-description 'skipTypesetting boolean?
307 "When true, all no typesetting is done at
308 this moment, causing the interpretation phase to go a lot faster. This can
309 help with debugging large scores.")
311 (translator-property-description 'slurBeginAttachment symbol?
312 "translates to the car of grob-property 'attachment of NoteColumn. See
315 (translator-property-description 'slurEndAttachment symbol? "translates to the cdr of grob-property 'attachment of NoteColumn. See @ref{Slur}.")
316 (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.")
317 (translator-property-description 'solo boolean? "set if solo is detected by the part combiner.")
318 (translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?.")
319 (translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining.")
320 (translator-property-description 'soloText string? "text for begin of solo when part-combining.")
321 (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
322 (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.")
323 (translator-property-description 'split-interval boolean? "set if part-combiner separated voices based on splitInterval.")
324 (translator-property-description 'squashedPosition integer? " Vertical position of
325 squashing for Pitch_squash_engraver.")
326 (translator-property-description 'stavesFound list? "list of all staff-symbols found.")
327 (translator-property-description 'stanza string? "Stanza `number' to print at start of a verse. Use in LyricsVoice context.")
330 (translator-property-description 'stemLeftBeamCount integer? "
331 Specify the number of beams to draw on the left side of the next note.
332 Overrides automatic beaming. The value is only used once, and then it
335 (translator-property-description 'stemRightBeamCount integer? "idem, for the right side.")
336 (translator-property-description 'stz string? "Abbreviated form for a stanza, see also Stanza property.")
337 (translator-property-description 'subdivideBeams boolean? "If set, multiple beams will be subdivided at beat
338 positions - by only drawing one beam over the beat.")
339 (translator-property-description 'textNonEmpty boolean? " If set
340 to true then text placed above or below the staff is not assumed to
341 have zero width. @code{\fatText} and @code{\emptyText} are predefined
344 (translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set.")
345 (translator-property-description 'timeSignatureFraction number-pair? "
346 pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
347 (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
348 Switch off for cadenzas.")
349 (translator-property-description 'transposing integer? "Transpose the MIDI output. Set this property to the number of half-steps to transpose by.")
350 (translator-property-description 'tremoloFlags integer? "Number of tremolo flags to add if none is specified.")
351 (translator-property-description 'tupletNumberFormatFunction procedure?
352 "Function taking a music as input, producing a string. This function is called to determine the text to print on a tuplet bracket.")
354 (translator-property-description 'tupletInvisible boolean? "
355 If set to true, tuplet bracket creation is switched off
356 entirely. This has the same effect as setting both
357 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
358 @code{#f}, but as this does not even create any grobs, this setting
359 uses less memory and time.")
360 (translator-property-description 'tupletSpannerDuration moment? "
361 Normally a tuplet bracket is as wide as the
362 @code{ imes} expression that gave rise to it. By setting this
363 property, you can make brackets last shorter. Example
366 @@lilypond[verbatim,fragment]
367 context Voice imes 2/3 @{
368 property Voice.tupletSpannerDuration = #(make-moment 1 4)
374 (translator-property-description 'unirhythm boolean? "set if unirhythm is detected by the part combiner.")
375 (translator-property-description 'unisilence boolean? "set if unisilence is detected by the part combiner.")
376 (translator-property-description 'unison boolean? "set if unisono is detected by the part combiner. .")
377 (translator-property-description 'verticalAlignmentChildCallback
378 procedure? "what callback to add to children of a vertical alignment.
379 It determines what alignment procedure is used on the alignment
381 (translator-property-description 'voltaSpannerDuration moment? "maximum duration of the volta bracket.
383 Set to a duration to control the size of the brackets printed by
384 @code{\\alternative}. It specifies the number of whole notes duration
385 to use for the brackets. This can be used to shrink the length of
386 brackets in the situation where one alternative is very large. It may
387 have odd effects if the specified duration is longer than the music
388 given in an @code{\\alternative}.
390 (translator-property-description 'weAreGraceContext boolean? ".")
391 (translator-property-description 'whichBar string?
392 "This property is read to determine what type of barline to create.
396 \\property Staff.whichBar = \"|:\"
399 This will create a start-repeat bar in this staff only.
401 If not set explicitly (by property or @code{\bar}), this is set
402 according to values of @code{defaultBarType}, @code{barAlways},
403 @code{barNonAuto} and @code{measurePosition}.
405 Valid values are described in @ref{(lilypond-internals)bar-line-interface}.