1 ;;;; translator-property-description.scm -- part of backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 (define-public all-translation-properties '())
11 (define (translator-property-description symbol type? description)
12 (if (not (equal? #f (object-property symbol 'translation-doc)))
14 (ly:warn (string-append "Redefining " (symbol->string symbol) "\n"))
18 (set-object-property! symbol 'translation-type? type?)
19 (set-object-property! symbol 'translation-doc description)
20 (set! all-translation-properties (cons symbol all-translation-properties))
25 (translator-property-description 'acceptHashTable vector? "Internal
26 variable: store table with MusicName to Engraver entries.")
27 (translator-property-description 'acknowledgeHashTable vector?
28 "Internal variable: store interface to engraver smob table for current
29 context. Don't mess with this.")
30 (translator-property-description 'aDueText string? "text for begin of a due")
31 (translator-property-description 'associatedVoice string? "Name of the
32 Voice that has the melody for this LyricsVoice.")
33 (translator-property-description 'autoBeamSettings list? "Specifies
34 when automatically generated beams should begin and end. The elements
39 function shortest-duration-in-beam time-signature
43 function = begin or end
44 shortest-duration-in-beam = numerator denominator; eg: 1 16
45 time-signature = numerator denominator, eg: 4 4
47 unspecified or wildcard entries for duration or time-signature
50 The user can override beam begin or end time by pushing a wildcard entries
51 '(begin * * * *) or '(end * * * *) resp., eg:
53 property Voice.autoBeamSettings push #'(end * * * *) = #(ly:make-moment 1 4)
57 ((end * * 3 2) . ,(ly:make-moment 1 2))
58 ((end 1 16 3 2) . ,(ly:make-moment 1 4))
59 ((end 1 32 3 2) . ,(ly:make-moment 1 8))
67 (translator-property-description 'autoAccidentals list? "List of
68 different ways to typeset an accidental. All algorithms in the list
69 are tried, and the one returning the most accidentals is used.
70 Each entry is either a symbol containg a context name or a name-value
71 pair containing an algorithm-description.
72 The list must begin with a symbol (context name).
73 The symbols denote in which context THE FOLLOWING algorithms (until next symbol)
74 will be interpreted. All notes in the interpretation context will share accidentals.
75 The contexts must be stated in order, innermost first.
79 This is the default algorithm. Accidentals are typeset if the note changes
80 the accidental of that note in that octave. Accidentals lasts to the end of the measure
81 and then as many measures as specified in the value. I.e. 1 means to the end
82 of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.
84 Accidentals are typeset if the note is different from
85 the previous note on the same pitch in any octave. The value has same meaning as in
90 (translator-property-description 'autoCautionaries list? "List similar to
91 autoAccidentals, but it controls cautionary accidentals rather than
92 normal ones. Both lists are tried, and the one giving the most accidentals
93 wins. In case of draw, a normal accidental is typeset.
96 (translator-property-description 'automaticPhrasing boolean? " If set,
97 the @ref{Lyric_phrasing_engraver} will match note heads of context
98 called Voice X to syllables from LyricsVoice called
99 X-<something>. This feature is turned on by default. See the example
100 file @file{lyrics-multi-stanza.ly}.
103 (translator-property-description 'automaticMelismata boolean? " If
104 set, \\addlyrics will assume that beams, slurs and ties signal
105 melismata, and align lyrics accordingly.
108 (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
110 (translator-property-description 'barCheckSynchronize boolean? "If
111 true then reset measurePosition when finding a barcheck. Turn off when
112 using barchecks in polyphonic music.")
113 (translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
114 automatically; they must be explicitly created with @code{bar}
115 keywords. Unlike with the @code{cadenza} keyword, measures are
116 still counted. Bar generation will resume according to that
117 count if this property is set to zero.
119 (translator-property-description 'barNumberVisibility procedure? "Procedure that takes an int and returns whether the corresponding bar number should be printed")
120 (translator-property-description 'bassFigureFormatFunction procedure? "DOCME")
121 (translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
122 (translator-property-description 'beatLength ly:moment? "The length of one beat in this time signature.")
123 (translator-property-description 'beatGrouping list?
124 "List of beatgroups. Eg. in 5/8 time #(list 2 3).")
125 (translator-property-description 'breakAlignOrder list? "Defines the order in which
126 prefatory matter (clefs, key signatures) appears, eg. this puts the
127 key signatures after the bar lines:
130 \\property Score.breakAlignOrder = #'(
140 (translator-property-description 'busyGrobs list? "
141 a queue of (END-MOMENT . GROB) conses. This is for internal (C++) use only.
142 Use at your own risk. This property contains the grobs for which END-MOMENT >= NOW.
145 (translator-property-description 'centralCPosition number? "Place of
146 the central C, measured in half staffspaces. Usually determined by
147 looking at clefPosition and clefGlyph.")
149 (translator-property-description
150 'changeMoment moment-pair?
151 "duration that voices are examined for differences, when
152 part-combining. Usually unset or zero when combining threads into one
153 voice, and 1 (or the duration of one measure) when combining voices
156 (translator-property-description
157 'chordNameFunction procedure?
158 "The function that converts lists of pitches to chord names.")
159 (translator-property-description
160 'chordNoteNamer procedure?
161 "Function that converts from a pitch object to a text markup. Used for single pitches.")
162 (translator-property-description
163 'chordRootNamer procedure?
164 "Function that converts from a pitch object to a text markup. Used for chords.")
165 (translator-property-description
166 'chordNameExceptions list?
167 "Alist of chord exceptions. Contains (CHORD . MARKUP) entries.")
168 (translator-property-description
169 'chordNameSeparator markup?
170 "The markup object used to separate parts of a chord name.")
173 (translator-property-description 'chordChanges boolean? "Only show changes in chords scheme?")
174 (translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
175 (translator-property-description 'clefOctavation integer? "Add
176 this much extra octavation. Values of 7 and -7 are common.")
178 (translator-property-description 'clefPosition number? "Where should
179 the center of the clef symbol go? On systems with an odd number of
180 stafflines, the value 0 puts the clef on the middle staffline; a
181 positive value shifts it up, a negative value shifts it down. The
182 unit of this distance is the half staff space.")
184 (translator-property-description 'combineParts boolean? "try to combine parts?")
185 (translator-property-description 'connectArpeggios boolean? " If
186 set, connect all arpeggios that are found. In this way, you can make
187 arpeggios that cross staves.
189 (translator-property-description 'createKeyOnClefChange boolean? "Print a key signature whenever the clef is changed.")
190 (translator-property-description 'crescendoText markup? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}")
191 (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.")
192 (translator-property-description 'decrescendoText markup? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}")
193 (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
196 (translator-property-description 'currentCommandColumn ly:grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
197 (translator-property-description 'currentMusicalColumn ly:grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
198 (translator-property-description 'defaultBarType string? "Sets the default type of bar line. Available bar types: [FIXME];
200 This variable is typically read at Score level, so overriding
201 Staff.defaultBarType will have no effect.
204 (translator-property-description 'devNullThread symbol? "User control of Thread_devnull_engraver: one of
207 Behave in normal way: remove one set of grobs when in unisolo.
209 Remove any grob that comes along.
214 (translator-property-description 'devNullVoice symbol? "User control of Voice_devnull_engraver: one of
217 Behave in normal way: remove spanners when in unisolo.
219 Remove any spanners that come along.
224 (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.")
226 (translator-property-description 'dynamicAbsoluteVolumeFunction procedure? "
229 (translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
233 (translator-property-description 'explicitKeySignatureVisibility
234 procedure? "visibility-lambda function for explicit Key changes;
235 \override of #'break-visibility will set the visibility for normal
236 (ie. at the start of the line) key signatures.")
238 (translator-property-description 'extraNatural boolean? "Whether to typeset an
239 extra natural sign before accidentals changing from a non-natural to
243 (translator-property-description 'extraVerticalExtent number-pair?
244 "extra vertical extent, same format as MinimumVerticalExtent")
247 (translator-property-description 'finalizations list? "List of expressions to evaluate before proceeding to next time step. Internal variable.")
248 (translator-property-description 'followVoice boolean?
249 "if set, note heads are tracked across staff switches by a thin line")
250 (translator-property-description 'fontSize integer?
251 "Used to set the relative size of all grobs
252 in a context. This is done using the @code{Font_size_engraver}.")
254 (translator-property-description 'allowBeamBreak boolean?
255 "If true allow line breaks during beams.")
257 (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.")
258 (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
259 (translator-property-description 'graceAlignPosition ly:dir? "put the grace note before or after the main note?")
260 (translator-property-description 'highStringOne boolean? "Whether the 1st string is the string with
261 highest pitch on the instrument (used by the automatic string selector).")
262 (translator-property-description 'instr markup? "see @code{instrument}")
263 (translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
264 @cindex Instrument_name_engraver
266 added to the Staff translator, then the @code{instrument} property
267 is used to label the first line of the staff and the @code{instr}
268 property is used to label subsequent lines. If the
269 @code{midiInstrument} property is not set, then @code{instrument}
270 is used to determine the instrument for MIDI output.")
272 (translator-property-description 'instrumentEqualizer procedure? "[DOCUMENT-ME]")
273 (translator-property-description 'instrumentSupport list? "
274 list of grobs to attach instrument name to.
276 (translator-property-description 'keyAccidentalOrder list? "
277 Alist that defines in what order alterations should be printed.
278 The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from -1, 1.
280 (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.")
282 (translator-property-description 'lastKeySignature list? "Last key
283 signature before a key signature change.")
285 (translator-property-description 'localKeySignature list? "the key
286 signature at this point in the measure. The format is the same as for keySignature. Is reset at every bar line."
288 (translator-property-description 'localKeySignatureChanges list? "Experimental.
290 (translator-property-description 'majorSevenSymbol markup? "How should
291 the major7 be formatted in a chord name?")
292 (translator-property-description 'measureLength ly:moment? "Length of one
293 measure in the current time signature last?")
294 (translator-property-description 'measurePosition ly:moment? " How much
295 of the current measure (measured in whole notes) have we had. This
296 can be set manually to create incomplete measures (anacrusis, upbeat),
297 the start of the music.
299 (translator-property-description 'melismaBusy boolean? "Signifies
300 whether a melisma is active. This can be used to signal melismas on
301 top of those automatically detected. ")
302 (translator-property-description 'melismaEngraverBusy boolean? "See melismaBusy. This is set automatically.")
303 (translator-property-description 'metronomeMarkFormatter procedure?
304 "How to produce a metronome markup.
305 Called with 2 arguments, event and context.")
306 (translator-property-description 'midiInstrument string? "Name of the
307 MIDI instrument to use ")
308 (translator-property-description 'midiMinimumVolume number? "[DOCUMENT-ME]")
309 (translator-property-description 'midiMaximumVolume number? "[DOCUMENT-ME]")
310 (translator-property-description 'minimumFret number? "The tablature
311 auto string-selecting mechanism selects the highest string with a fret
312 not less than minimumFret")
313 (translator-property-description 'minimumVerticalExtent number-pair?
314 "minimum vertical extent, same format as VerticalExtent")
315 (translator-property-description 'autoBeaming boolean? "If set to true
316 then beams are generated automatically.")
317 (translator-property-description 'noDirection boolean? "Don't set directions by a2-engraver when part-combining.")
318 (translator-property-description 'oneBeat ly:moment? " How long does one beat in the current time signature last?")
319 (translator-property-description
320 'originalCentralCPosition integer?
321 "Used for temporary overriding central C in octavation brackets. ")
322 (translator-property-description 'othersolo boolean? "FIXME")
323 (translator-property-description 'ottavation string? "If set, the text
324 for an 8va spanner. Changing this implies a new text spanner. ")
325 (translator-property-description 'pedalSustainStrings list? "List of string to print for sustain-pedal. Format is
326 (UP UPDOWN DOWN), where each of the three is the string to print when
327 this is done with the pedal.")
328 (translator-property-description 'pedalUnaCordaStrings list? "see pedalSustainStrings.")
329 (translator-property-description 'pedalSostenutoStrings list? "see pedalSustainStrings.")
331 (translator-property-description 'phrasingPunctuation string? "")
332 (translator-property-description 'rehearsalMark number-or-string? "")
333 (translator-property-description 'regularSpacingDelta ly:moment? "TODO")
334 (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")
335 (translator-property-description 'scriptDefinitions list? "
336 Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
339 (translator-property-description 'restNumberThreshold number?
340 "If a multimeasure rest takes less
341 than this number of measures, no number is printed. ")
343 (translator-property-description 'scriptHorizontal boolean? " Put
344 scripts left or right of note heads. Support for this is limited.
345 Accidentals will collide with scripts.
347 (translator-property-description 'fingerHorizontalDirection integer?
348 "If set, put the middle fingerings to
349 the side of the note head. Use LEFT, RIGHT or unset.")
351 (translator-property-description 'skipBars boolean? " Set to true to
352 skip the empty bars that are produced by multimeasure notes and rests.
353 These bars will not appear on the printed output. If not set (the
354 default) multimeasure notes and rests expand into their full length,
355 printing the appropriate number of empty bars so that synchronization
356 with other voices is preserved.
360 @@lilypond[fragment,verbatim,center]
361 r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
367 (translator-property-description 'skipTypesetting boolean?
368 "When true, all no typesetting is done at
369 this moment, causing the interpretation phase to go a lot faster. This can
370 help with debugging large scores.")
371 (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.")
372 (translator-property-description 'solo boolean? "set if solo is detected by the part combiner.")
373 (translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?.")
374 (translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining.")
375 (translator-property-description 'soloText string? "text for begin of solo when part-combining.")
376 (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
377 (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.")
378 (translator-property-description 'split-interval boolean? "set if part-combiner separated voices based on splitInterval.")
379 (translator-property-description 'squashedPosition integer? " Vertical position of
380 squashing for Pitch_squash_engraver.")
381 (translator-property-description 'stringOneTopmost boolean? "Whether the 1st string is printed on the
382 top line of the tablature.")
383 (translator-property-description 'stavesFound list? "list of all staff-symbols found.")
384 (translator-property-description 'stanza markup? "Stanza `number' to print at start of a verse. Use in LyricsVoice context.")
385 (translator-property-description 'stemLeftBeamCount integer? "
386 Specify the number of beams to draw on the left side of the next note.
387 Overrides automatic beaming. The value is only used once, and then it
390 (translator-property-description 'stemRightBeamCount integer? "idem, for the right side.")
391 (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).")
392 (translator-property-description 'stz markup? "Abbreviated form for a stanza, see also Stanza property.")
393 (translator-property-description 'subdivideBeams boolean? "If set, multiple beams will be subdivided at beat
394 positions - by only drawing one beam over the beat.")
395 (translator-property-description 'systemStartDelimiter symbol? "Which grob to make for the start of the system/staff?")
396 (translator-property-description 'tablatureFormat procedure?
397 "Function formatting a tab notehead; it takes
398 a string number, a list of string tunings and Pitch object. It returns the text as a string.")
400 (translator-property-description 'textNonEmpty boolean? " If set
401 to true then text placed above or below the staff is not assumed to
402 have zero width. @code{\fatText} and @code{\emptyText} are predefined
405 (translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set.")
406 (translator-property-description 'timeSignatureFraction number-pair? "
407 pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
408 (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
409 Switch off for cadenzas.")
410 (translator-property-description 'tonic ly:pitch?
411 "The tonic of the current scale")
412 (translator-property-description 'transposing integer? "Transpose the MIDI output. Set this property to the number of half-steps to transpose by.")
413 (translator-property-description 'tremoloFlags integer? "Number of tremolo flags to add if none is specified.")
414 (translator-property-description 'tupletNumberFormatFunction procedure?
415 "Function taking a music as input, producing a string. This function is called to determine the text to print on a tuplet bracket.")
417 (translator-property-description 'tupletInvisible boolean? "
418 If set to true, tuplet bracket creation is switched off
419 entirely. This has the same effect as setting both
420 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
421 @code{#f}, but as this does not even create any grobs, this setting
422 uses less memory and time.")
423 (translator-property-description 'tupletSpannerDuration ly:moment? "
424 Normally a tuplet bracket is as wide as the
425 @code{ imes} expression that gave rise to it. By setting this
426 property, you can make brackets last shorter. Example
429 @@lilypond[verbatim,fragment]
430 context Voice imes 2/3 @{
431 property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
437 (translator-property-description 'unirhythm boolean? "set if unirhythm is detected by the part combiner.")
438 (translator-property-description 'unisilence boolean? "set if unisilence is detected by the part combiner.")
439 (translator-property-description 'unison boolean? "set if unisono is detected by the part combiner. .")
440 (translator-property-description 'verticalAlignmentChildCallback
441 procedure? "what callback to add to children of a vertical alignment.
442 It determines what alignment procedure is used on the alignment
444 (translator-property-description 'verticalExtent number-pair? "hard
445 coded vertical extent. The format is a pair of dimensions, for
446 example, this sets the sizes of a staff to 10 (5+5) staffspaces high.
449 property Staff.verticalExtent = #(-5.0 . 5.0)
452 VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are
453 predefined in all relevant contexts to @code{#f}, so they will not
456 Note that these VerticalExtents can only operate on vertical groups,
457 and therefore only work in contexts which contain an
458 @code{Axis_group_engraver}.
461 (translator-property-description 'voltaOnThisStaff boolean?
462 "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.")
463 (translator-property-description 'voltaSpannerDuration ly:moment? "maximum duration of the volta bracket.
465 Set to a duration to control the size of the brackets printed by
466 @code{\\alternative}. It specifies the number of whole notes duration
467 to use for the brackets. This can be used to shrink the length of
468 brackets in the situation where one alternative is very large. It may
469 have odd effects if the specified duration is longer than the music
470 given in an @code{\\alternative}.
472 (translator-property-description 'whichBar string?
473 "This property is read to determine what type of barline to create.
477 \\property Staff.whichBar = \"|:\"
480 This will create a start-repeat bar in this staff only.
482 If not set explicitly (by property or @code{\bar}), this is set
483 according to values of @code{defaultBarType}, @code{barAlways},
484 @code{barNonAuto} and @code{measurePosition}.
486 Valid values are described in @ref{(lilypond-internals)bar-line-interface}.