Node: Context properties, Previous: Engravers, Up: Translation



Context properties


aDueText (string)
text for begin of a due
acceptHashTable (vector)
Internal variable: store table with MusicName to Engraver entries.
acknowledgeHashTable (vector)
Internal variable: store interface to engraver smob table for current context. Don't mess with this.
alignBassFigureAccidentals (boolean)
If true, then the accidentals are aligned in bass figure context.
allowBeamBreak (boolean)
If true allow line breaks during beams.
associatedVoice (string)
Name of the Voice that has the melody for this LyricsVoice.
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:
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.
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.

autoBeamSettings (list)
Specifies when automatically generated beams should begin and end. The elements have the format:
          
             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))
               ...
              )
          
          

autoBeaming (boolean)
If set to true then beams are generated automatically.
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.
automaticBars (boolean)
If set to true then bar lines will not be printed automatically; they must be explicitly created with bar keywords. Unlike with the cadenza keyword, measures are still counted. Bar generation will resume according to that count if this property is set to zero.
automaticMelismata (boolean)
If set, \addlyrics will assume that beams, slurs and ties signal melismata, and align lyrics accordingly.
automaticPhrasing (boolean)
If set, the Lyric_phrasing_engraver will match note heads of context called Voice X to syllables from LyricsVoice called X-<something>. This feature is turned on by default. See the example file lyrics-multi-stanza.ly.
barAlways (boolean)
If set to true a bar line is drawn after each note.
barCheckSynchronize (boolean)
If true then reset measurePosition when finding a barcheck. Turn off when using barchecks in polyphonic music.
barNumberVisibility (procedure)
Procedure that takes an int and returns whether the corresponding bar number should be printed
bassFigureFormatFunction (procedure)
DOCME
beamMelismaBusy (boolean)
Signal if a beam is set when automaticMelismata is set
beatGrouping (list)
List of beatgroups. Eg. in 5/8 time #(list 2 3).
beatLength (moment)
The length of one beat in this time signature.
breakAlignOrder (list)
Defines the order in which prefatory matter (clefs, key signatures) appears, eg. this puts the key signatures after the bar lines:
          	\property Score.breakAlignOrder = #'(
          	  span-bar
          	  breathing-sign
          	  clef
          	  staff-bar
          	  key
          	  time-signature
          	)
          

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.
centralCPosition (number)
Place of the central C, measured in half staffspaces. Usually determined by looking at clefPosition and clefGlyph.
changeMoment (unknown)
duration that voices are examined for differences, when part-combining. Usually unset or zero when combining threads into one voice, and 1 (or the duration of one measure) when combining voices into one staff.
chordChanges (boolean)
Only show changes in chords scheme?
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.
chordNameFunction (procedure)
The function that converts lists of pitches to chord names.
chordNameSeparator (markup)
The markup object used to separate parts of a chord name.
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.
clefGlyph (string)
Name of the symbol within the music font
clefOctavation (integer)
Add this much extra octavation. Values of 7 and -7 are common.
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.
combineParts (boolean)
try to combine parts?
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.
crescendoSpanner (symbol)
Type of spanner to be used for crescendi. One of: hairpin, line, dashed-line, dotted-line. If unset, hairpin type is used.
crescendoText (markup)
Text to print at start of non-hairpin crecscendo, ie: cresc.
currentBarNumber (integer)
Contains the current barnumber. This property is incremented at every barline.
currentCommandColumn (grob (GRaphical OBject))
Grob that is X-parent to all current breakable (clef, key signature, etc.) items.
currentMusicalColumn (grob (GRaphical OBject))
Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).
decrescendoSpanner (symbol)
Type of spanner to be used for decrescendi. One of: hairpin, line, dashed-line, dotted-line. If unset, hairpin type is used.
decrescendoText (markup)
Text to print at start of non-hairpin decrecscendo, ie: dim.
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.

devNullThread (symbol)
User control of Thread_devnull_engraver: one of
(), or unset
Behave in normal way: remove one set of grobs when in unisolo.
always:
Remove any grob that comes along.
never:
Do nothing.

devNullVoice (symbol)
User control of Voice_devnull_engraver: one of
(), or unset
Behave in normal way: remove spanners when in unisolo.
always:
Remove any spanners that come along.
never:
Do nothing.

dynamicAbsoluteVolumeFunction (procedure)
[DOCUMENT-ME]
explicitClefVisibility (procedure)
visibility-lambda function for clef changes.
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.
extraNatural (boolean)
Whether to typeset an extra natural sign before accidentals changing from a non-natural to another non-natural.
extraVerticalExtent (pair of numbers)
extra vertical extent, same format as MinimumVerticalExtent
finalizations (list)
List of expressions to evaluate before proceeding to next time step. Internal variable.
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.
followVoice (boolean)
if set, note heads are tracked across staff switches by a thin line
fontSize (integer)
Used to set the relative size of all grobs in a context. This is done using the Font_size_engraver.
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.
graceSettings (vector)
Overrides for grace notes. This property should be manipulated through the add-grace-property function.
highStringOne (boolean)
Whether the 1st string is the string with highest pitch on the instrument (used by the automatic string selector).
instr (markup)
see instrument
instrument (markup)
If Instrument_name_engraver is added to the Staff translator, then the instrument property is used to label the first line of the staff and the instr property is used to label subsequent lines. If the midiInstrument property is not set, then instrument is used to determine the instrument for MIDI output.
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.
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.
lastKeySignature (list)
Last key signature before a key signature change.
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.
localKeySignatureChanges (list)
Experimental. [DOCME]
majorSevenSymbol (markup)
How should the major7 be formatted in a chord name?
measureLength (moment)
Length of one measure in the current time signature last?
measurePosition (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.
melismaBusy (boolean)
Signifies whether a melisma is active. This can be used to signal melismas on top of those automatically detected.
melismaBusyProperties (list)
List of properties (symbols) to determine whether a melisma is playing.
melismaEngraverBusy (boolean)
See melismaBusy. This is set automatically.
metronomeMarkFormatter (procedure)
How to produce a metronome markup. Called with 2 arguments, event and context.
midiInstrument (string)
Name of the MIDI instrument to use
midiMaximumVolume (number)
[DOCUMENT-ME]
midiMinimumVolume (number)
[DOCUMENT-ME]
minimumFret (number)
The tablature auto string-selecting mechanism selects the highest string with a fret not less than minimumFret
minimumVerticalExtent (pair of numbers)
minimum vertical extent, same format as VerticalExtent
noDirection (boolean)
Don't set directions by a2-engraver when part-combining.
originalCentralCPosition (integer)
Used for temporary overriding central C in octavation brackets.
othersolo (boolean)
FIXME
ottavation (string)
If set, the text for an 8va spanner. Changing this implies a new text spanner.
pedalSostenutoStrings (list)
see pedalSustainStrings.
pedalSostenutoStyle (symbol)
see pedalSustainStyle.
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.
pedalSustainStyle (symbol)
A symbol that indicates how to print sustain pedals: text, bracket or mixed (both).
pedalUnaCordaStrings (list)
see pedalSustainStrings.
pedalUnaCordaStyle (symbol)
see pedalSustainStyle.
phrasingPunctuation (string)
A string of characters that are considered lyric punctuation
rehearsalMark (number or string)
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.
scriptDefinitions (list)
Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See scm/script.scm for more information
scriptHorizontal (boolean)
Put scripts left or right of note heads. Support for this is limited. Accidentals will collide with scripts.
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, printing the appropriate number of empty bars so that synchronization with other voices is preserved.
          @lilypond[fragment,verbatim,center]
          r1 r1*3 R1*3  \\property Score.skipBars= ##t r1*3 R1*3
          
          @end lilypond
          

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.
slurMelismaBusy (boolean)
Signal a slur if automaticMelismata is set.
solo (boolean)
set if solo is detected by the part combiner.
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.
split-interval (boolean)
set if part-combiner separated voices based on splitInterval.
splitInterval (pair of numbers)
part-combiner will separate its two voices (or threads) when interval between the two voices is contained in this range.
squashedPosition (integer)
Vertical position of squashing for Pitch_squash_engraver.
stanza (markup)
Stanza `number' to print at start of a verse. Use in LyricsVoice context.
stavesFound (list)
list of all staff-symbols found.
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. .
stemRightBeamCount (integer)
idem, for the right side.
stringOneTopmost (boolean)
Whether the 1st string is printed on the top line of the tablature.
stringTunings (list)
The tablature strings tuning. Must be a list of the different semitons pitch of each string (starting by the lower one).
stz (markup)
Abbreviated form for a stanza, see also Stanza property.
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?
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.
tieMelismaBusy (boolean)
Signal ties when automaticMelismata is set.
timeSignatureFraction (pair of numbers)
pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time signature.
timing (boolean)
Keep administration of measure length, position, bar number, etc? Switch off for cadenzas.
tonic (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.
tupletInvisible (boolean)
If set to true, tuplet bracket creation is switched off entirely. This has the same effect as setting both tupletNumberVisibility and tupletBracketVisibility to #f, but as this does not even create any grobs, this setting uses less memory and time.
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 (moment)
Normally a tuplet bracket is as wide as the imes expression that gave rise to it. By setting this property, you can make brackets last shorter. Example
          @lilypond[verbatim,fragment]
          context Voice 	imes 2/3 {
            property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
            c-[8 c c-] c-[ c c-]
          }
          @end lilypond
          
.
unirhythm (boolean)
set if unirhythm is detected by the part combiner.
unisilence (boolean)
set if unisilence is detected by the part combiner.
unison (boolean)
set if unisono is detected by the part combiner. .
verticalAlignmentChildCallback (procedure)
what callback to add to children of a vertical alignment. It determines what alignment procedure is used on the alignment itself. .
verticalExtent (pair of numbers)
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.
          property Staff.verticalExtent = #(-5.0 . 5.0)
          

VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are predefined in all relevant contexts to #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 Axis_group_engraver.

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.
voltaSpannerDuration (moment)
maximum duration of the volta bracket.

Set to a duration to control the size of the brackets printed by \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 \alternative. .

whichBar (string)
This property is read to determine what type of barline to create.

Example:

          \property Staff.whichBar = "|:"
          

This will create a start-repeat bar in this staff only.

If not set explicitly (by property or bar), this is set according to values of defaultBarType, barAlways, barNonAuto and measurePosition.

Valid values are described in (lilypond-internals)bar-line-interface.

.


This page is for LilyPond-2.0.1 (stable-branch).

Report errors to <bug-lilypond@gnu.org>.