2 (define all-translation-properties '())
4 (define (translator-property-description symbol type? description)
5 (set-object-property! symbol 'translation-type? type?)
6 (set-object-property! symbol 'translation-doc description)
7 (set! all-translation-properties (cons symbol all-translation-properties))
12 (translator-property-description 'CONTEXTNAMEMinimumVerticalExtent number-pair? "minimum vertical extent, same format as CONTEXTNAMEVerticalExtent [fixme, naming]")
13 (translator-property-description 'CONTEXTNAMEVerticalExtent number-pair? "hard coded vertical extent.
14 The format is a pair of dimensions, for example, this sets the sizes
15 of a staff to 10 (5+5) staffspaces high.
18 property Staff.StaffVerticalExtent = #(-5.0 . 5.0)
22 (translator-property-description 'CONTEXTNAMExtraVerticalExtent number-pair? "extra vertical extent, same format
23 CONTEXTNAMEMinimumVerticalExtent [fixme, naming]")
24 (translator-property-description 'Generic_property_list list? "description of the conversion.
26 Defines names and types for generic properties. These are properties
27 than can be plugged into the backend directly. See the init file
28 @file{generic-property.scm} for details. For internal use only,
31 (translator-property-description 'aDueText string? "text for begin of a due")
32 (translator-property-description 'associatedVoice string? "Name of the Voice that has the melody for this LyricsVoice.")
33 (translator-property-description 'autoBeamSettings list? "
34 Specifies when automatically generated beams should begin and end. The elements have the format:
38 function shortest-duration-in-beam time-signature
42 function = begin or end
43 shortest-duration-in-beam = numerator denominator; eg: 1 16
44 time-signature = numerator denominator, eg: 4 4
46 unspecified or wildcard entries for duration or time-signature
49 The user can override beam begin or end time by pushing a wildcard entries
50 '(begin * * * *) or '(end * * * *) resp., eg:
52 property Voice.autoBeamSettings push #'(end * * * *) = #(make-moment 1 4)
56 ((end * * 3 2) . ,(make-moment 1 2))
57 ((end 1 16 3 2) . ,(make-moment 1 4))
58 ((end 1 32 3 2) . ,(make-moment 1 8))
64 (translator-property-description 'automaticPhrasing boolean? " If set,
65 the @ref{Lyric_phrasing_engraver} will match note heads of context
66 called Voice X to syllables from LyricsVoice called
67 X-<something>. This feature is turned on by default. See the example
68 file @file{lyrics-multi-stanza.ly}.
71 (translator-property-description 'automaticMelismata boolean? " If
72 set, \addlyrics will assume that beams, slurs and ties signal
73 melismata, and align lyrics accordingly.
76 (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
78 (translator-property-description 'barCheckNoSynchronize boolean? "If set, don't reset measurePosition when finding a bbarcheck. This
79 makes bar-checks for polyphonic music easier.")
80 (translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
81 automatically; they must be explicitly created with @code{bar}
82 keywords. Unlike with the @code{cadenza} keyword, measures are
83 still counted. Bar generation will resume according to that
84 count if this property is set to zero.
86 (translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
87 (translator-property-description 'breakAlignOrder list? "Defines the order in which
88 prefatory matter (clefs, key signatures) appears, eg. this puts the
89 key signatures after the bar lines:
92 \\property Score.breakAlignOrder = #'(
102 (translator-property-description 'centralCPosition number? "Place of the central C. Usually determined by looking at clefPosition and clefGlyph.")
103 (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.")
104 (translator-property-description 'chordChanges boolean? "Only show changes in chords scheme?")
105 (translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
106 (translator-property-description 'clefOctavation integer? "Add
107 this much extra octavation. Values of 7 and -7 are common.")
108 (translator-property-description 'clefPitches list? "an alist mapping GLYPHNAME to the position of the central C for that symbol")
109 (translator-property-description 'clefPosition number? "Where should the center of the symbol go?")
110 (translator-property-description 'combineParts boolean? "try to combine parts?")
111 (translator-property-description 'connectArpeggios boolean? " If
112 set, connect all arpeggios that are found. In this way, you can make
113 arpeggios that cross staffs.
115 (translator-property-description 'createKeyOnClefChange boolean? "Print a key signature whenever the clef is changed.")
116 (translator-property-description 'crescendoText string? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}")
117 (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.")
118 (translator-property-description 'decrescendoText string? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}")
119 (translator-property-description 'devNullThread symbol? "User control of Thread_devnull_engraver: one of
122 Behave in normal way: remove one set of grobs when in unisolo.
124 Remove any grob that comes along.
129 (translator-property-description 'devNullVoice symbol? "User control of Voice_devnull_engraver: one of
132 Behave in normal way: remove spanners when in unisolo.
134 Remove any spanners that come along.
139 (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.")
140 (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
143 (translator-property-description 'currentCommandColumn ly-grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
144 (translator-property-description 'currentMusicalColumn ly-grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
145 (translator-property-description 'defaultBarType string? "Sets the default type of bar line. Available bar types: [FIXME];
147 This variable is typically read at Score level, so overriding
148 Staff.defaultBarType will have no effect.
151 (translator-property-description 'chordChanges boolean? "Only generate chords
154 (translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
156 (translator-property-description 'explicitKeySignatureVisibility
157 procedure? "visibility-lambda function for explicit Key changes;
158 \override of #'visibility-lambda will set the visibility for normal
159 (ie. at the start of the line) key signatures.")
162 (translator-property-description 'followThread boolean?
163 "if set, note heads are tracked across staff switches by a thin line")
164 (translator-property-description 'forceClef boolean? "Show clef symbol, even if it hasn't changed.")
165 (translator-property-description 'forgetAccidentals boolean? "do
166 not set localKeySignature when a note alterated differently from
167 localKeySignature is found.
169 Causes accidentals to be printed at every note instead of
170 remembered for the duration of a measure.
172 (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
173 (translator-property-description 'graceAlignPosition dir? "put the grace note before or after the main note?")
174 (translator-property-description 'instr markup? "see @code{instrument}")
175 (translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
176 @cindex Instrument_name_engraver
178 added to the Staff translator, then the @code{instrument} property
179 is used to label the first line of the staff and the @code{instr}
180 property is used to label subsequent lines. If the
181 @code{midiInstrument} property is not set, then @code{instrument}
182 is used to determine the instrument for MIDI output.")
183 (translator-property-description 'keyAccidentalOrder list? "
184 Alist that defines in what order alterations should be printed.
185 The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from -1, 1.
187 (translator-property-description 'keyOctaviation boolean? "")
188 (translator-property-description 'keySignature list? "The current key signature. This is an alist containing (NAME . ALTER) pairs, where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2 ")
190 (translator-property-description 'localKeySignature list? "the key
191 signature at this point in the measure. The format is an alist with
192 entries of the form (NAME . ALTER)
193 or ((OCTAVE . NAME) . ALTER),
194 where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2"
197 (translator-property-description 'measureLength moment? "Length of one
198 measure in the current time signature last?")
199 (translator-property-description 'measurePosition moment? " How much
200 of the current measure (measured in whole notes) have we had. This
201 can be set manually to create incomplete measures (anacrusis, upbeat),
202 the start of the music.
204 (translator-property-description 'melismaBusy boolean? "Signifies
205 whether a melisma is active. This can be used to signal melismas on
206 top of those automatically detected. ")
207 (translator-property-description 'melismaEngraverBusy boolean? "See @ref{(lilypond)melismaBusy}. This is set automatically.")
208 (translator-property-description 'midiInstrument string? "Name of the
209 MIDI instrument to use ")
210 (translator-property-description 'noAutoBeaming boolean? "If set to true then beams are not generated automatically.
212 (translator-property-description 'noResetKey boolean? "Do not
213 reset local key to the value of keySignature at the start of a measure,
214 as determined by measurePosition.
216 Do not reset the key at the start of a measure. Accidentals will be
217 printed only once and are in effect until overridden, possibly many
220 (translator-property-description 'oneBeat moment? " How long does one beat in the current time signature last?")
221 (translator-property-description 'pedalSustainStrings list? "List of string to print for sustain-pedal. Format is
222 (UP UPDOWN DOWN), where each of the three is the string to print when
223 this is done with the pedal.")
224 (translator-property-description 'pedalUnaChordaStrings string? "see pedalSustainStrings.")
225 (translator-property-description 'pedalSostenutoStrings string? "see pedalSustainStrings.")
227 (translator-property-description 'phrasingPunctuation string? "")
228 (translator-property-description 'rehearsalMark number-or-string? "")
229 (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")
230 (translator-property-description 'repeatCommands list? "")
231 (translator-property-description 'scriptDefinitions list? "
232 Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
235 (translator-property-description 'scriptHorizontal boolean? " Put
236 scripts left or right of note heads. Support for this is limited.
237 Accidentals will collide with scripts.
239 (translator-property-description 'scriptHorizontal boolean? " Put
240 scripts left or right of note heads. Support for this is limited.
241 Accidentals will collide with scripts.
244 (translator-property-description 'skipBars boolean? " Set to true to
245 skip the empty bars that are produced by multimeasure notes and rests.
246 These bars will not appear on the printed output. If not set (the
247 default) multimeasure notes and rests expand into their full length,
248 printing the appropriate number of empty bars so that synchronization
249 with other voices is preserved.
253 @@lilypond[fragment,verbatim,center]
254 r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
260 (translator-property-description 'slurBeginAttachment symbol?
261 "translates to the car of grob-property 'attachment of NoteColumn. See
264 (translator-property-description 'slurEndAttachment symbol? "translates to the cdr of grob-property 'attachment of NoteColumn. See @ref{Slur}.")
265 (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.")
266 (translator-property-description 'solo boolean? "set if solo is detected by the part combiner.")
267 (translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?.")
268 (translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining.")
269 (translator-property-description 'soloText string? "text for begin of solo when part-combining.")
270 (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
271 (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.")
272 (translator-property-description 'split-interval boolean? "set if part-combiner separated voices based on splitInterval.")
273 (translator-property-description 'squashedPosition integer? " Vertical position of
274 squashing for Pitch_squash_engraver.")
275 (translator-property-description 'staffsFound list? "list of all staff-symbols found.")
276 (translator-property-description 'stanza string? "Stanza `number' to print at start of a verse. Use in LyricsVoice context.")
279 (translator-property-description 'stemLeftBeamCount integer? "
280 Specify the number of beams to draw on the left side of the next note.
281 Overrides automatic beaming. The value is only used once, and then it
284 (translator-property-description 'stemRightBeamCount integer? "idem, for the right side.")
285 (translator-property-description 'stz string? "Abbreviated form for a stanza, see also Stanza property.")
286 (translator-property-description 'textNonEmpty boolean? " If set
287 to true then text placed above or below the staff is not assumed to
288 have zero width. @code{\fatText} and @code{\emptyText} are predefined
291 (translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set.")
292 (translator-property-description 'timeSignatureFraction number-pair? "
293 pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
294 (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
295 Switch off for cadenzas.")
296 (translator-property-description 'transposing integer? "Transpose the MIDI output. Set this property to the number of half-steps to transpose by.")
297 (translator-property-description 'tremoloFlags integer? "Number of tremolo flags to add if none is specified.")
298 (translator-property-description 'tupletNumberFormatFunction procedure?
299 "Function taking a music as input, producing a string. This function is called to determine the text to print on a tuplet bracket.")
301 (translator-property-description 'tupletInvisible boolean? "
302 If set to true, tuplet bracket creation is switched off
303 entirely. This has the same effect as setting both
304 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
305 @code{#f}, but as this does not even create any grobs, this setting
306 uses less memory and time.")
307 (translator-property-description 'tupletSpannerDuration moment? "
308 Normally a tuplet bracket is as wide as the
309 @code{ imes} expression that gave rise to it. By setting this
310 property, you can make brackets last shorter. Example
313 @@lilypond[verbatim,fragment]
314 context Voice imes 2/3 @{
315 property Voice.tupletSpannerDuration = #(make-moment 1 4)
321 (translator-property-description 'unirhythm boolean? "set if unirhythm is detected by the part combiner.")
322 (translator-property-description 'unisilence boolean? "set if unisilence is detected by the part combiner.")
323 (translator-property-description 'unison boolean? "set if unisono is detected by the part combiner. .")
324 (translator-property-description 'verticalAlignmentChildCallback
325 procedure? "what callback to add to children of a vertical alignment.
326 It determines what alignment procedure is used on the alignment
328 (translator-property-description 'voltaSpannerDuration moment? "maximum duration of the volta bracket.
330 Set to a duration to control the size of the brackets printed by
331 @code{\\alternative}. It specifies the number of whole notes duration
332 to use for the brackets. This can be used to shrink the length of
333 brackets in the situation where one alternative is very large. It may
334 have odd effects if the specified duration is longer than the music
335 given in an @code{\\alternative}.
337 (translator-property-description 'weAreGraceContext boolean? ".")
338 (translator-property-description 'whichBar string?
339 "This property is read to determine what type of barline to create.
343 \\property Staff.whichBar = \"|:\"
346 This will create a start-repeat bar in this staff only.
348 If not set explicitly (by property or @code{\bar}), this is set
349 according to values of @code{defaultBarType}, @code{barAlways},
350 @code{barNonAuto} and @code{measurePosition}.
352 Legal values are described in @ref{(lilypond-internals)bar-line-interface}.