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