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