LilyPond Internals Reference: 2.1.15 GregorianTranscriptionStaff

[ << Translation ]	[Top][Contents][Index]	[ Backend >> ]
[ < GregorianTranscriptionLyrics ]	[ Up : Contexts ]	[ GregorianTranscriptionVoice > ]

2.1.15 `GregorianTranscriptionStaff`

A staff for notating Gregorian chant in modern style.

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

This context creates the following layout object(s): Accidental, AccidentalCautionary, AccidentalPlacement, AccidentalSuggestion, BarLine, BassFigure, BassFigureAlignment, BassFigureAlignmentPositioning, BassFigureBracket, BassFigureContinuation, BassFigureLine, Clef, ClefModifier, CueClef, CueEndClef, Divisio, DotColumn, FingeringColumn, InstrumentName, KeyCancellation, KeySignature, LedgerLineSpanner, NoteCollision, OttavaBracket, PianoPedalBracket, RestCollision, ScriptColumn, ScriptRow, SostenutoPedal, SostenutoPedalLineSpanner, StaffEllipsis, StaffHighlight, StaffSpacing, StaffSymbol, SustainPedal, SustainPedalLineSpanner, UnaCordaPedal, UnaCordaPedalLineSpanner and VerticalAxisGroup.

This context sets the following properties:

Set context property autoAccidentals to:

'(Staff #<procedure 55e919b1c1a0 at /build/out/share/lilypond/current/scm/lily/music-functions.scm:1681:0 (context pitch barnum)>)

Set context property autoCautionaries to '().
Set context property caesuraTypeTransform to caesura-to-bar-line-or-divisio.
Set context property caesuraType to:
```
'((breath . varcomma))
```
Set context property createSpacing to #t.
Set context property doubleRepeatBarType to "||".
Set context property doubleRepeatSegnoBarType to "S-||".
Set context property endRepeatBarType to "||".
Set context property endRepeatSegnoBarType to "S-||".
Set context property extraNatural to #f.
Set context property fineBarType to "||".
Set context property fineSegnoBarType to "S-||".
Set context property fineStartRepeatSegnoBarType to "S-||".
Set context property forbidBreakBetweenBarLines to #f.
Set context property ignoreFiguredBassRest to #f.
Set context property instrumentName to '().
Set context property localAlterations to '().
Set context property measureBarType to '().

Set context property ottavationMarkups to:

'((4 . "29")
  (3 . "22")
  (2 . "15")
  (1 . "8")
  (-1 . "8")
  (-2 . "15")
  (-3 . "22")
  (-4 . "29"))

Set context property printKeyCancellation to #f.
Set context property sectionBarType to "||".
Set context property segnoBarType to "S-||".
Set context property shortInstrumentName to '().
Set context property startRepeatBarType to "||".
Set context property startRepeatSegnoBarType to "S-||".
Set context property underlyingRepeatBarType to "||".
Set grob property extra-spacing-height in BreathingSign to item::extra-spacing-height-including-staff.
Set grob property extra-spacing-width in BreathingSign to :
```
'(-1.0 . 0.0)
```

This is not a ‘Bottom’ context; search for such a one will commence after creating an implicit context of type GregorianTranscriptionVoice.

Context GregorianTranscriptionStaff can contain CueVoice, GregorianTranscriptionVoice and NullVoice.

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

Accidental_engraver

Make accidentals. Catch note heads, ties and notices key-change events. This engraver usually lives at Staff level, but reads the settings for Accidental at Voice level, so you can \override them at Voice.

Properties (read)

accidentalGrouping (symbol)

If set to 'voice, accidentals on the same note in different octaves may be horizontally staggered if in different voices.

autoAccidentals (list)

List of different ways to typeset an accidental.

For determining when to print an accidental, several different rules are tried. The rule that gives the highest number of accidentals is used.

Each entry in the list is either a symbol or a procedure.

symbol

The symbol is the name of the context in which the following rules are to be applied. For example, if context is Score then all staves share accidentals, and if context is Staff then all voices in the same staff share accidentals, but staves do not.

procedure

The procedure represents an accidental rule to be applied to the previously specified context.

The procedure takes the following arguments:

context: The current context to which the rule should be applied.
pitch: The pitch of the note to be evaluated.
barnum: The current bar number.

The procedure returns a pair of booleans. The first states whether an extra natural should be added. The second states whether an accidental should be printed. (#t . #f) does not make sense.

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.

extraNatural (boolean)

Whether to typeset an extra natural sign before accidentals that reduce the effect of a previous alteration.

harmonicAccidentals (boolean)

If set, harmonic notes in chords get accidentals.

internalBarNumber (integer)

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

keyAlterations (list)

The current key signature. This is an alist containing (step . alter) or ((octave . step) . alter), where step is a number in the range 0 to 6 and alter a fraction, denoting alteration. For alterations, use symbols, e.g., keyAlterations = #`((6 . ,FLAT)).

localAlterations (list)

The key signature at this point in the measure. The format is the same as for keyAlterations, but can also contain ((octave . name) . (alter barnumber . measureposition)) pairs.

Properties (write)

localAlterations (list): The key signature at this point in the measure. The format is the same as for keyAlterations, but can also contain ((octave . name) . (alter barnumber . measureposition)) pairs.

This engraver creates the following layout object(s): Accidental, AccidentalCautionary, AccidentalPlacement and AccidentalSuggestion.

Alteration_glyph_engraver

Set the glyph-name-alist of all grobs having the accidental-switch-interface to the value of the context’s alterationGlyphs property, when defined.

Properties (read)

alterationGlyphs (list): Alist mapping alterations to accidental glyphs. Alterations are given as exact numbers, e.g., -1/2 for flat. This applies to all grobs that can print accidentals.

Axis_group_engraver

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

Properties (read)

currentCommandColumn (graphical (layout) object): Grob that is X-parent to all current breakable items (clef, key signature, etc.).
hasAxisGroup (boolean): True if the current context is contained in an axis group.
keepAliveInterfaces (list): A list of symbols, signifying grob interfaces that are worth keeping a staff with remove-empty set around for.

Properties (write)

hasAxisGroup (boolean): True if the current context is contained in an axis group.

This engraver creates the following layout object(s): VerticalAxisGroup.

Bar_engraver

Create bar lines for various commands, including \\bar.

If forbidBreakBetweenBarLines is true, allow line breaks at bar lines only.

Music types accepted: ad-hoc-jump-event, caesura-event, coda-mark-event, dal-segno-event, fine-event, section-event, segno-mark-event and volta-span-event

Properties (read)

caesuraType (list)

An alist

((bar-line . bar-type)
 (breath . breath-type)
 (scripts . script-type…)
 (underlying-bar-line . bar-type))

specifying which breath mark, bar line, and scripts to create at \caesura. All entries are optional.

bar-line has higher priority than a measure bar line and underlying-bar-line has lower priority than a measure bar line.

caesuraTypeTransform (procedure)

An engraver callback taking three arguments and returning an alist of the same kind as caesuraType.

The first argument is the context.

The second argument is the value of caesuraType with an additional entry (articulations . symbol-list) identifying the articulations attached to the caesura in the music. If the transform function returns this second argument unmodified, it is as if no transform function were set; the function is free to return a different value. The transform function can remove articulations, but any added articulations are ignored.

The third argument is a symbol-list identifying certain things the engraver has observed. bar-line indicates that the engraver has observed a BarLine at the current moment.

doubleRepeatBarType (string)

Bar line to insert where the end of one \repeat volta coincides with the start of another. The default is ‘:..:’.

doubleRepeatSegnoBarType (string)

Bar line to insert where an in-staff segno coincides with the end of one \repeat volta and the beginning of another. The default is ‘:|.S.|:’.

endRepeatBarType (string)

Bar line to insert at the end of a \repeat volta. The default is ‘:|.’.

endRepeatSegnoBarType (string)

Bar line to insert where an in-staff segno coincides with the end of a \repeat volta. The default is ‘:|.S’.

fineBarType (string)

Bar line to insert at \fine. Where there is also a repeat bar line, the repeat bar line takes precedence and this value is appended to it as an annotation. The default is ‘|.’.

fineSegnoBarType (string)

Bar line to insert where an in-staff segno coincides with \fine. The default is ‘|.S’.

fineStartRepeatSegnoBarType (string)

Bar line to insert where an in-staff segno coincides with \fine and the start of a \repeat volta. The default is ‘|.S.|:’.

forbidBreakBetweenBarLines (boolean)

If set to true, Bar_engraver forbids line breaks where there is no bar line.

measureBarType (string)

Bar line to insert at a measure boundary.

repeatCommands (list)

A list of commands related to volta-style repeats. In general, each element is a list, '(command args…), but a command with no arguments may be abbreviated to a symbol; e.g., '((start-repeat)) may be given as '(start-repeat).

end-repeat: End a repeated section.
start-repeat: Start a repeated section.
volta text: If text is markup, start a volta bracket with that label; if text is #f, end a volta bracket.

sectionBarType (string)

Bar line to insert at \section. Where there is also a repeat bar line, the repeat bar line takes precedence and this value is appended to it as an annotation. The default is ‘||’.

segnoBarType (string)

Bar line to insert at an in-staff segno. The default is ‘S’.

segnoStyle (symbol)

A symbol that indicates how to print a segno: bar-line or mark.

startRepeatBarType (string)

Bar line to insert at the start of a \repeat volta. The default is ‘.|:’.

startRepeatSegnoBarType (string)

Bar line to insert where an in-staff segno coincides with the start of a \repeat volta. The default is ‘S.|:’.

underlyingRepeatBarType (string)

Bar line to insert at points of repetition or departure where no bar line would normally appear, for example at the end of a system broken in mid measure where the next system begins with a segno. Where there is also a repeat bar line, the repeat bar line takes precedence and this value is appended to it as an annotation. The default is ‘||’.

whichBar (string)

The current bar line type, or '() if there is no bar line. Setting this explicitly in user code is deprecated. Use \bar or related commands to set it.

Properties (write)

currentBarLine (graphical (layout) object): Set to the BarLine that Bar_engraver has created in the current timestep.
forbidBreak (boolean): If set to #t, prevent a line break at this point, except if explicitly requested by the user.

This engraver creates the following layout object(s): BarLine.

Clef_engraver

Determine and set reference point for pitches.

Properties (read)

clefGlyph (string): Name of the symbol within the music font.
clefPosition (number): Where should the center of the clef symbol go, measured in half staff spaces from the center of the staff.
clefTransposition (integer): Add this much extra transposition. Values of 7 and -7 are common.
clefTranspositionStyle (symbol): Determines the way the ClefModifier grob is displayed. Possible values are ‘default’, ‘parenthesized’ and ‘bracketed’.
explicitClefVisibility (vector): ‘break-visibility’ function for clef changes.
forbidBreak (boolean): If set to #t, prevent a line break at this point, except if explicitly requested by the user.
forceBreak (boolean): Set to #t when an event forcing a line break was heard.
forceClef (boolean): Show clef symbol, even if it has not changed. Only active for the first clef after the property is set, not for the full staff.

This engraver creates the following layout object(s): Clef and ClefModifier.

Collision_engraver

Collect NoteColumns, and as soon as there are two or more, put them in a NoteCollision object.

This engraver creates the following layout object(s): NoteCollision.

Cue_clef_engraver

Determine and set reference point for pitches in cued voices.

Properties (read)

clefTransposition (integer): Add this much extra transposition. Values of 7 and -7 are common.
cueClefGlyph (string): Name of the symbol within the music font.
cueClefPosition (number): Where should the center of the clef symbol go, measured in half staff spaces from the center of the staff.
cueClefTransposition (integer): Add this much extra transposition. Values of 7 and -7 are common.
cueClefTranspositionStyle (symbol): Determines the way the ClefModifier grob is displayed. Possible values are ‘default’, ‘parenthesized’ and ‘bracketed’.
explicitCueClefVisibility (vector): ‘break-visibility’ function for cue clef changes.
forbidBreak (boolean): If set to #t, prevent a line break at this point, except if explicitly requested by the user.
forceBreak (boolean): Set to #t when an event forcing a line break was heard.
middleCCuePosition (number): The position of the middle C, as determined only by the clef of the cue notes. This can be calculated by looking at cueClefPosition and cueClefGlyph.

This engraver creates the following layout object(s): ClefModifier, CueClef and CueEndClef.

Divisio_engraver

Create divisiones: chant notation for points of breathing or caesura.

Music types accepted: caesura-event, fine-event, section-event, volta-repeat-end-event and volta-repeat-start-event

Properties (read)

caesuraType (list)

An alist

((bar-line . bar-type)
 (breath . breath-type)
 (scripts . script-type…)
 (underlying-bar-line . bar-type))

specifying which breath mark, bar line, and scripts to create at \caesura. All entries are optional.

bar-line has higher priority than a measure bar line and underlying-bar-line has lower priority than a measure bar line.

caesuraTypeTransform (procedure)

An engraver callback taking three arguments and returning an alist of the same kind as caesuraType.

The first argument is the context.

The third argument is a symbol-list identifying certain things the engraver has observed. bar-line indicates that the engraver has observed a BarLine at the current moment.

This engraver creates the following layout object(s): Divisio.

Dot_column_engraver

Engrave 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 layout object(s): DotColumn.

Figured_bass_engraver

Make figured bass numbers.

Music types accepted: bass-figure-event and rest-event

Properties (read)

figuredBassAlterationDirection (direction): Where to put alterations relative to the main figure.
figuredBassCenterContinuations (boolean): Whether to vertically center pairs of extender lines. This does not work with three or more lines.
figuredBassFormatter (procedure): A routine generating a markup for a bass figure.
ignoreFiguredBassRest (boolean): Don’t swallow rest events.
implicitBassFigures (list): A list of bass figures that are not printed as numbers, but only as extender lines.
useBassFigureExtenders (boolean): Whether to use extender lines for repeated bass figures.

This engraver creates the following layout object(s): BassFigure, BassFigureAlignment, BassFigureBracket, BassFigureContinuation and BassFigureLine.

Figured_bass_position_engraver

Position figured bass alignments over notes.

This engraver creates the following layout object(s): BassFigureAlignmentPositioning.

Fingering_column_engraver

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

This engraver creates the following layout object(s): FingeringColumn.

Font_size_engraver

Put fontSize into font-size grob property.

Properties (read)

fontSize (number): The relative size of all grobs in a context.

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

Instrument_name_engraver

Create a system start text for instrument or vocal names.

Properties (read)

currentCommandColumn (graphical (layout) object): Grob that is X-parent to all current breakable items (clef, key signature, etc.).
instrumentName (markup): The name to print left of a staff. The instrumentName property labels the staff in the first system, and the shortInstrumentName property labels following lines.
shortInstrumentName (markup): See instrumentName.
shortVocalName (markup): Name of a vocal line, short version.
vocalName (markup): Name of a vocal line.

This engraver creates the following layout object(s): InstrumentName.

Key_engraver

Engrave a key signature.

Music types accepted: key-change-event

Properties (read)

createKeyOnClefChange (boolean): Print a key signature whenever the clef is changed.
explicitKeySignatureVisibility (vector): ‘break-visibility’ function for explicit key changes. ‘\override’ of the break-visibility property will set the visibility for normal (i.e., at the start of the line) key signatures.
extraNatural (boolean): Whether to typeset an extra natural sign before accidentals that reduce the effect of a previous alteration.
forbidBreak (boolean): If set to #t, prevent a line break at this point, except if explicitly requested by the user.
forceBreak (boolean): Set to #t when an event forcing a line break was heard.
keyAlterationOrder (list): A list of pairs that defines in what order alterations should be printed. The format of an entry is (step . alter), where step is a number from 0 to 6 and alter from -1 (double flat) to 1 (double sharp), with exact rationals for alterations in between, e.g., 1/2 for sharp.
keyAlterations (list): The current key signature. This is an alist containing (step . alter) or ((octave . step) . alter), where step is a number in the range 0 to 6 and alter a fraction, denoting alteration. For alterations, use symbols, e.g., keyAlterations = #`((6 . ,FLAT)).
lastKeyAlterations (list): Last key signature before a key signature change.
middleCClefPosition (number): The position of the middle C, as determined only by the clef. This can be calculated by looking at clefPosition and clefGlyph.
printKeyCancellation (boolean): Print restoration alterations before a key signature change.

Properties (write)

keyAlterations (list): The current key signature. This is an alist containing (step . alter) or ((octave . step) . alter), where step is a number in the range 0 to 6 and alter a fraction, denoting alteration. For alterations, use symbols, e.g., keyAlterations = #`((6 . ,FLAT)).
lastKeyAlterations (list): Last key signature before a key signature change.
tonic (pitch): The tonic of the current scale.

This engraver creates the following layout object(s): KeyCancellation and KeySignature.

Ledger_line_engraver

Create the spanner to draw ledger lines, and notices objects that need ledger lines.

This engraver creates the following layout object(s): LedgerLineSpanner.

Merge_mmrest_numbers_engraver

Engraver to merge multi-measure rest numbers in multiple voices.

This works by gathering all multi-measure rest numbers at a time step. If they all have the same text and there are at least two only the first one is retained and the others are hidden.

Non_musical_script_column_engraver

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

This engraver creates the following layout object(s): ScriptColumn.

Ottava_spanner_engraver

Create a text spanner when the ottavation property changes.

Music types accepted: ottava-event

Properties (read)

currentMusicalColumn (graphical (layout) object): Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).
middleCOffset (number): The offset of middle C from the position given by middleCClefPosition This is used for ottava brackets.
ottavation (markup): If set, the text for an ottava spanner. Changing this creates a new text spanner.

This engraver creates the following layout object(s): OttavaBracket.

Output_property_engraver

Apply a procedure to any grob acknowledged.

Music types accepted: apply-output-event

Piano_pedal_align_engraver

Align piano pedal symbols and brackets.

Properties (read)

currentCommandColumn (graphical (layout) object): Grob that is X-parent to all current breakable items (clef, key signature, etc.).

This engraver creates the following layout object(s): SostenutoPedalLineSpanner, SustainPedalLineSpanner and UnaCordaPedalLineSpanner.

Piano_pedal_engraver

Engrave piano pedal symbols and brackets.

Music types accepted: sostenuto-event, sustain-event and una-corda-event

Properties (read)

currentCommandColumn (graphical (layout) object): Grob that is X-parent to all current breakable items (clef, key signature, etc.).
pedalSostenutoStrings (list): See pedalSustainStrings.
pedalSostenutoStyle (symbol): See pedalSustainStyle.
pedalSustainStrings (list): A list of strings 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.

This engraver creates the following layout object(s): PianoPedalBracket, SostenutoPedal, SustainPedal and UnaCordaPedal.

Pure_from_neighbor_engraver

Coordinates items that get their pure heights from their neighbors.

Rest_collision_engraver

Handle collisions of rests.

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

This engraver creates the following layout object(s): RestCollision.

Script_row_engraver