2.1.25 VaticanaVoice

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

This context also accepts commands for the following context(s):

Voice.

This context creates the following layout object(s):

Arpeggio, Beam, BendAfter, BreathingSign, ClusterSpannerBeacon, ClusterSpanner, CombineTextScript, DotColumn, Dots, DoublePercentRepeatCounter, DoublePercentRepeat, DynamicLineSpanner, DynamicTextSpanner, DynamicText, Fingering, Glissando, Hairpin, InstrumentSwitch, LaissezVibrerTieColumn, LaissezVibrerTie, MultiMeasureRestNumber, MultiMeasureRestText, MultiMeasureRest, NoteColumn, NoteHead, NoteSpacing, PercentRepeatCounter, PercentRepeat, PhrasingSlur, RepeatSlash, RepeatTieColumn, RepeatTie, Rest, ScriptColumn, Script, StringNumber, StrokeFinger, TextScript, TextSpanner, TieColumn, Tie, TrillPitchAccidental, TrillPitchGroup, TrillPitchHead, TrillSpanner, TupletBracket, TupletNumber, VaticanaLigature and VoiceFollower.

This context sets the following properties:

This context is a ‘bottom’ context; it cannot contain other contexts.

This context is built from the following engraver(s):

Vaticana_ligature_engraver

Handle ligatures by glueing special ligature heads together.

Music types accepted:

ligature-event and pes-or-flexa-event

This engraver creates the following layout object(s):

DotColumn and VaticanaLigature.

Skip_event_swallow_translator

Swallow \skip.

Instrument_switch_engraver

Create a cue text for taking instrument.

Properties (read)

instrumentCueName (markup)

The name to print if another instrument is to be taken.

This engraver creates the following layout object(s):

InstrumentSwitch.

Grace_engraver

Set font size and other properties for grace notes.

Properties (read)

graceSettings (list)

Overrides for grace notes. This property should be manipulated through the add-grace-property function.

Tuplet_engraver

Catch tuplet events and generate appropriate bracket.

Music types accepted:

tuplet-span-event

Properties (read)

tupletFullLength (boolean)

If set, the tuplet is printed up to the start of the next note.

tupletFullLengthNote (boolean)

If set, end at the next note, otherwise end on the matter (time signatures, etc.) before the note.

This engraver creates the following layout object(s):

TupletBracket and TupletNumber.

Tie_engraver

Generate ties between note heads of equal pitch.

Music types accepted:

tie-event

Properties (read)

tieWaitForNote (boolean)

If true, tied notes do not have to follow each other directly. This can be used for writing out arpeggios.

Properties (write)

tieMelismaBusy (boolean)

Signal whether a tie is present.

This engraver creates the following layout object(s):

Tie and TieColumn.

Cluster_spanner_engraver

Engrave a cluster using Spanner notation.

Music types accepted:

cluster-note-event

This engraver creates the following layout object(s):

ClusterSpanner and ClusterSpannerBeacon.

Phrasing_slur_engraver

Print phrasing slurs. Similar to Slur_engraver.

Music types accepted:

phrasing-slur-event

This engraver creates the following layout object(s):

PhrasingSlur.

Spanner_break_forbid_engraver

Forbid breaks in certain spanners.

Note_spacing_engraver

Generate NoteSpacing, an object linking horizontal lines for use in spacing.

This engraver creates the following layout object(s):

NoteSpacing.

Rhythmic_column_engraver

Generate NoteColumn, an object that groups stems, note heads, and rests.

This engraver creates the following layout object(s):

NoteColumn.

Script_column_engraver

Find potentially colliding scripts and put them into a ScriptColumn object; that will fix the collisions.

This engraver creates the following layout object(s):

ScriptColumn.

Script_engraver

Handle note scripted articulations.

Music types accepted:

articulation-event

Properties (read)

scriptDefinitions (list)

The description of scripts. This is used by the Script_engraver for typesetting note-superscripts and subscripts. See ‘scm/script.scm’ for more information.

This engraver creates the following layout object(s):

Script.

Bend_engraver

Create fall spanners.

Music types accepted:

bend-after-event

This engraver creates the following layout object(s):

BendAfter.

Fingering_engraver

Create fingering scripts.

Music types accepted:

stroke-finger-event and fingering-event

This engraver creates the following layout object(s):

Fingering.

Dynamic_align_engraver

Align hairpins and dynamic texts on a horizontal line

Properties (read)

currentMusicalColumn (layout object)

Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).

This engraver creates the following layout object(s):

DynamicLineSpanner.

New_dynamic_engraver

Create hairpins, dynamic texts, and their vertical alignments. The symbols are collected onto a DynamicLineSpanner grob which takes care of vertical positioning.

Music types accepted:

span-dynamic-event and absolute-dynamic-event

Properties (read)

crescendoSpanner (symbol)

The type of spanner to be used for crescendi. Available values are ‘hairpin’ and ‘text’. If unset, a hairpin crescendo is used.

crescendoText (markup)

The text to print at start of non-hairpin crescendo, i.e., ‘cresc.’.

currentMusicalColumn (layout object)

Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).

decrescendoSpanner (symbol)

The type of spanner to be used for decrescendi. Available values are ‘hairpin’ and ‘text’. If unset, a hairpin decrescendo is used.

decrescendoText (markup)

The text to print at start of non-hairpin decrescendo, i.e., ‘dim.’.

This engraver creates the following layout object(s):

DynamicText, DynamicTextSpanner, Hairpin and TextSpanner.

Text_engraver

Create text scripts.

Music types accepted:

text-script-event

This engraver creates the following layout object(s):

TextScript.

Part_combine_engraver

Part combine engraver for orchestral scores: Print markings ‘a2’, ‘Solo’, ‘Solo II’, and ‘unisono’.

Music types accepted:

part-combine-event

Properties (read)

printPartCombineTexts (boolean)

Set ‘Solo’ and ‘A due’ texts in the part combiner?

soloText (markup)

The text for the start of a solo when part-combining.

soloIIText (markup)

The text for the start of a solo for voice ‘two’ when part-combining.

aDueText (markup)

Text to print at a unisono passage.

This engraver creates the following layout object(s):

CombineTextScript.

Slash_repeat_engraver

Make beat repeats.

Music types accepted:

percent-event

Properties (read)

measureLength (moment)

Length of one measure in the current time signature.

This engraver creates the following layout object(s):

RepeatSlash.

Percent_repeat_engraver

Make whole bar and double bar repeats.

Music types accepted:

percent-event

Properties (read)

countPercentRepeats (boolean)

If set, produce counters for percent repeats.

currentCommandColumn (layout object)

Grob that is X-parent to all current breakable (clef, key signature, etc.) items.

measureLength (moment)

Length of one measure in the current time signature.

repeatCountVisibility (procedure)

A procedure taking as arguments an integer and context, returning whether the corresponding percent repeat number should be printed when countPercentRepeats is set.

Properties (write)

forbidBreak (boolean)

If set to ##t, prevent a line break at this point.

This engraver creates the following layout object(s):

DoublePercentRepeat, DoublePercentRepeatCounter, PercentRepeat and PercentRepeatCounter.

Chord_tremolo_engraver

Generate beams for tremolo repeats.

Music types accepted:

tremolo-span-event

This engraver creates the following layout object(s):

Beam.

New_fingering_engraver

Create fingering scripts for notes in a new chord. This engraver is ill-named, since it also takes care of articulations and harmonic note heads.

Properties (read)

fingeringOrientations (list)

A list of symbols, containing ‘left’, ‘right’, ‘up’ and/or ‘down’. This list determines where fingerings are put relative to the chord being fingered.

harmonicDots (boolean)

If set, harmonic notes in dotted chords get dots.

strokeFingerOrientations (list)

See fingeringOrientations.

stringNumberOrientations (list)

See fingeringOrientations.

This engraver creates the following layout object(s):

Fingering, Script, StringNumber and StrokeFinger.

Auto_beam_engraver

Generate beams based on measure characteristics and observed Stems. Uses beatLength, measureLength, and measurePosition to decide when to start and stop a beam. Overriding beaming is done through Stem_engraver properties stemLeftBeamCount and stemRightBeamCount.

Music types accepted:

beam-forbid-event

Properties (read)

autoBeaming (boolean)

If set to true then beams are generated automatically.

autoBeamSettings (list)

Specifies when automatically generated beams should begin and end. See behavior Setting automatic beam behavior for more information.

beatLength (moment)

The length of one beat in this time signature.

subdivideBeams (boolean)

If set, multiple beams will be subdivided at beat positions by only drawing one beam over the beat.

This engraver creates the following layout object(s):

Beam.

Grace_beam_engraver

Handle Beam events by engraving beams. If omitted, then notes are printed with flags instead of beams. Only engraves beams when we are at grace points in time.

Music types accepted:

beam-event

Properties (read)

beamMelismaBusy (boolean)

Signal if a beam is present.

beatLength (moment)

The length of one beat in this time signature.

subdivideBeams (boolean)

If set, multiple beams will be subdivided at beat positions by only drawing one beam over the beat.

This engraver creates the following layout object(s):

Beam.

Beam_engraver

Handle Beam events by engraving beams. If omitted, then notes are printed with flags instead of beams.

Music types accepted:

beam-event

Properties (read)

beamMelismaBusy (boolean)

Signal if a beam is present.

beatLength (moment)

The length of one beat in this time signature.

subdivideBeams (boolean)

If set, multiple beams will be subdivided at beat positions by only drawing one beam over the beat.

Properties (write)

forbidBreak (boolean)

If set to ##t, prevent a line break at this point.

This engraver creates the following layout object(s):

Beam.

Tweak_engraver

Read the tweaks property from the originating event, and set properties.

Rest_engraver

Engrave rests.

Music types accepted:

rest-event

Properties (read)

middleCPosition (number)

The place of the middle C, measured in half staff-spaces. Usually determined by looking at middleCClefPosition and middleCOffset.

This engraver creates the following layout object(s):

Rest.

Dots_engraver

Create Dots objects for rhythmic-head-interfaces.

This engraver creates the following layout object(s):

Dots.

Note_heads_engraver

Generate note heads.

Music types accepted:

note-event

Properties (read)

middleCPosition (number)

The place of the middle C, measured in half staff-spaces. Usually determined by looking at middleCClefPosition and middleCOffset.

staffLineLayoutFunction (procedure)

Layout of staff lines, traditional, or semitone.

This engraver creates the following layout object(s):

NoteHead.

Breathing_sign_engraver

Create a breathing sign.

Music types accepted:

breathing-event

This engraver creates the following layout object(s):

BreathingSign.

Glissando_engraver

Engrave glissandi.

Music types accepted:

glissando-event

This engraver creates the following layout object(s):

Glissando.

Note_head_line_engraver

Engrave a line between two note heads, for example a glissando. If followVoice is set, staff switches also generate a line.

Properties (read)

followVoice (boolean)

If set, note heads are tracked across staff switches by a thin line.

This engraver creates the following layout object(s):

Glissando and VoiceFollower.

Repeat_tie_engraver

Create repeat ties.

Music types accepted:

repeat-tie-event

This engraver creates the following layout object(s):

RepeatTie and RepeatTieColumn.

Laissez_vibrer_engraver

Create laissez vibrer items.

Music types accepted:

laissez-vibrer-event

This engraver creates the following layout object(s):

LaissezVibrerTie and LaissezVibrerTieColumn.

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) cons cells. This is for internal (C++) use only. This property contains the grobs which are still busy (e.g. note heads, spanners, etc.).

Properties (write)

forbidBreak (boolean)

If set to ##t, prevent a line break at this point.

Grob_pq_engraver

Administrate when certain grobs (e.g., note heads) stop playing.

Properties (read)

busyGrobs (list)

A queue of (end-moment . GROB) cons cells. This is for internal (C++) use only. This property contains the grobs which are still busy (e.g. note heads, spanners, etc.).

Properties (write)

busyGrobs (list)

A queue of (end-moment . GROB) cons cells. This is for internal (C++) use only. This property contains the grobs which are still busy (e.g. note heads, spanners, etc.).

Trill_spanner_engraver

Create trill spanner from an event.

Music types accepted:

trill-span-event

This engraver creates the following layout object(s):

TrillSpanner.

Text_spanner_engraver

Create text spanner from an event.

Music types accepted:

text-span-event

This engraver creates the following layout object(s):

TextSpanner.

Multi_measure_rest_engraver

Engrave multi-measure rests that are produced with ‘R’. It reads measurePosition and internalBarNumber to determine what number to print over the MultiMeasureRest. Reads measureLength to determine whether it should use a whole rest or a breve rest to represent one measure.

Music types accepted:

multi-measure-text-event and multi-measure-rest-event

Properties (read)

internalBarNumber (integer)

Contains the current barnumber. This property is used for internal timekeeping, among others by the Accidental_engraver.

restNumberThreshold (number)

If a multimeasure rest has more measures than this, a number is printed.

breakableSeparationItem (layout object)

The breakable items in this time step, for this staff.

currentCommandColumn (layout object)

Grob that is X-parent to all current breakable (clef, key signature, etc.) items.

measurePosition (moment)

How much of the current measure have we had. This can be set manually to create incomplete measures.

measureLength (moment)

Length of one measure in the current time signature.

This engraver creates the following layout object(s):

MultiMeasureRest, MultiMeasureRestNumber and MultiMeasureRestText.

Arpeggio_engraver

Generate an Arpeggio symbol.

Music types accepted:

arpeggio-event

This engraver creates the following layout object(s):

Arpeggio.

Output_property_engraver

Apply a procedure to any grob acknowledged.

Music types accepted:

apply-output-event

Pitched_trill_engraver

Print the bracketed note head after a note head with trill.

This engraver creates the following layout object(s):

TrillPitchAccidental, TrillPitchGroup and TrillPitchHead.

Font_size_engraver

Put fontSize into font-size grob property.

Properties (read)

fontSize (number)

The relative size of all grobs in a context.


Internals Reference