scm/define-context-properties.scm

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