scm/define-context-properties.scm

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