1 ;;;; define-context-properties.scm -- part of backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 (define-public all-translation-properties '())
11 (define (translator-property-description symbol type? description)
15 (string? description)))
16 (throw 'init-format-error))
19 (if (not (equal? #f (object-property symbol 'translation-doc)))
20 (ly:error (_ "symbol ~S redefined" symbol)))
22 (set-object-property! symbol 'translation-type? type?)
23 (set-object-property! symbol 'translation-doc description)
24 (set! all-translation-properties (cons symbol all-translation-properties))
28 (define-public all-user-translation-properties
31 (apply translator-property-description x))
36 (aDueText ,markup? "Text to print at a unisono passage.")
37 (alignBelowContext ,string? "Where to insert newly created context in
38 vertiical alignment.")
39 (alignAboveContext ,string? "Where to insert newly created context in
40 vertiical alignment.")
41 (alignBassFigureAccidentals ,boolean? "If true, then the accidentals
42 are aligned in bass figure context.")
43 (associatedVoice ,string? "Name of the @code{Voice} that has the
44 melody for this @code{Lyrics} line.")
45 (autoAccidentals ,list? "List of different ways to typeset an
48 For determining when to print an accidental, several different rules
49 are tried. The rule that gives the highest number of accidentals is
52 Each entry in the list is either a symbol or a procedure.
57 The symbol is the name of the context in which the following rules are to be
58 applied. For example, if @var{context} is @rinternals{Score} then all
59 staves share accidentals, and if @var{context} is @rinternals{Staff} then
60 all voices in the same staff share accidentals, but staves do not.
63 The procedure represents an accidental rule to be applied to the previously
66 The procedure takes the following arguments:
71 The current context to which the rule should be applied.
74 The pitch of the note to be evaluated.
77 The current bar number.
80 The current measure position.
84 The procedure returns a pair of booleans. The first states whether an extra
85 natural should be added. The second states whether an accidental should be
86 printed. @code{(#t . #f)} does not make sense.
89 (autoBeamCheck ,procedure? "A procedure taking three
90 arguments, @var{context}, @var{dir} [start/stop (-1 or 1)], and
91 @var{test} [shortest note in the beam]. A non-@code{#f} return value
92 starts or stops the auto beam.")
93 (autoBeamSettings ,list? "Specifies when automatically generated
94 beams should begin and end. See @ruser{Setting automatic beam
95 behavior} for more information.")
96 (autoBeaming ,boolean? "If set to true then beams are generated
98 (autoCautionaries ,list? "List similar to @code{autoAccidentals},
99 but it controls cautionary accidentals rather than normal ones. Both
100 lists are tried, and the one giving the most accidentals wins. In
101 case of draw, a normal accidental is typeset.")
102 (automaticBars ,boolean? "If set to true then bar lines will not
103 be printed automatically; they must be explicitly created with a
104 @code{\\bar} command. Unlike the @code{\\cadenza} keyword, measures
105 are still counted. Bar generation will resume according to that count
106 if this property is unset.")
109 (barAlways ,boolean? "If set to true a bar line is drawn after
111 (barCheckSynchronize ,boolean? "If true then reset
112 @code{measurePosition} when finding a bar check.")
113 (barNumberVisibility ,procedure? "A Procedure that takes an
114 integer and returns whether the corresponding bar number should be
116 (bassFigureFormatFunction ,procedure? "A procedure that is
117 called to produce the formatting for a @code{BassFigure} grob. It
118 takes a list of @code{BassFigureEvent}s, a context, and the grob to
120 (bassStaffProperties ,list? "An alist of property settings to
121 apply for the down staff of @code{PianoStaff}. Used by
122 @code{\\autochange}.")
123 (beatLength ,ly:moment? "The length of one beat in this time
125 (beatGrouping ,list? "A list of beatgroups, e.g., in 5/8 time
129 (chordChanges ,boolean? "Only show changes in chords scheme?")
130 (chordNameFunction ,procedure? "The function that converts lists
131 of pitches to chord names.")
132 (chordNameExceptions ,list? "An alist of chord exceptions.
133 Contains @code{(@var{chord} . @var{markup})} entries.")
134 (chordNameExceptionsFull ,list? "An alist of full chord
135 exceptions. Contains @code{(@var{chord} . @var{markup})} entries.")
136 (chordNameExceptionsPartial ,list? "An alist of partial chord
137 exceptions. Contains @code{(@var{chord} . (@var{prefix-markup}
138 @var{suffix-markup}))} entries.")
139 (chordNameSeparator ,markup? "The markup object used to
140 separate parts of a chord name.")
141 (chordNoteNamer ,procedure? "A function that converts from a pitch
142 object to a text markup. Used for single pitches.")
143 (chordPrefixSpacer ,number? "The space added between the root
144 symbol and the prefix of a chord name.")
145 (chordRootNamer ,procedure? "A function that converts from a pitch
146 object to a text markup. Used for chords.")
147 (clefGlyph ,string? "Name of the symbol within the music font.")
148 (clefOctavation ,integer? "Add this much extra octavation.
149 Values of 7 and -7 are common.")
150 (clefPosition ,number? "Where should the center of the clef
151 symbol go, measured in half staff spaces from the center of the
153 (completionBusy ,boolean? "Whether a completion-note head is playing.")
154 (connectArpeggios ,boolean? "If set, connect arpeggios across
156 (countPercentRepeats ,boolean? "If set, produce counters for
158 (createKeyOnClefChange ,boolean? "Print a key signature whenever
159 the clef is changed.")
160 (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
161 Should be set for staves.")
162 (crescendoText ,markup? "The text to print at start of non-hairpin
163 crescendo, i.e., @samp{cresc.}.")
164 (crescendoSpanner ,symbol? "The type of spanner to be used for
165 crescendi. Available values are @samp{hairpin}, @samp{line},
166 @samp{dashed-line}, @samp{dotted-line}. If unset, a hairpin crescendo
168 (currentBarNumber ,integer? "Contains the current barnumber.
169 This property is incremented at every bar line.")
172 (decrescendoSpanner ,symbol? "See @code{crescendoSpanner}.")
173 (decrescendoText ,markup? "The text to print at start of
174 non-hairpin decrescendo, i.e., @samp{dim.}.")
175 (defaultBarType ,string? "Set the default type of bar line. See
176 @code{whichBar} for information on available bar types.
178 This variable is read by @rinternals{Timing_translator} at
179 @rinternals{Score} level.")
180 (doubleSlurs ,boolean? "If set, two slurs are created for every
181 slurred note, one above and one below the chord.")
182 (drumPitchTable ,hash-table? "A table mapping percussion
183 instruments (symbols) to pitches.")
184 (drumStyleTable ,hash-table? "A hash table which maps drums to
185 layout settings. Predefined values: @samp{drums-style},
186 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style}, and
187 @samp{percussion-style}.
189 The layout style is a hash table, containing the drum-pitches (e.g.,
190 the symbol @samp{hihat}) as keys, and a list
191 @code{(@var{notehead-style} @var{script} @var{vertical-position})} as
195 (explicitClefVisibility ,vector? "@samp{break-visibility}
196 function for clef changes.")
197 (explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
198 function for explicit key changes. @samp{\\override} of the
199 @code{break-visibility} property will set the visibility for normal
200 (i.e., at the start of the line) key signatures.")
201 (extendersOverRests ,boolean? "Whether to continue extenders as
203 (extraNatural ,boolean? "Whether to typeset an extra natural sign
204 before accidentals changing from a non-natural to another
208 (figuredBassAlterationDirection ,ly:dir? "Where to put alterations
209 relative to the main figure.")
210 (figuredBassCenterContinuations ,boolean? "Whether to vertically
211 center pairs of extender lines. This does not work with three or more
213 (figuredBassFormatter ,procedure? "A routine generating a markup
215 (figuredBassPlusDirection ,ly:dir? "Where to put plus signs
216 relative to the main figure.")
217 (fingeringOrientations ,list? "A list of symbols, containing
218 @samp{left}, @samp{right}, @samp{up} and/or @samp{down}. This list
219 determines where fingerings are put relative to the chord being
221 (firstClef ,boolean? "If true, create a new clef when starting a
223 (followVoice ,boolean? "If set, note heads are tracked across
224 staff switches by a thin line.")
225 (fontSize ,number? "The relative size of all grobs in a context.")
226 (forbidBreak ,boolean? "If set to @code{##t}, prevent a line break
228 (forceClef ,boolean? "Show clef symbol, even if it has not
229 changed. Only active for the first clef after the property is set, not
230 for the full staff.")
233 (gridInterval ,ly:moment? "Interval for which to generate
237 (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
239 (harmonicDots ,boolean? "If set, harmonic notes in dotted chords get
241 (highStringOne ,boolean? "Whether the first string is the string
242 with highest pitch on the instrument. This used by the automatic
243 string selector for tablature notation.")
246 (ignoreBarChecks ,boolean? "Ignore bar checks.")
247 (ignoreFiguredBassRest ,boolean? "Don't swallow rest events.")
248 (ignoreMelismata ,boolean? "Ignore melismata for this
249 @rinternals{Lyrics} line.")
250 (implicitBassFigures ,list? "A list of bass figures that are not
251 printed as numbers, but only as extender lines.")
252 (implicitTimeSignatureVisibility ,vector? "break visibility for
253 the default time signature.")
254 (instrumentCueName ,markup? "The name to print if another
255 instrument is to be taken.")
256 (instrumentName ,markup? "The name to print left of a staff. The
257 @code{instrument} property labels the staff in the first system, and
258 the @code{instr} property labels following lines.")
259 (instrumentEqualizer ,procedure? "A function taking a string
260 (instrument name), and returning a @code{(@var{min} . @var{max})} pair
261 of numbers for the loudness range of the instrument.")
262 ;; the definition is reversed wrt traditional transposition
263 ;; otherwise \transpose { \transposition .. } won't work
264 (instrumentTransposition ,ly:pitch? "Define the transposition of
265 the instrument. Its value is the pitch that sounds like middle@tie{}C.
266 This is used to transpose the MIDI output, and @code{\\quote}s.")
267 (internalBarNumber ,integer? "Contains the current barnumber.
268 This property is used for internal timekeeping, among others by the
269 @code{Accidental_engraver}.")
272 (keepAliveInterfaces ,list? "A list of symbols, signifying grob
273 interfaces that are worth keeping a staff with @code{remove-empty} set
275 (keyAlterationOrder ,list? "An alist that defines in what order
276 alterations should be printed. The format is @code{(@var{step}
277 . @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and
278 @var{alter} from -2 (sharp) to 2 (flat).")
279 (keySignature ,list? "The current key signature. This is an alist
280 containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} .
281 @var{step}) . @var{alter})}, where @var{step} is a number in the range
282 0 to@tie{}6 and @var{alter} a fraction, denoting alteration. For
283 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.")
286 (lyricMelismaAlignment ,ly:dir? "Alignment to use for a melisma syllable.")
289 (majorSevenSymbol ,markup? "How should the major 7th be formatted
291 (markFormatter ,procedure? "A procedure taking as arguments the
292 context and the rehearsal mark. It should return the formatted mark as
294 (maximumFretStretch ,number? "Don't allocate frets further than
295 this from specified frets.")
296 (measureLength ,ly:moment? "Length of one measure in the current
298 (measurePosition ,ly:moment? "How much of the current measure have
299 we had. This can be set manually to create incomplete measures.")
300 (melismaBusyProperties ,list? "A list of properties (symbols) to
301 determine whether a melisma is playing. Setting this property will
302 influence how lyrics are aligned to notes. For example, if set to
303 @code{#'(melismaBusy beamMelismaBusy)}, only manual melismata and
304 manual beams are considered. Possible values include
305 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
306 @code{beamMelismaBusy}.")
307 (metronomeMarkFormatter ,procedure? "How to produce a metronome
308 markup. Called with four arguments: text, duration, count and context.")
309 (midiInstrument ,string? "Name of the MIDI instrument to use.")
310 (midiMaximumVolume ,number? "Analogous to
311 @code{midiMinimumVolume}.")
312 (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
313 Ranges from 0 to@tie{}1.")
314 (middleCClefPosition ,number? "The position of the middle C,
315 as determined only by the clef. This can be calculated by looking at
316 @code{clefPosition} and @code{clefGlyph}.")
317 (middleCOffset ,number? "The offset of
318 middle C from the position given by @code{middleCClefPosition} This
319 is used for ottava brackets.")
320 (middleCPosition ,number? "The place of the middle C, measured in
321 half staff-spaces. Usually determined by looking at
322 @code{middleCClefPosition} and @code{middleCOffset}.")
323 (minimumFret ,number? "The tablature auto string-selecting
324 mechanism selects the highest string with a fret at least
325 @code{minimumFret}.")
326 (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a
327 page turn to be allowed.")
328 (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
329 repeated section for a page turn to be allowed within that section.")
332 (noteToFretFunction ,procedure? "How to produce a fret diagram.
333 Parameters: A list of note events and a list of tabstring events.")
336 (ottavation ,markup? "If set, the text for an ottava spanner.
337 Changing this creates a new text spanner.")
338 (output ,ly:music-output? "The output produced by a score-level
339 translator during music interpretation.")
342 (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
343 (pedalSostenutoStyle ,symbol? "See @code{pedalSustainStyle}.")
344 (pedalSustainStrings ,list? "A list of strings to print for
345 sustain-pedal. Format is @code{(@var{up} @var{updown} @var{down})},
346 where each of the three is the string to print when this is done with
348 (pedalSustainStyle ,symbol? "A symbol that indicates how to print
349 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
350 (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
351 (pedalUnaCordaStyle ,symbol? "See @code{pedalSustainStyle}.")
352 (predefinedDiagramTable ,hash-table? "The hash table of predefined
353 fret diagrams to use in FretBoards.")
354 (printKeyCancellation ,boolean? "Print restoration alterations
355 before a key signature change.")
356 (printOctaveNames ,boolean? "Print octave marks for the
357 @code{NoteNames} context.")
358 (printPartCombineTexts ,boolean? "Set @q{Solo} and @q{A due} texts
359 in the part combiner?")
360 (proportionalNotationDuration ,ly:moment? "Global override for
361 shortest-playing duration. This is used for switching on proportional
365 (recordEventSequence ,procedure? "When
366 @code{Recording_group_engraver} is in this context, then upon
367 termination of the context, this function is called with current
368 context and a list of music objects. The list of contains entries with
369 start times, music objects and whether they are processed in this
371 (rehearsalMark ,integer? "The last rehearsal mark printed.")
372 (repeatCommands ,list? "This property is a list of commands
373 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
374 @code{#f}. @code{'end-repeat} is also accepted as a command.")
375 (restNumberThreshold ,number? "If a multimeasure rest has more
376 measures than this, a number is printed.")
379 (shapeNoteStyles ,vector? "Vector of symbols, listing style for
380 each note head relative to the tonic (qv.) of the scale.")
381 (shortInstrumentName ,markup? "See @code{instrument}.")
382 (shortVocalName ,markup? "Name of a vocal line, short version.")
383 (skipBars ,boolean? "If set to true, then skip the empty bars
384 that are produced by multimeasure notes and rests. These bars will
385 not appear on the printed output. If not set (the default),
386 multimeasure notes and rests expand into their full length, printing
387 the appropriate number of empty bars so that synchronization with other
393 \\set Score.skipBars= ##t
397 (skipTypesetting ,boolean? "If true, no typesetting is done,
398 speeding up the interpretation phase. Useful for debugging large
400 (soloIIText ,markup? "The text for the start of a solo for
401 voice @q{two} when part-combining.")
402 (soloText ,markup? "The text for the start of a solo when
404 (squashedPosition ,integer? "Vertical position of squashing for
405 @rinternals{Pitch_squash_engraver}.")
406 (staffLineLayoutFunction ,procedure? "Layout of staff lines,
407 @code{traditional}, or @code{semitone}.")
408 (stanza ,markup? "Stanza @q{number} to print before the start of a
409 verse. Use in @code{Lyrics} context.")
410 (stemLeftBeamCount ,integer? "Specify the number of beams to draw
411 on the left side of the next note. Overrides automatic beaming. The
412 value is only used once, and then it is erased.")
413 (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
414 (stringNumberOrientations ,list? "See
415 @code{fingeringOrientations}.")
416 (stringOneTopmost ,boolean? "Whether the first string is
417 printed on the top line of the tablature.")
418 (stringTunings ,list? "The tablature strings tuning. It is a list
419 of the pitch (in semitones) of each string (starting with the lower
421 (strokeFingerOrientations ,list? "See
422 @code{fingeringOrientations}.")
423 (subdivideBeams ,boolean? "If set, multiple beams will be
424 subdivided at beat positions by only drawing one beam over the beat.")
425 (suggestAccidentals ,boolean? "If set, accidentals are typeset as
426 cautionary suggestions over the note.")
427 (systemStartDelimiter ,symbol? "Which grob to make for the start
428 of the system/staff? Set to @code{SystemStartBrace},
429 @code{SystemStartBracket} or @code{SystemStartBar}.")
430 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating
431 the nesting of a start delimiters.")
434 (tablatureFormat ,procedure? "A function formatting a tablature
435 note head. Called with three arguments: string number, context and event.
436 It returns the text as a string.")
437 (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
439 (tempoUnitCount ,number? "Count for specifying tempo.")
440 (tempoUnitDuration ,ly:duration? "Unit for specifying tempo.")
441 (tempoText ,markup? "Text for tempo marks.")
442 (tempoHideNote ,boolean? "Hide the note=count in tempo marks.")
443 (tieWaitForNote ,boolean? "If true, tied notes do not have to
444 follow each other directly. This can be used for writing out
446 (timeSignatureFraction ,number-pair? "A pair of numbers,
447 signifying the time signature. For example, @code{#'(4 . 4)} is a
448 4/4 time signature.")
449 (timing ,boolean? "Keep administration of measure length,
450 position, bar number, etc.? Switch off for cadenzas.")
451 (tonic ,ly:pitch? "The tonic of the current scale.")
452 (trebleStaffProperties ,list? "An alist of property settings to
453 apply for the up staff of @code{PianoStaff}. Used by
454 @code{\\autochange}.")
455 (tremoloFlags ,integer? "The number of tremolo flags to add if no
456 number is specified.")
457 (tupletFullLength ,boolean? "If set, the tuplet is printed up to
458 the start of the next note.")
459 (tupletFullLengthNote ,boolean? "If set, end at the next note,
460 otherwise end on the matter (time signatures, etc.) before the note.")
461 (tupletSpannerDuration ,ly:moment? "Normally, a tuplet bracket is
462 as wide as the @code{\\times} expression that gave rise to it. By
463 setting this property, you can make brackets last shorter.
467 \\set tupletSpannerDuration = #(ly:make-moment 1 4)
468 \\times 2/3 @{ c8 c c c c c @}
473 (useBassFigureExtenders ,boolean? "Whether to use extender lines
474 for repeated bass figures.")
476 (verticallySpacedContexts ,list? "List of symbols, containing
477 context names whose vertical axis groups should be taken into account
478 for vertical spacing of systems.")
479 (vocalName ,markup? "Name of a vocal line.")
480 (voltaSpannerDuration ,ly:moment? "This specifies the maximum
481 duration to use for the brackets printed for @code{\\alternative}.
482 This can be used to shrink the length of brackets in the situation
483 where one alternative is very large.")
486 (whichBar ,string? "This property is read to determine what type
487 of bar line to create.
492 \\set Staff.whichBar = \"|:\"
496 This will create a start-repeat bar in this staff only. Valid values
497 are described in @rinternals{bar-line-interface}.")
501 (define-public all-internal-translation-properties
504 (set-object-property! (car x) 'internal-translation #t)
505 (apply translator-property-description x))
509 (associatedVoiceContext ,ly:context? "The context object of the
510 @code{Voice} that has the melody for this @code{Lyrics}.")
513 (barCheckLastFail ,ly:moment? "Where in the measure did the last
515 (beamMelismaBusy ,boolean? "Signal if a beam is present.")
516 (breakableSeparationItem ,ly:grob? "The breakable items in this
517 time step, for this staff.")
518 (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
519 @var{GROB})} cons cells. This is for internal (C++) use only. This
520 property contains the grobs which are still busy (e.g. note heads,
524 (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
525 current breakable (clef, key signature, etc.) items.")
526 (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
527 non-breakable items (note heads, lyrics, etc.).")
530 (dynamicAbsoluteVolumeFunction ,procedure? "[DOCUMENT-ME]")
533 (finalizations ,list? "A list of expressions to evaluate before
534 proceeding to next time step. This is an internal variable.")
537 (graceSettings ,list? "Overrides for grace notes. This property
538 should be manipulated through the @code{add-grace-property} function.")
541 (hasStaffSpacing ,boolean? "True if the current
542 @code{CommandColumn} contains items that will affect spacing.")
545 (instrumentSupport ,grob-list? "A list of grobs to attach the
546 instrument name to.")
549 (lastKeySignature ,list? "Last key signature before a key
551 (localKeySignature ,list? "The key signature at this point in the
552 measure. The format is the same as for @code{keySignature}, but can
553 also contain @code{((@var{octave} . @var{name}) . (@var{alter}
554 @var{barnumber} . @var{measureposition}))} pairs.")
557 (melismaBusy ,boolean? "Signifies whether a melisma is active.
558 This can be used to signal melismas on top of those automatically
562 (originalMiddleCPosition ,integer? "Used for temporary overriding
563 middle@tie{}C in octavation brackets.")
566 (quotedEventTypes ,list? "A list of symbols, representing the
567 event types that should be duplicated for @code{\\quote} commands.")
568 ; (quotes ,hash-table? "A hash table, mapping names to
569 ;@code{music-event} vectors.")
572 (rootSystem ,ly:grob? "The System object.")
575 (scriptDefinitions ,list? "The description of scripts. This is
576 used by the @code{Script_engraver} for typesetting note-superscripts
577 and subscripts. See @file{scm/script.scm} for more information.")
578 (slurMelismaBusy ,boolean? "Signal if a slur is present.")
579 (stavesFound ,grob-list? "A list of all staff-symbols found.")
582 (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
585 (define-public all-translation-properties
586 (append all-user-translation-properties
587 all-internal-translation-properties))
589 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
591 (define-public default-melisma-properties
592 '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy))