1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;;; GNU General Public License for more details.
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 (define-public all-translation-properties '())
22 (define (translator-property-description symbol type? description)
26 (string? description)))
27 (throw 'init-format-error))
30 (if (not (equal? #f (object-property symbol 'translation-doc)))
31 (ly:error (_ "symbol ~S redefined" symbol)))
33 (set-object-property! symbol 'translation-type? type?)
34 (set-object-property! symbol 'translation-doc description)
35 (set! all-translation-properties (cons symbol all-translation-properties))
39 (define-public all-user-translation-properties
42 (apply translator-property-description x))
47 (accidentalGrouping ,symbol? "If set to @code{'voice}, accidentals
48 on the same note in different octaves may be horizontally staggered
49 if in different voices.")
50 (aDueText ,markup? "Text to print at a unisono passage.")
51 (additionalPitchPrefix ,string? "Text with which to prefix
52 additional pitches within a chord name.")
53 (alignAboveContext ,string? "Where to insert newly created context in
55 (alignBassFigureAccidentals ,boolean? "If true, then the accidentals
56 are aligned in bass figure context.")
57 (alignBelowContext ,string? "Where to insert newly created context in
59 (alternativeNumberingStyle ,symbol? "The style of an alternative's bar
60 numbers. Can be @code{numbers} for going back to the same number or
61 @code{numbers-with-letters} for going back to the same number with letter
62 suffixes. No setting will not go back in measure-number time.")
63 (alternativeRestores ,symbol-list? "Timing variables that are
64 restored to their value at the end of the first alternative in
65 subsequent alternatives.")
66 (associatedVoice ,string? "Name of the @code{Voice} that has the
67 melody for this @code{Lyrics} line.")
68 (autoAccidentals ,list? "List of different ways to typeset an
71 For determining when to print an accidental, several different rules
72 are tried. The rule that gives the highest number of accidentals is
75 Each entry in the list is either a symbol or a procedure.
80 The symbol is the name of the context in which the following rules are to be
81 applied. For example, if @var{context} is @rinternals{Score} then all
82 staves share accidentals, and if @var{context} is @rinternals{Staff} then
83 all voices in the same staff share accidentals, but staves do not.
86 The procedure represents an accidental rule to be applied to the previously
89 The procedure takes the following arguments:
94 The current context to which the rule should be applied.
97 The pitch of the note to be evaluated.
100 The current bar number.
103 The current measure position.
107 The procedure returns a pair of booleans. The first states whether an extra
108 natural should be added. The second states whether an accidental should be
109 printed. @code{(#t . #f)} does not make sense.
112 (autoBeamCheck ,procedure? "A procedure taking three
113 arguments, @var{context}, @var{dir} [start/@/stop (-1 or 1)], and
114 @var{test} [shortest note in the beam]. A non-@code{#f} return value
115 starts or stops the auto beam.")
116 (autoBeaming ,boolean? "If set to true then beams are generated
118 (autoCautionaries ,list? "List similar to @code{autoAccidentals},
119 but it controls cautionary accidentals rather than normal ones. Both
120 lists are tried, and the one giving the most accidentals wins. In
121 case of draw, a normal accidental is typeset.")
122 (automaticBars ,boolean? "If set to false then bar lines will not
123 be printed automatically; they must be explicitly created with a
124 @code{\\bar} command. Unlike the @code{\\cadenzaOn} keyword, measures
125 are still counted. Bar line generation will resume according to that
126 count if this property is unset.")
129 (barAlways ,boolean? "If set to true a bar line is drawn after
131 (barCheckSynchronize ,boolean? "If true then reset
132 @code{measurePosition} when finding a bar check.")
133 (barNumberFormatter ,procedure? "A procedure that takes a bar
134 number, measure position, and alternative number and returns a markup
135 of the bar number to print.")
136 (barNumberVisibility ,procedure? "A procedure that takes a bar
137 number and a measure position and returns whether the corresponding
138 bar number should be printed. Note that the actual print-out of
139 bar numbers is controlled with the @code{break-visibility} property.
141 The following procedures are predefined:
144 @item all-bar-numbers-visible
145 Enable bar numbers for all bars, including the first one and broken
146 bars (which get bar numbers in parentheses).
148 @item first-bar-number-invisible
149 Enable bar numbers for all bars (including broken bars) except the
150 first one. If the first bar is broken, it doesn't get a bar number
153 @item first-bar-number-invisible-save-broken-bars
154 Enable bar numbers for all bars (including broken bars) except the
155 first one. A broken first bar gets a bar number.
157 @item first-bar-number-invisible-and-no-parenthesized-bar-numbers
158 Enable bar numbers for all bars except the first bar and broken bars.
161 @item (every-nth-bar-number-visible @var{n})
162 Assuming @var{n} is value@tie{}2, for example, this enables bar numbers
163 for bars 2, 4, 6, etc.
165 @item (modulo-bar-number-visible @var{n} @var{m})
166 If bar numbers 1, 4, 7, etc., should be enabled, @var{n}@tie{}(the modulo)
167 must be set to@tie{}3 and @var{m}@tie{}(the division remainder) to@tie{}1.
170 (baseMoment ,ly:moment? "Smallest unit of time that will stand on its
171 own as a subdivided section.")
172 (bassFigureFormatFunction ,procedure? "A procedure that is
173 called to produce the formatting for a @code{BassFigure} grob. It
174 takes a list of @code{BassFigureEvent}s, a context, and the grob to
176 (bassStaffProperties ,list? "An alist of property settings to
177 apply for the down staff of @code{PianoStaff}. Used by
178 @code{\\autochange}.")
179 (beamExceptions ,list? "An alist of exceptions to autobeam rules
180 that normally end on beats.")
181 (beamHalfMeasure ,boolean? "Whether to allow a beam to begin
182 halfway through the measure in triple time, which could look like 6/8.")
183 (beatStructure ,list? "List of @code{baseMoment}s that are combined
186 (chordChanges ,boolean? "Only show changes in chords scheme?")
187 (chordNameExceptions ,list? "An alist of chord exceptions.
188 Contains @code{(@var{chord} . @var{markup})} entries.")
189 (chordNameExceptionsFull ,list? "An alist of full chord
190 exceptions. Contains @code{(@var{chord} . @var{markup})} entries.")
191 (chordNameExceptionsPartial ,list? "An alist of partial chord
192 exceptions. Contains @code{(@var{chord} . (@var{prefix-markup}
193 @var{suffix-markup}))} entries.")
194 (chordNameFunction ,procedure? "The function that converts lists
195 of pitches to chord names.")
196 (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
197 (chordNameSeparator ,markup? "The markup object used to
198 separate parts of a chord name.")
199 (slashChordSeparator ,markup? "The markup object used to separate
200 a chord name from its root note in case of inversions or slash
202 (chordNoteNamer ,procedure? "A function that converts from a pitch
203 object to a text markup. Used for single pitches.")
204 (chordPrefixSpacer ,number? "The space added between the root
205 symbol and the prefix of a chord name.")
206 (chordRootNamer ,procedure? "A function that converts from a pitch
207 object to a text markup. Used for chords.")
208 (clefGlyph ,string? "Name of the symbol within the music font.")
209 (clefTransposition ,integer? "Add this much extra transposition.
210 Values of 7 and -7 are common.")
211 (clefTranspositionFormatter ,procedure? "A procedure that takes the
212 Transposition number as a string and the style as a symbol and returns a
214 (clefTranspositionStyle ,symbol? "Determines the way the ClefModifier
215 grob is displayed. Possible values are @samp{default}, @samp{parenthesized}
216 and @samp{bracketed}.")
217 (clefPosition ,number? "Where should the center of the clef
218 symbol go, measured in half staff spaces from the center of the
220 (completionBusy ,boolean? "Whether a completion-note head is playing.")
221 (completionUnit ,ly:moment? "Sub-bar unit of completion.")
222 (connectArpeggios ,boolean? "If set, connect arpeggios across
224 (countPercentRepeats ,boolean? "If set, produce counters for
226 (createKeyOnClefChange ,boolean? "Print a key signature whenever
227 the clef is changed.")
228 (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
229 Should be set for staves.")
230 (crescendoSpanner ,symbol? "The type of spanner to be used for
231 crescendi. Available values are @samp{hairpin} and @samp{text}. If unset,
232 a hairpin crescendo is used.")
233 (crescendoText ,markup? "The text to print at start of non-hairpin
234 crescendo, i.e., @samp{cresc.}.")
235 (cueClefGlyph ,string? "Name of the symbol within the music font.")
236 (cueClefTransposition ,integer? "Add this much extra transposition.
237 Values of 7 and -7 are common.")
238 (cueClefTranspositionFormatter ,procedure? "A procedure that
239 takes the Transposition number as a string and the style as a symbol
240 and returns a markup.")
241 (cueClefTranspositionStyle ,symbol? "Determines the way the ClefModifier
242 grob is displayed. Possible values are @samp{default}, @samp{parenthesized}
243 and @samp{bracketed}.")
244 (cueClefPosition ,number? "Where should the center of the clef
245 symbol go, measured in half staff spaces from the center of the
247 (currentBarNumber ,integer? "Contains the current barnumber.
248 This property is incremented at every bar line.")
251 (decrescendoSpanner ,symbol? "The type of spanner to be used for
252 decrescendi. Available values are @samp{hairpin} and @samp{text}. If
253 unset, a hairpin decrescendo is used.")
254 (decrescendoText ,markup? "The text to print at start of
255 non-hairpin decrescendo, i.e., @samp{dim.}.")
256 (defaultBarType ,string? "Set the default type of bar line. See
257 @code{whichBar} for information on available bar types.
259 This variable is read by @rinternals{Timing_translator} at
260 @rinternals{Score} level.")
261 (defaultStrings ,list? "A list of strings to use in calculating
262 frets for tablatures and fretboards if no strings are provided in
263 the notes for the current moment.")
264 (doubleRepeatSegnoType ,string? "Set the default bar line for
265 the combinations double repeat with segno. Default is @samp{:|.S.|:}.")
266 (doubleRepeatType ,string? "Set the default bar line for double
268 (doubleSlurs ,boolean? "If set, two slurs are created for every
269 slurred note, one above and one below the chord.")
270 (drumPitchTable ,hash-table? "A table mapping percussion
271 instruments (symbols) to pitches.")
272 (drumStyleTable ,hash-table? "A hash table which maps drums to
273 layout settings. Predefined values: @samp{drums-style},
274 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style}, and
275 @samp{percussion-style}.
277 The layout style is a hash table, containing the drum-pitches (e.g.,
278 the symbol @samp{hihat}) as keys, and a list
279 @code{(@var{notehead-style} @var{script} @var{vertical-position})} as
282 (endRepeatSegnoType ,string? "Set the default bar line for the
283 combinations ending of repeat with segno. Default is @samp{:|.S}.")
284 (endRepeatType ,string? "Set the default bar line for the ending
286 (explicitClefVisibility ,vector? "@samp{break-visibility}
287 function for clef changes.")
288 (explicitCueClefVisibility ,vector? "@samp{break-visibility}
289 function for cue clef changes.")
290 (explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
291 function for explicit key changes. @samp{\\override} of the
292 @code{break-visibility} property will set the visibility for
293 normal (i.e., at the start of the line) key signatures.")
294 (extendersOverRests ,boolean? "Whether to continue extenders as
296 (extraNatural ,boolean? "Whether to typeset an extra natural sign
297 before accidentals that reduce the effect of a previous alteration.")
300 (figuredBassAlterationDirection ,ly:dir? "Where to put alterations
301 relative to the main figure.")
302 (figuredBassCenterContinuations ,boolean? "Whether to vertically
303 center pairs of extender lines. This does not work with three or more
305 (figuredBassFormatter ,procedure? "A routine generating a markup
307 (figuredBassPlusDirection ,ly:dir? "Where to put plus signs
308 relative to the main figure.")
309 (fingeringOrientations ,list? "A list of symbols, containing
310 @samp{left}, @samp{right}, @samp{up} and/@/or @samp{down}. This list
311 determines where fingerings are put relative to the chord being
313 (firstClef ,boolean? "If true, create a new clef when starting a
315 (followVoice ,boolean? "If set, note heads are tracked across
316 staff switches by a thin line.")
317 (fontSize ,number? "The relative size of all grobs in a context.")
318 (forbidBreak ,boolean? "If set to @code{#t}, prevent a line break
320 (forceClef ,boolean? "Show clef symbol, even if it has not
321 changed. Only active for the first clef after the property is set, not
322 for the full staff.")
323 (fretLabels ,list? "A list of strings or Scheme-formatted markups
324 containing, in the correct order, the labels to be used for lettered
325 frets in tablature.")
328 (glissandoMap ,list? "A map in the form of
329 '((source1 . target1) (source2 . target2) (sourcen . targetn))
330 showing the glissandi to be drawn for note columns.
331 The value '() will default to
332 '((0 . 0) (1 . 1) (n . n)),
333 where n is the minimal number of note-heads in
334 the two note columns between which the glissandi occur.")
335 (gridInterval ,ly:moment? "Interval for which to generate
339 (handleNegativeFrets ,symbol? "How the automatic fret calculator
340 should handle calculated negative frets. Values include @code{'ignore},
341 to leave them out of the diagram completely, @code{'include}, to include
342 them as calculated, and @code{'recalculate}, to ignore the specified
343 string and find a string where they will fit with a positive fret number.")
344 (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
346 (harmonicDots ,boolean? "If set, harmonic notes in dotted chords get
348 (highStringOne ,boolean? "Whether the first string is the string
349 with highest pitch on the instrument. This used by the automatic
350 string selector for tablature notation.")
353 (ignoreBarChecks ,boolean? "Ignore bar checks.")
354 (ignoreFiguredBassRest ,boolean? "Don't swallow rest events.")
355 (ignoreMelismata ,boolean? "Ignore melismata for this
356 @rinternals{Lyrics} line.")
357 (implicitBassFigures ,list? "A list of bass figures that are not
358 printed as numbers, but only as extender lines.")
359 (implicitTimeSignatureVisibility ,vector? "break visibility for
360 the default time signature.")
361 (includeGraceNotes ,boolean? "Do not ignore grace notes for
362 @rinternals{Lyrics}.")
363 (instrumentCueName ,markup? "The name to print if another
364 instrument is to be taken.")
365 (instrumentEqualizer ,procedure? "A function taking a
366 string (instrument name), and returning a @code{(@var{min} . @var{max})}
367 pair of numbers for the loudness range of the instrument.")
368 (instrumentName ,markup? "The name to print left of a staff. The
369 @code{instrumentName} property labels the staff in the first system, and
370 the @code{shortInstrumentName} property labels following lines.")
371 (instrumentTransposition ,ly:pitch? "Define the transposition of
372 the instrument. Its value is the pitch that sounds when the instrument
373 plays written middle C. This is used to transpose the MIDI output,
374 and @code{\\quote}s.")
375 (internalBarNumber ,integer? "Contains the current barnumber.
376 This property is used for internal timekeeping, among others by the
377 @code{Accidental_engraver}.")
380 (keepAliveInterfaces ,list? "A list of symbols, signifying grob
381 interfaces that are worth keeping a staff with @code{remove-empty} set
383 (keyAlterationOrder ,list? "An alist that defines in what order
384 alterations should be printed. The format is
385 @code{(@var{step} . @var{alter})},
386 where @var{step} is a number from 0 to@tie{}6 and
387 @var{alter} from -2 (sharp) to 2 (flat).")
388 (keySignature ,list? "The current key signature. This is an alist
389 containing @code{(@var{step} . @var{alter})} or
390 @code{((@var{octave} . @var{step}) . @var{alter})}, where @var{step}
391 is a number in the range 0 to@tie{}6 and @var{alter} a fraction,
392 denoting alteration. For alterations, use symbols, e.g.
393 @code{keySignature = #`((6 . ,FLAT))}.")
396 (lyricMelismaAlignment ,number? "Alignment to use for a melisma syllable.")
399 (majorSevenSymbol ,markup? "How should the major 7th be formatted
401 (markFormatter ,procedure? "A procedure taking as arguments the
402 context and the rehearsal mark. It should return the formatted mark as
404 (maximumFretStretch ,number? "Don't allocate frets further than
405 this from specified frets.")
406 (measureLength ,ly:moment? "Length of one measure in the current
408 (measurePosition ,ly:moment? "How much of the current measure have
409 we had. This can be set manually to create incomplete measures.")
410 (melismaBusyProperties ,list? "A list of properties (symbols) to
411 determine whether a melisma is playing. Setting this property will
412 influence how lyrics are aligned to notes. For example, if set to
413 @code{'(melismaBusy beamMelismaBusy)}, only manual melismata and
414 manual beams are considered. Possible values include
415 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
416 @code{beamMelismaBusy}.")
417 (metronomeMarkFormatter ,procedure? "How to produce a metronome
418 markup. Called with two arguments: a @code{TempoChangeEvent} and context.")
419 (middleCClefPosition ,number? "The position of the middle C,
420 as determined only by the clef. This can be calculated by looking at
421 @code{clefPosition} and @code{clefGlyph}.")
422 (middleCCuePosition ,number? "The position of the middle C,
423 as determined only by the clef of the cue notes. This can be calculated by
424 looking at @code{cueClefPosition} and @code{cueClefGlyph}.")
425 (middleCOffset ,number? "The offset of
426 middle C from the position given by @code{middleCClefPosition} This
427 is used for ottava brackets.")
428 (middleCPosition ,number? "The place of the middle C, measured in
429 half staff-spaces. Usually determined by looking at
430 @code{middleCClefPosition} and @code{middleCOffset}.")
431 (midiInstrument ,string? "Name of the MIDI instrument to use.")
432 (midiMergeUnisons ,boolean? "If true, output only one MIDI note-on
433 event when notes with the same pitch, in the same MIDI-file track, overlap.")
434 (midiMaximumVolume ,number? "Analogous to
435 @code{midiMinimumVolume}.")
436 (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
437 Ranges from 0 to@tie{}1.")
438 (midiChannelMapping ,symbol? "How to map MIDI channels: per
439 @code{staff} (default), @code{instrument} or @code{voice}.")
440 (midiBalance ,number? "Stereo balance for the MIDI channel
441 associated with the current context. Ranges from@tie{}@w{-1} to@tie{}1,
442 where the values@tie{}@w{-1} (@code{#LEFT}),@tie{}0 (@code{#CENTER})
443 and@tie{}1 (@code{#RIGHT}) correspond to leftmost emphasis, center
444 balance, and rightmost emphasis, respectively.")
445 (midiPanPosition ,number? "Pan position for the MIDI channel
446 associated with the current context. Ranges from@tie{}@w{-1} to@tie{}1,
447 where the values@tie{}@w{-1} (@code{#LEFT}),@tie{}0 (@code{#CENTER})
448 and@tie{}1 (@code{#RIGHT}) correspond to hard left, center, and hard
449 right, respectively.")
450 (midiReverbLevel ,number? "Reverb effect level for the MIDI channel
451 associated with the current context. Ranges from 0 to@tie{}1
452 (0=off,@tie{}1=full effect).")
453 (midiChorusLevel ,number? "Chorus effect level for the MIDI channel
454 associated with the current context. Ranges from 0 to@tie{}1
455 (0=off,@tie{}1=full effect).")
456 (minimumFret ,number? "The tablature auto string-selecting
457 mechanism selects the highest string with a fret at least
458 @code{minimumFret}.")
459 (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a
460 page turn to be allowed.")
461 (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
462 repeated section for a page turn to be allowed within that section.")
464 (minorChordModifier ,markup? "Markup displayed following the root
467 (noChordSymbol ,markup? "Markup to be displayed for rests in a
468 ChordNames context.")
469 (noteToFretFunction ,procedure? "Convert list of notes and list of
470 defined strings to full list of strings and fret numbers.
471 Parameters: The context, a list of note events, a list of
472 tabstring events, and the fretboard grob if a fretboard is desired.")
475 (ottavation ,markup? "If set, the text for an ottava spanner.
476 Changing this creates a new text spanner.")
477 (output ,ly:music-output? "The output produced by a score-level
478 translator during music interpretation.")
481 (partCombineTextsOnNote ,boolean? "Print part-combine texts only on
482 the next note rather than immediately on rests or skips.")
483 (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
484 (pedalSostenutoStyle ,symbol? "See @code{pedalSustainStyle}.")
485 (pedalSustainStrings ,list? "A list of strings to print for
486 sustain-pedal. Format is @code{(@var{up} @var{updown} @var{down})},
487 where each of the three is the string to print when this is done with
489 (pedalSustainStyle ,symbol? "A symbol that indicates how to print
490 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
491 (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
492 (pedalUnaCordaStyle ,symbol? "See @code{pedalSustainStyle}.")
493 (predefinedDiagramTable ,hash-table? "The hash table of predefined
494 fret diagrams to use in FretBoards.")
495 (printKeyCancellation ,boolean? "Print restoration alterations
496 before a key signature change.")
497 (printOctaveNames ,boolean? "Print octave marks for the
498 @code{NoteNames} context.")
499 (printPartCombineTexts ,boolean? "Set @q{Solo} and @q{A due} texts
500 in the part combiner?")
501 (proportionalNotationDuration ,ly:moment? "Global override for
502 shortest-playing duration. This is used for switching on proportional
506 (rehearsalMark ,integer? "The last rehearsal mark printed.")
507 (repeatCommands ,list? "This property is a list of commands
508 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
509 @code{#f}. @code{'end-repeat} is also accepted as a command.")
510 (repeatCountVisibility ,procedure? "A procedure taking as
511 arguments an integer and context, returning whether the corresponding
512 percent repeat number should be printed when @code{countPercentRepeats}
514 (restCompletionBusy ,boolean? "Signal whether a completion-rest is active.")
515 (restNumberThreshold ,number? "If a multimeasure rest has more
516 measures than this, a number is printed.")
517 (restrainOpenStrings ,boolean? "Exclude open strings from the
518 automatic fret calculator.")
520 (searchForVoice ,boolean? "Signal whether a search should be made
521 of all contexts in the context hierarchy for a voice to provide rhythms
523 (segnoType ,string? "Set the default bar line for a requested segno.
524 Default is @samp{S}.")
525 (shapeNoteStyles ,vector? "Vector of symbols, listing style for
526 each note head relative to the tonic (qv.) of the scale.")
527 (shortInstrumentName ,markup? "See @code{instrumentName}.")
528 (shortVocalName ,markup? "Name of a vocal line, short version.")
529 (skipBars ,boolean? "If set to true, then skip the empty bars
530 that are produced by multimeasure notes and rests. These bars will
531 not appear on the printed output. If not set (the default),
532 multimeasure notes and rests expand into their full length, printing
533 the appropriate number of empty bars so that synchronization with other
539 \\set Score.skipBars= ##t
543 (skipTypesetting ,boolean? "If true, no typesetting is done,
544 speeding up the interpretation phase. Useful for debugging large
546 (soloIIText ,markup? "The text for the start of a solo for
547 voice @q{two} when part-combining.")
548 (soloText ,markup? "The text for the start of a solo when
550 (squashedPosition ,integer? "Vertical position of squashing for
551 @rinternals{Pitch_squash_engraver}.")
552 (staffLineLayoutFunction ,procedure? "Layout of staff lines,
553 @code{traditional}, or @code{semitone}.")
554 (stanza ,markup? "Stanza @q{number} to print before the start of a
555 verse. Use in @code{Lyrics} context.")
556 (startRepeatSegnoType ,string? "Set the default bar line for the
557 combinations beginning of repeat with segno. Default is @samp{S.|:}.")
558 (startRepeatType ,string? "Set the default bar line for the beginning
560 (stemLeftBeamCount ,integer? "Specify the number of beams to draw
561 on the left side of the next note. Overrides automatic beaming. The
562 value is only used once, and then it is erased.")
563 (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
564 (strictBeatBeaming ,boolean? "Should partial beams reflect the
565 beat structure even if it causes flags to hang out?")
566 (stringNumberOrientations ,list? "See
567 @code{fingeringOrientations}.")
568 (stringOneTopmost ,boolean? "Whether the first string is
569 printed on the top line of the tablature.")
570 (stringTunings ,list? "The tablature strings tuning. It is a list
571 of the pitches of each string (starting with the lowest numbered
573 (strokeFingerOrientations ,list? "See
574 @code{fingeringOrientations}.")
575 (subdivideBeams ,boolean? "If set, multiple beams will be
576 subdivided at @code{baseMoment} positions by only drawing one beam over the beat.")
577 (suggestAccidentals ,boolean? "If set, accidentals are typeset as
578 cautionary suggestions over the note.")
579 (systemStartDelimiter ,symbol? "Which grob to make for the start
580 of the system/@/staff? Set to @code{SystemStartBrace},
581 @code{SystemStartBracket} or @code{SystemStartBar}.")
582 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating
583 the nesting of a start delimiters.")
586 (tablatureFormat ,procedure? "A function formatting a tablature
587 note head. Called with three arguments: context, string number and,
588 fret number. It returns the text as a markup.")
589 (tabStaffLineLayoutFunction ,procedure? "A function determining the
590 staff position of a tablature note head. Called with two arguments:
591 the context and the string.")
592 (tempoHideNote ,boolean? "Hide the note = count in tempo marks.")
593 (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
595 (tieWaitForNote ,boolean? "If true, tied notes do not have to
596 follow each other directly. This can be used for writing out
598 (timeSignatureFraction ,fraction? "A pair of numbers,
599 signifying the time signature. For example, @code{'(4 . 4)} is a
600 4/4 time signature.")
601 (timeSignatureSettings ,cheap-list? "A nested alist of settings for
602 time signatures. Contains elements for various time signatures. The
603 element for each time signature contains entries for @code{baseMoment},
604 @code{beatStructure}, and @code{beamExceptions}.")
605 (timing ,boolean? "Keep administration of measure length,
606 position, bar number, etc.? Switch off for cadenzas.")
607 (tonic ,ly:pitch? "The tonic of the current scale.")
608 (topLevelAlignment ,boolean? "If true, the @var{Vertical_align_engraver}
609 will create a @var{VerticalAlignment}; otherwise, it will create a
611 (trebleStaffProperties ,list? "An alist of property settings to
612 apply for the up staff of @code{PianoStaff}. Used by
613 @code{\\autochange}.")
614 (tremoloFlags ,integer? "The number of tremolo flags to add if no
615 number is specified.")
616 (tupletFullLength ,boolean? "If set, the tuplet is printed up to
617 the start of the next note.")
618 (tupletFullLengthNote ,boolean? "If set, end at the next note,
619 otherwise end on the matter (time signatures, etc.) before the note.")
620 (tupletSpannerDuration ,ly:moment? "Normally, a tuplet bracket is
621 as wide as the @code{\\times} expression that gave rise to it. By
622 setting this property, you can make brackets last shorter.
626 \\set tupletSpannerDuration = #(ly:make-moment 1 4)
627 \\times 2/3 @{ c8 c c c c c @}
632 (useBassFigureExtenders ,boolean? "Whether to use extender lines
633 for repeated bass figures.")
635 (vocalName ,markup? "Name of a vocal line.")
636 (voltaSpannerDuration ,ly:moment? "This specifies the maximum
637 duration to use for the brackets printed for @code{\\alternative}.
638 This can be used to shrink the length of brackets in the situation
639 where one alternative is very large.")
642 (whichBar ,string? "This property is read to determine what type
643 of bar line to create.
648 \\set Staff.whichBar = \".|:\"
652 This will create a start-repeat bar in this staff only. Valid values
653 are described in @file{scm/bar-line.scm}.")
657 (define-public all-internal-translation-properties
660 (set-object-property! (car x) 'internal-translation #t)
661 (apply translator-property-description x))
665 (associatedVoiceContext ,ly:context? "The context object of the
666 @code{Voice} that has the melody for this @code{Lyrics}.")
669 (barCheckLastFail ,ly:moment? "Where in the measure did the last
671 (beamMelismaBusy ,boolean? "Signal if a beam is present.")
672 (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
673 @var{grob})} cons cells. This is for internal (C++) use only. This
674 property contains the grobs which are still busy (e.g. note heads,
678 (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
679 current breakable (clef, key signature, etc.) items.")
680 (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
681 non-breakable items (note heads, lyrics, etc.).")
684 (dynamicAbsoluteVolumeFunction ,procedure? "A procedure that takes
685 one argument, the text value of a dynamic event, and returns the absolute
686 volume of that dynamic event.")
689 (finalizations ,list? "A list of expressions to evaluate before
690 proceeding to next time step. This is an internal variable.")
693 (graceSettings ,list? "Overrides for grace notes. This property
694 should be manipulated through the @code{add-grace-property} function.")
697 (hasAxisGroup ,boolean? "True if the current context is contained
699 (hasStaffSpacing ,boolean? "True if the current
700 @code{CommandColumn} contains items that will affect spacing.")
703 (lastKeySignature ,list? "Last key signature before a key
705 (localKeySignature ,list? "The key signature at this point in the
706 measure. The format is the same as for @code{keySignature}, but can
707 also contain @code{((@var{octave} . @var{name}) . (@var{alter}
708 @var{barnumber} . @var{measureposition}))} pairs.")
711 (melismaBusy ,boolean? "Signifies whether a melisma is active.
712 This can be used to signal melismas on top of those automatically
716 (quotedCueEventTypes ,list? "A list of symbols, representing the
717 event types that should be duplicated for @code{\\cueDuring} commands.")
718 (quotedEventTypes ,list? "A list of symbols, representing the
719 event types that should be duplicated for @code{\\quoteDuring} commands.
720 This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
724 (rootSystem ,ly:grob? "The System object.")
727 (scriptDefinitions ,list? "The description of scripts. This is
728 used by the @code{Script_engraver} for typesetting note-superscripts
729 and subscripts. See @file{scm/@/script.scm} for more information.")
730 (slurMelismaBusy ,boolean? "Signal if a slur is present.")
731 (stavesFound ,grob-list? "A list of all staff-symbols found.")
734 (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
737 (define-public all-translation-properties
738 (append all-user-translation-properties
739 all-internal-translation-properties))
741 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
743 (define-public default-melisma-properties
744 '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy))