<!-- header_tag -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- Created on January 24, 2009 by texi2html 1.79
texi2html was written by:
Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
Olaf Bachmann <obachman@mathematik.uni-kl.de>
and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <texi2html-bug@nongnu.org>
-->
<head>
<title>LilyPond program-reference: 2.1.14 MensuralStaff</title>
<meta name="description" content="LilyPond program-reference: 2.1.14 MensuralStaff">
<meta name="keywords" content="LilyPond program-reference: 2.1.14 MensuralStaff">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.79">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="GNU LilyPond – Internals Reference">
<link href="Indices.html#Indices" rel="index" title="A. Indices">
<link href="index_toc.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index_abt.html#SEC_About" rel="help" title="About This Document">
<link href="Contexts.html#Contexts" rel="up" title="2.1 Contexts">
<link href="Indices.html#Indices" rel="next" title="A.2 Function index">
<link href="Lyrics.html#Lyrics" rel="previous" title="2.1.13 Lyrics">
<link rel="stylesheet" type="text/css" title="Patrick McCarty's design" href="lilypond-mccarty.css">
<link rel="alternate stylesheet" type="text/css" href="lilypond.css" title="Andrew Hawryluk's design">
<link rel="alternate stylesheet" type="text/css" href="lilypond-blue.css" title="Kurt Kroon's blue design">
<!--[if lte IE 7]>
<link href="lilypond-ie-fixes.css" rel="stylesheet" type="text/css">
<![endif]-->
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<div id="main">
<a name="MensuralStaff"></a>
<table class="nav_table">
<tr><td valign="middle" align="left" colspan="1">[<a href="Translation.html#Translation" title="Beginning of this chapter or previous chapter"> << Translation </a>]</td><td valign="middle" align="center" colspan="3">[<a href="index.html#Top" title="Cover (top) of document" rel="start">Top</a>][<a href="index_toc.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Indices.html#Indices" title="Index" rel="index">Index</a>][<a href="index_abt.html#SEC_About" title="About (help)" rel="help"> ? </a>]</td><td valign="middle" align="right" colspan="1">[<a href="Backend.html#Backend" title="Next chapter"> Backend >> </a>]</td></tr><tr><td valign="middle" align="left" colspan="2">[<a href="Lyrics.html#Lyrics" title="Previous section in reading order" accesskey="p" rel="previous"> < Lyrics </a>]</td><td valign="middle" align="center" colspan="1">[<a href="Contexts.html#Contexts" title="Up section" accesskey="u" rel="up"> Up : Contexts </a>]</td><td valign="middle" align="right" colspan="2">[<a href="MensuralVoice.html#MensuralVoice" title="Next section in reading order" accesskey="n" rel="next"> MensuralVoice > </a>]</td></tr></table>
<a name="MensuralStaff"></a>
<h3 class="subsection">2.1.14 MensuralStaff</h3>
<p>Same as <code>Staff</code> context, except that it is
accommodated for typesetting a piece in mensural style.
</p>
<p>This context also accepts commands for the following context(s):
</p>
<p>Staff.
</p>
<p>This context creates the following layout object(s):
</p>
<p><a href="AccidentalCautionary.html#AccidentalCautionary">AccidentalCautionary</a>, <a href="AccidentalPlacement.html#AccidentalPlacement">AccidentalPlacement</a>, <a href="AccidentalSuggestion.html#AccidentalSuggestion">AccidentalSuggestion</a>, <a href="Accidental.html#Accidental">Accidental</a>, <a href="BarLine.html#BarLine">BarLine</a>, <a href="BassFigureAlignmentPositioning.html#BassFigureAlignmentPositioning">BassFigureAlignmentPositioning</a>, <a href="BassFigureAlignment.html#BassFigureAlignment">BassFigureAlignment</a>, <a href="BassFigureBracket.html#BassFigureBracket">BassFigureBracket</a>, <a href="BassFigureContinuation.html#BassFigureContinuation">BassFigureContinuation</a>, <a href="BassFigureLine.html#BassFigureLine">BassFigureLine</a>, <a href="BassFigure.html#BassFigure">BassFigure</a>, <a href="Clef.html#Clef">Clef</a>, <a href="Custos.html#Custos">Custos</a>, <a href="DotColumn.html#DotColumn">DotColumn</a>, <a href="InstrumentName.html#InstrumentName">InstrumentName</a>, <a href="KeySignature.html#KeySignature">KeySignature</a>, <a href="LedgerLineSpanner.html#LedgerLineSpanner">LedgerLineSpanner</a>, <a href="NoteCollision.html#NoteCollision">NoteCollision</a>, <a href="OctavateEight.html#OctavateEight">OctavateEight</a>, <a href="OttavaBracket.html#OttavaBracket">OttavaBracket</a>, <a href="PianoPedalBracket.html#PianoPedalBracket">PianoPedalBracket</a>, <a href="RestCollision.html#RestCollision">RestCollision</a>, <a href="ScriptRow.html#ScriptRow">ScriptRow</a>, <a href="SostenutoPedalLineSpanner.html#SostenutoPedalLineSpanner">SostenutoPedalLineSpanner</a>, <a href="SostenutoPedal.html#SostenutoPedal">SostenutoPedal</a>, <a href="StaffSpacing.html#StaffSpacing">StaffSpacing</a>, <a href="StaffSymbol.html#StaffSymbol">StaffSymbol</a>, <a href="SustainPedalLineSpanner.html#SustainPedalLineSpanner">SustainPedalLineSpanner</a>, <a href="SustainPedal.html#SustainPedal">SustainPedal</a>, <a href="TimeSignature.html#TimeSignature">TimeSignature</a>, <a href="UnaCordaPedalLineSpanner.html#UnaCordaPedalLineSpanner">UnaCordaPedalLineSpanner</a>, <a href="UnaCordaPedal.html#UnaCordaPedal">UnaCordaPedal</a> and <a href="VerticalAxisGroup.html#VerticalAxisGroup">VerticalAxisGroup</a>.
</p>
<p>This context sets the following properties:
</p>
<ul>
<li> Set translator property <code>printKeyCancellation</code> to <code>#f</code>.
</li><li> Set translator property <code>autoCautionaries</code> to <code>'()</code>.
</li><li> Set translator property <code>autoAccidentals</code> to <code>'(Staff #<procedure #f (context pitch barnum measurepos)>)</code>.
</li><li> Set translator property <code>extraNatural</code> to <code>#f</code>.
</li><li> Set grob-property <code>neutral-direction</code> in <a href="Custos.html#Custos">Custos</a> to <code>-1</code>.
</li><li> Set grob-property <code>neutral-position</code> in <a href="Custos.html#Custos">Custos</a> to <code>3</code>.
</li><li> Set grob-property <code>style</code> in <a href="Custos.html#Custos">Custos</a> to <code>'mensural</code>.
</li><li> Set grob-property <code>glyph-name-alist</code> in <a href="Accidental.html#Accidental">Accidental</a> to <code>'((-1/2 . accidentals.mensuralM1) (0 . accidentals.vaticana0) (1/2 . accidentals.mensural1))</code>.
</li><li> Set grob-property <code>glyph-name-alist</code> in <a href="KeySignature.html#KeySignature">KeySignature</a> to <code>'((-1/2 . accidentals.mensuralM1) (0 . accidentals.vaticana0) (1/2 . accidentals.mensural1))</code>.
</li><li> Set grob-property <code>style</code> in <a href="TimeSignature.html#TimeSignature">TimeSignature</a> to <code>'mensural</code>.
</li><li> Set translator property <code>clefOctavation</code> to <code>0</code>.
</li><li> Set translator property <code>clefPosition</code> to <code>-2</code>.
</li><li> Set translator property <code>middleCPosition</code> to <code>-6</code>.
</li><li> Set translator property <code>middleCClefPosition</code> to <code>-6</code>.
</li><li> Set translator property <code>clefGlyph</code> to <code>"clefs.mensural.g"</code>.
</li><li> Set grob-property <code>thickness</code> in <a href="StaffSymbol.html#StaffSymbol">StaffSymbol</a> to <code>0.6</code>.
</li><li> Set grob-property <code>transparent</code> in <a href="BarLine.html#BarLine">BarLine</a> to <code>#t</code>.
</li><li> Set translator property <code>shortInstrumentName</code> to <code>'()</code>.
</li><li> Set translator property <code>instrumentName</code> to <code>'()</code>.
</li><li> Set grob-property <code>minimum-Y-extent</code> in <a href="VerticalAxisGroup.html#VerticalAxisGroup">VerticalAxisGroup</a> to <code>'(-4 . 4)</code>.
</li><li> Set translator property <code>ignoreFiguredBassRest</code> to <code>#t</code>.
</li><li> Set translator property <code>createSpacing</code> to <code>#t</code>.
</li><li> Set translator property <code>localKeySignature</code> to <code>'()</code>.
</li></ul>
<p>Context MensuralStaff can contain
<a href="MensuralVoice.html#MensuralVoice">MensuralVoice</a> and <a href="CueVoice.html#CueVoice">CueVoice</a>.
</p>
<p>This context is built from the following engraver(s):
</p><blockquote><dl compact="compact">
<dt> <code><a href="Custos_005fengraver.html#Custos_005fengraver">Custos_engraver</a></code></dt>
<dd><p>Engrave custodes.
</p>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="Custos.html#Custos">Custos</a>.
</p>
</dd>
<dt> <code><a href="Script_005frow_005fengraver.html#Script_005frow_005fengraver">Script_row_engraver</a></code></dt>
<dd><p>Determine order in horizontal side position elements.
</p>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="ScriptRow.html#ScriptRow">ScriptRow</a>.
</p>
</dd>
<dt> <code><a href="Figured_005fbass_005fposition_005fengraver.html#Figured_005fbass_005fposition_005fengraver">Figured_bass_position_engraver</a></code></dt>
<dd><p>Position figured bass alignments over notes.
</p>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="BassFigureAlignmentPositioning.html#BassFigureAlignmentPositioning">BassFigureAlignmentPositioning</a>.
</p>
</dd>
<dt> <code><a href="Figured_005fbass_005fengraver.html#Figured_005fbass_005fengraver">Figured_bass_engraver</a></code></dt>
<dd><p>Make figured bass numbers.
</p>
<p>Music types accepted:
</p>
<p><a href="bass_002dfigure_002devent.html#bass_002dfigure_002devent">bass-figure-event</a> and <a href="rest_002devent.html#rest_002devent">rest-event</a>
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>figuredBassAlterationDirection</code> (direction)</dt>
<dd><p>Where to put alterations
relative to the main figure.
</p></dd>
<dt> <code>figuredBassCenterContinuations</code> (boolean)</dt>
<dd><p>Whether to vertically
center pairs of extender lines. This does not work with three or more
lines.
</p></dd>
<dt> <code>figuredBassFormatter</code> (procedure)</dt>
<dd><p>A routine generating a markup
for a bass figure.
</p></dd>
<dt> <code>implicitBassFigures</code> (list)</dt>
<dd><p>A list of bass figures that are not
printed as numbers, but only as extender lines.
</p></dd>
<dt> <code>useBassFigureExtenders</code> (boolean)</dt>
<dd><p>Whether to use extender lines
for repeated bass figures.
</p></dd>
<dt> <code>ignoreFiguredBassRest</code> (boolean)</dt>
<dd><p>Don’t swallow rest events.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="BassFigure.html#BassFigure">BassFigure</a>, <a href="BassFigureAlignment.html#BassFigureAlignment">BassFigureAlignment</a>, <a href="BassFigureBracket.html#BassFigureBracket">BassFigureBracket</a>, <a href="BassFigureContinuation.html#BassFigureContinuation">BassFigureContinuation</a> and <a href="BassFigureLine.html#BassFigureLine">BassFigureLine</a>.
</p>
</dd>
<dt> <code><a href="Axis_005fgroup_005fengraver.html#Axis_005fgroup_005fengraver">Axis_group_engraver</a></code></dt>
<dd><p>Group all objects created in this context in a <code>VerticalAxisGroup</code> spanner.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>currentCommandColumn</code> (layout object)</dt>
<dd><p>Grob that is X-parent to all
current breakable (clef, key signature, etc.) items.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="VerticalAxisGroup.html#VerticalAxisGroup">VerticalAxisGroup</a>.
</p>
</dd>
<dt> <code><a href="String_005fnumber_005fengraver.html#String_005fnumber_005fengraver">String_number_engraver</a></code></dt>
<dd><p>Swallow string number events. The purpose of this engraver is to process tablatures for normal notation. To provent warnings for unprocessed string number events to obscure real error messages, this engraver swallows them all.
</p>
</dd>
<dt> <code><a href="Instrument_005fname_005fengraver.html#Instrument_005fname_005fengraver">Instrument_name_engraver</a></code></dt>
<dd><p>Create a system start text for instrument or vocal names.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>currentCommandColumn</code> (layout object)</dt>
<dd><p>Grob that is X-parent to all
current breakable (clef, key signature, etc.) items.
</p></dd>
<dt> <code>shortInstrumentName</code> (markup)</dt>
<dd><p>See <code>instrument</code>.
</p></dd>
<dt> <code>instrumentName</code> (markup)</dt>
<dd><p>The name to print left of a staff. The
<code>instrument</code> property labels the staff in the first system, and
the <code>instr</code> property labels following lines.
</p></dd>
<dt> <code>shortVocalName</code> (markup)</dt>
<dd><p>Name of a vocal line, short version.
</p></dd>
<dt> <code>vocalName</code> (markup)</dt>
<dd><p>Name of a vocal line.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="InstrumentName.html#InstrumentName">InstrumentName</a>.
</p>
</dd>
<dt> <code><a href="Piano_005fpedal_005falign_005fengraver.html#Piano_005fpedal_005falign_005fengraver">Piano_pedal_align_engraver</a></code></dt>
<dd><p>Align piano pedal symbols and brackets.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>currentCommandColumn</code> (layout object)</dt>
<dd><p>Grob that is X-parent to all
current breakable (clef, key signature, etc.) items.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="SostenutoPedalLineSpanner.html#SostenutoPedalLineSpanner">SostenutoPedalLineSpanner</a>, <a href="SustainPedalLineSpanner.html#SustainPedalLineSpanner">SustainPedalLineSpanner</a> and <a href="UnaCordaPedalLineSpanner.html#UnaCordaPedalLineSpanner">UnaCordaPedalLineSpanner</a>.
</p>
</dd>
<dt> <code><a href="Piano_005fpedal_005fengraver.html#Piano_005fpedal_005fengraver">Piano_pedal_engraver</a></code></dt>
<dd><p>Engrave piano pedal symbols and brackets.
</p>
<p>Music types accepted:
</p>
<p><a href="una_002dcorda_002devent.html#una_002dcorda_002devent">una-corda-event</a>, <a href="sustain_002devent.html#sustain_002devent">sustain-event</a> and <a href="sostenuto_002devent.html#sostenuto_002devent">sostenuto-event</a>
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>currentCommandColumn</code> (layout object)</dt>
<dd><p>Grob that is X-parent to all
current breakable (clef, key signature, etc.) items.
</p></dd>
<dt> <code>pedalSostenutoStrings</code> (list)</dt>
<dd><p>See <code>pedalSustainStrings</code>.
</p></dd>
<dt> <code>pedalSostenutoStyle</code> (symbol)</dt>
<dd><p>See <code>pedalSustainStyle</code>.
</p></dd>
<dt> <code>pedalSustainStrings</code> (list)</dt>
<dd><p>A list of strings to print for
sustain-pedal. Format is <code>(<var>up</var> <var>updown</var> <var>down</var>)</code>,
where each of the three is the string to print when this is done with
the pedal.
</p></dd>
<dt> <code>pedalSustainStyle</code> (symbol)</dt>
<dd><p>A symbol that indicates how to print
sustain pedals: <code>text</code>, <code>bracket</code> or <code>mixed</code> (both).
</p></dd>
<dt> <code>pedalUnaCordaStrings</code> (list)</dt>
<dd><p>See <code>pedalSustainStrings</code>.
</p></dd>
<dt> <code>pedalUnaCordaStyle</code> (symbol)</dt>
<dd><p>See <code>pedalSustainStyle</code>.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="PianoPedalBracket.html#PianoPedalBracket">PianoPedalBracket</a>, <a href="SostenutoPedal.html#SostenutoPedal">SostenutoPedal</a>, <a href="SustainPedal.html#SustainPedal">SustainPedal</a> and <a href="UnaCordaPedal.html#UnaCordaPedal">UnaCordaPedal</a>.
</p>
</dd>
<dt> <code><a href="Accidental_005fengraver.html#Accidental_005fengraver">Accidental_engraver</a></code></dt>
<dd><p>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 <code>Voice</code> level, so you can <code>\override</code> them at <code>Voice</code>.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>autoAccidentals</code> (list)</dt>
<dd><p>List of different ways to typeset an
accidental.
</p>
<p>For determining when to print an accidental, several different rules
are tried. The rule that gives the highest number of accidentals is
used.
</p>
<p>Each entry in the list is either a symbol or a procedure.
</p>
<dl compact="compact">
<dt> <var>symbol</var></dt>
<dd><p>The symbol is the name of the context in which the following rules are to be
applied. For example, if <var>context</var> is <a name="index-Score-1"></a>
<a href="../lilypond-internals/Score.html#Score">Score</a> then all
staves share accidentals, and if <var>context</var> is <a name="index-Staff-1"></a>
<a href="../lilypond-internals/Staff.html#Staff">Staff</a> then
all voices in the same staff share accidentals, but staves do not.
</p>
</dd>
<dt> <var>procedure</var></dt>
<dd><p>The procedure represents an accidental rule to be applied to the previously
specified context.
</p>
<p>The procedure takes the following arguments:
</p>
<dl compact="compact">
<dt> <code>context</code></dt>
<dd><p>The current context to which the rule should be applied.
</p>
</dd>
<dt> <code>pitch</code></dt>
<dd><p>The pitch of the note to be evaluated.
</p>
</dd>
<dt> <code>barnum</code></dt>
<dd><p>The current bar number.
</p>
</dd>
<dt> <code>measurepos</code></dt>
<dd><p>The current measure position.
</p>
</dd>
</dl>
<p>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. <code>(#t . #f)</code> does not make sense.
</p>
</dd>
</dl>
</dd>
<dt> <code>autoCautionaries</code> (list)</dt>
<dd><p>List similar to <code>autoAccidentals</code>,
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.
</p></dd>
<dt> <code>internalBarNumber</code> (integer)</dt>
<dd><p>Contains the current barnumber.
This property is used for internal timekeeping, among others by the
<code>Accidental_engraver</code>.
</p></dd>
<dt> <code>extraNatural</code> (boolean)</dt>
<dd><p>Whether to typeset an extra natural sign
before accidentals changing from a non-natural to another
non-natural.
</p></dd>
<dt> <code>harmonicAccidentals</code> (boolean)</dt>
<dd><p>If set, harmonic notes in chords
get accidentals.
</p></dd>
<dt> <code>keySignature</code> (list)</dt>
<dd><p>The current key signature. This is an alist
containing <code>(<var>step</var> . <var>alter</var>)</code> or <code>((<var>octave</var> .
<var>step</var>) . <var>alter</var>)</code>, where <var>step</var> is a number in the range
0 to 6 and <var>alter</var> a fraction, denoting alteration. For
alterations, use symbols, e.g. <code>keySignature = #`((6 . ,FLAT))</code>.
</p></dd>
<dt> <code>localKeySignature</code> (list)</dt>
<dd><p>The key signature at this point in the
measure. The format is the same as for <code>keySignature</code>, but can
also contain <code>((<var>octave</var> . <var>name</var>) . (<var>alter</var>
<var>barnumber</var> . <var>measureposition</var>))</code> pairs.
</p></dd>
</dl>
</blockquote>
<p>Properties (write)
</p><blockquote><dl compact="compact">
<dt> <code>localKeySignature</code> (list)</dt>
<dd><p>The key signature at this point in the
measure. The format is the same as for <code>keySignature</code>, but can
also contain <code>((<var>octave</var> . <var>name</var>) . (<var>alter</var>
<var>barnumber</var> . <var>measureposition</var>))</code> pairs.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="Accidental.html#Accidental">Accidental</a>, <a href="AccidentalCautionary.html#AccidentalCautionary">AccidentalCautionary</a>, <a href="AccidentalPlacement.html#AccidentalPlacement">AccidentalPlacement</a> and <a href="AccidentalSuggestion.html#AccidentalSuggestion">AccidentalSuggestion</a>.
</p>
</dd>
<dt> <code><a href="Rest_005fcollision_005fengraver.html#Rest_005fcollision_005fengraver">Rest_collision_engraver</a></code></dt>
<dd><p>Handle collisions of rests.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>busyGrobs</code> (list)</dt>
<dd><p>A queue of <code>(<var>end-moment</var> .
<var>GROB</var>)</code> cons cells. This is for internal (C++) use only. This
property contains the grobs which are still busy (e.g. note heads,
spanners, etc.).
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="RestCollision.html#RestCollision">RestCollision</a>.
</p>
</dd>
<dt> <code><a href="Grob_005fpq_005fengraver.html#Grob_005fpq_005fengraver">Grob_pq_engraver</a></code></dt>
<dd><p>Administrate when certain grobs (e.g., note heads) stop playing.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>busyGrobs</code> (list)</dt>
<dd><p>A queue of <code>(<var>end-moment</var> .
<var>GROB</var>)</code> cons cells. This is for internal (C++) use only. This
property contains the grobs which are still busy (e.g. note heads,
spanners, etc.).
</p></dd>
</dl>
</blockquote>
<p>Properties (write)
</p><blockquote><dl compact="compact">
<dt> <code>busyGrobs</code> (list)</dt>
<dd><p>A queue of <code>(<var>end-moment</var> .
<var>GROB</var>)</code> cons cells. This is for internal (C++) use only. This
property contains the grobs which are still busy (e.g. note heads,
spanners, etc.).
</p></dd>
</dl>
</blockquote>
</dd>
<dt> <code><a href="Collision_005fengraver.html#Collision_005fengraver">Collision_engraver</a></code></dt>
<dd><p>Collect <code>NoteColumns</code>, and as soon as there are two or more, put them in a <code>NoteCollision</code> object.
</p>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="NoteCollision.html#NoteCollision">NoteCollision</a>.
</p>
</dd>
<dt> <code><a href="Staff_005fsymbol_005fengraver.html#Staff_005fsymbol_005fengraver">Staff_symbol_engraver</a></code></dt>
<dd><p>Create the constellation of five (default) staff lines.
</p>
<p>Music types accepted:
</p>
<p><a href="staff_002dspan_002devent.html#staff_002dspan_002devent">staff-span-event</a>
</p>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="StaffSymbol.html#StaffSymbol">StaffSymbol</a>.
</p>
</dd>
<dt> <code><a href="Ledger_005fline_005fengraver.html#Ledger_005fline_005fengraver">Ledger_line_engraver</a></code></dt>
<dd><p>Create the spanner to draw ledger lines, and notices objects that need ledger lines.
</p>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="LedgerLineSpanner.html#LedgerLineSpanner">LedgerLineSpanner</a>.
</p>
</dd>
<dt> <code><a href="Time_005fsignature_005fengraver.html#Time_005fsignature_005fengraver">Time_signature_engraver</a></code></dt>
<dd><p>Create a <a href="TimeSignature.html#TimeSignature">TimeSignature</a> whenever <code>timeSignatureFraction</code> changes.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>implicitTimeSignatureVisibility</code> (vector)</dt>
<dd><p>break visibility for
the default time signature.
</p></dd>
<dt> <code>timeSignatureFraction</code> (pair of numbers)</dt>
<dd><p>A pair of numbers,
signifying the time signature. For example, <code>#'(4 . 4)</code> is a
4/4 time signature.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="TimeSignature.html#TimeSignature">TimeSignature</a>.
</p>
</dd>
<dt> <code><a href="Key_005fengraver.html#Key_005fengraver">Key_engraver</a></code></dt>
<dd><p>Engrave a key signature.
</p>
<p>Music types accepted:
</p>
<p><a href="key_002dchange_002devent.html#key_002dchange_002devent">key-change-event</a>
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>createKeyOnClefChange</code> (boolean)</dt>
<dd><p>Print a key signature whenever
the clef is changed.
</p></dd>
<dt> <code>explicitKeySignatureVisibility</code> (vector)</dt>
<dd><p>‘<samp>break-visibility</samp>’
function for explicit key changes. ‘<samp>\override</samp>’ of the
<code>break-visibility</code> property will set the visibility for normal
(i.e., at the start of the line) key signatures.
</p></dd>
<dt> <code>extraNatural</code> (boolean)</dt>
<dd><p>Whether to typeset an extra natural sign
before accidentals changing from a non-natural to another
non-natural.
</p></dd>
<dt> <code>keyAlterationOrder</code> (list)</dt>
<dd><p>An alist that defines in what order
alterations should be printed. The format is <code>(<var>step</var>
. <var>alter</var>)</code>, where <var>step</var> is a number from 0 to 6 and
<var>alter</var> from -2 (sharp) to 2 (flat).
</p></dd>
<dt> <code>keySignature</code> (list)</dt>
<dd><p>The current key signature. This is an alist
containing <code>(<var>step</var> . <var>alter</var>)</code> or <code>((<var>octave</var> .
<var>step</var>) . <var>alter</var>)</code>, where <var>step</var> is a number in the range
0 to 6 and <var>alter</var> a fraction, denoting alteration. For
alterations, use symbols, e.g. <code>keySignature = #`((6 . ,FLAT))</code>.
</p></dd>
<dt> <code>lastKeySignature</code> (list)</dt>
<dd><p>Last key signature before a key
signature change.
</p></dd>
<dt> <code>printKeyCancellation</code> (boolean)</dt>
<dd><p>Print restoration alterations
before a key signature change.
</p></dd>
</dl>
</blockquote>
<p>Properties (write)
</p><blockquote><dl compact="compact">
<dt> <code>keySignature</code> (list)</dt>
<dd><p>The current key signature. This is an alist
containing <code>(<var>step</var> . <var>alter</var>)</code> or <code>((<var>octave</var> .
<var>step</var>) . <var>alter</var>)</code>, where <var>step</var> is a number in the range
0 to 6 and <var>alter</var> a fraction, denoting alteration. For
alterations, use symbols, e.g. <code>keySignature = #`((6 . ,FLAT))</code>.
</p></dd>
<dt> <code>lastKeySignature</code> (list)</dt>
<dd><p>Last key signature before a key
signature change.
</p></dd>
<dt> <code>tonic</code> (pitch)</dt>
<dd><p>The tonic of the current scale.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="KeySignature.html#KeySignature">KeySignature</a>.
</p>
</dd>
<dt> <code><a href="Clef_005fengraver.html#Clef_005fengraver">Clef_engraver</a></code></dt>
<dd><p>Determine and set reference point for pitches.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>clefGlyph</code> (string)</dt>
<dd><p>Name of the symbol within the music font.
</p></dd>
<dt> <code>clefOctavation</code> (integer)</dt>
<dd><p>Add this much extra octavation.
Values of 7 and -7 are common.
</p></dd>
<dt> <code>clefPosition</code> (number)</dt>
<dd><p>Where should the center of the clef
symbol go, measured in half staff spaces from the center of the
staff.
</p></dd>
<dt> <code>explicitClefVisibility</code> (vector)</dt>
<dd><p>‘<samp>break-visibility</samp>’
function for clef changes.
</p></dd>
<dt> <code>forceClef</code> (boolean)</dt>
<dd><p>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.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="Clef.html#Clef">Clef</a> and <a href="OctavateEight.html#OctavateEight">OctavateEight</a>.
</p>
</dd>
<dt> <code><a href="Ottava_005fspanner_005fengraver.html#Ottava_005fspanner_005fengraver">Ottava_spanner_engraver</a></code></dt>
<dd><p>Create a text spanner when the ottavation property changes.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>ottavation</code> (markup)</dt>
<dd><p>If set, the text for an ottava spanner.
Changing this creates a new text spanner.
</p></dd>
<dt> <code>originalMiddleCPosition</code> (integer)</dt>
<dd><p>Used for temporary overriding
middle C in octavation brackets.
</p></dd>
<dt> <code>currentMusicalColumn</code> (layout object)</dt>
<dd><p>Grob that is X-parent to all
non-breakable items (note heads, lyrics, etc.).
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="OttavaBracket.html#OttavaBracket">OttavaBracket</a>.
</p>
</dd>
<dt> <code><a href="Staff_005fcollecting_005fengraver.html#Staff_005fcollecting_005fengraver">Staff_collecting_engraver</a></code></dt>
<dd><p>Maintain the <code>stavesFound</code> variable.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>stavesFound</code> (list of grobs)</dt>
<dd><p>A list of all staff-symbols found.
</p></dd>
</dl>
</blockquote>
<p>Properties (write)
</p><blockquote><dl compact="compact">
<dt> <code>stavesFound</code> (list of grobs)</dt>
<dd><p>A list of all staff-symbols found.
</p></dd>
</dl>
</blockquote>
</dd>
<dt> <code><a href="Dot_005fcolumn_005fengraver.html#Dot_005fcolumn_005fengraver">Dot_column_engraver</a></code></dt>
<dd><p>Engrave dots on dotted notes shifted to the right of the note. If omitted, then dots appear on top of the notes.
</p>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="DotColumn.html#DotColumn">DotColumn</a>.
</p>
</dd>
<dt> <code><a href="Separating_005fline_005fgroup_005fengraver.html#Separating_005fline_005fgroup_005fengraver">Separating_line_group_engraver</a></code></dt>
<dd><p>Generate objects for computing spacing parameters.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>createSpacing</code> (boolean)</dt>
<dd><p>Create <code>StaffSpacing</code> objects?
Should be set for staves.
</p></dd>
</dl>
</blockquote>
<p>Properties (write)
</p><blockquote><dl compact="compact">
<dt> <code>hasStaffSpacing</code> (boolean)</dt>
<dd><p>True if the current
<code>CommandColumn</code> contains items that will affect spacing.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="StaffSpacing.html#StaffSpacing">StaffSpacing</a>.
</p>
</dd>
<dt> <code><a href="Font_005fsize_005fengraver.html#Font_005fsize_005fengraver">Font_size_engraver</a></code></dt>
<dd><p>Put <code>fontSize</code> into <code>font-size</code> grob property.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>fontSize</code> (number)</dt>
<dd><p>The relative size of all grobs in a context.
</p></dd>
</dl>
</blockquote>
</dd>
<dt> <code><a href="Bar_005fengraver.html#Bar_005fengraver">Bar_engraver</a></code></dt>
<dd><p>Create barlines. This engraver is controlled through the <code>whichBar</code> property. If it has no bar line to create, it will forbid a linebreak at this point.
</p>
<p>Properties (read)
</p><blockquote><dl compact="compact">
<dt> <code>whichBar</code> (string)</dt>
<dd><p>This property is read to determine what type
of bar line to create.
</p>
<p>Example:
</p>
<blockquote><pre class="example"><pre class="example">\set Staff.whichBar = "|:"
</pre></pre></blockquote>
<p>This will create a start-repeat bar in this staff only. Valid values
are described in <a name="index-bar_002dline_002dinterface-2"></a>
<a href="../lilypond-internals/bar_002dline_002dinterface.html#bar_002dline_002dinterface">bar-line-interface</a>.
</p></dd>
</dl>
</blockquote>
<p>Properties (write)
</p><blockquote><dl compact="compact">
<dt> <code>forbidBreak</code> (boolean)</dt>
<dd><p>If set to <code>##t</code>, prevent a line break
at this point.
</p></dd>
</dl>
</blockquote>
<p>This engraver creates the following layout object(s):
</p>
<p><a href="BarLine.html#BarLine">BarLine</a>.
</p>
</dd>
<dt> <code><a href="Output_005fproperty_005fengraver.html#Output_005fproperty_005fengraver">Output_property_engraver</a></code></dt>
<dd><p>Apply a procedure to any grob acknowledged.
</p>
<p>Music types accepted:
</p>
<p><a href="apply_002doutput_002devent.html#apply_002doutput_002devent">apply-output-event</a>
</p>
</dd>
</dl>
</blockquote>
<hr size="6">
<table class="nav_table">
<tr><td valign="middle" align="left" colspan="1">[<a href="Translation.html#Translation" title="Beginning of this chapter or previous chapter"> << Translation </a>]</td><td valign="middle" align="center" colspan="3">[<a href="index.html#Top" title="Cover (top) of document" rel="start">Top</a>][<a href="index_toc.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Indices.html#Indices" title="Index" rel="index">Index</a>][<a href="index_abt.html#SEC_About" title="About (help)" rel="help"> ? </a>]</td><td valign="middle" align="right" colspan="1">[<a href="Backend.html#Backend" title="Next chapter"> Backend >> </a>]</td></tr><tr><td valign="middle" align="left" colspan="2">[<a href="Lyrics.html#Lyrics" title="Previous section in reading order" accesskey="p" rel="previous"> < Lyrics </a>]</td><td valign="middle" align="center" colspan="1">[<a href="Contexts.html#Contexts" title="Up section" accesskey="u" rel="up"> Up : Contexts </a>]</td><td valign="middle" align="right" colspan="2">[<a href="MensuralVoice.html#MensuralVoice" title="Next section in reading order" accesskey="n" rel="next"> MensuralVoice > </a>]</td></tr></table>
<!-- footer_tag -->
<div class="footer">
<p class="footer_version">
This page is for LilyPond-2.12.2 (stable-branch).
</p>
<p class="footer_report">
Your <a href="http://lilypond.org/web/devel/participating/documentation-adding">suggestions for the documentation</a> are welcome, please report errors to our <a href="http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs">bug list</a>.
</p>
</div>
<!-- FOOTER -->
<!-- end div#main here -->
</div>
<div id="tocframe">
<p class="toc_uplink"><a href="../index.html"
title="Documentation Index"><< Back to Documentation Index</a></p>
<h4 class="toc_header"> <a href="index.html#Top" title="Start of the manual">Internals Reference</a></h4>
<div class="contents">
<ul class="toc">
<li><a name="toc-Music-definitions-1" href="Music-definitions.html#Music-definitions">1. Music definitions</a>
<ul class="toc">
<li><a name="toc-Music-expressions-1" href="Music-expressions.html#Music-expressions">1.1 Music expressions</a> </li>
<li><a name="toc-Music-classes-1" href="Music-classes.html#Music-classes">1.2 Music classes</a> </li>
<li><a name="toc-Music-properties-1" href="Music-properties.html#Music-properties">1.3 Music properties</a> </li>
</ul>
</li>
<li class="toc_current"><a name="toc-Translation-1" href="Translation.html#Translation">2. Translation</a>
<ul class="toc">
<li class="toc_current"><a name="toc-Contexts-1" href="Contexts.html#Contexts">2.1 Contexts</a>
<ul class="toc">
<li><a name="toc-ChoirStaff-1" href="ChoirStaff.html#ChoirStaff">2.1.1 ChoirStaff</a> </li>
<li><a name="toc-ChordNames-1" href="ChordNames.html#ChordNames">2.1.2 ChordNames</a> </li>
<li><a name="toc-CueVoice-1" href="CueVoice.html#CueVoice">2.1.3 CueVoice</a> </li>
<li><a name="toc-Devnull-1" href="Devnull.html#Devnull">2.1.4 Devnull</a> </li>
<li><a name="toc-DrumStaff-1" href="DrumStaff.html#DrumStaff">2.1.5 DrumStaff</a> </li>
<li><a name="toc-DrumVoice-1" href="DrumVoice.html#DrumVoice">2.1.6 DrumVoice</a> </li>
<li><a name="toc-FiguredBass-1" href="FiguredBass.html#FiguredBass">2.1.7 FiguredBass</a> </li>
<li><a name="toc-FretBoards-1" href="FretBoards.html#FretBoards">2.1.8 FretBoards</a> </li>
<li><a name="toc-Global-1" href="Global.html#Global">2.1.9 Global</a> </li>
<li><a name="toc-GrandStaff-1" href="GrandStaff.html#GrandStaff">2.1.10 GrandStaff</a> </li>
<li><a name="toc-GregorianTranscriptionStaff-1" href="GregorianTranscriptionStaff.html#GregorianTranscriptionStaff">2.1.11 GregorianTranscriptionStaff</a> </li>
<li><a name="toc-GregorianTranscriptionVoice-1" href="GregorianTranscriptionVoice.html#GregorianTranscriptionVoice">2.1.12 GregorianTranscriptionVoice</a> </li>
<li><a name="toc-Lyrics-1" href="Lyrics.html#Lyrics">2.1.13 Lyrics</a> </li>
<li class="toc_current"><a name="toc-MensuralStaff-1" href="MensuralStaff.html#MensuralStaff">2.1.14 MensuralStaff</a> </li>
<li><a name="toc-MensuralVoice-1" href="MensuralVoice.html#MensuralVoice">2.1.15 MensuralVoice</a> </li>
<li><a name="toc-NoteNames-1" href="NoteNames.html#NoteNames">2.1.16 NoteNames</a> </li>
<li><a name="toc-PianoStaff-1" href="PianoStaff.html#PianoStaff">2.1.17 PianoStaff</a> </li>
<li><a name="toc-RhythmicStaff-1" href="RhythmicStaff.html#RhythmicStaff">2.1.18 RhythmicStaff</a> </li>
<li><a name="toc-Score-1" href="Score.html#Score">2.1.19 Score</a> </li>
<li><a name="toc-Staff-1" href="Staff.html#Staff">2.1.20 Staff</a> </li>
<li><a name="toc-StaffGroup-1" href="StaffGroup.html#StaffGroup">2.1.21 StaffGroup</a> </li>
<li><a name="toc-TabStaff-1" href="TabStaff.html#TabStaff">2.1.22 TabStaff</a> </li>
<li><a name="toc-TabVoice-1" href="TabVoice.html#TabVoice">2.1.23 TabVoice</a> </li>
<li><a name="toc-VaticanaStaff-1" href="VaticanaStaff.html#VaticanaStaff">2.1.24 VaticanaStaff</a> </li>
<li><a name="toc-VaticanaVoice-1" href="VaticanaVoice.html#VaticanaVoice">2.1.25 VaticanaVoice</a> </li>
<li><a name="toc-Voice-1" href="Voice.html#Voice">2.1.26 Voice</a> </li>
</ul>
</li>
<li><a name="toc-Engravers-and-Performers-1" href="Engravers-and-Performers.html#Engravers-and-Performers">2.2 Engravers and Performers</a> </li>
<li><a name="toc-Tunable-context-properties-1" href="Tunable-context-properties.html#Tunable-context-properties">2.3 Tunable context properties</a> </li>
<li><a name="toc-Internal-context-properties-1" href="Internal-context-properties.html#Internal-context-properties">2.4 Internal context properties</a> </li>
</ul>
</li>
<li><a name="toc-Backend-1" href="Backend.html#Backend">3. Backend</a>
<ul class="toc">
<li><a name="toc-All-layout-objects-1" href="All-layout-objects.html#All-layout-objects">3.1 All layout objects</a> </li>
<li><a name="toc-Graphical-Object-Interfaces-1" href="Graphical-Object-Interfaces.html#Graphical-Object-Interfaces">3.2 Graphical Object Interfaces</a> </li>
<li><a name="toc-User-backend-properties-1" href="User-backend-properties.html#User-backend-properties">3.3 User backend properties</a> </li>
<li><a name="toc-Internal-backend-properties-1" href="Internal-backend-properties.html#Internal-backend-properties">3.4 Internal backend properties</a> </li>
</ul>
</li>
<li><a name="toc-Scheme-functions-1" href="Scheme-functions.html#Scheme-functions">4. Scheme functions</a> </li>
<li><a name="toc-Indices-1" href="Indices.html#Indices">A. Indices</a>
<ul class="toc">
<li><a name="toc-Concept-index" href="Indices.html#Indices">A.1 Concept index</a> </li>
<li><a name="toc-Function-index" href="Indices.html#Indices">A.2 Function index</a> </li>
</ul>
</li>
</ul>
</div>
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
ffe16b32b9f5eec0add70c0a6bc8cec8
>
files
>
5065
