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? "")
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))
63 (translator-property-description 'automaticPhrasing boolean? " If set,
64 the @ref{Lyric_phrasing_engraver} will match note heads of context
65 called Voice X to syllables from LyricsVoice called
66 X-<something>. This feature is turned on by default. See the example
67 file @file{lyrics-multi-stanza.ly}.
70 (translator-property-description 'automaticMelismata boolean? " If
71 set, \addlyrics will assume that beams, slurs and ties signal
72 melismata, and align lyrics accordingly.
74 (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
76 (translator-property-description 'barCheckNoSynchronize boolean? "If set, don't reset measurePosition when finding a bbarcheck. This
77 makes bar-checks for polyphonic music easier.")
78 (translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
79 automatically; they must be explicitly created with @code{bar}
80 keywords. Unlike with the @code{cadenza} keyword, measures are
81 still counted. Bar generation will resume according to that
82 count if this property is set to zero.
84 (translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
85 (translator-property-description 'beamMelismaBusy boolean? "")
86 (translator-property-description 'breakAlignOrder list? "Defines the order in which
87 prefatory matter (clefs, key signatures) appears, eg. this puts the
88 key signatures after the bar lines:
91 \\property Score.breakAlignOrder = #'(
101 (translator-property-description 'centralCPosition number? "Place of the central C. Usually determined by looking at clefPosition and clefGlyph.")
102 (translator-property-description 'chordInversion boolean? " Determines whether LilyPond should look for chord inversions when
103 translating from notes to chord names. Set to 1 to find
104 inversions. The default is 0 which does not look for
106 (translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
107 (translator-property-description 'clefOctavation integer? "Add
108 this much extra octavation. Values of 7 and -7 are common.")
109 (translator-property-description 'clefPitches list? "an alist mapping GLYPHNAME to the position of the central C for that symbol")
110 (translator-property-description 'clefPosition number? "Where should the center of the symbol go?")
111 (translator-property-description 'combineParts boolean? "try to combine parts?")
112 (translator-property-description 'connectArpeggios boolean? " If
113 set, connect all arpeggios that are found. In this way, you can make
114 arpeggios that cross staffs.
116 (translator-property-description 'createKeyOnClefChange boolean? "")
117 (translator-property-description 'currentBarNumber integer? "this is read to determine
118 the number to put on the bar ")
119 (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
122 (translator-property-description 'currentCommandColumn ly-grob? "")
123 (translator-property-description 'currentMusicalColumn ly-grob? "")
124 (translator-property-description 'defaultBarType string? "Sets the default type of bar line. Available bar types: [FIXME]
126 (translator-property-description 'drarnChords boolean? "")
127 (translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
128 (translator-property-description 'explicitKeySignatureVisibility procedure? "")
129 (translator-property-description 'forgetAccidentals boolean? "do
130 not set localKeySignature when a note alterated differently from
131 localKeySignature is found.
133 Causes accidentals to be printed at every note instead of
134 remembered for the duration of a measure.
136 (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
137 (translator-property-description 'graceAlignPosition dir? "put the grace note before or after the main note?")
138 (translator-property-description 'instr markup? "see @code{instrument}")
139 (translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
140 @cindex Instrument_name_engraver
142 added to the Staff translator, then the @code{instrument} property
143 is used to label the first line of the staff and the @code{instr}
144 property is used to label subsequent lines. If the
145 @code{midiInstrument} property is not set, then @code{instrument}
146 is used to determine the instrument for MIDI output.")
147 (translator-property-description 'keyAccidentalOrder list? "")
148 (translator-property-description 'keyOctaviation boolean? "")
149 (translator-property-description 'keySignature list? "")
150 (translator-property-description 'keySignature list? "")
151 (translator-property-description 'localKeySignature list? "the key signature at this point in the measure")
152 (translator-property-description 'measureLength moment? " How long does one measure in the current time signature last?")
153 (translator-property-description 'measurePosition moment? "
154 How much of the current measure (measured in whole notes) have we had?
156 Set this manually to create incomplete measures (anacrusis, upbeat), eg. at the start of
159 (translator-property-description 'melismaBusy boolean? "")
160 (translator-property-description 'melismaEngraverBusy boolean? "")
161 (translator-property-description 'midiInstrument string? "")
162 (translator-property-description 'noAutoBeaming boolean? " If set to true then beams are not generated automatically.
164 (translator-property-description 'noResetKey boolean? "Do not
165 reset local key to the value of keySignature at the start of a measure,
166 as determined by measurePosition.
168 Do not reset the key at the start of a measure. Accidentals will be
169 printed only once and are in effect until overridden, possibly many
172 (translator-property-description 'oneBeat moment? " How long does one beat in the current time signature last?")
173 (translator-property-description 'phrasingPunctuation string? "")
174 (translator-property-description 'rehearsalMark number-or-string? "")
175 (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")
176 (translator-property-description 'repeatCommands list? "")
177 (translator-property-description 'scriptDefinitions list? "
178 Description of scripts to use. (fixme)
180 (translator-property-description 'scriptHorizontal boolean? " Put scripts left or right of note heads. Support for this is
181 limited. Accidentals will collide with scripts.
184 (translator-property-description 'scriptHorizontal boolean? " Put scripts left or right of note heads. Support for this is
185 limited. Accidentals will collide with scripts.
188 (translator-property-description 'skipBars boolean? " Set to true to skip the empty bars that are produced by
189 multimeasure notes and rests. These bars will not appear on the
190 printed output. If not set (the default) multimeasure
191 notes and rests expand into their full length, printing the appropriate
192 number of empty bars so that synchronization with other voices is
195 @c my @vebatim patch would help...
197 @@lilypond[fragment,verbatim,center]
198 r1 r1*3 R1*3property Score.skipBars=1 r1*3 R1*3
204 (translator-property-description 'slurBeginAttachment symbol? "translates to the car of grob-property 'attachment.")
205 (translator-property-description 'slurEndAttachment symbol? "translates to the cdr of grob-property 'attachment.")
206 (translator-property-description 'slurMelismaBusy boolean? "")
207 (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set")
208 (translator-property-description 'solo boolean? "set if solo is detected")
209 (translator-property-description 'soloADue boolean? "set Solo/A due texts?")
210 (translator-property-description 'soloIIText string? "text for begin of solo for voice ``two''")
211 (translator-property-description 'soloText string? "text for begin of solo")
212 (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
213 (translator-property-description 'split-interval number-pair? "always split into two voices for contained intervals")
214 (translator-property-description 'squashedPosition integer? " Vertical position of
216 (translator-property-description 'staffsFound list? "list of all staff-symbols found.")
217 (translator-property-description 'staffsFound list? "")
218 (translator-property-description 'stanza string? "Stanza `number' to print at start of a verse")
219 (translator-property-description 'startSustain string? "")
220 (translator-property-description 'startUnaChorda string? "")
221 (translator-property-description 'stemLeftBeamCount integer? "
222 Specify the number of beams to draw on the left side of the next note.
223 Overrides automatic beaming. The value is only used once, and then it
226 (translator-property-description 'stemRightBeamCount integer? "idem, for the right side")
227 (translator-property-description 'stopStartSustain string? "")
228 (translator-property-description 'stopSustain string? "")
229 (translator-property-description 'stopUnaChorda string? "")
230 (translator-property-description 'stz string? "")
231 (translator-property-description 'textNonEmpty boolean? " If set
232 to true then text placed above or below the staff is not assumed to
233 have zero width. @code{fatText} and @code{emptyText} are predefined
236 (translator-property-description 'tieMelismaBusy boolean? "")
237 (translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set")
238 (translator-property-description 'timeSignatureFraction number-pair? "
239 pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
240 (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
241 Switch off for cadenzas.")
242 (translator-property-description 'tremoloFlags integer? "")
243 (translator-property-description 'tupletInvisible boolean? "
244 If set to true, tuplet bracket creation is switched off
245 entirely. This has the same effect as setting both
246 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
247 @code{#f}, but as this does not even create any grobs, this setting
248 uses less memory and time.")
249 (translator-property-description 'tupletSpannerDuration moment? "
250 Normally a tuplet bracket is as wide as the
251 @code{ imes} expression that gave rise to it. By setting this
252 property, you can make brackets last shorter. Example
255 @@lilypond[verbatim,fragment]
256 context Voice imes 2/3 @{
257 property Voice.tupletSpannerDuration = #(make-moment 1 4)
263 (translator-property-description 'unirhythm boolean? "set if unirhythm is detected")
264 (translator-property-description 'unisilence boolean? "set if unisilence is detected")
265 (translator-property-description 'unison boolean? "set if unisono is detected ")
266 (translator-property-description 'verticalAlignmentChildCallback
267 procedure? "what callback to add to children of a vertical alignment.
268 It determines what alignment procedure is used on the alignment
270 (translator-property-description 'voltaSpannerDuration moment? "maximum duration of the volta bracket.
272 Set to a duration to control the size of the brackets printed by
273 @code{
\alternative}. It specifies the number of whole notes duration
274 to use for the brackets. This can be used to shrink the length of
275 brackets in the situation where one alternative is very large. It may
276 have odd effects if the specified duration is longer than the music
277 given in an @code{
\alternative}.
279 (translator-property-description 'weAreGraceContext boolean? "")
280 (translator-property-description 'whichBar string? "This property is read to determine what type of barline to create.
283 \\property Staff.whichBar = \"|:\"
285 will create a start-repeat bar in this staff only
287 (translator-property-description 'whichBar string? "")
288 (translator-property-description 'whichBar string? "if not set
289 explicitly (by property or bar), this is set according to values of
290 defaultBarType, barAlways, barNonAuto and measurePosition.