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