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