Node:VaticanaStaff, Next:, Previous:Thread, Up:Contexts



VaticanaStaff

Same as Staff context, except that it is accommodated for tyepsetting Gregorian Chant in the notational style of Editio Vaticana.

This context is also known as:

Staff

This context creates the following grobs: Accidental, BarLine, Clef, Custos, DotColumn, InstrumentName, KeySignature, NoteCollision, OctavateEight, OttavaSpanner, RestCollision, SeparatingGroupSpanner, SeparationItem, SostenutoPedalLineSpanner, SostenutoPedal, StaffSymbol, SustainPedalLineSpanner, SustainPedal, UnaCordaPedalLineSpanner, UnaCordaPedal, VerticalAxisGroup and VoltaBracket.

This context sets the following properties:

Context VaticanaStaff can contain VaticanaVoice

This context is built from the following engravers:


Engraver_group_engraver
A group of engravers taken together
Custos_engraver

This engraver creates the following grobs: Custos.

String_number_engraver
Swallow string-number-events - the purpose of this engraver is to process tab for normal notation. To provent warnings for unprocessed string-number-event to obscure real error messages, this engraver swallows them all.

Music types accepted: string-number-event

Forbid_line_break_engraver
Forbid line breaks when note heads are still playing at some point.

Properties (read)


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.

Grob_pq_engraver
Administrate when certain grobs (eg. note heads) stop playing; this engraver is a sort-of a failure, since it doesn't handle all sorts of borderline cases very well.

Properties (read)


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.
Properties (write)

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.

Instrument_name_engraver
Prints the name of the instrument (specified by Staff.instrument and Staff.instr) at the left of the staff.

Properties (read)


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.
This engraver creates the following grobs: InstrumentName.
Piano_pedal_engraver
Engrave piano pedal symbols and brackets.

Music types accepted: abort-event and pedal-event

Properties (read)


pedalUnaCordaStyle (symbol)
see pedalSustainStyle.
pedalSustainStyle (symbol)
A symbol that indicates how to print sustain pedals: text, bracket or mixed (both).
pedalSostenutoStyle (symbol)
see pedalSustainStyle.
pedalUnaCordaStrings (list)
see pedalSustainStrings.
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.
pedalSostenutoStrings (list)
see pedalSustainStrings.
This engraver creates the following grobs: SostenutoPedal, SostenutoPedalLineSpanner, SustainPedal, SustainPedalLineSpanner, UnaCordaPedal and UnaCordaPedalLineSpanner.
Accidental_engraver
Make accidentals. Catches note heads, ties and notices key-change events. Due to interaction with ties (which don't come together with note heads), this needs to be in a context higher than Tie_engraver.

Properties (read)


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.
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.

extraNatural (boolean)
Whether to typeset an extra natural sign before accidentals changing from a non-natural to another non-natural.
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.
Properties (write)

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.
This engraver creates the following grobs: Accidental.
Rest_collision_engraver
Handles collisions of rests.

This engraver creates the following grobs: RestCollision.

Collision_engraver

This engraver creates the following grobs: NoteCollision.

Staff_symbol_engraver
create the constellation of five (default) staff lines.

This engraver creates the following grobs: StaffSymbol.

Key_engraver

Music types accepted: key-change-event

Properties (read)


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.
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.
createKeyOnClefChange (boolean)
Print a key signature whenever the clef is changed.
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.
lastKeySignature (list)
Last key signature before a key signature change.
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.
Properties (write)

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.
tonic (pitch)
The tonic of the current scale
lastKeySignature (list)
Last key signature before a key signature change.
This engraver creates the following grobs: KeySignature.
Clef_engraver
Determine and set reference point for pitches

Properties (read)


explicitClefVisibility (procedure)
visibility-lambda function for clef changes.
clefOctavation (integer)
Add this much extra octavation. Values of 7 and -7 are common.
centralCPosition (number)
Place of the central C, measured in half staffspaces. Usually determined by looking at clefPosition and clefGlyph.
clefGlyph (string)
Name of the symbol within the music font
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.
This engraver creates the following grobs: Clef and OctavateEight.
Ottava_spanner_engraver
Create a text spanner when the ottavation property changes..

Properties (read)


ottavation (string)
If set, the text for an 8va spanner. Changing this implies a new text spanner.
This engraver creates the following grobs: OttavaSpanner.
Dot_column_engraver
Engraves dots on dotted notes shifted to the right of the note. If omitted, then dots appear on top of the notes.

This engraver creates the following grobs: DotColumn.

Separating_line_group_engraver
Generates objects for computing spacing parameters.

This engraver creates the following grobs: SeparatingGroupSpanner and SeparationItem.

Volta_engraver
Make volta brackets

Properties (read)


stavesFound (list)
list of all staff-symbols found.
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. .

repeatCommands (list)
This property is read to find any command of the form (volta . X), where X is a string or #f
This engraver creates the following grobs: VoltaBracket.
Font_size_engraver
Puts fontSize into font-relative-size grob property.

Properties (read)


fontSize (integer)
Used to set the relative size of all grobs in a context. This is done using the Font_size_engraver.

Bar_engraver
Create barlines. This engraver is controlled through the whichBar property. If it has no bar line to create, it will forbid a linebreak at this point

Properties (read)


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 engraver creates the following grobs: BarLine.
Output_property_engraver
Interpret Music of Output_property type, and apply a function to any Graphic objects that satisfies the predicate.

Music types accepted: layout-instruction

Axis_group_engraver
Group all objects created in this context in a VerticalAxisGroup spanner.

Properties (read)


extraVerticalExtent (pair of numbers)
extra vertical extent, same format as MinimumVerticalExtent
minimumVerticalExtent (pair of numbers)
minimum vertical extent, same format as VerticalExtent
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.

This engraver creates the following grobs: VerticalAxisGroup.

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

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