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}.
47 (translator-property-description
48 'acknowledgeHashTable vector?
49 "Internal variable: store interface to engraver smob table for current context. Don't mess with this."
52 (translator-property-description 'aDueText string? "text for begin of a due")
53 (translator-property-description 'associatedVoice string? "Name of the Voice that has the melody for this LyricsVoice.")
54 (translator-property-description 'autoBeamSettings list? "
55 Specifies when automatically generated beams should begin and end. The elements have the format:
59 function shortest-duration-in-beam time-signature
63 function = begin or end
64 shortest-duration-in-beam = numerator denominator; eg: 1 16
65 time-signature = numerator denominator, eg: 4 4
67 unspecified or wildcard entries for duration or time-signature
70 The user can override beam begin or end time by pushing a wildcard entries
71 '(begin * * * *) or '(end * * * *) resp., eg:
73 property Voice.autoBeamSettings push #'(end * * * *) = #(make-moment 1 4)
77 ((end * * 3 2) . ,(make-moment 1 2))
78 ((end 1 16 3 2) . ,(make-moment 1 4))
79 ((end 1 32 3 2) . ,(make-moment 1 8))
85 (translator-property-description 'autoAccidentals list? "List of
86 different ways to typeset an accidental. All algorithms in the list
87 are tried, and the one returning the most accidentals is used.
88 Each entry is either a symbol containg a context name or a name-value
89 pair containing an algorithm-description.
90 The list must begin with a symbol (context name).
91 The symbols denote in which context THE FOLLOWING algorithms (until next symbol)
92 will be interpreted. All notes in the interpretation context will share accidentals.
93 The contexts must be stated in order, innermost first.
97 This is the default algorithm. Accidentals are typeset if the note changes
98 the accidental of that note in that octave. Accidentals lasts to the end of the measure
99 and then as many measures as specified in the value. I.e. 1 means to the end
100 of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.
102 Accidentals are typeset if the note is different from
103 the previous note on the same pitch in any octave. The value has same meaning as in
108 (translator-property-description 'autoCautionaries list? "List similar to
109 autoAccidentals, but it controls cautionary accidentals rather than
110 normal ones. Both lists are tried, and the one giving the most accidentals
111 wins. In case of draw, a normal accidental is typeset.
114 (translator-property-description 'automaticPhrasing boolean? " If set,
115 the @ref{Lyric_phrasing_engraver} will match note heads of context
116 called Voice X to syllables from LyricsVoice called
117 X-<something>. This feature is turned on by default. See the example
118 file @file{lyrics-multi-stanza.ly}.
121 (translator-property-description 'automaticMelismata boolean? " If
122 set, \addlyrics will assume that beams, slurs and ties signal
123 melismata, and align lyrics accordingly.
126 (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
128 (translator-property-description 'barCheckNoSynchronize boolean? "If set, don't reset measurePosition when finding a bbarcheck. This
129 makes bar-checks for polyphonic music easier.")
130 (translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
131 automatically; they must be explicitly created with @code{bar}
132 keywords. Unlike with the @code{cadenza} keyword, measures are
133 still counted. Bar generation will resume according to that
134 count if this property is set to zero.
136 (translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
137 (translator-property-description 'beatLength moment? "The length of one beat in this time signature.")
138 (translator-property-description 'breakAlignOrder list? "Defines the order in which
139 prefatory matter (clefs, key signatures) appears, eg. this puts the
140 key signatures after the bar lines:
143 \\property Score.breakAlignOrder = #'(
153 (translator-property-description 'busyGrobs list? "
154 a queue of (END-MOMENT . GROB) conses. This is for internal (C++) use only.
155 Use at your own risk.
157 (translator-property-description 'centralCPosition number? "Place of the central C. Usually determined by looking at clefPosition and clefGlyph.")
158 (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.")
159 (translator-property-description 'chordChanges boolean? "Only show changes in chords scheme?")
160 (translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
161 (translator-property-description 'clefOctavation integer? "Add
162 this much extra octavation. Values of 7 and -7 are common.")
163 (translator-property-description 'clefPosition number? "Where should the center of the symbol go?")
164 (translator-property-description 'combineParts boolean? "try to combine parts?")
165 (translator-property-description 'connectArpeggios boolean? " If
166 set, connect all arpeggios that are found. In this way, you can make
167 arpeggios that cross staves.
169 (translator-property-description 'createKeyOnClefChange boolean? "Print a key signature whenever the clef is changed.")
170 (translator-property-description 'crescendoText markup? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}")
171 (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.")
172 (translator-property-description 'decrescendoText markup? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}")
173 (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
176 (translator-property-description 'currentCommandColumn ly-grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
177 (translator-property-description 'currentMusicalColumn ly-grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
178 (translator-property-description 'defaultBarType string? "Sets the default type of bar line. Available bar types: [FIXME];
180 This variable is typically read at Score level, so overriding
181 Staff.defaultBarType will have no effect.
184 (translator-property-description 'devNullThread symbol? "User control of Thread_devnull_engraver: one of
187 Behave in normal way: remove one set of grobs when in unisolo.
189 Remove any grob that comes along.
194 (translator-property-description 'devNullVoice symbol? "User control of Voice_devnull_engraver: one of
197 Behave in normal way: remove spanners when in unisolo.
199 Remove any spanners that come along.
204 (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.")
206 (translator-property-description 'dynamicAbsoluteVolumeFunction procedure? "
209 (translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
213 (translator-property-description 'explicitKeySignatureVisibility
214 procedure? "visibility-lambda function for explicit Key changes;
215 \override of #'visibility-lambda will set the visibility for normal
216 (ie. at the start of the line) key signatures.")
218 (translator-property-description 'extraNatural boolean? "Whether to typeset an
219 extra natural sign before accidentals changing from a non-natural to
222 (translator-property-description 'followVoice boolean?
223 "if set, note heads are tracked across staff switches by a thin line")
224 (translator-property-description 'fontSize integer?
225 "Used to set the relative size of all grobs
226 in a context. This is done using the @code{Font_size_engraver}.")
228 (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.")
229 (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
230 (translator-property-description 'graceAlignPosition dir? "put the grace note before or after the main note?")
231 (translator-property-description 'instr markup? "see @code{instrument}")
232 (translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
233 @cindex Instrument_name_engraver
235 added to the Staff translator, then the @code{instrument} property
236 is used to label the first line of the staff and the @code{instr}
237 property is used to label subsequent lines. If the
238 @code{midiInstrument} property is not set, then @code{instrument}
239 is used to determine the instrument for MIDI output.")
241 (translator-property-description 'instrumentEqualizer procedure? "[DOCUMENT-ME]")
242 (translator-property-description 'instrumentSupport list? "
243 list of grobs to attach instrument name to.
245 (translator-property-description 'keyAccidentalOrder list? "
246 Alist that defines in what order alterations should be printed.
247 The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from -1, 1.
249 (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.")
251 (translator-property-description 'lastKeySignature list? "Last key
252 signature before a key signature change.")
254 (translator-property-description 'localKeySignature list? "the key
255 signature at this point in the measure. The format is the same as for keySignature. Is reset at every bar line."
258 (translator-property-description 'measureLength moment? "Length of one
259 measure in the current time signature last?")
260 (translator-property-description 'measurePosition moment? " How much
261 of the current measure (measured in whole notes) have we had. This
262 can be set manually to create incomplete measures (anacrusis, upbeat),
263 the start of the music.
265 (translator-property-description 'melismaBusy boolean? "Signifies
266 whether a melisma is active. This can be used to signal melismas on
267 top of those automatically detected. ")
268 (translator-property-description 'melismaEngraverBusy boolean? "See @ref{(lilypond)melismaBusy}. This is set automatically.")
269 (translator-property-description 'midiInstrument string? "Name of the
270 MIDI instrument to use ")
271 (translator-property-description 'midiMinimumVolume number? "[DOCUMENT-ME]")
272 (translator-property-description 'midiMaximumVolume number? "[DOCUMENT-ME]")
275 (translator-property-description 'noAutoBeaming boolean? "If set to true then beams are not generated automatically.
277 (translator-property-description 'noDirection boolean? "Don't set directions by a2-engraver when part-combining.")
278 (translator-property-description 'oneBeat moment? " How long does one beat in the current time signature last?")
279 (translator-property-description 'pedalSustainStrings list? "List of string to print for sustain-pedal. Format is
280 (UP UPDOWN DOWN), where each of the three is the string to print when
281 this is done with the pedal.")
282 (translator-property-description 'pedalUnaCordaStrings list? "see pedalSustainStrings.")
283 (translator-property-description 'pedalSostenutoStrings list? "see pedalSustainStrings.")
285 (translator-property-description 'phrasingPunctuation string? "")
286 (translator-property-description 'rehearsalMark number-or-string? "")
287 (translator-property-description 'regularSpacingDelta moment? "TODO")
288 (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")
289 (translator-property-description 'scriptDefinitions list? "
290 Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
293 (translator-property-description 'scriptHorizontal boolean? " Put
294 scripts left or right of note heads. Support for this is limited.
295 Accidentals will collide with scripts.
298 (translator-property-description 'skipBars boolean? " Set to true to
299 skip the empty bars that are produced by multimeasure notes and rests.
300 These bars will not appear on the printed output. If not set (the
301 default) multimeasure notes and rests expand into their full length,
302 printing the appropriate number of empty bars so that synchronization
303 with other voices is preserved.
307 @@lilypond[fragment,verbatim,center]
308 r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
314 (translator-property-description 'skipTypesetting boolean?
315 "When true, all no typesetting is done at
316 this moment, causing the interpretation phase to go a lot faster. This can
317 help with debugging large scores.")
319 (translator-property-description 'slurBeginAttachment symbol?
320 "translates to the car of grob-property 'attachment of NoteColumn. See
323 (translator-property-description 'slurEndAttachment symbol? "translates to the cdr of grob-property 'attachment of NoteColumn. See @ref{Slur}.")
324 (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.")
325 (translator-property-description 'solo boolean? "set if solo is detected by the part combiner.")
326 (translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?.")
327 (translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining.")
328 (translator-property-description 'soloText string? "text for begin of solo when part-combining.")
329 (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
330 (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.")
331 (translator-property-description 'split-interval boolean? "set if part-combiner separated voices based on splitInterval.")
332 (translator-property-description 'squashedPosition integer? " Vertical position of
333 squashing for Pitch_squash_engraver.")
334 (translator-property-description 'stavesFound list? "list of all staff-symbols found.")
335 (translator-property-description 'stanza markup? "Stanza `number' to print at start of a verse. Use in LyricsVoice context.")
338 (translator-property-description 'stemLeftBeamCount integer? "
339 Specify the number of beams to draw on the left side of the next note.
340 Overrides automatic beaming. The value is only used once, and then it
343 (translator-property-description 'stemRightBeamCount integer? "idem, for the right side.")
344 (translator-property-description 'stz markup? "Abbreviated form for a stanza, see also Stanza property.")
345 (translator-property-description 'subdivideBeams boolean? "If set, multiple beams will be subdivided at beat
346 positions - by only drawing one beam over the beat.")
347 (translator-property-description 'systemStartDelimiter symbol? "Which grob to make for the start of the system/staff?")
348 (translator-property-description 'textNonEmpty boolean? " If set
349 to true then text placed above or below the staff is not assumed to
350 have zero width. @code{\fatText} and @code{\emptyText} are predefined
353 (translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set.")
354 (translator-property-description 'timeSignatureFraction number-pair? "
355 pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
356 (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
357 Switch off for cadenzas.")
358 (translator-property-description 'transposing integer? "Transpose the MIDI output. Set this property to the number of half-steps to transpose by.")
359 (translator-property-description 'tremoloFlags integer? "Number of tremolo flags to add if none is specified.")
360 (translator-property-description 'tupletNumberFormatFunction procedure?
361 "Function taking a music as input, producing a string. This function is called to determine the text to print on a tuplet bracket.")
363 (translator-property-description 'tupletInvisible boolean? "
364 If set to true, tuplet bracket creation is switched off
365 entirely. This has the same effect as setting both
366 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
367 @code{#f}, but as this does not even create any grobs, this setting
368 uses less memory and time.")
369 (translator-property-description 'tupletSpannerDuration moment? "
370 Normally a tuplet bracket is as wide as the
371 @code{ imes} expression that gave rise to it. By setting this
372 property, you can make brackets last shorter. Example
375 @@lilypond[verbatim,fragment]
376 context Voice imes 2/3 @{
377 property Voice.tupletSpannerDuration = #(make-moment 1 4)
383 (translator-property-description 'unirhythm boolean? "set if unirhythm is detected by the part combiner.")
384 (translator-property-description 'unisilence boolean? "set if unisilence is detected by the part combiner.")
385 (translator-property-description 'unison boolean? "set if unisono is detected by the part combiner. .")
386 (translator-property-description 'verticalAlignmentChildCallback
387 procedure? "what callback to add to children of a vertical alignment.
388 It determines what alignment procedure is used on the alignment
390 (translator-property-description 'voltaSpannerDuration moment? "maximum duration of the volta bracket.
392 Set to a duration to control the size of the brackets printed by
393 @code{\\alternative}. It specifies the number of whole notes duration
394 to use for the brackets. This can be used to shrink the length of
395 brackets in the situation where one alternative is very large. It may
396 have odd effects if the specified duration is longer than the music
397 given in an @code{\\alternative}.
399 (translator-property-description 'weAreGraceContext boolean? ".")
400 (translator-property-description 'whichBar string?
401 "This property is read to determine what type of barline to create.
405 \\property Staff.whichBar = \"|:\"
408 This will create a start-repeat bar in this staff only.
410 If not set explicitly (by property or @code{\bar}), this is set
411 according to values of @code{defaultBarType}, @code{barAlways},
412 @code{barNonAuto} and @code{measurePosition}.
414 Valid values are described in @ref{(lilypond-internals)bar-line-interface}.