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