scm/define-context-properties.scm

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