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