scm/define-context-properties.scm

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