@var{context} is @internalsref{Score} then all staves share
accidentals, and if @var{context} is @internalsref{Staff} then all
voices in the same staff share accidentals, but staves do not.
+
@item octavation:
Whether the accidental changes all octaves or only the current
- octave.
-@item lazyness:
- Over how many barlines the accidental lasts.
- If @var{lazyness} is @code{-1} then the accidental is forget
- immediately, and if @var{lazyness} is @code{#t} then the accidental
- lasts forever.
-
-@c [TODO: should use +infinity for this case?]
-
+ octave. Valid choices are
+
+ @table @samp
+ @item same-octave:
+ This is the default algorithm. Accidentals are typeset if the note changes
+ the accidental of that note in that octave. Accidentals lasts to the end of the measure
+ and then as many measures as specified in the value. I.e. 1 means to the end
+ of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.
+ @item any-octave:
+ Accidentals are typeset if the note is different from
+ the previous note on the same pitch in any octave. The value has same meaning as in
+ same-octave.
+ @end table
+
+@item lazyness
+
+ Over how many barlines the accidental lasts.
+ If @var{lazyness} is @code{-1} then the accidental is forget
+ immediately, and if @var{lazyness} is @code{#t} then the accidental
+ lasts forever.
@end table
+
@refcommands
@cindex @code{\defaultAccidentals}
Stem \set #'Y-extent-callback = ##f
minimumVerticalExtent = #'(-4.0 . 5.0)
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
\paper {
%% need to do this, because of indented @itemize
minimumVerticalExtent = #'(-3.0 . 4.0)
drumStyleTable = #timbales-style
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
}
@end lilypond
Stem \set #'transparent = ##t
Stem \set #'Y-extent-callback = ##f
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
}
@end lilypond
Stem \set #'transparent = ##t
Stem \set #'Y-extent-callback = ##f
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
}
@end lilypond
Stem \set #'transparent = ##t
Stem \set #'Y-extent-callback = ##f
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
}
@end lilypond
@node The Lyrics context
@subsection The Lyrics context
-Lyrics are printed by interpreting them in a @internalsref{LyricsVoice} context:
+Lyrics are printed by interpreting them in a @internalsref{Lyrics} context:
@example
- \context LyricsVoice \lyrics @dots{}
+ \context Lyrics \lyrics @dots{}
@end example
@cindex automatic syllable durations
correct duration for each syllable. This is achieved by combining the
melody and the lyrics with the @code{\lyricsto} expression:
@example
-\lyricsto @var{name} \new LyricsVoice @dots{}
+\lyricsto @var{name} \new Lyrics @dots{}
@end example
This aligns the lyrics to the
hierarchy of staves and lyrics first, e.g.
@example
\context ChoirStaff \notes <<
- \context LyricsVoice = sopranoLyrics @{ s1 @}
+ \context Lyrics = sopranoLyrics @{ s1 @}
\context Voice = soprano @{ @emph{music} @}
- \context LyricsVoice = tenor @{ s1 @}
+ \context Lyrics = tenor @{ s1 @}
\context Voice = tenorLyrics @{ @emph{music} @}
>>
@end example
and then combine the appropriate melodies and lyric lines:
@example
- \lyricsto "soprano" \new LyricsVoice @emph{the lyrics}
+ \lyricsto "soprano" \new Lyrics @emph{the lyrics}
@end example
@noindent
f e f
\melismaEnd
e2 }
- \lyricsto "lala" \new LyricsVoice \lyrics {
+ \lyricsto "lala" \new Lyrics \lyrics {
la di __ daah
} >>
@end lilypond
When multiple stanzas are put on the same melody, it can happen that
two stanzas have melismata in different locations. This can be
remedied by switching off melismata for one
-@internalsref{LyricsVoice}. This is achieved by setting
+@internalsref{Lyrics}. This is achieved by setting
the @code{ignoreMelismata} property to @code{#t}. An example is shown
in @inputfileref{input/regression,lyric-combine-new.ly}.
@seealso
Internals: Music expressions: @internalsref{LyricCombineMusic},
-Contexts: @internalsref{LyricsVoice}, @internalsref{Melisma_engraver}.
+Contexts: @internalsref{Lyrics}, @internalsref{Melisma_engraver}.
Examples: @inputfileref{input/template,satb.ly},
@inputfileref{input/regression,lyric-combine-new.ly}.
For proper processing of extender lines, the
-@internalsref{LyricsVoice} and @internalsref{Voice} should be
+@internalsref{Lyrics} and @internalsref{Voice} should be
linked. This can be achieved either by using @code{\lyricsto} or by
setting corresponding names for both contexts. The latter is explained
in @ref{More stanzas}.
g2 e4 a2 f4 g2. @}
@end example
-Then set the @internalsref{LyricsVoice} contexts to names starting with
+Then set the @internalsref{Lyrics} contexts to names starting with
that identity followed by a dash. In the preceding example, the
@internalsref{Voice} identity is @code{duet}, so the identities of the
-@internalsref{LyricsVoice}s are marked @code{duet-1} and @code{duet-2}:
+@internalsref{Lyrics}s are marked @code{duet-1} and @code{duet-2}:
@example
- \context LyricsVoice = "duet-1" @{
+ \context Lyrics = "duet-1" @{
Hi, my name is bert. @}
- \context LyricsVoice = "duet-2" @{
+ \context Lyrics = "duet-2" @{
Ooooo, ch\'e -- ri, je t'aime. @}
@end example
\score {
<< \notes \relative c'' \context Voice = duet { \time 3/4
g2 e4 a2 f4 g2. }
- \lyrics << \lyricsto "duet" \new LyricsVoice {
- \property LyricsVoice . stanza = "1"
+ \lyrics << \lyricsto "duet" \new Lyrics {
+ \property Lyrics . stanza = "1"
Hi, my name is bert. }
- \lyricsto "duet" \new LyricsVoice {
- \property LyricsVoice . stanza = "2"
+ \lyricsto "duet" \new Lyrics {
+ \property Lyrics . stanza = "2"
Ooooo, ch\'e -- ri, je t'aime. }
>> >>
}
@cindex singer's names
@cindex name of singer
-Stanza numbers can be added by setting @code{LyricsVoice.stanza}, e.g.
+Stanza numbers can be added by setting @code{Lyrics.stanza}, e.g.
@example
- \property LyricsVoice . stanza = "Bert"
+ \property Lyrics . stanza = "Bert"
@dots{}
- \property LyricsVoice . stanza = "Ernie"
+ \property Lyrics . stanza = "Ernie"
@end example
Notice how dots are surrounded with spaces in @code{\lyrics} mode, to
-prevent @code{LyricsVoice.stanza} being interpreted as a single
+prevent @code{Lyrics.stanza} being interpreted as a single
string.
-Names of the singers should be added using @code{LyricsVoice
-. vocalName} and @code{LyricsVoice . vocNam}, analogous to instrument
+Names of the singers should be added using @code{Lyrics
+. vocalName} and @code{Lyrics . vocNam}, analogous to instrument
annotations for staves.
To make empty spaces in lyrics, use @code{\skip}.
In orchestral scores, staff lines that only have rests are usually
removed. This saves some space. This style is called `French Score'.
-For @internalsref{Lyrics}, @internalsref{LyricsVoice},
+For @internalsref{Lyrics}, @internalsref{Lyrics},
@internalsref{ChordNames} and @internalsref{FiguredBass}, this is
switched on by default. When these line of these contexts turn out
empty after the line-breaking process, they are removed.
\[ c'\melisma c' \flexa a \] \[ a \flexa \deminutum g\melismaEnd \] f \divisioMinima
}
}
- \lyricsto "cantus" \new LyricsVoice \lyrics {
+ \lyricsto "cantus" \new Lyrics \lyrics {
San- ctus, San- ctus, San- ctus
} >>
_\verylongfermata
r
}
- \context LyricsVoice \lyrics {
+ \context Lyrics \lyrics {
"shortfermata" "fermata" "longfermata" "verylongfermata"
} >>
}
(set-object-property! symbol 'translation-type? type?)
(set-object-property! symbol 'translation-doc description)
(set! all-translation-properties (cons symbol all-translation-properties))
+ symbol
)
-
-
-(translator-property-description 'acceptHashTable vector? "Internal
-variable: store table with MusicName to Engraver entries.")
-(translator-property-description 'acknowledgeHashTable vector?
-"Internal variable: store interface to engraver smob table for current
-context. Don't mess with this.")
-(translator-property-description 'aDueText string? "text for begin of a due")
-(translator-property-description 'alignBassFigureAccidentals boolean?
+(define all-user-translation-properties
+ (map
+ (lambda (x)
+ (apply translator-property-description x))
+ `(
+ (aDueText ,string? "text for begin of a due")
+ (alignBassFigureAccidentals ,boolean?
"If true, then the accidentals are aligned in bass figure context.")
-(translator-property-description 'allowBeamBreak boolean?
- "If true allow line breaks during beams.")
-(translator-property-description 'associatedVoice string? "Name of the
-Voice that has the melody for this LyricsVoice.")
-(translator-property-description 'associatedVoiceContext ly:context? "The context object of the Voice that has the melody for this LyricsVoice.")
-(translator-property-description 'autoBeamSettings list? "Specifies
-when automatically generated beams should begin and end. The elements
-have the format:
-
-@example
-
- function shortest-duration-in-beam time-signature
-
-where
-
- function = begin or end
- shortest-duration-in-beam = numerator denominator; eg: 1 16
- time-signature = numerator denominator, eg: 4 4
-
-unspecified or wildcard entries for duration or time-signature
-are given by * *
-
-The user can override beam begin or end time by pushing a wildcard entries
-'(begin * * * *) or '(end * * * *) resp., eg:
-
- property Voice.autoBeamSettings push #'(end * * * *) = #(ly:make-moment 1 4)
-
-The head of the list:
- '(
-((end * * 3 2) . ,(ly:make-moment 1 2))
-((end 1 16 3 2) . ,(ly:make-moment 1 4))
-((end 1 32 3 2) . ,(ly:make-moment 1 8))
- ...
- )
-
-@end example")
-
-;; "
-
-(translator-property-description 'autoAccidentals list? "List of
-different ways to typeset an accidental. All algorithms in the list
-are tried, and the one returning the most accidentals is used.
-Each entry is either a symbol containg a context name or a name-value
-pair containing an algorithm-description.
-The list must begin with a symbol (context name).
-The symbols denote in which context THE FOLLOWING algorithms (until next symbol)
-will be interpreted. All notes in the interpretation context will share accidentals.
-The contexts must be stated in order, innermost first.
-The algorithms are:
-@table @samp
-@item same-octave:
-This is the default algorithm. Accidentals are typeset if the note changes
-the accidental of that note in that octave. Accidentals lasts to the end of the measure
-and then as many measures as specified in the value. I.e. 1 means to the end
-of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.
-@item any-octave:
-Accidentals are typeset if the note is different from
-the previous note on the same pitch in any octave. The value has same meaning as in
-same-octave.
-@end table
-")
-(translator-property-description 'autoBeaming boolean? "If set to true
+ (allowBeamBreak ,boolean? "If true allow line breaks during beams.")
+ (associatedVoice ,string? "Name of the
+Voice that has the melody for this Lyrics.")
+ (autoBeamSettings ,list? "Specifies
+when automatically generated beams should begin and end.
+See the notation manual for more information. ")
+ (autoAccidentals ,list? "List of
+different ways to typeset an accidental. See the notation manual for more information on setting this.")
+ (autoBeaming ,boolean? "If set to true
then beams are generated automatically.")
-(translator-property-description 'autoCautionaries list? "List similar to
+ (autoCautionaries ,list? "List similar to
autoAccidentals, but it controls cautionary accidentals rather than
normal ones. Both lists are tried, and the one giving the most accidentals
wins. In case of draw, a normal accidental is typeset.
")
-(translator-property-description 'automaticBars boolean? " If set to true then bar lines will not be printed
- automatically; they must be explicitly created with @code{bar}
- keywords. Unlike with the @code{cadenza} keyword, measures are
- still counted. Bar generation will resume according to that
- count if this property is set to zero.
+ (automaticBars ,boolean? " If set to true then bar lines will not be
+printed automatically; they must be explicitly created with
+@code{\\bar} command. Unlike the @code{\\cadenza} keyword, measures
+are still counted. Bar generation will resume according to that count
+if this property is unset.
")
-(translator-property-description 'barAlways boolean? "If set to true a bar line is drawn after each note.
-")
-(translator-property-description 'barCheckLastFail ly:moment? "Where in the measurze did the last barcheck fail?")
+ (barAlways ,boolean? "If set to true a bar line is drawn after each
+note.")
-(translator-property-description 'barCheckSynchronize boolean? "If
-true then reset measurePosition when finding a barcheck. Turn off when
-using barchecks in polyphonic music.")
-(translator-property-description 'barNumberVisibility procedure? "Procedure that takes an int and returns whether the corresponding bar number should be printed")
-(translator-property-description 'bassFigureFormatFunction procedure? "DOCME")
-(translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is present.")
-(translator-property-description 'beatLength ly:moment? "The length of one beat in this time signature.")
-(translator-property-description 'beatGrouping list?
- "List of beatgroups. Eg. in 5/8 time #(list 2 3).")
+ (barCheckSynchronize ,boolean? "If true then reset measurePosition
+when finding a barcheck.")
+ (barNumberVisibility ,procedure? "Procedure that takes an int and
+returns whether the corresponding bar number should be printed")
+ (bassFigureFormatFunction ,procedure? "DOCME")
+ (beatLength ,ly:moment? "The length of one beat in this time signature.")
+ (beatGrouping ,list?
+ "List of beatgroups. Eg. in 5/8 time #(list 2 3).")
-(translator-property-description 'breakableSeparationItem ly:grob?
-"The breakable items in this time step, for this staff.")
-(translator-property-description 'breakAlignOrder list? "Defines the order in which
+ (breakAlignOrder ,list? "Defines the order in which
prefatory matter (clefs, key signatures) appears, eg. this puts the
key signatures after the bar lines:
)
@end example
")
-(translator-property-description 'busyGrobs list? "
-a queue of (END-MOMENT . GROB) conses. This is for internal (C++) use only.
-Use at your own risk. This property contains the grobs for which END-MOMENT >= NOW.
-")
-(translator-property-description 'centralCPosition number? "Place of
-the central C, measured in half staffspaces. Usually determined by
-looking at clefPosition and clefGlyph.")
-
-(translator-property-description
- 'chordNameFunction procedure?
- "The function that converts lists of pitches to chord names.")
-(translator-property-description
- 'chordNoteNamer procedure?
- "Function that converts from a pitch object to a text markup. Used for single pitches.")
-(translator-property-description
- 'chordRootNamer procedure?
- "Function that converts from a pitch object to a text markup. Used for chords.")
-(translator-property-description
- 'chordNameExceptions list?
- "Alist of chord exceptions. Contains (CHORD . MARKUP) entries.")
-(translator-property-description
- 'chordNameExceptionsFull list?
- "Alist of chord exceptions. Contains (CHORD . (MARKUP)) entries.")
-(translator-property-description
- 'chordNameExceptionsPartial list?
- "Alist of partial chord exceptions. Contains (CHORD . (PREFIX-MARKUP SUFFIX-MARKUP)) entries.")
-(translator-property-description
- 'chordNameSeparator markup?
- "The markup object used to separate parts of a chord name.")
-
-(translator-property-description 'chordChanges boolean? "Only show changes in chords scheme?")
-(translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
-(translator-property-description 'clefOctavation integer? "Add
+ (centralCPosition ,number? "Place of the central C, measured in half
+staffspaces. Usually determined by looking at clefPosition and
+clefGlyph.")
+
+ (chordNameFunction ,procedure?
+ "The function that converts lists of pitches to chord names.")
+ (chordNoteNamer ,procedure?
+ "Function that converts from a pitch object to a text markup. Used for single pitches.")
+ (chordRootNamer ,procedure?
+ "Function that converts from a pitch object to a text markup. Used for chords.")
+ (chordNameExceptions ,list?
+ "Alist of chord exceptions. Contains (CHORD . MARKUP) entries.")
+ (chordNameExceptionsFull ,list?
+ "Alist of chord exceptions. Contains (CHORD . (MARKUP)) entries.")
+ (chordNameExceptionsPartial ,list?
+ "Alist of partial chord exceptions. Contains (CHORD . (PREFIX-MARKUP SUFFIX-MARKUP)) entries.")
+ (chordNameSeparator ,markup?
+ "The markup object used to separate parts of a chord name.")
+
+ (chordChanges ,boolean? "Only show changes in chords scheme?")
+ (clefGlyph ,string? "Name of the symbol within the music font")
+ (clefOctavation ,integer? "Add
this much extra octavation. Values of 7 and -7 are common.")
-(translator-property-description 'clefPosition number? "Where should
-the center of the clef symbol go? On systems with an odd number of
-stafflines, the value 0 puts the clef on the middle staffline; a
-positive value shifts it up, a negative value shifts it down. The
-unit of this distance is the half staff space.")
+ (clefPosition ,number? "Where should the center of the clef symbol go?
+The unit of this distance is the half staff space, and 0 represents the vertical center.")
-(translator-property-description 'connectArpeggios boolean? " If
-set, connect all arpeggios that are found. In this way, you can make
-arpeggios that cross staves.
-")
-(translator-property-description 'createKeyOnClefChange boolean? "Print a key signature whenever the clef is changed.")
-(translator-property-description 'crescendoText markup? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}")
-(translator-property-description 'crescendoSpanner symbol? "Type of spanner to be used for crescendi. One of: @samp{hairpin}, @samp{line}, @samp{dashed-line}, @samp{dotted-line}. If unset, hairpin type is used.")
-(translator-property-description 'decrescendoText markup? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}")
-(translator-property-description 'drumPitchTable hash-table?
- "A table mapping percussion
+ (connectArpeggios ,boolean? " If set, connect all arpeggios that are
+found. In this way, you can make arpeggios that cross staves. ")
+ (createKeyOnClefChange ,boolean? "Print a key signature whenever the clef is changed.")
+ (crescendoText ,markup? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}")
+ (crescendoSpanner ,symbol? "Type of spanner to be used for crescendi.
+One of: @samp{hairpin}, @samp{line}, @samp{dashed-line},
+@samp{dotted-line}. If unset, hairpin type is used.")
+ (decrescendoText ,markup? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}")
+
+ (drumPitchTable ,hash-table? "A table mapping percussion
instruments (symbols) to pitches.")
-(translator-property-description 'drumStyleTable hash-table?
- "A hash table containing mapping drums to layout settings.
-Predefined values: @code{drums-style}, @code{timbales-style}, @code{congas-style}, @code{bongos-style}
-and @code{percussion-style}.
+ (drumStyleTable ,hash-table? "A hash table containing mapping
+drums to layout settings. Predefined values: @code{drums-style},
+@code{timbales-style}, @code{congas-style}, @code{bongos-style} and
+@code{percussion-style}.
-The layout style is a hash table, containing the drum-pitches (eg. the symbol @code{hihat}) as key,
-and a list (@var{notehead-style} @var{script} @var{vertical-position}) as values.
+The layout style is a hash table, containing the drum-pitches (eg. the
+symbol @code{hihat}) as key, and a list (@var{notehead-style}
+@var{script} @var{vertical-position}) as values.
")
-(translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
+ (currentBarNumber ,integer? "Contains the current barnumber. This property is incremented at
every barline.
")
-(translator-property-description 'currentCommandColumn ly:grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
-(translator-property-description 'currentMusicalColumn ly:grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
-(translator-property-description 'defaultBarType string? "Sets the default type of bar line. Available bar types: [FIXME];
-
-This variable is typically read at Score level, so overriding
-Staff.defaultBarType will have no effect.
+ (defaultBarType ,string? "Sets the default type of bar line.
+Available bar types: [FIXME];
+This variable is typically read by Timing_engraver at Score level, so
+overriding Staff.defaultBarType will have no effect.
")
-(translator-property-description 'decrescendoSpanner symbol? "Type of spanner to be used for decrescendi. One of: @samp{hairpin}, @samp{line}, @samp{dashed-line}, @samp{dotted-line}. If unset, hairpin type is used.")
+ (decrescendoSpanner ,symbol? "Type of spanner to be used for
+decrescendi. One of: @samp{hairpin}, @samp{line}, @samp{dashed-line},
+@samp{dotted-line}. If unset, hairpin type is used.")
-(translator-property-description 'dynamicAbsoluteVolumeFunction procedure? "
-[DOCUMENT-ME]
-")
-(translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
+ (explicitClefVisibility ,procedure? "visibility-lambda function for clef changes.")
-(translator-property-description 'explicitKeySignatureVisibility
-procedure? "visibility-lambda function for explicit Key changes;
-\\override of #'break-visibility will set the visibility for normal
-(ie. at the start of the line) key signatures.")
+ (explicitKeySignatureVisibility ,procedure? "visibility-lambda
+function for explicit Key changes; \\override of #'break-visibility
+will set the visibility for normal (ie. at the start of the line) key
+signatures.")
-(translator-property-description 'extraNatural boolean? "Whether to typeset an
+ (extraNatural ,boolean? "Whether to typeset an
extra natural sign before accidentals changing from a non-natural to
-another non-natural.
-")
+another non-natural.")
-(translator-property-description 'extraVerticalExtent number-pair?
-"extra vertical extent, same format as MinimumVerticalExtent")
+ (extraVerticalExtent ,number-pair?
+ "extra vertical extent, same format as MinimumVerticalExtent")
-(translator-property-description 'finalizations list? "List of expressions to evaluate before proceeding to next time step. Internal variable.")
-(translator-property-description 'followVoice boolean?
- "if set, note heads are tracked across staff switches by a thin line")
-(translator-property-description 'fontSize number?
- "Used to set the relative size of all grobs
-in a context. This is done using the @code{Font_size_engraver}.")
+ (followVoice ,boolean? "if set, note heads are tracked across staff
+switches by a thin line")
-(translator-property-description
- 'fingeringOrientations list?
- "List of symbols, containing left, right, up and/or down. This list determines where fingerings are put wrt. to the chord being fingered.")
+ (fontSize ,number?
+ "The relative size of all grobs in a context. This is
+done using the @code{Font_size_engraver}.")
-(translator-property-description 'forceClef boolean? "Show clef symbol, even if it hasn't changed. Only active for the first clef after the property is set, not for the full staff.")
+ (fingeringOrientations ,list?
+ "List of symbols, containing left, right, up and/or down. This list
+determines where fingerings are put relative to the chord being
+fingered.")
-(translator-property-description 'graceSettings vector?
- "Overrides for grace notes. This
-property should be manipulated through the @code{add-grace-property}
-function.")
+ (forceClef ,boolean? "Show clef symbol, even if it hasn't
+changed. Only active for the first clef after the property is set, not
+for the full staff.")
-(translator-property-description 'highStringOne boolean? "Whether the
-1st string is the string with highest pitch on the instrument (used by
-the automatic string selector).")
-
-(translator-property-description 'ignoreMelismata boolean?
- "Ignore melismata for this @ref{LyricsVoice}.")
-(translator-property-description 'instr markup? "see @code{instrument}")
-(translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
-@cindex Instrument_name_engraver
- is
- added to the Staff translator, then the @code{instrument} property
- is used to label the first line of the staff and the @code{instr}
- property is used to label subsequent lines. If the
- @code{midiInstrument} property is not set, then @code{instrument}
- is used to determine the instrument for MIDI output.")
-
-(translator-property-description 'instrumentEqualizer procedure? "[DOCUMENT-ME]")
-(translator-property-description 'instrumentSupport list? "
-list of grobs to attach instrument name to.
-")
-(translator-property-description 'keyAccidentalOrder list? "
+ (highStringOne ,boolean? "Whether the 1st string is the string with
+highest pitch on the instrument. This used by the automatic string
+selector for tab notation.")
+
+ (ignoreMelismata ,boolean? "Ignore melismata for this @ref{Lyrics}.")
+ (instr ,markup? "see @code{instrument}")
+
+ (instrument ,markup? "The name to print left of a staff. The
+@code{instrument} property labels the staff in the first system, and
+the @code{instr} property labels following lines.")
+ (instrumentEqualizer ,procedure? "[DOCUMENT-ME]")
+
+ (instrumentSupport ,list? "list of grobs to attach instrument name
+to.")
+ (keyAccidentalOrder ,list? "
Alist that defines in what order alterations should be printed.
The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from -1, 1.
")
-(translator-property-description 'keySignature list? "The current key signature. This is an alist containing (NAME . ALTER) or ((OCTAVE . NAME) . ALTER) or ((OCTAVE . NAME) . (ALTER . BARNUMBER)) pairs, where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2. The optional barnumber contains the number of the measure of the accidental. FIXME: describe broken tie entries.")
-
-(translator-property-description 'lastKeySignature list? "Last key
-signature before a key signature change.")
-(translator-property-description 'localKeySignature list? "the key
-signature at this point in the measure. The format is the same as for keySignature. Is reset at every bar line."
-)
-(translator-property-description 'localKeySignatureChanges list? "Experimental.
- [DOCME]")
+ (keySignature ,list? "The current key signature. This is an alist
+containing (NAME . ALTER) or ((OCTAVE . NAME) . ALTER).
+ where NAME is from 0.. 6 and
+ALTER from -4 (double flat) to 4 (double sharp).
+")
-(translator-property-description 'majorSevenSymbol markup? "How should
+ (majorSevenSymbol ,markup? "How should
the major7 be formatted in a chord name?")
-(translator-property-description 'markFormatter procedure? "Procedure
+ (markFormatter ,procedure? "Procedure
taking as arguments context and rehearsal mark. It should return the
formatted mark as a markup object.")
-(translator-property-description 'measureLength ly:moment? "Length of one
+ (measureLength ,ly:moment? "Length of one
measure in the current time signature last?")
-(translator-property-description 'measurePosition ly:moment? "How much
-of the current measure (measured in whole notes) have we had. This
-can be set manually to create incomplete measures (anacrusis, upbeat),
-the start of the music.
-")
-(translator-property-description 'melismaBusy boolean? "Signifies
-whether a melisma is active. This can be used to signal melismas on
-top of those automatically detected. ")
-(translator-property-description 'melismaBusyProperties list?
- "List of properties (symbols) to
+
+ (measurePosition ,ly:moment? "How much of the current measure
+have we had. This can be set manually to create incomplete
+measures.")
+
+ (melismaBusyProperties ,list? "List of properties (symbols) to
determine whether a melisma is playing. Setting this property will
influence how lyrics are aligned to notes. For example, if set to
-@code{#'(melismaBusy beamMelismaBusy)}, only manual melismata
-(i.e. setting @code{melismaBusy} to @code{#t}) and manual beams are
-considered. Possible values include @code{melismaBusy},
-@code{slurMelismaBusy}, @code{tieMelismaBusy}, and
+@code{#'(melismaBusy beamMelismaBusy)}, only manual melismata and
+manual beams are considered. Possible values include
+@code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
@code{beamMelismaBusy}")
-(translator-property-description 'metronomeMarkFormatter procedure?
- "How to produce a metronome markup.
-Called with 2 arguments, event and context.")
-(translator-property-description 'midiInstrument string? "Name of the
-MIDI instrument to use ")
-(translator-property-description 'midiMinimumVolume number? "[DOCUMENT-ME]")
-(translator-property-description 'midiMaximumVolume number? "[DOCUMENT-ME]")
-(translator-property-description 'minimumFret number? "The tablature
-auto string-selecting mechanism selects the highest string with a fret
-not less than minimumFret")
-(translator-property-description 'minimumVerticalExtent number-pair?
-"minimum vertical extent, same format as VerticalExtent")
-(translator-property-description 'recordEventSequence procedure?
- "Upon termination of this context,
+ (metronomeMarkFormatter ,procedure? "How to produce a metronome
+markup. Called with 2 arguments, event and context.")
+ (midiInstrument ,string? "Name of the MIDI instrument to use ")
+ (midiMinimumVolume ,number? "[DOCUMENT-ME]")
+ (midiMaximumVolume ,number? "[DOCUMENT-ME]")
+ (minimumFret ,number? "The tablature auto string-selecting mechanism
+selects the highest string with a fret not less than minimumFret")
+ (minimumVerticalExtent ,number-pair? "minimum vertical extent, same
+format as VerticalExtent")
+ (recordEventSequence ,procedure? "Upon termination of this context,
this function is called with current context and a list of music
objects. The list of contains entries with start times, music objects
and whether they're processed in this context.")
-
-(translator-property-description
- 'originalCentralCPosition integer?
- "Used for temporary overriding central C in octavation brackets. ")
-(translator-property-description 'othersolo boolean? "FIXME")
-(translator-property-description 'ottavation string? "If set, the text
-for an 8va spanner. Changing this implies a new text spanner. ")
-(translator-property-description 'pedalSustainStrings list? "List of string to print for sustain-pedal. Format is
- (UP UPDOWN DOWN), where each of the three is the string to print when
-this is done with the pedal.")
-(translator-property-description 'pedalUnaCordaStrings list? "see pedalSustainStrings.")
-(translator-property-description 'pedalSostenutoStrings list? "see pedalSustainStrings.")
-(translator-property-description 'pedalSustainStyle symbol? "A symbol
-that indicates how to print sustain pedals: text, bracket or mixed
-(both).")
-(translator-property-description 'pedalUnaCordaStyle symbol? "see pedalSustainStyle.")
-(translator-property-description 'pedalSostenutoStyle symbol? "see pedalSustainStyle.")
-
-(translator-property-description 'rehearsalMark integer? "The
-last rehearsal mark printed.")
-(translator-property-description 'repeatCommands list? "This property is read to find any command of the form (volta . X), where X is a string or #f")
-(translator-property-description 'scriptDefinitions list? "
-Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
-")
-
-(translator-property-description 'restNumberThreshold number?
- "If a multimeasure rest takes less
+ (ottavation ,string? "If set, the text for an 8va spanner. Changing
+this implies a new text spanner. ")
+ (pedalSustainStrings ,list? "List of string to print for
+sustain-pedal. Format is (UP UPDOWN DOWN), where each of the three is
+the string to print when this is done with the pedal.")
+ (pedalUnaCordaStrings ,list? "see pedalSustainStrings.")
+ (pedalSostenutoStrings ,list? "see pedalSustainStrings.")
+ (pedalSustainStyle ,symbol? "A symbol that indicates how to print
+sustain pedals: text, bracket or mixed (both).")
+ (pedalUnaCordaStyle ,symbol? "see pedalSustainStyle.")
+ (pedalSostenutoStyle ,symbol? "see pedalSustainStyle.")
+ (rehearsalMark ,integer? "The last rehearsal mark printed.")
+ (repeatCommands ,list? "This property is read to find any command of the form (volta . X), where X is a string or #f")
+
+ (restNumberThreshold ,number?
+ "If a multimeasure rest takes less
than this number of measures, no number is printed. ")
-(translator-property-description 'skipBars boolean? "If set to true, then
+ (skipBars ,boolean? "If set to true, then
skip the empty bars that are produced by multimeasure notes and rests.
These bars will not appear on the printed output. If not set (the
default) multimeasure notes and rests expand into their full length,
r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
@@end lilypond
@end example
-
")
-(translator-property-description 'skipTypesetting boolean?
- "When true, all no typesetting is done at
+ (skipTypesetting ,boolean?
+ "When true, all no typesetting is done at
this moment, causing the interpretation phase to go a lot faster. This can
help with debugging large scores.")
-(translator-property-description 'slurMelismaBusy boolean? "Signal if a slur is present.")
-(translator-property-description 'solo boolean? "set if solo is detected by the part combiner.")
-(translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?")
-(translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining.")
-(translator-property-description 'soloText string? "text for begin of solo when part-combining.")
-(translator-property-description 'sparseTies boolean? "only create one tie per chord.")
-(translator-property-description 'squashedPosition integer? " Vertical position of
+ (soloADue ,boolean? "set Solo/A due texts in the part combiner?")
+ (soloIIText ,string? "text for begin of solo for voice ``two'' when part-combining.")
+ (soloText ,string? "text for begin of solo when part-combining.")
+ (sparseTies ,boolean? "only create one tie per chord.")
+ (squashedPosition ,integer? " Vertical position of
squashing for Pitch_squash_engraver.")
-(translator-property-description 'stringOneTopmost boolean? "Whether the 1st string is printed on the
+
+ (stringOneTopmost ,boolean? "Whether the 1st string is printed on the
top line of the tablature.")
-(translator-property-description 'stavesFound list? "list of all staff-symbols found.")
-(translator-property-description 'stanza markup? "Stanza `number' to
-print before the start of a verse. Use in LyricsVoice context.")
-(translator-property-description 'stemLeftBeamCount integer? "
-Specify the number of beams to draw on the left side of the next note.
-Overrides automatic beaming. The value is only used once, and then it
-is erased.
-.")
-(translator-property-description 'stemRightBeamCount integer? "idem, for the right side.")
-(translator-property-description 'stringTunings list? "The tablature strings tuning. Must be a list of the different semitons pitch of each string (starting by the lower one).")
-(translator-property-description 'subdivideBeams boolean? "If set, multiple beams will be subdivided at beat
-positions - by only drawing one beam over the beat.")
-(translator-property-description 'systemStartDelimiter symbol? "Which grob to make for the start of the system/staff? Set to @code{SystemStartBrace}, @code{SystemStartBracket} or @code{SystemStartBar}.")
-(translator-property-description 'tablatureFormat procedure?
- "Function formatting a tab notehead; it takes
-a string number, a list of string tunings and Pitch object. It returns the text as a string.")
-
-(translator-property-description 'tieMelismaBusy boolean? "Signal whether a tie is present.")
-(translator-property-description 'timeSignatureFraction number-pair?
-"pair of numbers, signifying the time signature. For example #'(4 . 4)
+
+ (stanza ,markup? "Stanza `number' to print before the start of a
+verse. Use in Lyrics context.")
+
+ (stemLeftBeamCount ,integer? " Specify the number of beams to draw on
+the left side of the next note. Overrides automatic beaming. The
+value is only used once, and then it is erased. [JUNKME.]")
+
+ (stemRightBeamCount ,integer? "idem, for the right side. [JUNKME]")
+
+ (stringTunings ,list? "The tablature strings tuning. Must be a list of
+the different semitons pitch of each string (starting by the lower
+one).")
+
+ (subdivideBeams ,boolean? "If set, multiple beams will be subdivided
+at beat positions - by only drawing one beam over the beat.")
+
+ (systemStartDelimiter ,symbol? "Which grob to make for the start of
+the system/staff? Set to @code{SystemStartBrace},
+@code{SystemStartBracket} or @code{SystemStartBar}.")
+
+ (tablatureFormat ,procedure? "Function formatting a tab notehead; it
+takes a string number, a list of string tunings and Pitch object. It
+returns the text as a string.")
+
+ (timeSignatureFraction ,number-pair?
+ "pair of numbers, signifying the time signature. For example #'(4 . 4)
is a 4/4 time signature.")
-(translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
+ (timing ,boolean? " Keep administration of measure length, position, bar number, etc?
Switch off for cadenzas.")
-(translator-property-description 'tonic ly:pitch?
- "The tonic of the current scale")
-(translator-property-description 'transposing integer? "Transpose the MIDI output. Set this property to the number of half-steps to transpose by.")
-(translator-property-description 'tremoloFlags integer? "Number of tremolo flags to add if none is specified.")
-(translator-property-description 'tupletNumberFormatFunction procedure?
- "Function taking a music as input, producing a string. This function is called to determine the text to print on a tuplet bracket.")
-
-
-;; remove this?
-(translator-property-description 'tupletInvisible boolean? "
- If set to true, tuplet bracket creation is switched off
-entirely. This has the same effect as setting both
-@code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
-@code{#f}, but as this does not even create any grobs, this setting
-uses less memory and time.")
-
-(translator-property-description 'tupletSpannerDuration ly:moment? "
+ (tonic ,ly:pitch?
+ "The tonic of the current scale")
+ (transposing ,integer? "Transpose the MIDI output. Set this property to the number of half-steps to transpose by.")
+
+ (tremoloFlags ,integer? "Number of tremolo flags to add if none is specified.")
+
+ (tupletNumberFormatFunction
+ ,procedure?
+ "Function taking a music as input, producing a string. This function
+is called to determine the text to print on a tuplet bracket.")
+
+ (tupletSpannerDuration ,ly:moment? "
Normally a tuplet bracket is as wide as the
@code{\\times} expression that gave rise to it. By setting this
property, you can make brackets last shorter. Example
@@end lilypond
@end example
.")
-(translator-property-description 'verticalAlignmentChildCallback
-procedure? "what callback to add to children of a vertical alignment.
+ (verticalAlignmentChildCallback ,procedure? "what callback to add to children of a vertical alignment.
It determines what alignment procedure is used on the alignment
itself. .")
-(translator-property-description 'verticalExtent number-pair? "hard
-coded vertical extent. The format is a pair of dimensions, for
-example, this sets the sizes of a staff to 10 (5+5) staffspaces high.
+ (verticalExtent ,number-pair? "hard coded vertical extent. The format
+is a pair of dimensions, for example, this sets the sizes of a staff
+to 10 (5+5) staffspaces high.
@example
property Staff.verticalExtent = #'(-5.0 . 5.0)
@end example
-VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are
-predefined in all relevant contexts to @code{#f}, so they will not
-inherit values.
-Note that these VerticalExtents can only operate on vertical groups,
-and therefore only work in contexts which contain an
-@code{Axis_group_engraver}.
-")
+This does not work for Voice or any other context that doesn't form a
+vertical group.")
-(translator-property-description 'vocalName markup?
- "Name of a vocal line.")
-(translator-property-description 'vocNam markup?
- "Name of a vocal line, short version.")
+ (vocalName ,markup? "Name of a vocal line.")
+ (vocNam ,markup? "Name of a vocal line, short version.")
-(translator-property-description 'voltaOnThisStaff boolean?
- "Normally, volta brackets are put only on the topmost staff. Setting
+ (voltaOnThisStaff ,boolean?
+ "Normally, volta brackets are put only on the topmost staff. Setting
this variable to true, will force a bracket to be on this staff as
well.")
-(translator-property-description 'voltaSpannerDuration ly:moment? "maximum duration of the volta bracket.
+ (voltaSpannerDuration ,ly:moment? "This specifies the maximum duration
+to use for the brackets printed for @code{\\alternative}. This can be
+used to shrink the length of brackets in the situation where one
+alternative is very large.")
- Set to a duration to control the size of the brackets printed by
-@code{\\alternative}. It specifies the number of whole notes duration
-to use for the brackets. This can be used to shrink the length of
-brackets in the situation where one alternative is very large. It may
-have odd effects if the specified duration is longer than the music
-given in an @code{\\alternative}.
-.")
-(translator-property-description 'whichBar string?
- "This property is read to determine what type of barline to create.
+ (whichBar
+ ,string?
+ "This property is read to determine what type of barline to create.
Example:
@example
@end example
This will create a start-repeat bar in this staff only.
+Valid values are described in @ref{bar-line-interface}.
+")
+ )))
-If not set explicitly (by property or @code{\\bar}), this is set
-according to values of @code{defaultBarType}, @code{barAlways},
-@code{barNonAuto} and @code{measurePosition}.
+(define all-internal-translation-properties
+ (map
+ (lambda (x)
+ (set-object-property! (car x) 'internal-translation #t)
+ (apply translator-property-description x)
-Valid values are described in @ref{bar-line-interface}.
+ )
+
+ `(
+
+ (slurMelismaBusy ,boolean? "Signal if a slur is present.")
+ (originalCentralCPosition
+ ,integer?
+ "Used for temporary overriding central C in octavation brackets. ")
+ (melismaBusy ,boolean? "Signifies
+whether a melisma is active. This can be used to signal melismas on
+top of those automatically detected. ")
+ (graceSettings ,vector?
+ "Overrides for grace notes. This
+property should be manipulated through the @code{add-grace-property}
+function.")
+ (currentCommandColumn ,ly:grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
+ (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
+ (breakableSeparationItem ,ly:grob?
+ "The breakable items in this time step, for this staff.")
+
+ (localKeySignature ,list? "the key signature at this point in the
+measure. The format is the same as for keySignature, but can also contain
+((OCTAVE . NAME) . (ALTER . BARNUMBER)) pairs. It is reset at every
+bar line.
+" )
+
+
+ (localKeySignatureChanges ,list? "Experimental.
+ [DOCME]")
+
+ (finalizations ,list? "List of expressions to evaluate before proceeding to next time step. Internal variable.")
+ (busyGrobs ,list? "
+a queue of (END-MOMENT . GROB) conses. This is for internal (C++) use only.
+This property contains the grobs which are still busy (eg. noteheads, spanners, etc.)
+")
+ (barCheckLastFail ,ly:moment? "Where in the measurze did the last barcheck fail?")
+ (associatedVoiceContext ,ly:context? "The context object of the Voice that has the melody for this Lyrics.")
+ (acceptHashTable ,vector? "Internal
+variable: store table with MusicName to Engraver entries.")
+ (acknowledgeHashTable ,vector?
+ "Internal variable: store interface to engraver smob table for current
+context.")
+
+ (beamMelismaBusy ,boolean? "Signal if a beam is present.")
+(dynamicAbsoluteVolumeFunction ,procedure? "[DOCUMENT-ME]
")
+(lastKeySignature ,list? "Last key
+signature before a key signature change.")
+
+(scriptDefinitions ,list? "
+Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
+")
+(stavesFound ,grob-list? "list of all staff-symbols found.")
+(tieMelismaBusy ,boolean? "Signal whether a tie is present.")
+ )
+ ))
+
+(define all-translation-properties
+ (append all-user-translation-properties
+ all-internal-translation-properties))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
projects / lilypond.git / commitdiff