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