used. Here is a simple example to change the color of the
note head:
+@cindex color property, example
+@cindex NoteHead, example of overriding
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=1]
c d
\override NoteHead #'color = #red
in many of the following examples. Here we revert the color
of the note head to the default value for the final two notes:
+@cindex color property, example
+@cindex NoteHead, example of overriding
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=1]
c d
\override NoteHead #'color = #red
back to its default value. Using the same example, we can
change the color of a single note like this:
+@cindex color property, example
+@cindex NoteHead, example of overriding
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=1]
c d
\once \override NoteHead #'color = #red
middle note head (the E) in a C major chord. Let's first see what
@code{\once \override} would do:
+@cindex font-size property, example
+@cindex NoteHead, example of overriding
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=1]
<c e g>4
\once \override NoteHead #'font-size = #-3
So to return to our example, the size of the middle note of
a chord would be changed in this way:
+@cindex font-size property, example
+@cindex @code{\tweak}, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=1]
<c e g>4
<c \tweak #'font-size #-3 e g>4
A @code{\tweak} command can also be used to modify just one in
a series of articulations, as shown here:
+@cindex color property, example
+@cindex @code{\tweak}, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
a ^Black
-\tweak #'color #red ^Red
notes and the second one specifies that the tuplet number is to be
printed in red on the first short tuplet bracket.
+@cindex @code{\tweak}, example
+@cindex direction property, example
+@cindex color property, example
+
@lilypond[quote,ragged-right,verbatim,fragment,relative=2]
\tweak #'direction #up
\times 4/3 {
appearance may be modified in the usual way with
@code{\override} commands:
+@cindex text property, example
+@cindex tuplet-number function, example
+@cindex transparent property, example
+@cindex TupletNumber, example of overriding
+
@c NOTE Tuplet brackets collide if notes are high on staff
@c See issue 509
@lilypond[quote,ragged-right,verbatim,fragment,relative=1]
@cindex override example
@cindex Internals Reference, example of using
+@cindex @code{\addlyrics} example
Let's use a concrete example with a simple fragment of real
music:
The man who feels love's sweet e -- mo -- tion
}
}
-@end lilypond
+@end lilypond
Suppose now that we decide we would like the slurs to be a
little heavier. Is this possible? The slur is certainly a
answer is, @q{Within the music, before the first slur and
close to it.} Let's do that:
+@cindex Slur example of overriding
+@cindex thickness property, example
+
@lilypond[quote,verbatim,relative=2]
{
\time 6/8
is simply discarded. So the command with @code{\once} must be
repositioned as follows:
+@cindex Slur, example of overriding
+@cindex thickness property, example
+
@lilypond[quote,verbatim,relative=2]
{
\time 6/8
@code{\once} placed immediately before each of the notes where
the slurs begin:
+@cindex Slur, example of overriding
+@cindex thickness property, example
+
@lilypond[quote,verbatim,relative=2]
{
\time 6/8
command to return the @code{thickness} property to its default value
after the second slur:
+@cindex Slur, example of overriding
+@cindex thickness property, example
+
@lilypond[quote,verbatim,relative=2]
{
\time 6/8
and this should be placed just in front of and close to the
lyrics which it should affect, like this:
+@cindex font-shape property, example
+@cindex italic, example
+@cindex LyricText, example of overriding
+@cindex @code{\addlyrics}, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 6/8
setting its value to @code{#f}. Let's try it, as before, omitting
the implied Context, @code{Voice}:
+@cindex BarLine, example of overriding
+@cindex stencil property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 12/16
produced, and nothing is logged in the log file. Let's try correcting
it by adding the correct context:
+@cindex BarLine, example of overriding
+@cindex stencil property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 12/16
required, as always, to precede the value itself in the
@code{\override} command.
+@cindex BarLine, example of overriding
+@cindex break-visibility property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 12/16
@code{grob-interface}. So the command to make the time signature
transparent is:
+@cindex TimeSignature, example of overriding
+@cindex transparent property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 12/16
stencil for the time signature should be set to @code{#f}
instead:
+@cindex TimeSignature, example of overriding
+@cindex stencil property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 12/16
@ruser{List of colors}. To set the bar lines to white
we write:
+@cindex BarLine, example of overriding
+@cindex color property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 12/16
@cindex color, X11
@cindex X11 colors
-@funindex x22-color
+@funindex x11-color
The second way of changing the color is to use the list of
X11 color names in the second list in @ruser{List of colors}.
converts X11 color names into the list of internal values,
@code{x11-color}, like this:
+@cindex BarLine, example of overriding
+@cindex color property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 12/16
set the color to red the value should be @code{(rgb-color 1 0 0)}
and to white it should be @code{(rgb-color 1 1 1)}:
+@cindex BarLine, example of overriding
+@cindex color property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 12/16
this by setting all the layout objects in our example to
various shades of grey:
+@cindex StaffSymbol, example of overriding
+@cindex TimeSignature, example of overriding
+@cindex Clef, example of overriding
+@cindex NoteHead, example of overriding
+@cindex Stem, example of overriding
+@cindex BarLine, example of overriding
+@cindex color property, example
+@cindex x11-color, example of using
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
{
\time 12/16
see @ref{Nesting music expressions}) which showed
how to introduce a new temporary staff, as in an @rglos{ossia}.
+@cindex alignAboveContext property, example
+@cindex @code{\with}, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
\new Staff ="main" {
\relative g' {
already know now how to remove the clef and time signature --
we simply set the stencil of each to @code{#f}, as follows:
+@cindex alignAboveContext property, example
+@cindex @code{\with}, example
+@cindex stencil property, example
+@cindex Clef, example of overriding
+@cindex TimeSignature, example of overriding
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
\new Staff ="main" {
\relative g' {
required to ensure the enclosed overrides and music are applied
to the ossia staff.
-But what is the difference between modifying the staff context by
+But what is the difference between modifying the staff context by
using @code{\with} and modifying the stencils of the clef and the
-time signature with \override? The main difference is that
+time signature with \override? The main difference is that
changes made in a @code{\with} clause are made at the time the
context is created, and remain in force as the @strong{default}
values for the duration of that context, whereas
music are dynamic -- they make changes synchronized with
a particular point in the music. If changes are unset or
reverted using @code{\unset} or @code{\revert} they return to
-their default values, which will be the ones set in the
+their default values, which will be the ones set in the
@code{\with} clause, or if none have been set there, the normal
default values.
So we could replace the example above with
+@cindex alignAboveContext property, example
+@cindex @code{\with}, example
+@cindex Clef, example of overriding
+@cindex TimeSignature, example of overriding
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
\new Staff ="main" {
\relative g' {
Let's try it in our ossia example:
+@cindex alignAboveContext property, example
+@cindex @code{\with}, example
+@cindex Clef, example of overriding
+@cindex TimeSignature, example of overriding
+@cindex fontSize property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
\new Staff ="main" {
\relative g' {
}
@end lilypond
-This is still not quite right. The note heads and flags are
+This is still not quite right. The note heads and flags are
smaller, but the stems are too long in proportion and the
staff lines are spaced too widely apart. These need to be
scaled down in proportion to the font reduction. The next
and returns a scaling factor suitable for reducing other
objects in proportion. It is used like this:
+@cindex alignAboveContext property, example
+@cindex @code{\with}, example
+@cindex Clef, example of overriding
+@cindex TimeSignature, example of overriding
+@cindex fontSize property, example
+@cindex StaffSymbol, example of overriding
+@cindex magstep function, example of using
+@cindex staff-space property, example
+@cindex stencil property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
\new Staff ="main" {
\relative g' {
For small changes in scale, as in the example above, the
thickness of the various drawn lines such as bar lines,
-beams, hairpins, slurs, etc does not usually require global
+beams, hairpins, slurs, etc does not usually require global
adjustment. If the thickness of any particular layout object
needs to be adjusted this can be best achieved by overriding its
@code{thickness} property. An example of changing the thickness
of slurs was shown above in @ref{Properties of layout objects}.
The thickness of all drawn objects (i.e., those not produced
-from a font) may be changed in the same way.
+from a font) may be changed in the same way.
@node Placement of objects
@section Placement of objects
@menu
-* Automatic behavior::
-* Within-staff objects::
-* Outside-staff objects::
+* Automatic behavior::
+* Within-staff objects::
+* Outside-staff objects::
@end menu
which the objects should be placed, as follows.
First, LilyPond places all the within-staff objects.
-Then it sorts the outside-staff objects according to their
+Then it sorts the outside-staff objects according to their
@code{outside-staff-priority}. The outside-staff objects are
taken one by one, beginning with the object with the lowest
@code{outside-staff-priority}, and placed so that they do not
-collide with any objects that have already been placed. That is,
-if two outside-staff grobs are competing for the same space, the
+collide with any objects that have already been placed. That is,
+if two outside-staff grobs are competing for the same space, the
one with the lower @code{outside-staff-priority} will be placed
closer to the staff. If two objects have the same
@code{outside-staff-priority} the one encountered first will be
placed closer to the staff.
-In the following example all the markup texts have the same
+In the following example all the markup texts have the same
priority (since it is not explicitly set). Note that @q{Text3}
is automatically positioned close to the staff again, nestling
under @q{Text2}.
+@cindex markup example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
c2^"Text1"
c^"Text2"
all stems forced up, and finally four notes reverted back to the
default behavior.
+@cindex Stem, example of overriding
+@cindex direction property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
a4 g c a
\override Stem #'direction = #DOWN
@cindex fingering, placement
@cindex fingering, chords
-The placement of fingering is also affected by the value
-of its @code{direction} property, but there are special
+The placement of fingering on single notes can also be controlled
+by the @code{direction} property, but changing @code{direction}
+has no effect on chords. As we shall see, there are special
commands which allow the fingering of individual notes
of chords to be controlled, with the fingering being placed
above, below, to the left or to the right of each note.
-First, here's the effect of @code{direction} on fingering,
-the first bar shows the default, then the effect of specifying
-@code{DOWN} and @code{UP}:
+First, here's the effect of @code{direction} on the fingering
+attached to single notes. The first bar shows the default
+behaviour, and the following two bars shows the effect of
+specifying @code{DOWN} and @code{UP}:
-@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
+@cindex Fingering, example of overriding
+@cindex direction property, example
+
+@lilypond[quote,verbatim,relative=2]
c-5 a-3 f-1 c'-5
\override Fingering #'direction = #DOWN
c-5 a-3 f-1 c'-5
c-5 a-3 f-1 c'-5
@end lilypond
-This is how to control fingering on single notes, but the
-@code{direction} property is ignored for chords. Instead, by default,
-the fingering is automatically placed both above and below the notes
-of a chord, as shown:
+However, overriding the @code{direction} property is not the
+easiest way of manually setting the fingering above or below
+the notes; using @code{_} or @code{^} instead of @code{-} before
+the fingering number is usually preferable. Here is the previous
+example using this method:
-@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
+@cindex fingering example
+
+@lilypond[quote,verbatim,relative=2]
+c-5 a-3 f-1 c'-5
+c_5 a_3 f_1 c'_5
+c^5 a^3 f^1 c'^5
+@end lilypond
+
+The @code{direction} property is ignored for chords, but the
+directional prefixes, @code{_} and @code{^} do work. By default,
+the fingering is automatically placed both above and below the
+notes of a chord, as shown:
+
+@cindex fingering example
+
+@lilypond[quote,verbatim,relative=2]
<c-5 g-3>
<c-5 g-3 e-2>
<c-5 g-3 e-2 c-1>
@end lilypond
-Greater control over the placement of fingering of the
-individual notes in a chord is possible by using
-the @code{\set fingeringOrientations} command. The format of
-this command is
+@noindent
+but this may be overriden to manually force all or any of the
+individual fingering numbers above or below:
+
+@cindex fingering example
+
+@lilypond[quote,verbatim,relative=2]
+<c-5 g-3 e-2 c-1>
+<c^5 g_3 e_2 c_1>
+<c^5 g^3 e^2 c_1>
+@end lilypond
+
+Even greater control over the placement of fingering of the
+individual notes in a chord is possible by using the
+@code{\set fingeringOrientations} command. The format of this
+command is:
@example
@code{\set fingeringOrientations = #'([up] [left/right] [down])}
@code{New_fingering_engraver}.
The property may be set to a list of one to three values.
-It controls whether fingerings may be placed above (if
+It controls whether fingerings may be placed above (if
@code{up} appears in the list), below (if @code{down} appears),
to the left (if @code{left} appears, or to the right
(if @code{right} appears). Conversely, if a location is not
-listed, no fingering is placed there. LilyPond takes these
+listed, no fingering is placed there. LilyPond takes these
constraints and works out the best placement for the fingering
of the notes of the following chords. Note that @code{left} and
@code{right} are mutually exclusive -- fingering may be placed
only on one side or the other, not both.
-To control the placement of the fingering of a single note
-using this command it is necessary to write it as a single
-note chord by placing angle brackets round it.
-
+@warning{To control the placement of the fingering of a single
+note using this command it is necessary to write it as a single
+note chord by placing angle brackets round it.}
+
Here are a few examples:
+@cindex fingering example
+@cindex @code{\set}, example of using
+@cindex fingeringOrientations property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=1]
\set fingeringOrientations = #'(left)
<f-2>
\set fingeringOrientations = #'(right)
<f-2>
< c-1 e-2 g-3 b-5 > 4
-@end lilypond
+@end lilypond
@noindent
If the fingering seems a little crowded the @code{font-size}
<f-2>
< c-1 e-2 g-3 b-5 > 4
@end lilypond
-@c START HERE
-@node Outside staff objects
-@subsection Outside staff objects
+
+@node Outside-staff objects
+@subsection Outside-staff objects
Outside-staff objects are automatically placed to avoid collisions.
Objects with the lower value of the @code{outside-staff-priority}
these.
@cindex text spanner
+@cindex ottava bracket
+
@funindex \startTextSpan
+@funindex startTextSpan
@funindex \stopTextSpan
-@cindex ottava bracket
+@funindex stopTextSpan
+
+@cindex TextSpanner, example of overriding
+@cindex bound-details property, example
@lilypond[quote,fragment,ragged-right,verbatim,relative=1]
% Set details for later Text Spanner
It also shows how ottava brackets are created.
-Note that bar numbers, metronome marks and rehearsal marks
-are not shown. By default these are created in the
-@code{Score} context and their @code{outside-staff-priority}
-is ignored relative to the layout objects which are created
-in the @code{Staff} context.
-If you wish to place bar numbers, metronome marks or rehearsal
-marks in accordance with the value of their
-@code{outside-staff-priority} the @code{Bar_number_engraver},
-@code{Metronome_mark_engraver} or @code{Mark_engraver} respectively
-should be removed from the @code{Score} context and placed in the
-top @code{Staff} context. If this is done, these marks will be
-given the following default @code{outside-staff-priority} values:
+@cindex tweaking bar number placement
+@cindex bar numbers, tweaking placement
+@cindex tweaking metronome mark placement
+@cindex metronome mark, tweaking placement
+@cindex tweaking rehearsal mark placement
+@cindex rehearsal marks, tweaking placement
+
+Note that bar numbers, metronome marks and rehearsal marks are not
+shown. By default these are created in the @code{Score} context and
+their @code{outside-staff-priority} is ignored relative to the layout
+objects which are created in the @code{Staff} context. If you wish to
+place bar numbers, metronome marks or rehearsal marks in accordance
+with the value of their @code{outside-staff-priority} the
+@code{Bar_number_engraver}, @code{Metronome_mark_engraver} or
+@code{Mark_engraver} respectively should be removed from the
+@code{Score} context and placed in the top @code{Staff} context. If
+this is done, these marks will be given the following default
+@code{outside-staff-priority} values:
@multitable @columnfractions .3 .3
@headitem Layout Object @tab Priority
@item @code{BarNumber} @tab @code{ 100}
@end multitable
-If the default values of @code{outside-staff-priority} do not
-give you the placing you want, the priority of any of the objects
-may be overridden. Suppose we would
-like the ottava bracket to be placed below the text spanner in the
-example above. All we need to do is to look up the priority of
-@code{OttavaBracket} in the IR or in the tables above, and reduce
-it to a value lower than that of a @code{TextSpanner}, remembering
-that @code{OttavaBracket} is created in the @code{Staff} context:
+If the default values of @code{outside-staff-priority} do not give you
+the placing you want, the priority of any of the objects may be
+overridden. Suppose we would like the ottava bracket to be placed
+below the text spanner in the example above. All we need to do is to
+look up the priority of @code{OttavaBracket} in the IR or in the
+tables above, and reduce it to a value lower than that of a
+@code{TextSpanner}, remembering that @code{OttavaBracket} is created
+in the @code{Staff} context:
+
+@cindex TextSpanner, example of overriding
+@cindex bound-details property, example
@lilypond[quote,fragment,ragged-right,verbatim,relative=1]
% Set details for later Text Spanner
in the IR or in the tables above, and increase the priority of
@qq{Text3} to a higher value:
+@cindex TextScript, example of overriding
+@cindex outside-staff-priority property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
c2^"Text1"
c^"Text2"
c^"Text4"
@end lilypond
-This certainly lifts @qq{Text3} above @qq{Text4} but it also
-lifts it above @qq{Text2}, and @qq{Text4} now drops down.
-Perhaps this is not so good. What we would really like to do
-is to position all the annotation at the same distance above
-the staff? To do this, we clearly
-will need to space the notes out horizontally to make more
+This certainly lifts @qq{Text3} above @qq{Text4} but it also lifts it
+above @qq{Text2}, and @qq{Text4} now drops down. Perhaps this is not
+so good. What we would really like to do is to position all the
+annotation at the same distance above the staff. To do this, we
+clearly will need to space the notes out horizontally to make more
room for the text. This is done using the @code{textLengthOn}
command.
@subheading \textLengthOn
-@funindex \textLengthOn
@cindex notes, spreading out with text
+@funindex \textLengthOn
+@funindex textLengthOn
+@funindex \textLengthOff
+@funindex textLengthOff
+
By default, text produced by markup takes up no horizontal space
as far as laying out the music is concerned. The @code{\textLengthOn}
command reverses this behavior, causing the notes to be spaced
@code{\override}, @code{\set}, @code{\revert} or @code{unset},
so cannot be used with @code{\textLengthOn}.
+@cindex markup text, allowing collisions
+
Markup text will also avoid notes which project above the staff.
If this is not desired, the automatic displacement upwards may
be turned off by setting the priority to @code{#f}. Here's an
example to show how markup text interacts with such notes.
+@cindex TextScript, example of overriding
+@cindex outside-staff-priority property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
% This markup is short enough to fit without collision
c2^"Tex"
@subheading Dynamics
+@cindex tweaking dynamics placement
+@cindex dynamics, tweaking placement
+
Dynamic markings will normally be positioned beneath the
staff, but may be positioned above with the @code{dynamicUp}
command. They will be positioned vertically relative to the
@end lilypond
@noindent
-Should a similar situation arise in @q{real} music, it may
-be preferable to space out the notes
-a little further, so the dynamic markings can all fit at the
-same vertical distance from the staff. We were able to do this
-for markup text by using the @code{\textLengthOn} command, but there
-is no equivalent command for dynamic marks. So we shall have to
-work out how to do this using @code{\override} commands.
+Should a similar situation arise in @q{real} music, it may be
+preferable to space out the notes a little further, so the dynamic
+markings can all fit at the same vertical distance from the staff. We
+were able to do this for markup text by using the @code{\textLengthOn}
+command, but there is no equivalent command for dynamic marks. So we
+shall have to work out how to do this using @code{\override} commands.
@subheading Grob sizing
@cindex grob sizing
@cindex sizing grobs
-@cindex @code{X-offset}
-@cindex @code{Y-offset}
-@cindex @code{X-extent}
-@cindex @code{Y-extent}
First we must learn how grobs are sized. All grobs have a
reference point defined within them which is used to position
@noindent
Let's see if this works in our previous example:
+@cindex DynamicText, example of overriding
+@cindex extra-spacing-width property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
\dynamicUp
\override DynamicText #'extra-spacing-width = #'(0 . 0)
lines, so moving the left edge half a unit to the left and the
right edge half a unit to the right should do it:
+@cindex DynamicText, example of overriding
+@cindex extra-spacing-width property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
\dynamicUp
% Extend width by 1 staff space
@node Moving objects
@subsection Moving objects
+@cindex moving overlapping objects
+@cindex moving colliding objects
+@cindex moving colliding grobs
+@cindex objects, moving colliding
+@cindex grobs, moving colliding
+
This may come as a surprise, but LilyPond is not perfect. Some
notation elements can overlap. This is unfortunate, but in fact
rather rare. Usually the need to move objects is for clarity or
suitable.
@item
-The @strong{object properties}, which LilyPond uses
-when positioning layout objects, may be modified using
-@code{\override}. The advantages
-of making changes to this type of property are (a) that some
-other objects will be moved automatically if necessary to make
-room and (b) the single override can apply to all instances of
-the same type of object. Such properties include:
+The @strong{object properties}, which LilyPond uses when positioning
+layout objects, may be modified using @code{\override}. The
+advantages of making changes to this type of property are (a) that
+some other objects will be moved automatically if necessary to make
+room and (b) the single override can apply to all instances of the
+same type of object. Such properties include:
@itemize
@code{padding}, @code{left-padding},
@code{right-padding}, @code{staff-padding}
+@cindex padding
@cindex left-padding property
@cindex padding property
@cindex right-padding property
@cindex staff-padding property
+
As an object is being positioned the value of its @code{padding}
-property specifies the gap that must be left between itself and
-the nearest edge of the object against which it is being
-positioned. Note that it is the @code{padding} value of the object
-@strong{being placed} that is used;
-the @code{padding} value of the object which is already placed is
-ignored. Gaps specified by @code{padding} can be applied
-to all objects which support the @code{side-position-interface}.
+property specifies the gap that must be left between itself and the
+nearest edge of the object against which it is being positioned. Note
+that it is the @code{padding} value of the object @strong{being
+placed} that is used; the @code{padding} value of the object which is
+already placed is ignored. Gaps specified by @code{padding} can be
+applied to all objects which support the
+@code{side-position-interface}.
Instead of @code{padding}, the placement of groups of accidentals
is controlled by @code{left-padding} and @code{right-padding}.
of the accidentals.
The @code{staff-padding} property is closely related to the
-@code{padding} property: @code{padding}
-controls the minimum amount of space between any object which
-supports the @code{side-position-interface} and the nearest
-other object (generally the note or the staff lines);
-@code{staff-padding} applies only to those objects which are always
-set outside the staff -- it controls the minimum amount of space
-that should be inserted between that object and the staff. Note
-that @code{staff-padding} has no effect on objects which are
-positioned relative to the note rather than the staff, even though
-it may be overridden without error for such objects -- it is simply
-ignored.
-
-To discover which padding property is required for the object
-you wish to reposition, you
-need to return to the IR and look up the object's properties.
-Be aware that the padding properties might not be located in the
-obvious object, so look in objects that appear to be related.
+@code{padding} property: @code{padding} controls the minimum amount of
+space between any object which supports the
+@code{side-position-interface} and the nearest other object (generally
+the note or the staff lines); @code{staff-padding} applies only to
+those objects which are always set outside the staff -- it controls
+the minimum amount of space that should be inserted between that
+object and the staff. Note that @code{staff-padding} has no effect on
+objects which are positioned relative to the note rather than the
+staff, even though it may be overridden without error for such objects
+-- it is simply ignored.
+
+To discover which padding property is required for the object you wish
+to reposition, you need to return to the IR and look up the object's
+properties. Be aware that the padding properties might not be located
+in the obvious object, so look in objects that appear to be related.
All padding values are measured in staff spaces. For most
objects, this value is set by default to be around 1.0 or less
@code{self-alignment-X}
@cindex self-alignment-X property
+
This property can be used to align the object to the left, to
the right, or to center it with respect to the parent object's
reference point. It may be used with all objects which support
@code{extra-spacing-width}
@cindex extra-spacing-width property
+
This property is available for all objects which support the
@code{item-interface}. It takes two numbers, the first is added
to the leftmost extent and the second is added to the rightmost
@code{staff-position}
@cindex staff-position property
+
@code{staff-position} is a property of the
@code{staff-symbol-referencer-interface}, which is supported by
objects which are positioned relative to the staff. It specifies
note columns, and an object called @code{NoteColumn} is created
to lay out the notes in that column.
-The @code{force-hshift}
-property is a property of a @code{NoteColumn} (actually of the
-@code{note-column-interface}). Changing it permits a note column
-to be moved in units appropriate to a note column, viz. the note
-head width of the first voice note. It should be used in
-complex situations where the normal @code{\shiftOn} commands (see
-@ref{Explicitly instantiating voices}) do
-not resolve the note conflict. It is preferable to the
-@code{extra-offset} property for this purpose as there is no need
-to work out the distance in staff-spaces, and moving the notes
-into or out of a @code{NoteColumn} affects other actions such as
-merging note heads.
+The @code{force-hshift} property is a property of a @code{NoteColumn}
+(actually of the @code{note-column-interface}). Changing it permits a
+note column to be moved in units appropriate to a note column,
+viz. the note head width of the first voice note. It should be used
+in complex situations where the normal @code{\shiftOn} commands (see
+@ref{Explicitly instantiating voices}) do not resolve the note
+conflict. It is preferable to the @code{extra-offset} property for
+this purpose as there is no need to work out the distance in
+staff-spaces, and moving the notes into or out of a @code{NoteColumn}
+affects other actions such as merging note heads.
@end itemize
@item
Finally, when all else fails, objects may be manually repositioned
-relative to the staff center line vertically, or by
-displacing them by any distance to a new position. The
-disadvantages are that the correct values for the repositioning
-have to be worked out, often by trial and error, for every object
-individually, and, because the movement is done after LilyPond has
-placed all other objects, the user is responsible for avoiding any
-collisions that might ensue. But the main difficulty with this
-approach is that the repositioning values may need to be reworked
-if the music is later modified. The properties that can be used
-for this type of manual repositioning are:
+relative to the staff center line vertically, or by displacing them by
+any distance to a new position. The disadvantages are that the
+correct values for the repositioning have to be worked out, often by
+trial and error, for every object individually, and, because the
+movement is done after LilyPond has placed all other objects, the user
+is responsible for avoiding any collisions that might ensue. But the
+main difficulty with this approach is that the repositioning values
+may need to be reworked if the music is later modified. The
+properties that can be used for this type of manual repositioning are:
@table @code
@item extra-offset
+
@cindex extra-offset property
-This property applies to any layout object
-supporting the @code{grob-interface}. It takes a pair of
-numbers which specify the extra displacement in the horizontal and
-vertical directions. Negative numbers move the object to
-the left or down. The units are staff-spaces. The extra
-displacement is made after the typesetting of objects is
-finished, so an object may be repositioned anywhere without
+
+This property applies to any layout object supporting the
+@code{grob-interface}. It takes a pair of numbers which specify the
+extra displacement in the horizontal and vertical directions.
+Negative numbers move the object to the left or down. The units are
+staff-spaces. The extra displacement is made after the typesetting of
+objects is finished, so an object may be repositioned anywhere without
affecting anything else.
@item positions
+
@cindex positions property
+
This is most useful for manually adjusting the slope and height
of beams, slurs, and tuplets. It takes a pair of numbers
giving the position of the left and right ends of the beam, slur,
help to resolve overlapping notation.
@subheading padding property
-@cindex padding property
+
+@cindex padding
+@cindex fixing overlapping notation
+@cindex overlapping notation
The @code{padding} property can be set to increase
(or decrease) the distance between symbols that are printed
above or below notes.
+@cindex Script, example of overriding
+@cindex padding property, example
+
@lilypond[quote,fragment,relative=1,verbatim]
c2\fermata
\override Script #'padding = #3
b2\fermata
@end lilypond
+@cindex MetronomeMark, example of overriding
+@cindex padding property, example
+
@lilypond[quote,fragment,relative=1,verbatim]
% This will not work, see below:
\override MetronomeMark #'padding = #3
Note in the second example how important it is to figure out what
context handles a certain object. Since the @code{MetronomeMark}
-object
-is handled in the @code{Score} context, property changes in the
+object is handled in the @code{Score} context, property changes in the
@code{Voice} context will not be noticed. For more details, see
@ruser{Modifying properties}.
@subheading left-padding and right-padding
+
@cindex left-padding property
@cindex right-padding property
with a markup containing the natural and flat symbols in the
order we would like, like this:
+@cindex Accidental, example of overriding
+@cindex text property, example
+@cindex stencil property, example
+@cindex AccidentalPlacement, example of overriding
+@cindex right-padding property, example
+
@lilypond[quote,ragged-right,verbatim]
naturalplusflat = \markup { \natural \flat }
\relative c'' {
@noindent
@subheading staff-padding property
-@cindex staff-padding property
+
+@cindex aligning objects on a baseline
+@cindex objects, aligning on a baseline
@code{staff-padding} can be used to align objects such as dynamics
-along a baseline at a fixed height above the staff, rather than
-at a height dependent on the position of the note to which they
-are attached. It is not a property of
-@code{DynamicText} but of @code{DynamicLineSpanner}.
-This is because the baseline should apply equally to @strong{all}
-dynamics, including those created as extended spanners.
-So this is the way to align the dynamic marks in the example
-taken from the previous section:
+along a baseline at a fixed height above the staff, rather than at a
+height dependent on the position of the note to which they are
+attached. It is not a property of @code{DynamicText} but of
+@code{DynamicLineSpanner}. This is because the baseline should apply
+equally to @strong{all} dynamics, including those created as extended
+spanners. So this is the way to align the dynamic marks in the
+example taken from the previous section:
+
+@cindex DynamicText, example of overriding
+@cindex extra-spacing-width property, example
+@cindex DynamicLineSpanner, example of overriding
+@cindex staff-padding property, example
@lilypond[quote,fragment,ragged-right,verbatim,relative=2]
\dynamicUp
@subheading self-alignment-X property
-@cindex self-alignment-X property
The following example shows how this can resolve the collision
of a string fingering object with a note's stem by aligning the
right edge with the reference point of the parent note:
+@cindex StringNumber, example of overriding
+@cindex self-alignment-X property, example
+
@lilypond[quote,fragment,ragged-right,verbatim,relative=3]
\voiceOne
< a \2 >
@end lilypond
@subheading staff-position property
-@cindex staff-position property
+
+@cindex object collision within a staff
Multimeasure rests in one voice can collide with notes in another.
Since these rests are typeset centered between the bar lines, it
<< {c c c c} \\ {R1} >>
@end lilypond
-The best solution here is to move the multimeasure rest down,
-since the rest is in voice two.
-The default in @code{\voiceTwo} (i.e. in the second voice of a
-@code{<<@{...@} \\ @{...@}>>} construct)
-is that @code{staff-position} is set to -4 for MultiMeasureRest,
-so we need to move it, say, four half-staff spaces down to
-@code{-8}.
+The best solution here is to move the multimeasure rest down, since
+the rest is in voice two. The default in @code{\voiceTwo} (i.e. in
+the second voice of a @code{<<@{...@} \\ @{...@}>>} construct) is that
+@code{staff-position} is set to -4 for MultiMeasureRest, so we need to
+move it, say, four half-staff spaces down to @code{-8}.
+
+@cindex MultiMeasureRest, example of overriding
+@cindex staff-position property, example
@lilypond[quote,verbatim,fragment,ragged-right, relative=1]
<<
because the ledger line above the rest is inserted automatically.
@subheading extra-offset property
-@cindex extra-offset property
+
+@cindex positioning objects
+@cindex positioning grobs
+@cindex objects, positioning
+@cindex grobs, positioning
The @code{extra-offset} property provides complete control over the
positioning of an object both horizontally and vertically.
In the following example, the second fingering is moved a little to
the left, and 1.8 staff space downwards:
+@cindex Fingering, example of overriding
+@cindex extra-offset property, example
+
@lilypond[quote,fragment,relative=1,verbatim]
\stemUp
f-5
@subheading positions property
-@cindex positions property
+
+@cindex controlling tuplets, slurs, phrasing slurs, and beams manually
+@cindex manually controlling tuplets, slurs, phrasing slurs, and beams
+@cindex tuplet beams, controlling manually
+@cindex slurs, controlling manually
+@cindex phrasing slurs, controlling manually
+@cindex beams, controlling manually
The @code{positions} property allows the position and slope of
- tuplets, slurs, phrasing slurs and beams to be controlled
-manually. Here's an example which has an ugly phrasing slur
-due to its trying to avoid the slur on the acciaccatura.
+tuplets, slurs, phrasing slurs and beams to be controlled manually.
+Here's an example which has an ugly phrasing slur due to its trying to
+avoid the slur on the acciaccatura.
@lilypond[quote,verbatim,fragment,ragged-right,relative=1]
r4 \acciaccatura e8\( d8 c ~c d c d\)
@end lilypond
@noindent
-but if there were some reason why this could not be done the
+But if there were some reason why this could not be done the
other alternative would be to move the left end of the phrasing
slur down a little using the @code{positions} property. This
also resolves the rather nasty shape.
+@cindex PhrasingSlur, example of overriding
+@cindex positions property, example
+
@lilypond[quote,verbatim,fragment,ragged-right,relative=1]
r4
\once \override PhrasingSlur #'positions = #'(-4 . -3)
up from their position at 2 staff-spaces above the center line to,
say, 3:
+@cindex Beam, example of overriding
+@cindex positions property, example
+
@lilypond[quote,verbatim,fragment,ragged-right]
{
\clef "bass"
second voice.
@subheading force-hshift property
-@cindex force-hshift property
+
@c FIXME: formatting stuff (ie not important right now IMO)
@c @a nchor Chopin finally corrected TODOgp
@end lilypond
@noindent
-The lower two notes of the first chord (i.e,
-those in the third voice) should not be shifted away from the
-note column of the higher two notes. To correct this we set
-@code{force-hshift}, which is a property of
-@code{NoteColumn}, of these notes to zero.
-The lower note of the second chord is best placed just to the
-right of the higher notes. We achieve this by setting
-@code{force-hshift} of this note to 0.5, ie half a note head's
-width to the right of the note column of the higher notes.
+The lower two notes of the first chord (i.e, those in the third voice)
+should not be shifted away from the note column of the higher two
+notes. To correct this we set @code{force-hshift}, which is a
+property of @code{NoteColumn}, of these notes to zero. The lower note
+of the second chord is best placed just to the right of the higher
+notes. We achieve this by setting @code{force-hshift} of this note to
+0.5, ie half a note head's width to the right of the note column of
+the higher notes.
Here's the final result:
+@cindex NoteColumn, example of overriding
+@cindex force-hshift property, example
+
@lilypond[quote,verbatim,fragment,ragged-right]
\new Staff \relative c'' {
\key aes \major
dynamics, fingering and pedalling.
@c The following should appear as music without code
+@c This example should not be indexed
@lilypond[quote,ragged-right]
rhMusic = \relative c'' {
r2
}
@end lilypond
-All the notes are right, but the appearance is far from
-satisfactory. The tie clashes with the change in time signature,
-the beaming in the third bar is wrong, the notes are not
-merged together, and several notation elements are missing.
-Let's first deal with the easier things.
-We can correct the beaming by inserting a beam
-manually, and we can easily add the left hand slur and the right
-hand phrasing slur, since these were all covered in the Tutorial.
-Doing this gives:
+All the notes are right, but the appearance is far from satisfactory.
+The tie clashes with the change in time signature, the beaming in the
+third bar is wrong, the notes are not merged together, and several
+notation elements are missing. Let's first deal with the easier
+things. We can correct the beaming by inserting a beam manually, and
+we can easily add the left hand slur and the right hand phrasing slur,
+since these were all covered in the Tutorial. Doing this gives:
@lilypond[quote,verbatim,ragged-right]
rhMusic = \relative c'' {
}
@end lilypond
-The first bar is now correct. The second bar contains an arpeggio
-and is terminated by a double bar line. How do we do these, as they
-have not been mentioned in this Learning Manual? This is where
-we need to turn to the Notation Reference. Looking up @q{arpeggio}
-and @q{bar line} in the
-index quickly shows us that an arpeggio is produced by appending
-@code{\arpeggio} to a chord, and a double bar line is produced by
-the @code{\bar "||"} command. That's easily done. We next need
-to correct the collision of the tie with the time signature. This
-is best done by moving the tie upwards. Moving objects was covered
-earlier in @ref{Moving objects}, which says that objects positioned
-relative to the staff can be moved by overriding their
+The first bar is now correct. The second bar contains an arpeggio and
+is terminated by a double bar line. How do we do these, as they have
+not been mentioned in this Learning Manual? This is where we need to
+turn to the Notation Reference. Looking up @q{arpeggio} and @q{bar
+line} in the index quickly shows us that an arpeggio is produced by
+appending @code{\arpeggio} to a chord, and a double bar line is
+produced by the @code{\bar "||"} command. That's easily done. We
+next need to correct the collision of the tie with the time signature.
+This is best done by moving the tie upwards. Moving objects was
+covered earlier in @ref{Moving objects}, which says that objects
+positioned relative to the staff can be moved by overriding their
@code{staff-position} property, which is specified in half staff
spaces relative to the center line of the staff. So the following
-override placed just before the first tied note would move the tie
-up to 3.5 half staff spaces above the center line:
+override placed just before the first tied note would move the tie up
+to 3.5 half staff spaces above the center line:
@code{\once \override Tie #'staff-position = #3.5}
}
@end lilypond
-On to bar three and the start of the Moderato section. The
-tutorial showed how to add embolded text with the @code{\markup}
-command, so adding @q{Moderato} in bold is easy.
-But how do we merge notes in different voices together? This is
-where we need to turn to the Notation Reference for help. A search
-for @qq{merge} in the Notation Reference index quickly leads us to
-the commands for merging differently headed and differently
-dotted notes in @ruser{Collision resolution}. In our
-example we need to merge both types of note for the duration
-of the polyphonic section in bar 3, so using the information
-we find in the Notation Reference we add
+On to bar three and the start of the Moderato section. The tutorial
+showed how to add embolded text with the @code{\markup} command, so
+adding @q{Moderato} in bold is easy. But how do we merge notes in
+different voices together? This is where we need to turn to the
+Notation Reference for help. A search for @qq{merge} in the Notation
+Reference index quickly leads us to the commands for merging
+differently headed and differently dotted notes in @ruser{Collision
+resolution}. In our example we need to merge both types of note for
+the duration of the polyphonic section in bar 3, so using the
+information we find in the Notation Reference we add
@example
\mergeDifferentlyHeadedOn
using @code{\shiftOnn} to avoid it interfering with the two D's.
Applying these changes gives:
+@cindex Tie, example of overriding
+@cindex staff-position property, example
+
@lilypond[quote,verbatim,ragged-right]
rhMusic = \relative c'' {
r2 c4.\( g8 |
earlier tweaks: we make the stem transparent, and move the C with
the @code{force-hshift} property. Here's the final result:
+@cindex NoteColumn, example of overriding
+@cindex force-hshift property, example
+@cindex Stem, example of overriding
+@cindex transparent property, example
+
@lilypond[quote,verbatim,ragged-right]
rhMusic = \relative c'' {
r2
@cindex removing objects
@cindex objects, removing
@cindex hiding objects
+@cindex objects, hiding
@cindex invisible objects
+@cindex objects, invisible
@cindex tying notes across voices
@subheading Tying notes across voices
and blanking the first up-stem in that voice, the tie appears to
cross voices:
+@cindex Stem, example of overriding
+@cindex transparent propery, example
+
@lilypond[quote,fragment,relative=2,verbatim]
<<
{
its @code{stencil} property to @code{#f} would be the best way.
We show here the effect of the two methods:
+@cindex MetronomeMark, example of overriding
+@cindex transparent property, example
+
@lilypond[quote,verbatim,ragged-right]
\score {
\relative c'' {
}
@end lilypond
+@cindex MetronomeMark, example of overriding
+@cindex stencil property, example
+
@lilypond[quote,verbatim,ragged-right]
\score {
\relative c'' {
@node Using variables for tweaks
@subsection Using variables for tweaks
+@cindex variables, using for tweaks
+@cindex using variables for tweaks
+@cindex tweaks, using variables for
+
Override commands are often long and tedious to type, and they
have to be absolutely correct. If the same overrides are to be
used many times it may be worth defining variables to hold them.
perhaps choose shorter names for the variables to make them
quicker to type:
+@cindex LyricText, example of overriding
+@cindex font-shape property, example
+@cindex font-series property, example
+
@lilypond[quote,verbatim]
emphasize = {
\override Lyrics . LyricText #'font-shape = #'italic
Let's begin by looking at some files in @file{ly/}.
Open @file{ly/property-init.ly} in a text editor. The one
you normally use for @code{.ly} files will be fine. This file
-contains the definitions of all the standard LilyPond built-in
+contains the definitions of all the standard LilyPond predefined
commands, such as @code{\stemUp} and @code{\slurDotted}. You will
see that these are nothing more than definitions of variables
containing one or a group of @code{\override} commands. For
@}
@end example
-If you do not like the default values these built-in commands can
+If you do not like the default values these predefined commands can
be redefined easily, just like any other variable, at the
head of your input file.
@tab Contents
@item @file{ly/engraver-init.ly}
@tab Definitions of engraver Contexts
-@item @file{ly/paper-defaults.ly}
+@item @file{ly/paper-defaults-init.ly}
@tab Specifications of paper-related defaults
@item @file{ly/performer-init.ly}
@tab Definitions of performer Contexts
@item @file{ly/property-init.ly}
- @tab Definitions of all common built-in commands
+ @tab Definitions of all common predefined commands
+@item @file{ly/spanner-init.ly}
+ @tab Definitions of spanner-related predefined commands
@end multitable
Other settings (such as the definitions of markup commands) are
example we color the note head in accordance with its position on
the staff.
+@cindex x11-color function, example of using
+@cindex NoteHead, example of overriding
+@cindex color property, setting to Scheme procedure
+
@lilypond[quote,verbatim,ragged-right]
#(define (color-notehead grob)
"Color the notehead according to its position on the staff."
\relative c' {
% Arrange to obtain color from color-notehead procedure
\override NoteHead #'color = #color-notehead
- c2 c' |
- b4 g8 a b4 c |
- c,2 a' |
+ c2 c' |
+ b4 g8 a b4 c |
+ c,2 a' |
g1 |
}
\addlyrics {
projects / lilypond.git / blobdiff