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