scm/define-context-properties.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2011  Han-Wen Nienhuys <hanwen@xs4all.nl>
   4 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
   5 ;;;;
   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.
  10 ;;;;
  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.
  15 ;;;;
  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/>.
  18
  19
  20 (define-public all-translation-properties '())
  21
  22 (define (translator-property-description symbol type? description)
  23   (if (not (and
  24             (symbol? symbol)
  25             (procedure? type?)
  26             (string? description)))
  27       (throw 'init-format-error))
  28
  29
  30   (if (not (equal? #f (object-property symbol 'translation-doc)))
  31       (ly:error (_ "symbol ~S redefined" symbol)))
  32
  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))
  36   symbol)
  37
  38
  39 (define-public all-user-translation-properties
  40   (map
  41    (lambda (x)
  42      (apply translator-property-description x))
  43    `(
  44
  45      ;; TODO FIXME
  46
  47      (aDueText ,markup? "Text to print at a unisono passage.")
  48      (additionalPitchPrefix ,string? "Text with which to prefix
  49 additional pitches within a chord name.")
  50      (alignAboveContext ,string? "Where to insert newly created context in
  51 vertical alignment.")
  52      (alignBassFigureAccidentals ,boolean? "If true, then the accidentals
  53 are aligned in bass figure context.")
  54      (alignBelowContext ,string? "Where to insert newly created context in
  55 vertical alignment.")
  56      (alternativeNumberingStyle ,symbol? "The style of an alternative's bar
  57 numbers.  Can be @code{numbers} for going back to the same number or
  58 @code{numbers-with-letters} for going back to the same number with letter
  59 suffixes.  No setting will not go back in measure-number time.")
  60      (associatedVoice ,string? "Name of the @code{Voice} that has the
  61 melody for this @code{Lyrics} line.")
  62      (autoAccidentals ,list? "List of different ways to typeset an
  63 accidental.
  64
  65 For determining when to print an accidental, several different rules
  66 are tried.  The rule that gives the highest number of accidentals is
  67 used.
  68
  69 Each entry in the list is either a symbol or a procedure.
  70
  71 @table @var
  72
  73 @item symbol
  74 The symbol is the name of the context in which the following rules are to be
  75 applied.  For example, if @var{context} is @rinternals{Score} then all
  76 staves share accidentals, and if @var{context} is @rinternals{Staff} then
  77 all voices in the same staff share accidentals, but staves do not.
  78
  79 @item procedure
  80 The procedure represents an accidental rule to be applied to the previously
  81 specified context.
  82
  83 The procedure takes the following arguments:
  84
  85 @table @code
  86
  87 @item context
  88 The current context to which the rule should be applied.
  89
  90 @item pitch
  91 The pitch of the note to be evaluated.
  92
  93 @item barnum
  94 The current bar number.
  95
  96 @item measurepos
  97 The current measure position.
  98
  99 @end table
 100
 101 The procedure returns a pair of booleans.  The first states whether an extra
 102 natural should be added.  The second states whether an accidental should be
 103 printed.  @code{(#t . #f)} does not make sense.
 104
 105 @end table")
 106      (autoBeamCheck ,procedure? "A procedure taking three
 107 arguments, @var{context}, @var{dir} [start/@/stop (-1 or 1)], and
 108 @var{test} [shortest note in the beam].  A non-@code{#f} return value
 109 starts or stops the auto beam.")
 110      (autoBeaming ,boolean? "If set to true then beams are generated
 111 automatically.")
 112      (autoCautionaries ,list? "List similar to @code{autoAccidentals},
 113 but it controls cautionary accidentals rather than normal ones.  Both
 114 lists are tried, and the one giving the most accidentals wins.  In
 115 case of draw, a normal accidental is typeset.")
 116      (automaticBars ,boolean? "If set to false then bar lines will not
 117 be printed automatically; they must be explicitly created with a
 118 @code{\\bar} command.  Unlike the @code{\\cadenzaOn} keyword, measures
 119 are still counted.  Bar line generation will resume according to that
 120 count if this property is unset.")
 121
 122
 123      (barAlways ,boolean? "If set to true a bar line is drawn after
 124 each note.")
 125      (barCheckSynchronize ,boolean? "If true then reset
 126 @code{measurePosition} when finding a bar check.")
 127      (barNumberVisibility ,procedure? "A Procedure that takes an
 128 integer and returns whether the corresponding bar number should be
 129 printed.")
 130      (baseMoment ,ly:moment? "Smallest unit of time that will stand on its
 131 own as a subdivided section.")
 132      (bassFigureFormatFunction ,procedure? "A procedure that is
 133 called to produce the formatting for a @code{BassFigure} grob.  It
 134 takes a list of @code{BassFigureEvent}s, a context, and the grob to
 135 format.")
 136      (bassStaffProperties ,list? "An alist of property settings to
 137 apply for the down staff of @code{PianoStaff}.  Used by
 138 @code{\\autochange}.")
 139      (beamExceptions ,list? "An alist of exceptions to autobeam rules
 140 that normally end on beats.")
 141      (beatStructure ,list? "List of @code{baseMoment}s that are combined
 142 to make beats.")
 143
 144      (chordChanges ,boolean? "Only show changes in chords scheme?")
 145      (chordNameExceptions ,list? "An alist of chord exceptions.
 146 Contains @code{(@var{chord} . @var{markup})} entries.")
 147      (chordNameExceptionsFull ,list? "An alist of full chord
 148 exceptions.  Contains @code{(@var{chord} . @var{markup})} entries.")
 149      (chordNameExceptionsPartial ,list? "An alist of partial chord
 150 exceptions.  Contains @code{(@var{chord} . (@var{prefix-markup}
 151 @var{suffix-markup}))} entries.")
 152      (chordNameFunction ,procedure? "The function that converts lists
 153 of pitches to chord names.")
 154      (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
 155      (chordNameSeparator ,markup? "The markup object used to
 156 separate parts of a chord name.")
 157      (slashChordSeparator ,markup? "The markup object used to separate
 158 a chord name from its root note in case of inversions or slash
 159 chords.")
 160      (chordNoteNamer ,procedure? "A function that converts from a pitch
 161 object to a text markup.  Used for single pitches.")
 162      (chordPrefixSpacer ,number? "The space added between the root
 163 symbol and the prefix of a chord name.")
 164      (chordRootNamer ,procedure? "A function that converts from a pitch
 165 object to a text markup.  Used for chords.")
 166      (clefGlyph ,string? "Name of the symbol within the music font.")
 167      (clefOctavation ,integer? "Add this much extra octavation.
 168 Values of 7 and -7 are common.")
 169      (clefPosition ,number? "Where should the center of the clef
 170 symbol go, measured in half staff spaces from the center of the
 171 staff.")
 172      (completionBusy ,boolean? "Whether a completion-note head is playing.")
 173      (connectArpeggios ,boolean? "If set, connect arpeggios across
 174 piano staff.")
 175      (countPercentRepeats ,boolean? "If set, produce counters for
 176 percent repeats.")
 177      (createKeyOnClefChange ,boolean? "Print a key signature whenever
 178 the clef is changed.")
 179      (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
 180 Should be set for staves.")
 181      (crescendoSpanner ,symbol? "The type of spanner to be used for
 182 crescendi.  Available values are @samp{hairpin} and @samp{text}.  If unset,
 183 a hairpin crescendo is used.")
 184      (crescendoText ,markup? "The text to print at start of non-hairpin
 185 crescendo, i.e., @samp{cresc.}.")
 186      (cueClefGlyph ,string? "Name of the symbol within the music font.")
 187      (cueClefOctavation ,integer? "Add this much extra octavation.
 188 Values of 7 and -7 are common.")
 189      (cueClefPosition ,number? "Where should the center of the clef
 190 symbol go, measured in half staff spaces from the center of the
 191 staff.")
 192      (currentBarNumber ,integer? "Contains the current barnumber.
 193 This property is incremented at every bar line.")
 194
 195
 196      (decrescendoSpanner ,symbol? "The type of spanner to be used for
 197 decrescendi.  Available values are @samp{hairpin} and @samp{text}.  If
 198 unset, a hairpin decrescendo is used.")
 199      (decrescendoText ,markup? "The text to print at start of
 200 non-hairpin decrescendo, i.e., @samp{dim.}.")
 201      (defaultBarType ,string? "Set the default type of bar line.  See
 202 @code{whichBar} for information on available bar types.
 203
 204 This variable is read by @rinternals{Timing_translator} at
 205 @rinternals{Score} level.")
 206      (defaultStrings ,list? "A list of strings to use in calculating
 207 frets for tablatures and fretboards if no strings are provided in
 208 the notes for the current moment.")
 209      (doubleRepeatType ,string? "Set the default bar line for double
 210 repeats.")
 211      (doubleSlurs ,boolean? "If set, two slurs are created for every
 212 slurred note, one above and one below the chord.")
 213      (drumPitchTable ,hash-table? "A table mapping percussion
 214 instruments (symbols) to pitches.")
 215      (drumStyleTable ,hash-table? "A hash table which maps drums to
 216 layout settings.  Predefined values: @samp{drums-style},
 217 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style}, and
 218 @samp{percussion-style}.
 219
 220 The layout style is a hash table, containing the drum-pitches (e.g.,
 221 the symbol @samp{hihat}) as keys, and a list
 222 @code{(@var{notehead-style} @var{script} @var{vertical-position})} as
 223 values.")
 224
 225
 226      (explicitClefVisibility ,vector? "@samp{break-visibility}
 227 function for clef changes.")
 228      (explicitCueClefVisibility ,vector? "@samp{break-visibility}
 229 function for cue clef changes.")
 230      (explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
 231 function for explicit key changes.  @samp{\\override} of the
 232 @code{break-visibility} property will set the visibility for normal
 233 (i.e., at the start of the line) key signatures.")
 234      (extendersOverRests ,boolean? "Whether to continue extenders as
 235 they cross a rest.")
 236      (extraNatural ,boolean? "Whether to typeset an extra natural sign
 237 before accidentals that reduce the effect of a previous alteration.")
 238
 239
 240      (figuredBassAlterationDirection ,ly:dir? "Where to put alterations
 241 relative to the main figure.")
 242      (figuredBassCenterContinuations ,boolean? "Whether to vertically
 243 center pairs of extender lines.  This does not work with three or more
 244 lines.")
 245      (figuredBassFormatter ,procedure? "A routine generating a markup
 246 for a bass figure.")
 247      (figuredBassPlusDirection ,ly:dir? "Where to put plus signs
 248 relative to the main figure.")
 249      (fingeringOrientations ,list? "A list of symbols, containing
 250 @samp{left}, @samp{right}, @samp{up} and/@/or @samp{down}.  This list
 251 determines where fingerings are put relative to the chord being
 252 fingered.")
 253      (firstClef ,boolean? "If true, create a new clef when starting a
 254 staff.")
 255      (followVoice ,boolean? "If set, note heads are tracked across
 256 staff switches by a thin line.")
 257      (fontSize ,number? "The relative size of all grobs in a context.")
 258      (forbidBreak ,boolean? "If set to @code{#t}, prevent a line break
 259 at this point.")
 260      (forceClef ,boolean? "Show clef symbol, even if it has not
 261 changed.  Only active for the first clef after the property is set, not
 262 for the full staff.")
 263      (fretLabels ,list? "A list of strings or Scheme-formatted markups
 264 containing, in the correct order, the labels to be used for lettered
 265 frets in tablature.")
 266
 267
 268      (glissandoMap ,list? "A map in the form of '((source1 . target1)
 269 (source2 . target2) (sourcen . targetn)) showing the glissandi to
 270 be drawn for note columns.  The value '() will default to '((0 . 0)
 271 (1 . 1) (n . n)), where n is the minimal number of note-heads in
 272 the two note columns between which the glissandi occur.")
 273      (gridInterval ,ly:moment? "Interval for which to generate
 274 @code{GridPoint}s.")
 275
 276
 277      (handleNegativeFrets ,symbol? "How the automatic fret calculator
 278 should handle calculated negative frets.  Values include @code{'ignore},
 279 to leave them out of the diagram completely, @code{'include}, to include
 280 them as calculated, and @code{'recalculate}, to ignore the specified
 281 string and find a string where they will fit with a positive fret number.")
 282      (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
 283 get accidentals.")
 284      (harmonicDots ,boolean? "If set, harmonic notes in dotted chords get
 285 dots.")
 286      (highStringOne ,boolean? "Whether the first string is the string
 287 with highest pitch on the instrument.  This used by the automatic
 288 string selector for tablature notation.")
 289
 290
 291      (ignoreBarChecks ,boolean? "Ignore bar checks.")
 292      (ignoreFiguredBassRest ,boolean? "Don't swallow rest events.")
 293      (ignoreMelismata ,boolean? "Ignore melismata for this
 294 @rinternals{Lyrics} line.")
 295      (implicitBassFigures ,list? "A list of bass figures that are not
 296 printed as numbers, but only as extender lines.")
 297      (implicitTimeSignatureVisibility ,vector? "break visibility for
 298 the default time signature.")
 299      (includeGraceNotes ,boolean? "Do not ignore grace notes for
 300 @rinternals{Lyrics}.")
 301      (instrumentCueName ,markup? "The name to print if another
 302 instrument is to be taken.")
 303      (instrumentEqualizer ,procedure? "A function taking a string
 304 (instrument name), and returning a @code{(@var{min} . @var{max})} pair
 305 of numbers for the loudness range of the instrument.")
 306      (instrumentName ,markup? "The name to print left of a staff.  The
 307 @code{instrumentName} property labels the staff in the first system, and
 308 the @code{shortInstrumentName} property labels following lines.")
 309      ;; the definition is reversed wrt traditional transposition
 310      ;; otherwise \transpose { \transposition .. } won't work
 311      (instrumentTransposition ,ly:pitch? "Define the transposition of
 312 the instrument.  Its value is the pitch that sounds like middle@tie{}C.
 313 This is used to transpose the MIDI output, and @code{\\quote}s.")
 314      (internalBarNumber ,integer? "Contains the current barnumber.
 315 This property is used for internal timekeeping, among others by the
 316 @code{Accidental_engraver}.")
 317
 318
 319      (keepAliveInterfaces ,list? "A list of symbols, signifying grob
 320 interfaces that are worth keeping a staff with @code{remove-empty} set
 321 around for.")
 322      (keyAlterationOrder ,list? "An alist that defines in what order
 323 alterations should be printed.  The format is @code{(@var{step}
 324 . @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and
 325 @var{alter} from -2 (sharp) to 2 (flat).")
 326      (keySignature ,list? "The current key signature.  This is an alist
 327 containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} .
 328 @var{step}) . @var{alter})},  where @var{step} is a number in the range
 329 0 to@tie{}6 and @var{alter} a fraction, denoting alteration.  For
 330 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.")
 331
 332
 333      (lyricMelismaAlignment ,number? "Alignment to use for a melisma syllable.")
 334
 335
 336      (majorSevenSymbol ,markup? "How should the major 7th be formatted
 337 in a chord name?")
 338      (markFormatter ,procedure? "A procedure taking as arguments the
 339 context and the rehearsal mark.  It should return the formatted mark as
 340 a markup object.")
 341      (maximumFretStretch ,number? "Don't allocate frets further than
 342 this from specified frets.")
 343      (measureLength ,ly:moment? "Length of one measure in the current
 344 time signature.")
 345      (measurePosition ,ly:moment? "How much of the current measure have
 346 we had.  This can be set manually to create incomplete measures.")
 347      (melismaBusyProperties ,list? "A list of properties (symbols) to
 348 determine whether a melisma is playing.  Setting this property will
 349 influence how lyrics are aligned to notes.  For example, if set to
 350 @code{'(melismaBusy beamMelismaBusy)}, only manual melismata and
 351 manual beams are considered.  Possible values include
 352 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
 353 @code{beamMelismaBusy}.")
 354      (metronomeMarkFormatter ,procedure? "How to produce a metronome
 355 markup.  Called with two arguments: a @code{TempoChangeEvent} and context.")
 356      (middleCClefPosition ,number? "The position of the middle C,
 357 as determined only by the clef.  This can be calculated by looking at
 358 @code{clefPosition} and @code{clefGlyph}.")
 359      (middleCCuePosition ,number? "The position of the middle C,
 360 as determined only by the clef of the cue notes.  This can be calculated by
 361 looking at @code{cueClefPosition} and @code{cueClefGlyph}.")
 362      (middleCOffset ,number? "The offset of
 363 middle C from the position given by @code{middleCClefPosition} This
 364 is used for ottava brackets.")
 365      (middleCPosition ,number? "The place of the middle C, measured in
 366 half staff-spaces.  Usually determined by looking at
 367 @code{middleCClefPosition} and @code{middleCOffset}.")
 368      (midiInstrument ,string? "Name of the MIDI instrument to use.")
 369      (midiMergeUnisons ,boolean? "If true, output only one MIDI note-on
 370 event when notes with the same pitch, in the same MIDI-file track, overlap.")
 371      (midiMaximumVolume ,number? "Analogous to
 372 @code{midiMinimumVolume}.")
 373      (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
 374 Ranges from 0 to@tie{}1.")
 375      (midiChannelMapping ,symbol? "How to map MIDI channels: per @code{instrument} (default), @code{staff} or @code{voice}.")
 376      (minimumFret ,number? "The tablature auto string-selecting
 377 mechanism selects the highest string with a fret at least
 378 @code{minimumFret}.")
 379      (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a
 380 page turn to be allowed.")
 381      (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
 382 repeated section for a page turn to be allowed within that section.")
 383
 384      (minorChordModifier ,markup? "Markup displayed following the root
 385 for a minor chord")
 386
 387      (noChordSymbol ,markup? "Markup to be displayed for rests in a
 388 ChordNames context.")
 389      (noteToFretFunction ,procedure? "Convert list of notes and list of
 390 defined strings to full list of strings and fret numbers.
 391 Parameters: The context, a list of note events, a list of
 392 tabstring events, and the fretboard grob if a fretboard is desired.")
 393
 394
 395      (ottavation ,markup? "If set, the text for an ottava spanner.
 396 Changing this creates a new text spanner.")
 397      (output ,ly:music-output? "The output produced by a score-level
 398 translator during music interpretation.")
 399
 400
 401      (partCombineTextsOnNote ,boolean? "Print part-combine texts only on
 402 the next note rather than immediately on rests or skips.")
 403      (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
 404      (pedalSostenutoStyle ,symbol? "See @code{pedalSustainStyle}.")
 405      (pedalSustainStrings ,list? "A list of strings to print for
 406 sustain-pedal.  Format is @code{(@var{up} @var{updown} @var{down})},
 407 where each of the three is the string to print when this is done with
 408 the pedal.")
 409      (pedalSustainStyle ,symbol? "A symbol that indicates how to print
 410 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
 411      (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
 412      (pedalUnaCordaStyle ,symbol? "See @code{pedalSustainStyle}.")
 413      (predefinedDiagramTable ,hash-table? "The hash table of predefined
 414 fret diagrams to use in FretBoards.")
 415      (printKeyCancellation ,boolean? "Print restoration alterations
 416 before a key signature change.")
 417      (printOctaveNames ,boolean? "Print octave marks for the
 418 @code{NoteNames} context.")
 419      (printPartCombineTexts ,boolean? "Set @q{Solo} and @q{A due} texts
 420 in the part combiner?")
 421      (proportionalNotationDuration ,ly:moment? "Global override for
 422 shortest-playing duration.  This is used for switching on proportional
 423 notation.")
 424
 425
 426      (rehearsalMark ,integer? "The last rehearsal mark printed.")
 427      (repeatCommands ,list? "This property is a list of commands
 428 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
 429 @code{#f}.  @code{'end-repeat} is also accepted as a command.")
 430      (repeatCountVisibility ,procedure? "A procedure taking as
 431 arguments an integer and context, returning whether the corresponding
 432 percent repeat number should be printed when @code{countPercentRepeats}
 433 is set.")
 434      (restCompletionBusy ,boolean? "Signal whether a completion-rest is active.")
 435      (restNumberThreshold ,number? "If a multimeasure rest has more
 436 measures than this, a number is printed.")
 437
 438      (searchForVoice ,boolean? "Signal whether a search should be made
 439 of all contexts in the context hierarchy for a voice to provide rhythms
 440 for the lyrics.")
 441      (shapeNoteStyles ,vector? "Vector of symbols, listing style for
 442 each note head relative to the tonic (qv.) of the scale.")
 443      (shortInstrumentName ,markup? "See @code{instrumentName}.")
 444      (shortVocalName ,markup? "Name of a vocal line, short version.")
 445      (skipBars ,boolean? "If set to true, then skip the empty bars
 446 that are produced by multimeasure notes and rests.  These bars will
 447 not appear on the printed output.  If not set (the default),
 448 multimeasure notes and rests expand into their full length, printing
 449 the appropriate number of empty bars so that synchronization with other
 450 voices is preserved.
 451
 452 @example
 453 @{
 454   r1 r1*3 R1*3
 455   \\set Score.skipBars= ##t
 456   r1*3 R1*3
 457 @}
 458 @end example")
 459      (skipTypesetting ,boolean? "If true, no typesetting is done,
 460 speeding up the interpretation phase.  Useful for debugging large
 461 scores.")
 462      (soloIIText ,markup? "The text for the start of a solo for
 463 voice @q{two} when part-combining.")
 464      (soloText ,markup? "The text for the start of a solo when
 465 part-combining.")
 466      (squashedPosition ,integer? "Vertical position of squashing for
 467 @rinternals{Pitch_squash_engraver}.")
 468      (staffLineLayoutFunction ,procedure? "Layout of staff lines,
 469 @code{traditional}, or @code{semitone}.")
 470      (stanza ,markup? "Stanza @q{number} to print before the start of a
 471 verse.  Use in @code{Lyrics} context.")
 472      (stemLeftBeamCount ,integer? "Specify the number of beams to draw
 473 on the left side of the next note.  Overrides automatic beaming.  The
 474 value is only used once, and then it is erased.")
 475      (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
 476      (stringNumberOrientations ,list? "See
 477 @code{fingeringOrientations}.")
 478      (stringOneTopmost ,boolean? "Whether the first string is
 479 printed on the top line of the tablature.")
 480      (stringTunings ,list? "The tablature strings tuning.  It is a list
 481 of the pitches of each string (starting with the lowest numbered
 482 one).")
 483      (strokeFingerOrientations ,list? "See
 484 @code{fingeringOrientations}.")
 485      (subdivideBeams ,boolean? "If set, multiple beams will be
 486 subdivided at @code{baseMoment} positions by only drawing one beam over the beat.")
 487      (suggestAccidentals ,boolean? "If set, accidentals are typeset as
 488 cautionary suggestions over the note.")
 489      (systemStartDelimiter ,symbol? "Which grob to make for the start
 490 of the system/@/staff?  Set to @code{SystemStartBrace},
 491 @code{SystemStartBracket} or @code{SystemStartBar}.")
 492      (systemStartDelimiterHierarchy ,pair? "A nested list, indicating
 493 the nesting of a start delimiters.")
 494
 495
 496      (tablatureFormat ,procedure? "A function formatting a tablature
 497 note head.  Called with three arguments: context, string number and,
 498 fret number.  It returns the text as a markup.")
 499      (tabStaffLineLayoutFunction ,procedure? "A function determining the
 500 staff position of a tablature note head.  Called with two arguments:
 501 the context and the string.")
 502      (tempoHideNote ,boolean? "Hide the note = count in tempo marks.")
 503      (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
 504 minute.")
 505      (tieWaitForNote ,boolean? "If true, tied notes do not have to
 506 follow each other directly.  This can be used for writing out
 507 arpeggios.")
 508      (timeSignatureFraction ,fraction? "A pair of numbers,
 509 signifying the time signature.  For example, @code{'(4 . 4)} is a
 510 4/4 time signature.")
 511      (timeSignatureSettings ,cheap-list? "A nested alist of settings for
 512 time signatures.  Contains elements for various time signatures.  The
 513 element for each time signature contains entries for @code{baseMoment},
 514 @code{beatStructure}, and @code{beamExceptions}.")
 515      (timing ,boolean? "Keep administration of measure length,
 516 position, bar number, etc.?  Switch off for cadenzas.")
 517      (tonic ,ly:pitch? "The tonic of the current scale.")
 518      (topLevelAlignment ,boolean? "If true, the @var{Vertical_align_engraver}
 519 will create a @var{VerticalAlignment}; otherwise, it will create a
 520 @var{StaffGrouper}")
 521      (trebleStaffProperties ,list? "An alist of property settings to
 522 apply for the up staff of @code{PianoStaff}.  Used by
 523 @code{\\autochange}.")
 524      (tremoloFlags ,integer? "The number of tremolo flags to add if no
 525 number is specified.")
 526      (tupletFullLength ,boolean? "If set, the tuplet is printed up to
 527 the start of the next note.")
 528      (tupletFullLengthNote ,boolean? "If set, end at the next note,
 529 otherwise end on the matter (time signatures, etc.) before the note.")
 530      (tupletSpannerDuration ,ly:moment? "Normally, a tuplet bracket is
 531 as wide as the @code{\\times} expression that gave rise to it.  By
 532 setting this property, you can make brackets last shorter.
 533
 534 @example
 535 @{
 536   \\set tupletSpannerDuration = #(ly:make-moment 1 4)
 537   \\times 2/3 @{ c8 c c c c c @}
 538 @}
 539 @end example")
 540
 541
 542      (useBassFigureExtenders ,boolean? "Whether to use extender lines
 543 for repeated bass figures.")
 544
 545      (vocalName ,markup? "Name of a vocal line.")
 546      (voltaSpannerDuration ,ly:moment? "This specifies the maximum
 547 duration to use for the brackets printed for @code{\\alternative}.
 548 This can be used to shrink the length of brackets in the situation
 549 where one alternative is very large.")
 550
 551
 552      (whichBar ,string? "This property is read to determine what type
 553 of bar line to create.
 554
 555 Example:
 556
 557 @example
 558 \\set Staff.whichBar = \"|:\"
 559 @end example
 560
 561 @noindent
 562 This will create a start-repeat bar in this staff only.  Valid values
 563 are described in @rinternals{bar-line-interface}.")
 564      )))
 565
 566
 567 (define-public all-internal-translation-properties
 568   (map
 569    (lambda (x)
 570      (set-object-property! (car x) 'internal-translation #t)
 571      (apply translator-property-description x))
 572
 573    `(
 574
 575      (associatedVoiceContext ,ly:context? "The context object of the
 576 @code{Voice} that has the melody for this @code{Lyrics}.")
 577
 578
 579      (barCheckLastFail ,ly:moment? "Where in the measure did the last
 580 barcheck fail?")
 581      (beamMelismaBusy ,boolean? "Signal if a beam is present.")
 582      (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
 583 @var{grob})} cons cells.  This is for internal (C++) use only.  This
 584 property contains the grobs which are still busy (e.g. note heads,
 585 spanners, etc.).")
 586
 587
 588      (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
 589 current breakable (clef, key signature, etc.) items.")
 590      (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
 591 non-breakable items (note heads, lyrics, etc.).")
 592
 593
 594      (dynamicAbsoluteVolumeFunction ,procedure? "A procedure that takes
 595 one argument, the text value of a dynamic event, and returns the absolute
 596 volume of that dynamic event.")
 597
 598
 599      (finalizations ,list? "A list of expressions to evaluate before
 600 proceeding to next time step.  This is an internal variable.")
 601
 602
 603      (graceSettings ,list? "Overrides for grace notes.  This property
 604 should be manipulated through the @code{add-grace-property} function.")
 605
 606
 607      (hasStaffSpacing ,boolean? "True if the current
 608 @code{CommandColumn} contains items that will affect spacing.")
 609
 610
 611      (lastKeySignature ,list? "Last key signature before a key
 612 signature change.")
 613      (localKeySignature ,list? "The key signature at this point in the
 614 measure.  The format is the same as for @code{keySignature}, but can
 615 also contain @code{((@var{octave} . @var{name}) . (@var{alter}
 616 @var{barnumber} . @var{measureposition}))} pairs.")
 617
 618
 619      (melismaBusy ,boolean? "Signifies whether a melisma is active.
 620 This can be used to signal melismas on top of those automatically
 621 detected.")
 622
 623
 624      (quotedCueEventTypes ,list? "A list of symbols, representing the
 625 event types that should be duplicated for @code{\\cueDuring} commands.")
 626      (quotedEventTypes ,list? "A list of symbols, representing the
 627 event types that should be duplicated for @code{\\quoteDuring} commands.
 628 This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
 629 is not set")
 630
 631
 632      (rootSystem ,ly:grob? "The System object.")
 633
 634
 635      (scriptDefinitions ,list? "The description of scripts.  This is
 636 used by the @code{Script_engraver} for typesetting note-superscripts
 637 and subscripts.  See @file{scm/@/script.scm} for more information.")
 638      (slurMelismaBusy ,boolean? "Signal if a slur is present.")
 639      (stavesFound ,grob-list? "A list of all staff-symbols found.")
 640
 641
 642      (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
 643      )))
 644
 645 (define-public all-translation-properties
 646   (append all-user-translation-properties
 647           all-internal-translation-properties))
 648
 649 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 650
 651 (define-public default-melisma-properties
 652   '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy))