]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/learning/tweaks.itely
Doc: introduce Voices in correct order (part of 2169)
[lilypond.git] / Documentation / learning / tweaks.itely
1 @c -*- coding: utf-8; mode: texinfo; -*-
2
3 @ignore
4     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
5
6     When revising a translation, copy the HEAD committish of the
7     version that you are working on.  For details, see the Contributors'
8     Guide, node Updating translation committishes..
9 @end ignore
10
11 @c \version "2.15.10"
12
13 @node Tweaking output
14 @chapter Tweaking output
15
16 This chapter discusses how to modify output.  LilyPond is extremely
17 configurable; virtually every fragment of output may be changed.
18
19
20 @menu
21 * Tweaking basics::
22 * The Internals Reference manual::
23 * Appearance of objects::
24 * Placement of objects::
25 * Collisions of objects::
26 * Further tweaking::
27 @end menu
28
29 @node Tweaking basics
30 @section Tweaking basics
31
32 @menu
33 * Introduction to tweaks::
34 * Objects and interfaces::
35 * Naming conventions of objects and properties::
36 * Tweaking methods::
37 @end menu
38
39 @node Introduction to tweaks
40 @subsection Introduction to tweaks
41
42 @q{Tweaking} is a LilyPond term for the various methods available
43 to the user for modifying the actions taken during interpretation
44 of the input file and modifying the appearance of the printed
45 output.  Some tweaks are very easy to use; others are more
46 complex.  But taken together the methods available for tweaking
47 permit almost any desired appearance of the printed music to be
48 achieved.
49
50 In this section we cover the basic concepts required to understand
51 tweaking.  Later we give a variety of ready-made commands which can
52 simply be copied to obtain the same effect in your own scores, and
53 at the same time we show how these commands may be constructed so
54 that you may learn how to develop your own tweaks.
55
56 Before starting on this Chapter you may wish to review the section
57 @ref{Contexts and engravers}, as Contexts, Engravers, and the
58 Properties contained within them are fundamental to understanding
59 and constructing Tweaks.
60
61 @node Objects and interfaces
62 @subsection Objects and interfaces
63
64 @cindex object
65 @cindex grob
66 @cindex spanner
67 @cindex interface
68 @cindex properties, object
69 @cindex object properties
70 @cindex layout object
71 @cindex object, layout
72 @cindex interface
73
74 Tweaking involves modifying the internal operation and structures
75 of the LilyPond program, so we must first introduce some terms
76 which are used to describe those internal operations and
77 structures.
78
79 The term @q{Object} is a generic term used to refer to the
80 multitude of internal structures built by LilyPond during the
81 processing of an input file.  So when a command like @code{\new
82 Staff} is encountered a new object of type @code{Staff} is
83 constructed.  That @code{Staff} object then holds all the
84 properties associated with that particular staff, for example, its
85 name and its key signature, together with details of the engravers
86 which have been assigned to operate within that staff's context.
87 Similarly, there are objects to hold the properties of all other
88 contexts, such as @code{Voice} objects, @code{Score} objects,
89 @code{Lyrics} objects, as well as objects to represent all
90 notational elements such as bar lines,
91 note heads, ties, dynamics, etc.  Every object has its own set of
92 property values.
93
94 Some types of object are given special names.  Objects which represent
95 items of notation on the printed output such as note heads, stems,
96 slurs, ties, fingering, clefs, etc are called @q{Layout objects},
97 often known as @q{Graphical Objects}, or @q{Grobs} for short.  These
98 are still objects in the generic sense above, and so they too all have
99 properties associated with them, such as their position, size, color,
100 etc.
101
102 Some layout objects are still more specialized.  Phrasing slurs,
103 crescendo hairpins, ottava marks, and many other grobs are not
104 localized in a single place -- they have a starting point, an
105 ending point, and maybe other properties concerned with their
106 shape.  Objects with an extended shape like these are called
107 @q{Spanners}.
108
109 It remains to explain what @q{Interfaces} are.  Many objects, even
110 though they are quite different, share common features which need to
111 be processed in the same way.  For example, all grobs have a color, a
112 size, a position, etc, and all these properties are processed in the
113 same way during LilyPond's interpretation of the input file.  To
114 simplify these internal operations these common actions and properties
115 are grouped together in an object called a @code{grob-interface}.
116 There are many other groupings of common properties like this, each
117 one given a name ending in @code{interface}.  In total there are over
118 100 such interfaces.  We shall see later why this is of interest and
119 use to the user.
120
121 These, then, are the main terms relating to objects which we
122 shall use in this chapter.
123
124 @node Naming conventions of objects and properties
125 @subsection Naming conventions of objects and properties
126
127 @cindex naming conventions for objects
128 @cindex naming conventions for properties
129 @cindex objects, naming conventions
130 @cindex properties, naming conventions
131
132 We met some object naming conventions previously, in
133 @ref{Contexts and engravers}.  Here for reference is a list
134 of the most common object and property types together with
135 the conventions for naming them and a couple of examples of
136 some real names.  We have used @q{A} to stand for any capitalized
137 alphabetic character and @q{aaa} to stand for any number of
138 lower-case alphabetic characters.  Other characters are used
139 verbatim.
140
141 @multitable @columnfractions .33 .33 .33
142 @headitem Object/property type
143   @tab Naming convention
144   @tab Examples
145 @item Contexts
146   @tab Aaaa or AaaaAaaaAaaa
147   @tab Staff, GrandStaff
148 @item Layout Objects
149   @tab Aaaa or AaaaAaaaAaaa
150   @tab Slur, NoteHead
151 @item Engravers
152   @tab Aaaa_aaa_engraver
153   @tab Clef_engraver, Note_heads_engraver
154 @item Interfaces
155   @tab aaa-aaa-interface
156   @tab grob-interface, break-aligned-interface
157 @item Context Properties
158   @tab aaa or aaaAaaaAaaa
159   @tab alignAboveContext, skipBars
160 @item Layout Object Properties
161   @tab aaa or aaa-aaa-aaa
162   @tab direction, beam-thickness
163 @end multitable
164
165 As we shall see shortly, the properties of different types of
166 object are modified by different commands, so it is useful to
167 be able to recognize the type of object from the names of its
168 properties.
169
170
171 @node Tweaking methods
172 @subsection Tweaking methods
173
174 @cindex tweaking methods
175
176 @strong{\override command}
177
178 @cindex override command
179 @cindex override syntax
180
181 @funindex \override
182 @funindex override
183
184 We have already met the commands @code{\set} and @code{\with}, used to
185 change the properties of @strong{contexts} and to remove and add
186 @strong{engravers}, in @ref{Modifying context properties}, and
187 @ref{Adding and removing engravers}.  We must now introduce some more
188 important commands.
189
190 The command to change the properties of @strong{layout objects} is
191 @code{\override}.  Because this command has to modify
192 internal properties deep within LilyPond its syntax is not
193 as simple as the commands you have used so far.  It needs to
194 know precisely which property of which object in which context
195 has to be modified, and what its new value is to be.  Let's see
196 how this is done.
197
198 The general syntax of this command is:
199
200 @example
201 \override @var{Context}.@var{LayoutObject} #'@var{layout-property} =
202 #@var{value}
203 @end example
204
205 @noindent
206 This will set the property with the name @var{layout-property} of the
207 layout object with the name @var{LayoutObject}, which is a member of
208 the @var{Context} context, to the value @var{value}.
209
210 The @var{Context} can be omitted (and usually is) when the
211 required context is unambiguously implied and is one of lowest
212 level contexts, i.e., @code{Voice}, @code{ChordNames} or
213 @code{Lyrics}, and we shall omit it in many of the following
214 examples.  We shall see later when it must be specified.
215
216 Later sections deal comprehensively with properties and their
217 values, but to illustrate the format and use of these commands
218 we shall use just a few simple properties and values which are
219 easily understood.
220
221 For now, don't worry about the @code{#'}, which must precede the
222 layout property, and the@tie{}@code{#}, which must precede the value.
223 These must always be present in exactly this form.  This is the
224 most common command used in tweaking, and most of the rest of
225 this chapter will be directed to presenting examples of how it is
226 used.  Here is a simple example to change the color of the
227 note head:
228
229 @cindex color property, example
230 @cindex NoteHead, example of overriding
231
232 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
233 c4 d
234 \override NoteHead #'color = #red
235 e4 f |
236 \override NoteHead #'color = #green
237 g4 a b c |
238 @end lilypond
239
240 @strong{\revert command}
241
242 @cindex revert command
243
244 @funindex \revert
245 @funindex revert
246
247 Once overridden, the property retains its new value until it is
248 overridden again or a @code{\revert} command is encountered.
249 The @code{\revert} command has the following syntax and causes
250 the value of the property to revert to its original default
251 value; note, not its previous value if several @code{\override}
252 commands have been issued.
253
254 @example
255 \revert @var{Context}.@var{LayoutObject} #'@var{layout-property}
256 @end example
257
258 Again, just like @var{Context} in the @code{\override} command,
259 @var{Context} is often not needed.  It will be omitted
260 in many of the following examples.  Here we revert the color
261 of the note head to the default value for the final two notes:
262
263 @cindex color property, example
264 @cindex NoteHead, example of overriding
265
266 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
267 c4 d
268 \override NoteHead #'color = #red
269 e4 f |
270 \override NoteHead #'color = #green
271 g4 a
272 \revert NoteHead #'color
273 b4 c |
274 @end lilypond
275
276 @strong{\once prefix}
277
278 @funindex \once
279 @funindex once
280
281 Both the @code{\override} and the @code{\set} commands may be prefixed
282 by @code{\once}.  This causes the following @code{\override} or
283 @code{\set} command to be effective only during the current musical
284 moment before the property reverts back to its previous value (this can
285 be different from the default if another @code{\override} is still in
286 effect).  Using the same example, we can change the color of a single
287 note like this:
288
289 @cindex color property, example
290 @cindex NoteHead, example of overriding
291
292 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
293 c4 d
294 \override NoteHead #'color = #red
295 e4 f |
296 \once \override NoteHead #'color = #green
297 g4 a
298 \revert NoteHead #'color
299 b c |
300 @end lilypond
301
302 @strong{\overrideProperty command}
303
304 @cindex overrideProperty command
305
306 @funindex \overrideProperty
307 @funindex overrideProperty
308
309 There is another form of the override command,
310 @code{\overrideProperty}, which is occasionally required.
311 We mention it here for completeness, but for details see
312 @rextend{Difficult tweaks}.
313 @c Maybe explain in a later iteration  -td
314
315 @strong{\tweak command}
316
317 @cindex tweak command
318
319 @funindex \tweak
320 @funindex tweak
321
322 The final tweaking command which is available is @code{\tweak}.  This
323 should be used when several objects occur at the same musical moment,
324 but you only want to change the properties of selected ones, such as a
325 single note within a chord.  Using @code{\override} would affect all the
326 notes within a chord, whereas @code{\tweak} affects just the following
327 item in the input stream.
328
329 Here's an example.  Suppose we wish to change the size of the
330 middle note head (the E) in a C major chord.  Let's first see what
331 @code{\once \override} would do:
332
333 @cindex font-size property, example
334 @cindex NoteHead, example of overriding
335
336 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
337 <c e g>4
338 \once \override NoteHead #'font-size = #-3
339 <c e g>4
340 <c e g>4
341 @end lilypond
342
343 We see the override affects @emph{all} the note heads in the chord.
344 This is because all the notes of a chord occur at the same
345 @emph{musical moment}, and the action of @code{\once} is to
346 apply the override to all layout objects of the type specified
347 which occur at the same musical moment as the @code{\override}
348 command itself.
349
350 The @code{\tweak} command operates in a different way.  It acts
351 on the immediately following item in the input stream.  However,
352 it is effective only on objects which are created directly from
353 the input stream, essentially note heads and articulations;
354 objects such as stems and accidentals are created later and
355 cannot be tweaked in this way.
356
357 So to return to our example, the size of the middle note of
358 a chord would be changed in this way:
359
360 @cindex font-size property, example
361 @cindex @code{\tweak}, example
362
363 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
364 <c e g>4
365 <c \tweak #'font-size #-3 e g>4
366 @end lilypond
367
368 Note that the syntax of @code{\tweak} is different from that
369 of the @code{\override} command.  Neither the context nor the
370 layout object should be specified; in fact, it would generate
371 an error to do so.  These are both implied by the following
372 item in the input stream.  Note also that an equals sign should
373 not be present.  So the general syntax of the
374 @code{\tweak} command is simply
375
376 @example
377 \tweak #'@var{layout-property} #@var{value}
378 @end example
379
380 A @code{\tweak} command can also be used to modify just one in
381 a series of articulations, as shown here:
382
383 @cindex color property, example
384 @cindex @code{\tweak}, example
385
386 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
387 a4^"Black"
388   -\tweak #'color #red ^"Red"
389   -\tweak #'color #green _"Green"
390 @end lilypond
391
392 @noindent
393 Note that the @code{\tweak} command must be preceded by an articulation
394 mark since the tweaked expression needs to be applied as an articulation
395 itself.  In case of multiple direction overrides (@code{^} or @code{_}),
396 the leftmost override wins since it is applied last.
397
398 @cindex tuplets, nested
399 @cindex triplets, nested
400 @cindex bracket, tuplet
401 @cindex bracket, triplet
402 @cindex tuplet bracket
403 @cindex triplet bracket
404
405 @funindex TupletBracket
406
407 The @code{\tweak} command must also be used to change the
408 appearance of one of a set of nested tuplets which begin at the
409 same musical moment.  In the following example, the long tuplet
410 bracket and the first of the three short brackets begin at the
411 same musical moment, so any @code{\override} command would apply
412 to both of them.  In the example, @code{\tweak} is used to
413 distinguish between them.  The first @code{\tweak} command
414 specifies that the long tuplet bracket is to be placed above the
415 notes and the second one specifies that the tuplet number is to be
416 printed in red on the first short tuplet bracket.
417
418 @cindex @code{\tweak}, example
419 @cindex direction property, example
420 @cindex color property, example
421
422 @lilypond[quote,ragged-right,verbatim,fragment,relative=2]
423 \tweak #'direction #up
424 \times 4/3 {
425   \tweak #'color #red
426   \times 2/3 { c8[ c c] }
427   \times 2/3 { c8[ c c] }
428   \times 2/3 { c8[ c c] }
429 }
430 @end lilypond
431
432 If nested tuplets do not begin at the same moment, their
433 appearance may be modified in the usual way with
434 @code{\override} commands:
435
436 @cindex text property, example
437 @cindex tuplet-number function, example
438 @cindex transparent property, example
439 @cindex TupletNumber, example of overriding
440
441 @c NOTE Tuplet brackets collide if notes are high on staff
442 @c See issue 509
443 @lilypond[quote,ragged-right,verbatim,fragment,relative=1]
444 \times 2/3 { c8[ c c] }
445 \once \override TupletNumber
446   #'text = #tuplet-number::calc-fraction-text
447 \times 2/3 {
448   c8[ c]
449   c8[ c]
450   \once \override TupletNumber #'transparent = ##t
451   \times 2/3 { c8[ c c] }
452   \times 2/3 { c8[ c c] }
453 }
454 @end lilypond
455
456
457 @seealso
458 Notation Reference:
459 @ruser{The tweak command}.
460
461
462 @node The Internals Reference manual
463 @section The Internals Reference manual
464
465 @cindex Internals Reference
466
467 @menu
468 * Properties of layout objects::
469 * Properties found in interfaces::
470 * Types of properties::
471 @end menu
472
473 @node Properties of layout objects
474 @subsection Properties of layout objects
475
476 @cindex properties of layout objects
477 @cindex properties of grobs
478 @cindex grobs, properties of
479 @cindex layout objects, properties of
480 @cindex Internals Reference manual
481
482 Suppose you have a slur in a score which, to your mind,
483 appears too thin and you'd like to draw it a little heavier.
484 How do you go about doing this?  You know from the statements
485 earlier about the flexibility of LilyPond that such a thing
486 should be possible, and you would probably guess that an
487 @code{\override} command would be needed.  But is there a
488 heaviness property for a slur, and if there is, how might it
489 be modified?  This is where the Internals Reference manual
490 comes in.  It contains all the information you might need to
491 construct this and all other @code{\override} commands.
492
493 Before we look at the Internals Reference a word of warning.
494 This is a @strong{reference} document, which means there is
495 little or no explanation contained within it: its purpose is
496 to present information precisely and concisely.  This
497 means it might look daunting at first sight.  Don't worry!
498 The guidance and explanation presented here will enable you
499 to extract the information from the Internals Reference for
500 yourself with just a little practice.
501
502 @cindex override example
503 @cindex Internals Reference, example of using
504 @cindex @code{\addlyrics} example
505
506 Let's use a concrete example with a simple fragment of real
507 music:
508
509 @c Mozart, Die Zauberflöte Nr.7 Duett
510
511 @lilypond[quote,verbatim,relative=2]
512 {
513   \key es \major
514   \time 6/8
515   {
516     r4 bes8 bes[( g]) g |
517     g8[( es]) es d[( f]) as |
518     as8 g
519   }
520   \addlyrics {
521     The man who | feels love's sweet e -- | mo -- tion
522   }
523 }
524 @end lilypond
525
526 Suppose now that we decide we would like the slurs to be a
527 little heavier.  Is this possible?  The slur is certainly a
528 layout object, so the question is, @q{Is there a property
529 belonging to a slur which controls the heaviness?}  To answer
530 this we must look in the Internals Reference, or IR for short.
531
532 The IR for the version of LilyPond you are using may be found
533 on the LilyPond website at @uref{http://lilypond.org}.  Go to the
534 documentation page and click on the Internals Reference link.
535 For learning purposes you should use the standard HTML version,
536 not the @q{one big page} or the PDF.  For the next few
537 paragraphs to make sense you will need to actually do this
538 as you read.
539
540 Under the heading @strong{Top} you will see five links.  Select
541 the link to the @emph{Backend}, which is where information about
542 layout objects is to be found.  There, under the heading
543 @strong{Backend}, select the link to @emph{All layout objects}.
544 The page that appears lists all the layout objects used in your
545 version of LilyPond, in alphabetic order.  Select the link to
546 Slur, and the properties of Slurs are listed.
547
548 An alternative way of finding this page is from the Notation
549 Reference.  On one of the pages that deals with slurs you may find a
550 link to the Internals Reference.  This link will take you directly to
551 this page, but if you have an idea about the name of the layout object
552 to be tweaked, it is easier to go straight to the IR and search there.
553
554 This Slur page in the IR tells us first that Slur objects are created
555 by the Slur_engraver.  Then it lists the standard settings.  Note
556 these are @strong{not} in alphabetic order.  Browse down them looking
557 for a property that might control the heaviness of slurs, and you
558 should find
559
560 @example
561 @code{thickness} (number)
562      @code{1.2}
563      Line thickness, generally measured in @code{line-thickness}
564 @end example
565
566 This looks a good bet to change the heaviness.  It tells us that
567 the value of @code{thickness} is a simple @emph{number},
568 that the default value is 1.2, and that the units are
569 in another property called @code{line-thickness}.
570
571 As we said earlier, there are few to no explanations in the IR,
572 but we already have enough information to try changing the
573 slur thickness.  We see that the name of the layout object
574 is @code{Slur}, that the name of the property to change is
575 @code{thickness} and that the new value should be a number
576 somewhat larger than 1.2 if we are to make slurs thicker.
577
578 We can now construct the @code{\override} command by simply
579 substituting the values we have found for the names, omitting
580 the context.  Let's use a very large value for the thickness
581 at first, so we can be sure the command is working.  We get:
582
583 @example
584 \override Slur #'thickness = #5.0
585 @end example
586
587 Don't forget the @code{#'} preceding the
588 property name and a@tie{}@code{#} preceding the new value!
589
590 The final question is, @q{Where should this command be
591 placed?}  While you are unsure and learning, the best
592 answer is, @q{Within the music, before the first slur and
593 close to it.}  Let's do that:
594
595 @cindex Slur example of overriding
596 @cindex thickness property, example
597
598 @lilypond[quote,verbatim,relative=2]
599 {
600   \key es \major
601   \time 6/8
602   {
603     % Increase thickness of all following slurs from 1.2 to 5.0
604     \override Slur #'thickness = #5.0
605     r4 bes8 bes[( g]) g |
606     g8[( es]) es d[( f]) as |
607     as8 g
608   }
609   \addlyrics {
610     The man who | feels love's sweet e -- | mo -- tion
611   }
612 }
613 @end lilypond
614
615 @noindent
616 and we see that the slur is indeed heavier.
617
618 So this is the basic way of constructing @code{\override}
619 commands.  There are a few more complications that we
620 shall meet in later sections, but you now know all the
621 essentials required to make up your own -- but you will
622 still need some practice.  This is provided in the examples
623 which follow.
624
625 @subheading Finding the context
626
627 @cindex context, finding
628 @cindex context, identifying correct
629
630 But first, what if we had needed to specify the Context?
631 What should it be?  We could guess that slurs are in
632 the Voice context, as they are clearly closely associated
633 with individual lines of music, but can we be sure?  To
634 find out, go back to the top of the IR page describing the
635 Slur, where it says @q{Slur objects are created by: Slur
636 engraver}.  So slurs will be created in whichever context
637 the @code{Slur_engraver} is in.  Follow the link to the
638 @code{Slur_engraver} page.  At the very bottom it tells
639 us that @code{Slur_engraver} is part of five Voice contexts,
640 including the standard voice context, @code{Voice}, so our
641 guess was correct.  And because @code{Voice} is one of the
642 lowest level contexts which is implied unambiguously by
643 the fact that we are entering notes, we can omit it in this
644 location.
645
646 @subheading Overriding once only
647
648 @cindex overriding once only
649 @cindex once override
650
651 @funindex \once
652 @funindex once
653
654 As you can see, @emph{all} the slurs are thicker in the final example
655 above.  But what if we wanted just the first slur to be thicker?  This
656 is achieved with the @code{\once} command.  Placed immediately before
657 the @code{\override} command it causes it to change only the slur
658 which begins on the @strong{immediately following} note.  If the
659 immediately following note does not begin a slur the command has no
660 effect at all -- it is not remembered until a slur is encountered, it
661 is simply discarded.  So the command with @code{\once} must be
662 repositioned as follows:
663
664 @cindex Slur, example of overriding
665 @cindex thickness property, example
666
667 @lilypond[quote,verbatim,relative=2]
668 {
669   \key es \major
670   \time 6/8
671   {
672     r4 bes8
673     % Increase thickness of immediately following slur only
674     \once \override Slur #'thickness = #5.0
675     bes8[( g]) g |
676     g8[( es]) es d[( f]) as |
677     as8 g
678   }
679   \addlyrics {
680     The man who | feels love's sweet e -- | mo -- tion
681   }
682 }
683 @end lilypond
684
685 @noindent
686 Now only the first slur is made heavier.
687
688 The @code{\once} command can also be used before the @code{\set}
689 command.
690
691 @subheading Reverting
692
693 @cindex revert
694 @cindex default properties, reverting to
695
696 @funindex \revert
697 @funindex revert
698
699 Finally, what if we wanted just the first two slurs to be
700 heavier?  Well, we could use two commands, each preceded by
701 @code{\once} placed immediately before each of the notes where
702 the slurs begin:
703
704 @cindex Slur, example of overriding
705 @cindex thickness property, example
706
707 @lilypond[quote,verbatim,relative=2]
708 {
709   \key es \major
710   \time 6/8
711   {
712     r4 bes8
713     % Increase thickness of immediately following slur only
714     \once \override Slur #'thickness = #5.0
715     bes[( g]) g |
716     % Increase thickness of immediately following slur only
717     \once \override Slur #'thickness = #5.0
718     g8[( es]) es d[( f]) as |
719     as8 g
720   }
721   \addlyrics {
722     The man who | feels love's sweet e -- | mo -- tion
723   }
724 }
725 @end lilypond
726
727 @noindent
728 or we could omit the @code{\once} command and use the @code{\revert}
729 command to return the @code{thickness} property to its default value
730 after the second slur:
731
732 @cindex Slur, example of overriding
733 @cindex thickness property, example
734
735 @lilypond[quote,verbatim,relative=2]
736 {
737   \key es \major
738   \time 6/8
739   {
740     r4 bes8
741     % Increase thickness of all following slurs from 1.2 to 5.0
742     \override Slur #'thickness = #5.0
743     bes[( g]) g |
744     g8[( es]) es
745     % Revert thickness of all following slurs to default of 1.2
746     \revert Slur #'thickness
747     d8[( f]) as |
748     as8 g
749   }
750   \addlyrics {
751     The man who | feels love's sweet e -- | mo -- tion
752   }
753 }
754 @end lilypond
755
756 @noindent
757 The @code{\revert} command can be used to return any property
758 changed with @code{\override} back to its default value.
759 You may use whichever method best suits what you want to do.
760
761 That concludes our introduction to the IR, and the basic
762 method of tweaking.  Several examples follow in the later
763 sections of this Chapter, partly to introduce you to some of the
764 additional features of the IR, and partly to give you more
765 practice in extracting information from it.  These examples will
766 contain progressively fewer words of guidance and explanation.
767
768
769 @node Properties found in interfaces
770 @subsection Properties found in interfaces
771
772 @cindex interface
773 @cindex interface properties
774 @cindex properties in interfaces
775
776 Suppose now that we wish to print the lyrics in italics.  What form of
777 @code{\override} command do we need to do this?  We first look in the
778 IR page listing @q{All layout objects}, as before, and look for an
779 object that might control lyrics.  We find @code{LyricText}, which
780 looks right.  Clicking on this shows the settable properties for lyric
781 text.  These include the @code{font-series} and @code{font-size}, but
782 nothing that might give an italic shape.  This is because the shape
783 property is one that is common to all font objects, so, rather than
784 including it in every layout object, it is grouped together with other
785 similar common properties and placed in an @strong{Interface}, the
786 @code{font-interface}.
787
788 So now we need to learn how to find the properties of interfaces,
789 and to discover what objects use these interface properties.
790
791 Look again at the IR page which describes LyricText.  At the bottom of
792 the page is a list of clickable interfaces which LyricText supports.
793 The list has several items, including @code{font-interface}.  Clicking
794 on this brings up the properties associated with this interface, which
795 are also properties of all the objects which support it, including
796 LyricText.
797
798 Now we see all the user-settable properties which control fonts,
799 including @code{font-shape(symbol)}, where @code{symbol} can be
800 set to @code{upright}, @code{italics} or @code{caps}.
801
802 You will notice that @code{font-series} and @code{font-size} are also
803 listed there.  This immediately raises the question: Why are the
804 common font properties @code{font-series} and @code{font-size} listed
805 under @code{LyricText} as well as under the interface
806 @code{font-interface} but @code{font-shape} is not?  The answer is
807 that @code{font-series} and @code{font-size} are changed from their
808 global default values when a @code{LyricText} object is created, but
809 @code{font-shape} is not.  The entries in @code{LyricText} then tell
810 you the values for those two properties which apply to
811 @code{LyricText}.  Other objects which support @code{font-interface}
812 will set these properties differently when they are created.
813
814 Let's see if we can now construct the @code{\override} command
815 to change the lyrics to italics.  The object is @code{LyricText},
816 the property is @code{font-shape} and the value is
817 @code{italic}.  As before, we'll omit the context.
818
819 As an aside, although it is an important one, note that because the
820 values of @code{font-shape} are symbols they must be introduced with a
821 single apostrophe, @code{'}.  That is why apostrophes are needed
822 before @code{thickness} in the earlier example and @code{font-shape}.
823 These are both symbols too.  Symbols are then read internally by
824 LilyPond.  Some of them are the names of properties, like
825 @code{thickness} or @code{font-shape}, others are used as values that
826 can be given to properties, like @code{italic}.  Note the distinction
827 from arbitrary text strings, which would appear as @code{"a text
828 string"}; for more details about symbols and strings, see
829 @rextend{Scheme tutorial}.
830
831 So we see that the @code{\override} command needed to print the lyrics
832 in italics is:
833
834 @example
835 \override LyricText #'font-shape = #'italic
836 @end example
837
838 @noindent
839 This should be placed just in front of the lyrics we wish to affect,
840 like so:
841
842 @cindex font-shape property, example
843 @cindex italic, example
844 @cindex LyricText, example of overriding
845 @cindex @code{\addlyrics}, example
846
847 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
848 {
849   \key es \major
850   \time 6/8
851   {
852     r4 bes8 bes[( g]) g |
853     g8[( es]) es d[( f]) as |
854     as8 g
855   }
856   \addlyrics {
857     \override LyricText #'font-shape = #'italic
858     The man who | feels love's sweet e -- | mo -- tion
859   }
860 }
861 @end lilypond
862
863 @noindent
864 and the lyrics are all printed in italics.
865
866 @subheading Specifying the context in lyric mode
867
868 @cindex context, specifying in lyric mode
869 @cindex lyric mode, specifying context
870
871 In the case of lyrics, if you try specifying the context in the
872 format given earlier the command will fail.  A syllable
873 entered in lyricmode is terminated by either a space,
874 a newline or a digit.  All other characters are included
875 as part of the syllable.  For this reason a space or newline
876 must appear before the terminating @code{@}} to prevent it being
877 included as part of the final syllable.  Similarly,
878 spaces must be inserted before and after the
879 period or dot, @q{.}, separating the context name from the
880 object name, as otherwise the two names are run together and
881 the interpreter cannot recognize them.  So the command should be:
882
883 @example
884 \override Lyrics . LyricText #'font-shape = #'italic
885 @end example
886
887 @warning{In lyrics always leave whitespace between the final
888 syllable and the terminating brace.}
889
890 @warning{In overrides in lyrics always place spaces around
891 the dot between the context name and the object name.}
892
893
894 @seealso
895 Extending: @rextend{Scheme tutorial}.
896
897
898 @node Types of properties
899 @subsection Types of properties
900
901 @cindex property types
902
903 So far we have seen two types of property: @code{number} and
904 @code{symbol}.  To be valid, the value given to a property
905 must be of the correct type and obey the rules for that type.
906 The type of property is always shown in brackets after the
907 property name in the IR.  Here is a list of the types you may
908 need, together with the rules for that type, and some examples.
909 You must always add a hash symbol, @code{#}, of course,
910 to the front of these values when they are entered in the
911 @code{\override} command.
912
913 @multitable @columnfractions .2 .45 .35
914 @headitem Property type
915   @tab Rules
916   @tab Examples
917 @item Boolean
918   @tab Either True or False, represented by #t or #f
919   @tab @code{#t}, @code{#f}
920 @item Dimension (in staff space)
921   @tab A positive decimal number (in units of staff space)
922   @tab @code{2.5}, @code{0.34}
923 @item Direction
924   @tab A valid direction constant or its numerical equivalent (decimal
925 values between -1 and 1 are allowed)
926   @tab @code{LEFT}, @code{CENTER}, @code{UP},
927        @code{1}, @w{@code{-1}}
928 @item Integer
929   @tab A positive whole number
930   @tab @code{3}, @code{1}
931 @item List
932   @tab A set of values separated by spaces, enclosed in parentheses
933 and preceded by an apostrophe
934   @tab @code{'(left-edge staff-bar)}, @code{'(1)},
935        @code{'(1.0 0.25 0.5)}
936 @item Markup
937   @tab Any valid markup
938   @tab @code{\markup @{ \italic "cresc." @}}
939 @item Moment
940   @tab A fraction of a whole note constructed with the
941 make-moment function
942   @tab @code{(ly:make-moment 1 4)},
943        @code{(ly:make-moment 3 8)}
944 @item Number
945   @tab Any positive or negative decimal value
946   @tab @code{3.5}, @w{@code{-2.45}}
947 @item Pair (of numbers)
948   @tab Two numbers separated by a @q{space . space} and enclosed
949 in brackets preceded by an apostrophe
950   @tab @code{'(2 . 3.5)}, @code{'(0.1 . -3.2)}
951 @item Symbol
952   @tab Any of the set of permitted symbols for that property,
953 preceded by an apostrophe
954   @tab @code{'italic}, @code{'inside}
955 @item Unknown
956   @tab A procedure, or @code{#f} to cause no action
957   @tab @code{bend::print}, @code{ly:text-interface::print},
958        @code{#f}
959 @item Vector
960   @tab A list of three items enclosed in parentheses and preceded
961 by apostrophe-hash, @code{'#}.
962   @tab @code{'#(#t #t #f)}
963 @end multitable
964
965
966 @seealso
967 Extending: @rextend{Scheme tutorial}.
968
969
970 @node Appearance of objects
971 @section Appearance of objects
972
973 Let us now put what we have learned into practice with a few
974 examples which show how tweaks may be used to change the
975 appearance of the printed music.
976
977 @menu
978 * Visibility and color of objects::
979 * Size of objects::
980 * Length and thickness of objects::
981 @end menu
982
983 @node Visibility and color of objects
984 @subsection Visibility and color of objects
985
986 In the educational use of music we might wish to print a score
987 with certain elements omitted as an exercise for the student,
988 who is required to supply them.  As a simple example,
989 let us suppose the exercise is to supply the missing bar lines
990 in a piece of music.  But the bar lines are normally inserted
991 automatically.  How do we prevent them printing?
992
993 Before we tackle this, let us remember that object properties are
994 grouped in what are called @emph{interfaces} -- see @ref{Properties
995 found in interfaces}.  This is simply to group together those
996 properties that may be used together to tweak a graphical object -- if
997 one of them is allowed for an object, so are the others.  Some objects
998 then use the properties in some interfaces, others use them from other
999 interfaces.  The interfaces which contain the properties used by a
1000 particular grob are listed in the IR at the bottom of the page
1001 describing that grob, and those properties may be viewed by looking at
1002 those interfaces.
1003
1004 We explained how to find information about grobs in @ref{Properties of
1005 layout objects}.  Using the same approach, we go to the IR to find the
1006 layout object which prints bar lines.  Going via @emph{Backend} and
1007 @emph{All layout objects} we find there is a layout object called
1008 @code{BarLine}.  Its properties include two that control its
1009 visibility: @code{break-visibility} and @code{stencil}.  Barline also
1010 supports a number of interfaces, including the @code{grob-interface},
1011 where we find the @code{transparent} and the @code{color} properties.
1012 All of these can affect the visibility of bar lines (and, of course,
1013 by extension, many other layout objects too.)  Let's consider each of
1014 these in turn.
1015
1016 @subheading stencil
1017
1018 @cindex stencil property
1019
1020 This property controls the appearance of the bar lines by specifying
1021 the symbol (glyph) which should be printed.  In common
1022 with many other properties, it can be set to print nothing by
1023 setting its value to @code{#f}.  Let's try it, as before, omitting
1024 the implied Context, @code{Voice}:
1025
1026 @cindex BarLine, example of overriding
1027 @cindex stencil property, example
1028
1029 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1030 {
1031   \time 12/16
1032   \override BarLine #'stencil = ##f
1033   c4 b8 c d16 c d8 |
1034   g,8 a16 b8 c d4 e16 |
1035   e8
1036 }
1037 @end lilypond
1038
1039 The bar lines are still printed.  What is wrong?  Go back to the IR
1040 and look again at the page giving the properties of BarLine.  At the
1041 top of the page it says @qq{Barline objects are created by:
1042 Bar_engraver}.  Go to the @code{Bar_engraver} page.  At the bottom it
1043 gives a list of Contexts in which the bar engraver operates.  All of
1044 them are of the type @code{Staff}, so the reason the @code{\override}
1045 command failed to work as expected is because @code{Barline} is not in
1046 the default @code{Voice} context.  If the context is specified
1047 incorrectly, the command simply does not work.  No error message is
1048 produced, and nothing is logged in the log file.  Let's try correcting
1049 it by adding the correct context:
1050
1051 @cindex BarLine, example of overriding
1052 @cindex stencil property, example
1053
1054 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1055 {
1056   \time 12/16
1057   \override Staff.BarLine #'stencil = ##f
1058   c4 b8 c d16 c d8 |
1059   g,8 a16 b8 c d4 e16 |
1060   e8
1061 }
1062 @end lilypond
1063
1064 Now the bar lines have vanished.
1065
1066 Note, though, that setting the @code{stencil} property to @code{#f}
1067 will cause errors when the dimensions of the object are required for
1068 correct processing.  For example, errors will be generated if the
1069 @code{stencil} property of the @code{NoteHead} object is set to
1070 @code{#f}.  If this is the case, you can instead use the
1071 @code{point-stencil} function, which sets the stencil to a object
1072 with zero size:
1073
1074 @lilypond[quote,verbatim,relative=2]
1075 {
1076   c4 c
1077   \once \override NoteHead #'stencil = #point-stencil
1078   c4 c
1079 }
1080 @end lilypond
1081
1082 @subheading break-visibility
1083
1084 @cindex break-visibility property
1085
1086 We see from the @code{BarLine} properties in the IR that the
1087 @code{break-visibility} property requires a vector of three booleans.
1088 These control respectively whether bar lines are printed at the end of
1089 a line, in the middle of lines, and at the beginning of lines.  For
1090 our example we want all bar lines to be suppressed, so the value we
1091 need is @code{'#(#f #f #f)}.  Let's try that, remembering to include
1092 the @code{Staff} context.  Note also that in writing this value we
1093 have @code{#'#} before the opening bracket.  The @code{'#} is required
1094 as part of the value to introduce a vector, and the first@tie{}@code{#} is
1095 required, as always, to precede the value itself in the
1096 @code{\override} command.
1097
1098 @cindex BarLine, example of overriding
1099 @cindex break-visibility property, example
1100
1101 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1102 {
1103   \time 12/16
1104   \override Staff.BarLine #'break-visibility = #'#(#f #f #f)
1105   c4 b8 c d16 c d8 |
1106   g,8 a16 b8 c d4 e16 |
1107   e8
1108 }
1109 @end lilypond
1110
1111 And we see this too removes all the bar lines.
1112
1113 @subheading transparent
1114
1115 @cindex transparent property
1116 @cindex transparency
1117
1118 We see from the properties specified in the @code{grob-interface} page
1119 in the IR that the @code{transparent} property is a boolean.  This
1120 should be set to @code{#t} to make the grob transparent.  In this next
1121 example let us make the time signature invisible rather than the bar
1122 lines.  To do this we need to find the grob name for the time
1123 signature.  Back to the @q{All layout objects} page in the IR to find
1124 the properties of the @code{TimeSignature} layout object.  This is
1125 produced by the @code{Time_signature_engraver} which you can check
1126 also lives in the @code{Staff} context and also supports the
1127 @code{grob-interface}.  So the command to make the time signature
1128 transparent is:
1129
1130 @cindex TimeSignature, example of overriding
1131 @cindex transparent property, example
1132
1133 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1134 {
1135   \time 12/16
1136   \override Staff.TimeSignature #'transparent = ##t
1137   c4 b8 c d16 c d8 |
1138   g,8 a16 b8 c d4 e16 |
1139   e8
1140 }
1141 @end lilypond
1142
1143 @noindent
1144 The time signature is gone, but this command leaves a gap where
1145 the time signature should be.  Maybe this is what is wanted for
1146 an exercise for the student to fill it in, but in other
1147 circumstances a gap might be undesirable.  To remove it, the
1148 stencil for the time signature should be set to @code{#f}
1149 instead:
1150
1151 @cindex TimeSignature, example of overriding
1152 @cindex stencil property, example
1153
1154 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1155 {
1156   \time 12/16
1157   \override Staff.TimeSignature #'stencil = ##f
1158   c4 b8 c d16 c d8 |
1159   g,8 a16 b8 c d4 e16 |
1160   e8
1161 }
1162 @end lilypond
1163
1164 @noindent
1165 and the difference is obvious: setting the stencil to @code{#f}
1166 removes the object entirely; making the object @code{transparent}
1167 leaves it where it is, but makes it invisible.
1168
1169 @subheading color
1170
1171 @cindex color property
1172
1173 Finally let us try making the bar lines invisible by coloring
1174 them white.  (There is a difficulty with this in that the
1175 white bar line may or may not blank out the staff lines where
1176 they cross.  You may see in some of the examples below that this
1177 happens unpredictably.  The details of why this is so and how to
1178 control it are covered in @ruser{Painting objects white}.  But at
1179 the moment we are learning about color, so please just accept this
1180 limitation for now.)
1181
1182 The @code{grob-interface} specifies that the
1183 color property value is a list, but there is no
1184 explanation of what that list should be.  The list it
1185 requires is actually a list of values in internal units,
1186 but, to avoid having to know what these are, several ways
1187 are provided to specify colors.  The first way is to use one
1188 of the @q{normal} colors listed in the first table in
1189 @ruser{List of colors}.  To set the bar lines to white
1190 we write:
1191
1192 @cindex BarLine, example of overriding
1193 @cindex color property, example
1194
1195 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1196 {
1197   \time 12/16
1198   \override Staff.BarLine #'color = #white
1199   c4 b8 c d16 c d8 |
1200   g,8 a16 b8 c d4 e16 |
1201   e8
1202 }
1203 @end lilypond
1204
1205 @noindent
1206 and again, we see the bar lines are not visible.  Note that
1207 @emph{white} is not preceded by an apostrophe -- it is not
1208 a symbol, but a @emph{function}.  When called, it provides
1209 the list of internal values required to set the color to
1210 white.  The other colors in the normal list are functions
1211 too.  To convince yourself this is working you might like
1212 to change the color to one of the other functions in the
1213 list.
1214
1215 @cindex color, X11
1216 @cindex X11 colors
1217
1218 @funindex x11-color
1219
1220 The second way of changing the color is to use the list of
1221 X11 color names in the second list in @ruser{List of colors}.
1222 However, these must be preceded by another function, which
1223 converts X11 color names into the list of internal values,
1224 @code{x11-color}, like this:
1225
1226 @cindex BarLine, example of overriding
1227 @cindex color property, example
1228
1229 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1230 {
1231   \time 12/16
1232   \override Staff.BarLine #'color = #(x11-color 'white)
1233   c4 b8 c d16 c d8 |
1234   g,8 a16 b8 c d4 e16 |
1235   e8
1236 }
1237 @end lilypond
1238
1239 @noindent
1240 Note that in this case the function @code{x11-color} takes
1241 a symbol as an argument, so the symbol must be preceded by
1242 an apostrophe and the two enclosed in brackets.
1243
1244 @cindex rgb colors
1245 @cindex color, rgb
1246
1247 @funindex rgb-color
1248
1249 There is yet a third function, one which converts RGB values into
1250 internal colors -- the @code{rgb-color} function.  This takes
1251 three arguments giving the intensities of the red, green and
1252 blue colors.  These take values in the range 0 to 1.  So to
1253 set the color to red the value should be @code{(rgb-color 1 0 0)}
1254 and to white it should be @code{(rgb-color 1 1 1)}:
1255
1256 @cindex BarLine, example of overriding
1257 @cindex color property, example
1258
1259 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1260 {
1261   \time 12/16
1262   \override Staff.BarLine #'color = #(rgb-color 1 1 1)
1263   c4 b8 c d16 c d8 |
1264   g,8 a16 b8 c d4 e16 |
1265   e8
1266 }
1267 @end lilypond
1268
1269 Finally, there is also a grey scale available as part of the
1270 X11 set of colors.  These range from black, @code{'grey0'},
1271 to white, @code{'grey100}, in steps of 1.  Let's illustrate
1272 this by setting all the layout objects in our example to
1273 various shades of grey:
1274
1275 @cindex StaffSymbol, example of overriding
1276 @cindex TimeSignature, example of overriding
1277 @cindex Clef, example of overriding
1278 @cindex NoteHead, example of overriding
1279 @cindex Stem, example of overriding
1280 @cindex BarLine, example of overriding
1281 @cindex color property, example
1282 @cindex x11-color, example of using
1283
1284 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1285 {
1286   \time 12/16
1287   \override Staff.StaffSymbol   #'color = #(x11-color 'grey30)
1288   \override Staff.TimeSignature #'color = #(x11-color 'grey60)
1289   \override Staff.Clef          #'color = #(x11-color 'grey60)
1290   \override Voice.NoteHead      #'color = #(x11-color 'grey85)
1291   \override Voice.Stem          #'color = #(x11-color 'grey85)
1292   \override Staff.BarLine       #'color = #(x11-color 'grey10)
1293   c4 b8 c d16 c d8 |
1294   g,8 a16 b8 c d4 e16 |
1295   e8
1296 }
1297 @end lilypond
1298
1299 @noindent
1300 Note the contexts associated with each of the layout objects.
1301 It is important to get these right, or the commands will not
1302 work!  Remember, the context is the one in which the appropriate
1303 engraver is placed.  The default context for engravers can be
1304 found by starting from the layout object, going from there to
1305 the engraver which produces it, and on the engraver page in the
1306 IR it tells you in which context the engraver will normally be
1307 found.
1308
1309
1310 @node Size of objects
1311 @subsection Size of objects
1312
1313 @cindex changing size of objects
1314 @cindex size of objects
1315 @cindex objects, size of
1316 @cindex objects, changing size of
1317
1318 Let us begin by looking again at the earlier example
1319 see @ref{Nesting music expressions}) which showed
1320 how to introduce a new temporary staff, as in an @rglos{ossia}.
1321
1322 @cindex alignAboveContext property, example
1323 @cindex @code{\with}, example
1324
1325 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1326 \new Staff ="main" {
1327   \relative g' {
1328     r4 g8 g c4 c8 d |
1329     e4 r8
1330     <<
1331       { f8 c c }
1332       \new Staff \with {
1333         alignAboveContext = #"main" }
1334       { f8 f c }
1335     >>
1336     r4 |
1337   }
1338 }
1339 @end lilypond
1340
1341 Ossia are normally written without clef and time signature, and
1342 are usually printed slightly smaller than the main staff.  We
1343 already know now how to remove the clef and time signature --
1344 we simply set the stencil of each to @code{#f}, as follows:
1345
1346 @cindex alignAboveContext property, example
1347 @cindex @code{\with}, example
1348 @cindex stencil property, example
1349 @cindex Clef, example of overriding
1350 @cindex TimeSignature, example of overriding
1351
1352 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1353 \new Staff ="main" {
1354   \relative g' {
1355     r4 g8 g c4 c8 d |
1356     e4 r8
1357     <<
1358       { f8 c c }
1359       \new Staff \with {
1360         alignAboveContext = #"main"
1361       }
1362       {
1363         \override Staff.Clef #'stencil = ##f
1364         \override Staff.TimeSignature #'stencil = ##f
1365         { f8 f c }
1366       }
1367     >>
1368     r4 |
1369   }
1370 }
1371 @end lilypond
1372
1373 @noindent
1374 where the extra pair of braces after the @code{\with} clause are
1375 required to ensure the enclosed overrides and music are applied
1376 to the ossia staff.
1377
1378 But what is the difference between modifying the staff context by
1379 using @code{\with} and modifying the stencils of the clef and the
1380 time signature with \override?  The main difference is that
1381 changes made in a @code{\with} clause are made at the time the
1382 context is created, and remain in force as the @strong{default}
1383 values for the duration of that context, whereas
1384 @code{\set} or @code{\override} commands embedded in the
1385 music are dynamic -- they make changes synchronized with
1386 a particular point in the music.  If changes are unset or
1387 reverted using @code{\unset} or @code{\revert} they return to
1388 their default values, which will be the ones set in the
1389 @code{\with} clause, or if none have been set there, the normal
1390 default values.
1391
1392 Some context properties can be modified only in @code{\with} clauses.
1393 These are those properties which cannot sensibly be changed after the
1394 context has been created.  @code{alignAboveContext} and its partner,
1395 @code{alignBelowContext}, are two such properties -- once the staff
1396 has been created its alignment is decided and it would make no sense
1397 to try to change it later.
1398
1399 The default values of layout object properties can also be set
1400 in @code{\with} clauses.  Simply use the normal @code{\override}
1401 command leaving out the context name, since this is unambiguously
1402 defined as the context which the @code{\with} clause is modifying.
1403 If fact, an error will be generated if a context is specified
1404 in this location.
1405
1406 So we could replace the example above with
1407
1408 @cindex alignAboveContext property, example
1409 @cindex @code{\with}, example
1410 @cindex Clef, example of overriding
1411 @cindex TimeSignature, example of overriding
1412
1413 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1414 \new Staff ="main" {
1415   \relative g' {
1416     r4 g8 g c4 c8 d |
1417     e4 r8
1418     <<
1419       { f8 c c }
1420       \new Staff \with {
1421         alignAboveContext = #"main"
1422         % Don't print clefs in this staff
1423         \override Clef #'stencil = ##f
1424         % Don't print time signatures in this staff
1425         \override TimeSignature #'stencil = ##f
1426       }
1427       { f8 f c }
1428     >>
1429     r4 |
1430   }
1431 }
1432 @end lilypond
1433
1434 Finally we come to changing the size of layout objects.
1435
1436 Some layout objects are created as glyphs selected from a typeface
1437 font.  These include note heads, accidentals, markup, clefs, time
1438 signatures, dynamics and lyrics.  Their size is changed by modifying
1439 the @code{font-size} property, as we shall shortly see.  Other layout
1440 objects such as slurs and ties -- in general, spanner objects -- are
1441 drawn individually, so there is no @code{font-size} associated with
1442 them.  These objects generally derive their size from the objects to
1443 which they are attached, so usually there is no need to change their
1444 size manually.  Still other properties such as the length of stems and
1445 bar lines, thickness of beams and other lines, and the separation of
1446 staff lines all need to be modified in special ways.
1447
1448 Returning to the ossia example, let us first change the font-size.
1449 We can do this in two ways.  We can either change the size of the
1450 fonts of each object type, like @code{NoteHead}s with commands
1451 like
1452
1453 @example
1454 \override NoteHead #'font-size = #-2
1455 @end example
1456
1457 or we can change the size of all fonts by setting a special
1458 property, @code{fontSize}, using @code{\set}, or by including
1459 it in a @code{\with} clause (but without the @code{\set}).
1460
1461 @example
1462 \set fontSize = #-2
1463 @end example
1464
1465 Both of these statements would cause the font size to be reduced
1466 by 2 steps from its previous value, where each
1467 step reduces or increases the size by approximately 12%.
1468
1469 Let's try it in our ossia example:
1470
1471 @cindex alignAboveContext property, example
1472 @cindex @code{\with}, example
1473 @cindex Clef, example of overriding
1474 @cindex TimeSignature, example of overriding
1475 @cindex fontSize property, example
1476
1477 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1478 \new Staff ="main" {
1479   \relative g' {
1480     r4 g8 g c4 c8 d |
1481     e4 r8
1482     <<
1483       { f8 c c }
1484       \new Staff \with {
1485         alignAboveContext = #"main"
1486         \override Clef #'stencil = ##f
1487         \override TimeSignature #'stencil = ##f
1488         % Reduce all font sizes by ~24%
1489         fontSize = #-2
1490       }
1491       { f8 f c }
1492     >>
1493     r4 |
1494   }
1495 }
1496 @end lilypond
1497
1498 This is still not quite right.  The note heads and flags are
1499 smaller, but the stems are too long in proportion and the
1500 staff lines are spaced too widely apart.  These need to be
1501 scaled down in proportion to the font reduction.  The next
1502 sub-section discusses how this is done.
1503
1504 @node Length and thickness of objects
1505 @subsection Length and thickness of objects
1506
1507 @cindex distances
1508 @cindex thickness
1509 @cindex length
1510 @cindex magstep
1511 @cindex size, changing
1512 @cindex stem length, changing
1513 @cindex staff line spacing, changing
1514
1515 Distances and lengths in LilyPond are generally measured in
1516 staff-spaces, the distance between adjacent lines in the staff,
1517 (or occasionally half staff spaces) while most @code{thickness}
1518 properties are measured in units of an internal property called
1519 @code{line-thickness.}  For example, by default, the lines of
1520 hairpins are given a thickness of 1 unit of @code{line-thickness},
1521 while the @code{thickness} of a note stem is 1.3.  Note, though,
1522 that some thickness properties are different; for example, the
1523 thickness of beams is controlled by the value of the
1524 @code{beam-thickness} property, which is measured in staff-spaces.
1525
1526 So how are lengths to be scaled in proportion to the font size?
1527 This can be done with the help of a special function called
1528 @code{magstep} provided for exactly this purpose.  It takes
1529 one argument, the change in font size (#-2 in the example above)
1530 and returns a scaling factor suitable for reducing other
1531 objects in proportion.  It is used like this:
1532
1533 @cindex alignAboveContext property, example
1534 @cindex @code{\with}, example
1535 @cindex Clef, example of overriding
1536 @cindex TimeSignature, example of overriding
1537 @cindex fontSize property, example
1538 @cindex StaffSymbol, example of overriding
1539 @cindex magstep function, example of using
1540 @cindex staff-space property, example
1541 @cindex stencil property, example
1542
1543 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1544 \new Staff ="main" {
1545   \relative g' {
1546     r4 g8 g c4 c8 d |
1547     e4 r8
1548     <<
1549       { f8 c c }
1550       \new Staff \with {
1551         alignAboveContext = #"main"
1552         \override Clef #'stencil = ##f
1553         \override TimeSignature #'stencil = ##f
1554         fontSize = #-2
1555         % Reduce stem length and line spacing to match
1556         \override StaffSymbol #'staff-space = #(magstep -2)
1557       }
1558       { f8 f c }
1559     >>
1560     r4 |
1561   }
1562 }
1563 @end lilypond
1564
1565 @noindent
1566 Since the length of stems and many other length-related properties are
1567 always calculated relative to the value of the @code{staff-space}
1568 property these are automatically scaled down in length too.  Note that
1569 this affects only the vertical scale of the ossia -- the horizontal
1570 scale is determined by the layout of the main music in order to remain
1571 synchronized with it, so it is not affected by any of these changes in
1572 size.  Of course, if the scale of all the main music were changed in
1573 this way then the horizontal spacing would be affected.  This is
1574 discussed later in the layout section.
1575
1576 This, then, completes the creation of an ossia.  The sizes and
1577 lengths of all other objects may be modified in analogous ways.
1578
1579 For small changes in scale, as in the example above, the
1580 thickness of the various drawn lines such as bar lines,
1581 beams, hairpins, slurs, etc does not usually require global
1582 adjustment.  If the thickness of any particular layout object
1583 needs to be adjusted this can be best achieved by overriding its
1584 @code{thickness} property.  An example of changing the thickness
1585 of slurs was shown above in @ref{Properties of layout objects}.
1586 The thickness of all drawn objects (i.e., those not produced
1587 from a font) may be changed in the same way.
1588
1589
1590 @node Placement of objects
1591 @section Placement of objects
1592
1593 @menu
1594 * Automatic behavior::
1595 * Within-staff objects::
1596 * Outside-staff objects::
1597 @end menu
1598
1599
1600 @node Automatic behavior
1601 @subsection Automatic behavior
1602
1603 @cindex within-staff objects
1604 @cindex outside-staff objects
1605 @cindex objects, within-staff
1606 @cindex objects, outside-staff
1607
1608 There are some objects in musical notation that belong to
1609 the staff and there are other objects that should be
1610 placed outside the staff.  These are called within-staff
1611 objects and outside-staff objects respectively.
1612
1613 Within-staff objects are those that are located on the staff
1614 -- note heads, stems, accidentals, etc.  The positions of
1615 these are usually fixed by the music itself -- they are
1616 vertically positioned on specific lines of the staff or are
1617 tied to other objects that are so positioned.  Collisions of
1618 note heads, stems and accidentals in closely set chords are
1619 normally avoided automatically.  There are commands and
1620 overrides which can modify this automatic behavior, as we
1621 shall shortly see.
1622
1623 Objects belonging outside the staff include things such as
1624 rehearsal marks, text and dynamic markings.  LilyPond's rule for
1625 the vertical placement of outside-staff objects is to place them
1626 as close to the staff as possible but not so close that they
1627 collide with any other object.  LilyPond uses the
1628 @code{outside-staff-priority} property to determine the order in
1629 which the objects should be placed, as follows.
1630
1631 First, LilyPond places all the within-staff objects.
1632 Then it sorts the outside-staff objects according to their
1633 @code{outside-staff-priority}.  The outside-staff objects are
1634 taken one by one, beginning with the object with the lowest
1635 @code{outside-staff-priority}, and placed so that they do not
1636 collide with any objects that have already been placed.  That is,
1637 if two outside-staff grobs are competing for the same space, the
1638 one with the lower @code{outside-staff-priority} will be placed
1639 closer to the staff.  If two objects have the same
1640 @code{outside-staff-priority} the one encountered first will be
1641 placed closer to the staff.
1642
1643 In the following example all the markup texts have the same
1644 priority (since it is not explicitly set).  Note that @q{Text3}
1645 is automatically positioned close to the staff again, nestling
1646 under @q{Text2}.
1647
1648 @cindex markup example
1649
1650 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1651 c2^"Text1"
1652 c2^"Text2" |
1653 c2^"Text3"
1654 c2^"Text4" |
1655 @end lilypond
1656
1657 Staves are also positioned, by default, as closely together as
1658 possible (subject to a minimum separation).  If notes project
1659 a long way towards an adjacent staff they will force the
1660 staves further apart only if an overlap of the notation
1661 would otherwise occur.  The following example demonstrates
1662 this @q{nestling} of the notes on adjacent staves:
1663
1664 @lilypond[quote,ragged-right,verbatim]
1665 <<
1666   \new Staff {
1667     \relative c' { c4 a, }
1668   }
1669   \new Staff {
1670     \relative c'''' { c4 a, }
1671   }
1672 >>
1673 @end lilypond
1674
1675
1676 @node Within-staff objects
1677 @subsection Within-staff objects
1678
1679 We have already seen how the commands @code{\voiceXXX} affect
1680 the direction of slurs, ties, fingering and
1681 everything else which depends on the direction of the stems.
1682 These commands are essential when writing polyphonic music to
1683 permit interweaving melodic lines to be distinguished.
1684 But occasionally it may be necessary to override this automatic
1685 behavior.  This can be done for whole sections of music or even
1686 for an individual note.  The property which controls this
1687 behavior is the @code{direction} property of each layout object.
1688 We first explain what this does, and then introduce a number of
1689 ready-made commands which avoid your having to code explicit
1690 overrides for the more common modifications.
1691
1692 Some layout objects like slurs and ties curve, bend or point
1693 either up or down; others like stems and flags also move to
1694 right or left when they point up or down.  This is controlled
1695 automatically when @code{direction} is set.
1696
1697 @cindex down
1698 @cindex up
1699 @cindex center
1700 @cindex neutral
1701
1702 The following example shows in bar 1 the default behavior of stems,
1703 with those on high notes pointing down and those on low notes pointing
1704 up, followed by four notes with all stems forced down, four notes with
1705 all stems forced up, and finally four notes reverted back to the
1706 default behavior.
1707
1708 @cindex Stem, example of overriding
1709 @cindex direction property, example
1710
1711 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
1712 a4 g c a |
1713 \override Stem #'direction = #DOWN
1714 a4 g c a |
1715 \override Stem #'direction = #UP
1716 a4 g c a |
1717 \revert Stem #'direction
1718 a4 g c a |
1719 @end lilypond
1720
1721 Here we use the constants @code{DOWN} and @code{UP}.
1722 These have the values @w{@code{-1}} and @code{+1} respectively, and
1723 these numerical values may be used instead.  The value @code{0}
1724 may also be used in some cases.  It is simply treated as meaning
1725 @code{UP} for stems, but for some objects it means @q{center}.
1726 There is a constant, @code{CENTER} which has the value @code{0}.
1727
1728 However, these explicit overrides are not usually used, as there are
1729 simpler equivalent predefined commands available.  Here is a table of
1730 the commonest.  The meaning of each is stated where it is not obvious.
1731
1732 @multitable @columnfractions .2 .2 .25 .35
1733 @headitem Down/Left
1734   @tab Up/Right
1735   @tab Revert
1736   @tab Effect
1737 @item @code{\arpeggioArrowDown}
1738   @tab @code{\arpeggioArrowUp}
1739   @tab @code{\arpeggioNormal}
1740   @tab Arrow is at bottom, at top, or no arrow
1741 @item @code{\dotsDown}
1742   @tab @code{\dotsUp}
1743   @tab @code{\dotsNeutral}
1744   @tab Direction of movement to avoid staff lines
1745 @item @code{\dynamicDown}
1746   @tab @code{\dynamicUp}
1747   @tab @code{\dynamicNeutral}
1748   @tab
1749 @item @code{\phrasingSlurDown}
1750   @tab @code{\phrasingSlurUp}
1751   @tab @code{\phrasingSlurNeutral}
1752   @tab Note: distinct from slur commands
1753 @item @code{\slurDown}
1754   @tab @code{\slurUp}
1755   @tab @code{\slurNeutral}
1756   @tab
1757 @item @code{\stemDown}
1758   @tab @code{\stemUp}
1759   @tab @code{\stemNeutral}
1760   @tab
1761 @item @code{\textSpannerDown}
1762   @tab @code{\textSpannerUp}
1763   @tab @code{\textSpannerNeutral}
1764   @tab Text entered as spanner is below/above staff
1765 @item @code{\tieDown}
1766   @tab @code{\tieUp}
1767   @tab @code{\tieNeutral}
1768   @tab
1769 @item @code{\tupletDown}
1770   @tab @code{\tupletUp}
1771   @tab @code{\tupletNeutral}
1772   @tab Tuplets are below/above notes
1773 @end multitable
1774
1775 Note that these predefined commands may @strong{not} be
1776 preceded by @code{\once}.  If you wish to limit the
1777 effect to a single note you must either use the equivalent
1778 @code{\once \override} command or use the predefined command
1779 followed after the affected note by the corresponding
1780 @code{\xxxNeutral} command.
1781
1782 @unnumberedsubsubsec Fingering
1783
1784 @cindex fingering, placement
1785 @cindex fingering, chords
1786
1787 The placement of fingering on single notes can also be controlled
1788 by the @code{direction} property, but changing @code{direction}
1789 has no effect on chords.  As we shall see, there are special
1790 commands which allow the fingering of individual notes
1791 of chords to be controlled, with the fingering being placed
1792 above, below, to the left or to the right of each note.
1793
1794 First, here's the effect of @code{direction} on the fingering
1795 attached to single notes.  The first bar shows the default
1796 behaviour, and the following two bars shows the effect of
1797 specifying @code{DOWN} and @code{UP}:
1798
1799 @cindex Fingering, example of overriding
1800 @cindex direction property, example
1801
1802 @lilypond[quote,verbatim,relative=2]
1803 c4-5 a-3 f-1 c'-5 |
1804 \override Fingering #'direction = #DOWN
1805 c4-5 a-3 f-1 c'-5 |
1806 \override Fingering #'direction = #UP
1807 c4-5 a-3 f-1 c'-5 |
1808 @end lilypond
1809
1810 However, overriding the @code{direction} property is not the
1811 easiest way of manually setting the fingering above or below
1812 the notes; using @code{_} or @code{^} instead of @code{-} before
1813 the fingering number is usually preferable.  Here is the previous
1814 example using this method:
1815
1816 @cindex fingering example
1817
1818 @lilypond[quote,verbatim,relative=2]
1819 c4-5 a-3 f-1 c'-5 |
1820 c4_5 a_3 f_1 c'_5 |
1821 c4^5 a^3 f^1 c'^5 |
1822 @end lilypond
1823
1824 The @code{direction} property is ignored for chords, but the
1825 directional prefixes, @code{_} and @code{^} do work.  By default,
1826 the fingering is automatically placed both above and below the
1827 notes of a chord, as shown:
1828
1829 @cindex fingering example
1830
1831 @lilypond[quote,verbatim,relative=2]
1832 <c-5 g-3>4
1833 <c-5 g-3 e-2>4
1834 <c-5 g-3 e-2 c-1>4
1835 @end lilypond
1836
1837 @noindent
1838 but this may be overridden to manually force all or any of the
1839 individual fingering numbers above or below:
1840
1841 @cindex fingering example
1842
1843 @lilypond[quote,verbatim,relative=2]
1844 <c-5 g-3 e-2 c-1>4
1845 <c^5 g_3 e_2 c_1>4
1846 <c^5 g^3 e^2 c_1>4
1847 @end lilypond
1848
1849 Even greater control over the placement of fingering of the
1850 individual notes in a chord is possible by using the
1851 @code{\set fingeringOrientations} command.  The format of this
1852 command is:
1853
1854 @example
1855 @code{\set fingeringOrientations = #'([up] [left/right] [down])}
1856 @end example
1857
1858 @noindent
1859 @code{\set} is used because @code{fingeringOrientations} is a
1860 property of the @code{Voice} context, created and used by the
1861 @code{New_fingering_engraver}.
1862
1863 The property may be set to a list of one to three values.
1864 It controls whether fingerings may be placed above (if
1865 @code{up} appears in the list), below (if @code{down} appears),
1866 to the left (if @code{left} appears, or to the right
1867 (if @code{right} appears).  Conversely, if a location is not
1868 listed, no fingering is placed there.  LilyPond takes these
1869 constraints and works out the best placement for the fingering
1870 of the notes of the following chords.  Note that @code{left} and
1871 @code{right} are mutually exclusive -- fingering may be placed
1872 only on one side or the other, not both.
1873
1874 @warning{To control the placement of the fingering of a single
1875 note using this command it is necessary to write it as a single
1876 note chord by placing angle brackets round it.}
1877
1878 Here are a few examples:
1879
1880 @cindex fingering example
1881 @cindex @code{\set}, example of using
1882 @cindex fingeringOrientations property, example
1883
1884 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
1885 \set fingeringOrientations = #'(left)
1886 <f-2>4
1887 <c-1 e-2 g-3 b-5>4
1888 \set fingeringOrientations = #'(left)
1889 <f-2>4
1890 <c-1 e-2 g-3 b-5>4 |
1891 \set fingeringOrientations = #'(up left down)
1892 <f-2>4
1893 <c-1 e-2 g-3 b-5>4
1894 \set fingeringOrientations = #'(up left)
1895 <f-2>4
1896 <c-1 e-2 g-3 b-5>4 |
1897 \set fingeringOrientations = #'(right)
1898 <f-2>4
1899 <c-1 e-2 g-3 b-5>4
1900 @end lilypond
1901
1902 @noindent
1903 If the fingering seems a little crowded the @code{font-size}
1904 could be reduced.  The default value can be seen from the
1905 @code{Fingering} object in the IR to be @w{@code{-5}}, so let's
1906 try @w{@code{-7}}:
1907
1908 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
1909 \override Fingering #'font-size = #-7
1910 \set fingeringOrientations = #'(left)
1911 <f-2>4
1912 <c-1 e-2 g-3 b-5>4
1913 \set fingeringOrientations = #'(left)
1914 <f-2>4
1915 <c-1 e-2 g-3 b-5>4 |
1916 \set fingeringOrientations = #'(up left down)
1917 <f-2>4
1918 <c-1 e-2 g-3 b-5>4
1919 \set fingeringOrientations = #'(up left)
1920 <f-2>4
1921 <c-1 e-2 g-3 b-5>4 |
1922 \set fingeringOrientations = #'(right)
1923 <f-2>4
1924 <c-1 e-2 g-3 b-5>4
1925 @end lilypond
1926
1927 @node Outside-staff objects
1928 @subsection Outside-staff objects
1929
1930 Outside-staff objects are automatically placed to avoid collisions.
1931 Objects with the lower value of the @code{outside-staff-priority}
1932 property are placed nearer to the staff, and other outside-staff
1933 objects are then raised as far as necessary to avoid collisions.
1934 The @code{outside-staff-priority} is defined in the
1935 @code{grob-interface} and so is a property of all layout objects.
1936 By default it is set to @code{#f} for all within-staff objects,
1937 and to a numerical value appropriate to each outside-staff object
1938 when the object is created.  The following table shows the default
1939 numerical values for some of the commonest outside-staff objects.
1940
1941 @cindex spanners
1942
1943 Note the unusual names for some of the objects: spanner objects
1944 are automatically created to control the vertical positioning of
1945 grobs which (might) start and end at different musical moments, so
1946 changing the @code{outside-staff-priority} of the underlying grob
1947 will have no effect.  For example, changing
1948 @code{outside-staff-priority} of the @code{Hairpin} object will
1949 have no effect on the vertical positioning of hairpins -- you must
1950 change @code{outside-staff-priority} of the associated
1951 @code{DynamicLineSpanner} object instead.  This override must be
1952 placed at the start of the spanner, which might include several
1953 linked hairpins and dynamics.
1954
1955 @multitable @columnfractions .3 .3 .3
1956 @headitem Layout Object
1957   @tab Priority
1958   @tab Controls position of:
1959 @item @code{RehearsalMark}
1960   @tab @code{1500}
1961   @tab Rehearsal marks
1962 @item @code{MetronomeMark}
1963   @tab @code{1000}
1964   @tab Metronome marks
1965 @item @code{VoltaBracketSpanner}
1966   @tab @code{600}
1967   @tab Volta brackets
1968 @item @code{TextScript}
1969   @tab @code{450}
1970   @tab Markup text
1971 @item @code{MultiMeasureRestText}
1972   @tab @code{450}
1973   @tab Markup text over full-bar rests
1974 @item @code{OttavaBracket}
1975   @tab @code{400}
1976   @tab Ottava brackets
1977 @item @code{TextSpanner}
1978   @tab @code{350}
1979   @tab Text spanners
1980 @item @code{DynamicLineSpanner}
1981   @tab @code{250}
1982   @tab All dynamic markings
1983 @item @code{BarNumber}
1984   @tab @code{ 100}
1985   @tab Bar numbers
1986 @item @code{TrillSpanner}
1987   @tab @code{50}
1988   @tab Spanning trills
1989 @end multitable
1990
1991 Here is an example showing the default placement of some of
1992 these.
1993
1994 @cindex text spanner
1995 @cindex ottava bracket
1996
1997 @funindex \startTextSpan
1998 @funindex startTextSpan
1999 @funindex \stopTextSpan
2000 @funindex stopTextSpan
2001
2002 @cindex TextSpanner, example of overriding
2003 @cindex bound-details property, example
2004
2005 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
2006 % Set details for later Text Spanner
2007 \override TextSpanner #'(bound-details left text)
2008     = \markup { \small \bold Slower }
2009 % Place dynamics above staff
2010 \dynamicUp
2011 % Start Ottava Bracket
2012 \ottava #1
2013 c'4 \startTextSpan
2014 % Add Dynamic Text and hairpin
2015 c4\pp\<
2016 c4
2017 % Add Text Script
2018 c4^Text |
2019 c4 c
2020 % Add Dynamic Text and terminate hairpin
2021 c4\ff c \stopTextSpan |
2022 % Stop Ottava Bracket
2023 \ottava #0
2024 c,4 c c c |
2025 @end lilypond
2026
2027 This example also shows how to create Text Spanners --
2028 text with extender lines above a section of music.  The
2029 spanner extends from the @code{\startTextSpan} command to
2030 the @code{\stopTextSpan} command, and the format of the
2031 text is defined by the @code{\override TextSpanner} command.
2032 For more details see @ruser{Text spanners}.
2033
2034 It also shows how ottava brackets are created.
2035
2036 @cindex tweaking bar number placement
2037 @cindex bar numbers, tweaking placement
2038 @cindex tweaking metronome mark placement
2039 @cindex metronome mark, tweaking placement
2040 @cindex tweaking rehearsal mark placement
2041 @cindex rehearsal marks, tweaking placement
2042
2043 If the default values of @code{outside-staff-priority} do not give you
2044 the placing you want, the priority of any of the objects may be
2045 overridden.  Suppose we would like the ottava bracket to be placed
2046 below the text spanner in the example above.  All we need to do is to
2047 look up the priority of @code{OttavaBracket} in the IR or in the
2048 tables above, and reduce it to a value lower than that of a
2049 @code{TextSpanner}, remembering that @code{OttavaBracket} is created
2050 in the @code{Staff} context:
2051
2052 @cindex TextSpanner, example of overriding
2053 @cindex bound-details property, example
2054
2055 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
2056 % Set details for later Text Spanner
2057 \override TextSpanner #'(bound-details left text)
2058     = \markup { \small \bold Slower }
2059 % Place dynamics above staff
2060 \dynamicUp
2061 % Place following Ottava Bracket below Text Spanners
2062 \once \override Staff.OttavaBracket #'outside-staff-priority = #340
2063 % Start Ottava Bracket
2064 \ottava #1
2065 c'4 \startTextSpan
2066 % Add Dynamic Text
2067 c4\pp
2068 % Add Dynamic Line Spanner
2069 c4\<
2070 % Add Text Script
2071 c4^Text |
2072 c4 c
2073 % Add Dynamic Text
2074 c4\ff c \stopTextSpan |
2075 % Stop Ottava Bracket
2076 \ottava #0
2077 c,4 c c c |
2078 @end lilypond
2079
2080 Note that some of these objects, in particular bar numbers,
2081 metronome marks and rehearsal marks, live by default in the
2082 @code{Score} context, so be sure to use the correct context
2083 when these are being overriden.
2084
2085 @cindex slurs and outside-staff-priority
2086 @cindex slurs and articulations
2087 @cindex articulations and slurs
2088
2089 Slurs by default are classed as within-staff objects, but
2090 they often appear above the staff if the notes to
2091 which they are attached are high on the staff.  This can push
2092 outside-staff objects such as articulations too high, as the slur
2093 will be placed first.  The @code{avoid-slur} property of the
2094 articulation can be set to @code{'inside} to bring the articulation
2095 inside the slur, but the @code{avoid-slur} property is effective
2096 only if the @code{outside-staff-priority} is also set to @code{#f}.
2097 Alternatively, the @code{outside-staff-priority} of the slur
2098 can be set to a numerical value to cause it to be placed along with
2099 other outside-staff objects according to that value.  Here's an
2100 example showing the effect of the two methods:
2101
2102 @lilypond[quote,verbatim,relative=2]
2103 c4( c^\markup { \tiny \sharp } d4.) c8 |
2104 c4(
2105 \once \override TextScript #'avoid-slur = #'inside
2106 \once \override TextScript #'outside-staff-priority = ##f
2107 c4^\markup { \tiny \sharp } d4.) c8 |
2108 \once \override Slur #'outside-staff-priority = #500
2109 c4( c^\markup { \tiny \sharp } d4.) c8 |
2110 @end lilypond
2111
2112 Changing the @code{outside-staff-priority} can also be used to
2113 control the vertical placement of individual objects, although
2114 the results may not always be desirable.  Suppose we would
2115 like @qq{Text3} to be placed above @qq{Text4} in the example
2116 under Automatic behavior, above (see @ref{Automatic behavior}).
2117 All we need to do is to look up the priority of @code{TextScript}
2118 in the IR or in the tables above, and increase the priority of
2119 @qq{Text3} to a higher value:
2120
2121 @cindex TextScript, example of overriding
2122 @cindex outside-staff-priority property, example
2123
2124 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
2125 c2^"Text1"
2126 c2^"Text2" |
2127 \once \override TextScript #'outside-staff-priority = #500
2128 c2^"Text3"
2129 c2^"Text4" |
2130 @end lilypond
2131
2132 This certainly lifts @qq{Text3} above @qq{Text4} but it also lifts it
2133 above @qq{Text2}, and @qq{Text4} now drops down.  Perhaps this is not
2134 so good.  What we would really like to do is to position all the
2135 annotation at the same distance above the staff.  To do this, we
2136 clearly will need to space the notes out horizontally to make more
2137 room for the text.  This is done using the @code{textLengthOn}
2138 command.
2139
2140 @subheading \textLengthOn
2141
2142 @cindex notes, spreading out with text
2143
2144 @funindex \textLengthOn
2145 @funindex textLengthOn
2146 @funindex \textLengthOff
2147 @funindex textLengthOff
2148
2149 By default, text produced by markup takes up no horizontal space
2150 as far as laying out the music is concerned.  The @code{\textLengthOn}
2151 command reverses this behavior, causing the notes to be spaced
2152 out as far as is necessary to accommodate the text:
2153
2154 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
2155 \textLengthOn  % Cause notes to space out to accommodate text
2156 c2^"Text1"
2157 c2^"Text2" |
2158 c2^"Text3"
2159 c2^"Text4" |
2160 @end lilypond
2161
2162 The command to revert to the default behavior is
2163 @code{\textLengthOff}.  Remember @code{\once} only works with
2164 @code{\override}, @code{\set}, @code{\revert} or @code{unset},
2165 so cannot be used with @code{\textLengthOn}.
2166
2167 @cindex markup text, allowing collisions
2168
2169 Markup text will also avoid notes which project above the staff.
2170 If this is not desired, the automatic displacement upwards may
2171 be turned off by setting the priority to @code{#f}.  Here's an
2172 example to show how markup text interacts with such notes.
2173
2174 @cindex TextScript, example of overriding
2175 @cindex outside-staff-priority property, example
2176
2177 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
2178 % This markup is short enough to fit without collision
2179 c2^"Tex" c'' |
2180 R1 |
2181
2182 % This is too long to fit, so it is displaced upwards
2183 c,,2^"Text" c'' |
2184 R1 |
2185
2186 % Turn off collision avoidance
2187 \once \override TextScript #'outside-staff-priority = ##f
2188 c,,2^"Long Text   " c'' |
2189 R1 |
2190
2191 % Turn off collision avoidance
2192 \once \override TextScript #'outside-staff-priority = ##f
2193 \textLengthOn        % and turn on textLengthOn
2194 c,,2^"Long Text   "  % Spaces at end are honored
2195 c''2 |
2196 @end lilypond
2197
2198
2199 @subheading Dynamics
2200
2201 @cindex tweaking dynamics placement
2202 @cindex dynamics, tweaking placement
2203
2204 Dynamic markings will normally be positioned beneath the
2205 staff, but may be positioned above with the @code{dynamicUp}
2206 command.  They will be positioned vertically relative to the
2207 note to which they are attached, and will float below (or above)
2208 all within-staff objects such as phrasing slurs and bar numbers.
2209 This can give quite acceptable results, as this example
2210 shows:
2211
2212 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
2213 \clef "bass"
2214 \key aes \major
2215 \time 9/8
2216 \dynamicUp
2217 bes4.~\f\< \( bes4 bes8 des4\ff\> c16 bes\! |
2218 ees,2.~\)\mf ees4 r8 |
2219 @end lilypond
2220
2221 However, if the notes and attached dynamics are close
2222 together the automatic placement will avoid collisions
2223 by displacing later dynamic markings further away, but this may
2224 not be the optimum placement, as this rather artificial example
2225 shows:
2226
2227 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
2228 \dynamicUp
2229 a4\f b\mf c\mp b\p
2230 @end lilypond
2231
2232 @noindent
2233 Should a similar situation arise in @q{real} music, it may be
2234 preferable to space out the notes a little further, so the dynamic
2235 markings can all fit at the same vertical distance from the staff.  We
2236 were able to do this for markup text by using the @code{\textLengthOn}
2237 command, but there is no equivalent command for dynamic marks.  So we
2238 shall have to work out how to do this using @code{\override} commands.
2239
2240 @subheading Grob sizing
2241
2242 @cindex grob sizing
2243 @cindex sizing grobs
2244
2245 First we must learn how grobs are sized.  All grobs have a
2246 reference point defined within them which is used to position
2247 them relative to their parent object.  This point in the grob
2248 is then positioned at a horizontal distance, @code{X-offset},
2249 and at a vertical distance, @code{Y-offset}, from its parent.
2250 The horizontal extent of the object is given by a pair of
2251 numbers, @code{X-extent}, which say where the left and right
2252 edges are relative to the reference point.  The vertical extent
2253 is similarly defined by a pair of numbers, @code{Y-extent}.
2254 These are properties of all grobs which support the
2255 @code{grob-interface}.
2256
2257 @cindex @code{extra-spacing-width}
2258
2259 By default, outside-staff objects are given a width of zero so
2260 that they may overlap in the horizontal direction.  This is done
2261 by the trick of adding infinity to the leftmost extent and
2262 minus infinity to the rightmost extent by setting the
2263 @code{extra-spacing-width} to @code{'(+inf.0 . -inf.0)}.  So
2264 to ensure they do not overlap in the horizontal direction we
2265 must override this value of @code{extra-spacing-width} to
2266 @code{'(0 . 0)} so the true width shines through.  This is
2267 the command to do this for dynamic text:
2268
2269 @example
2270 \override DynamicText #'extra-spacing-width = #'(0 . 0)
2271 @end example
2272
2273 @noindent
2274 Let's see if this works in our previous example:
2275
2276 @cindex DynamicText, example of overriding
2277 @cindex extra-spacing-width property, example
2278
2279 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
2280 \dynamicUp
2281 \override DynamicText #'extra-spacing-width = #'(0 . 0)
2282 a4\f b\mf c\mp b\p |
2283 @end lilypond
2284
2285 @noindent
2286 Well, it has certainly stopped the dynamic marks being
2287 displaced, but two problems remain.  The marks should be
2288 spaced a little further apart and it would be better
2289 if they were all the same distance from the staff.
2290 We can solve the first problem easily.  Instead of making
2291 the @code{extra-spacing-width} zero we could add a little
2292 more to it.  The units are the space between two staff
2293 lines, so moving the left edge half a unit to the left and the
2294 right edge half a unit to the right should do it:
2295
2296 @cindex DynamicText, example of overriding
2297 @cindex extra-spacing-width property, example
2298
2299 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
2300 \dynamicUp
2301 % Extend width by 1 staff space
2302 \override DynamicText #'extra-spacing-width = #'(-0.5 . 0.5)
2303 a4\f b\mf c\mp b\p
2304 @end lilypond
2305
2306 @noindent
2307 This looks better, but maybe we would prefer the dynamic marks
2308 to be aligned along the same baseline rather than going up and
2309 down with the notes.  The property to do this is
2310 @code{staff-padding} which is covered in the following section.
2311
2312
2313 @node Collisions of objects
2314 @section Collisions of objects
2315
2316 @menu
2317 * Moving objects::
2318 * Fixing overlapping notation::
2319 * Real music example::
2320 @end menu
2321
2322 @node Moving objects
2323 @subsection Moving objects
2324
2325 @cindex moving overlapping objects
2326 @cindex moving colliding objects
2327 @cindex moving colliding grobs
2328 @cindex objects, moving colliding
2329 @cindex grobs, moving colliding
2330
2331 This may come as a surprise, but LilyPond is not perfect.  Some
2332 notation elements can overlap.  This is unfortunate, but in fact
2333 rather rare.  Usually the need to move objects is for clarity or
2334 aesthetic reasons -- they would look better with a little more
2335 or a little less space around them.
2336
2337 There are three main approaches to resolving overlapping
2338 notation.  They should be considered in the following order:
2339
2340 @enumerate
2341 @item
2342 The @strong{direction} of one of the overlapping objects may
2343 be changed using the predefined commands listed above for
2344 within-staff objects (see @ref{Within-staff objects}).
2345 Stems, slurs, beams, ties, dynamics, text and tuplets may be
2346 repositioned easily in this way.  The limitation is that you
2347 have a choice of only two positions, and neither may be
2348 suitable.
2349
2350 @item
2351 The @strong{object properties}, which LilyPond uses when positioning
2352 layout objects, may be modified using @code{\override}.  The
2353 advantages of making changes to this type of property are (a) that
2354 some other objects will be moved automatically if necessary to make
2355 room and (b) the single override can apply to all instances of the
2356 same type of object.  Such properties include:
2357
2358 @itemize
2359
2360 @item
2361 @code{direction}
2362
2363 This has already been covered in some detail -- see
2364 @ref{Within-staff objects}.
2365
2366 @item
2367 @code{padding}, @code{right-padding}, @code{staff-padding}
2368
2369 @cindex padding
2370 @cindex padding property
2371 @cindex right-padding property
2372 @cindex staff-padding property
2373
2374 As an object is being positioned the value of its @code{padding}
2375 property specifies the gap that must be left between itself and the
2376 nearest edge of the object against which it is being positioned.  Note
2377 that it is the @code{padding} value of the object @strong{being
2378 placed} that is used; the @code{padding} value of the object which is
2379 already placed is ignored.  Gaps specified by @code{padding} can be
2380 applied to all objects which support the
2381 @code{side-position-interface}.
2382
2383 Instead of @code{padding}, the placement of groups of accidentals
2384 is controlled by @code{right-padding}.  This property is to be found
2385 in the @code{AccidentalPlacement} object which, note, lives in the
2386 @strong{Staff} context.  In the typesetting process the note heads
2387 are typeset first and then the accidentals, if any, are added to the
2388 left of the note heads using the @code{right-padding} property to determine
2389 the separation from the note heads and between individual accidentals.
2390 So only the @code{right-padding} property of the @code{AccidentalPlacement}
2391 object has any effect on the placement of the accidentals.
2392
2393 The @code{staff-padding} property is closely related to the
2394 @code{padding} property: @code{padding} controls the minimum amount of
2395 space between any object which supports the
2396 @code{side-position-interface} and the nearest other object (generally
2397 the note or the staff lines); @code{staff-padding} applies only to
2398 those objects which are always set outside the staff -- it controls
2399 the minimum amount of space that should be inserted between that
2400 object and the staff.  Note that @code{staff-padding} has no effect on
2401 objects which are positioned relative to the note rather than the
2402 staff, even though it may be overridden without error for such objects
2403 -- it is simply ignored.
2404
2405 To discover which padding property is required for the object you wish
2406 to reposition, you need to return to the IR and look up the object's
2407 properties.  Be aware that the padding properties might not be located
2408 in the obvious object, so look in objects that appear to be related.
2409
2410 All padding values are measured in staff spaces.  For most
2411 objects, this value is set by default to be around 1.0 or less
2412 (it varies with each object).  It may be overridden if a larger
2413 (or smaller) gap is required.
2414
2415 @item
2416 @code{self-alignment-X}
2417
2418 @cindex self-alignment-X property
2419
2420 This property can be used to align the object to the left, to
2421 the right, or to center it with respect to the parent object's
2422 reference point.  It may be used with all objects which support
2423 the @code{self-alignment-interface}.  In general these are objects
2424 that contain text.  The values are @code{LEFT}, @code{RIGHT}
2425 or @code{CENTER}.  Alternatively, a numerical value between
2426 @w{@code{-1}} and @code{+1} may be specified, where @w{@code{-1}} is
2427 left-aligned, @code{+1} is right-aligned, and numbers in between
2428 move the text progressively from left-aligned to right-aligned.
2429 Numerical values greater than @code{1} may be specified to move
2430 the text even further to the left, or less than @w{@code{-1}} to
2431 move the text even further to the right.  A change of @code{1}
2432 in the value corresponds to a movement of half the text's length.
2433
2434 @item
2435 @code{extra-spacing-width}
2436
2437 @cindex extra-spacing-width property
2438
2439 This property is available for all objects which support the
2440 @code{item-interface}.  It takes two numbers, the first is added
2441 to the leftmost extent and the second is added to the rightmost
2442 extent.  Negative numbers move the edge to the left, positive to
2443 the right, so to widen an object the first number must be negative,
2444 the second positive.  Note that not all objects honor both
2445 numbers.  For example, the @code{Accidental} object only takes
2446 notice of the first (left edge) number.
2447
2448 @item
2449 @code{staff-position}
2450
2451 @cindex staff-position property
2452
2453 @code{staff-position} is a property of the
2454 @code{staff-symbol-referencer-interface}, which is supported by
2455 objects which are positioned relative to the staff.  It specifies
2456 the vertical position of the object relative to the center line
2457 of the staff in half staff-spaces.  It is useful in resolving
2458 collisions between layout objects like multi-measure rests, ties
2459 and notes in different voices.
2460
2461 @item
2462 @code{force-hshift}
2463
2464 @cindex force-hshift property
2465
2466 Closely spaced notes in a chord, or notes occurring at the same
2467 time in different voices, are arranged in two, occasionally more,
2468 columns to prevent the note heads overlapping.  These are called
2469 note columns, and an object called @code{NoteColumn} is created
2470 to lay out the notes in that column.
2471
2472 The @code{force-hshift} property is a property of a @code{NoteColumn}
2473 (actually of the @code{note-column-interface}).  Changing it permits a
2474 note column to be moved in units appropriate to a note column,
2475 viz. the note head width of the first voice note.  It should be used
2476 in complex situations where the normal @code{\shiftOn} commands (see
2477 @ref{Explicitly instantiating voices}) do not resolve the note
2478 conflict.  It is preferable to the @code{extra-offset} property for
2479 this purpose as there is no need to work out the distance in
2480 staff-spaces, and moving the notes into or out of a @code{NoteColumn}
2481 affects other actions such as merging note heads.
2482
2483 @end itemize
2484
2485 @item
2486 Finally, when all else fails, objects may be manually repositioned
2487 relative to the staff center line vertically, or by displacing them by
2488 any distance to a new position.  The disadvantages are that the
2489 correct values for the repositioning have to be worked out, often by
2490 trial and error, for every object individually, and, because the
2491 movement is done after LilyPond has placed all other objects, the user
2492 is responsible for avoiding any collisions that might ensue.  But the
2493 main difficulty with this approach is that the repositioning values
2494 may need to be reworked if the music is later modified.  The
2495 properties that can be used for this type of manual repositioning are:
2496
2497 @table @code
2498 @item extra-offset
2499
2500 @cindex extra-offset property
2501
2502 This property applies to any layout object supporting the
2503 @code{grob-interface}.  It takes a pair of numbers which specify the
2504 extra displacement in the horizontal and vertical directions.
2505 Negative numbers move the object to the left or down.  The units are
2506 staff-spaces.  The extra displacement is made after the typesetting of
2507 objects is finished, so an object may be repositioned anywhere without
2508 affecting anything else.
2509
2510 @item positions
2511
2512 @cindex positions property
2513
2514 This is most useful for manually adjusting the slope and height
2515 of beams, slurs, and tuplets.  It takes a pair of numbers
2516 giving the position of the left and right ends of the beam, slur,
2517 etc. relative to the center line of the staff.  Units are
2518 staff-spaces.  Note, though, that slurs and phrasing slurs cannot
2519 be repositioned by arbitrarily large amounts.  LilyPond first
2520 generates a list of possible positions for the slur and by default
2521 finds the slur that @qq{looks best}.  If the @code{positions}
2522 property has been overridden the slur that is closest to the
2523 requested positions is selected from the list.
2524 @end table
2525
2526 @end enumerate
2527
2528 A particular object may not have all of these properties.
2529 It is necessary to go to the IR to look up which properties
2530 are available for the object in question.
2531
2532 Here is a list of the objects which are most likely to be
2533 involved in collisions, together with the name of the object which
2534 should be looked up in the IR in order to discover which properties
2535 should be used to move them.
2536
2537 @multitable @columnfractions .5 .5
2538 @headitem Object type           @tab Object name
2539 @item Articulations             @tab @code{Script}
2540 @item Beams                     @tab @code{Beam}
2541 @item Dynamics (vertically)     @tab @code{DynamicLineSpanner}
2542 @item Dynamics (horizontally)   @tab @code{DynamicText}
2543 @item Fingerings                @tab @code{Fingering}
2544 @item Rehearsal / Text marks    @tab @code{RehearsalMark}
2545 @item Slurs                     @tab @code{Slur}
2546 @item Text e.g. @code{^"text"}  @tab @code{TextScript}
2547 @item Ties                      @tab @code{Tie}
2548 @item Tuplets                   @tab @code{TupletBracket}
2549 @end multitable
2550
2551
2552 @node Fixing overlapping notation
2553 @subsection Fixing overlapping notation
2554
2555 Let's now see how the properties in the previous section can
2556 help to resolve overlapping notation.
2557
2558 @subheading padding property
2559
2560 @cindex padding
2561 @cindex fixing overlapping notation
2562 @cindex overlapping notation
2563
2564 The @code{padding} property can be set to increase
2565 (or decrease) the distance between symbols that are printed
2566 above or below notes.
2567
2568 @cindex Script, example of overriding
2569 @cindex padding property, example
2570
2571 @lilypond[quote,fragment,relative=1,verbatim]
2572 c2\fermata
2573 \override Script #'padding = #3
2574 b2\fermata
2575 @end lilypond
2576
2577 @cindex MetronomeMark, example of overriding
2578 @cindex padding property, example
2579
2580 @lilypond[quote,fragment,relative=1,verbatim]
2581 % This will not work, see below
2582 \override MetronomeMark #'padding = #3
2583 \tempo 4 = 120
2584 c1 |
2585 % This works
2586 \override Score.MetronomeMark #'padding = #3
2587 \tempo 4 = 80
2588 d1 |
2589 @end lilypond
2590
2591 Note in the second example how important it is to figure out what
2592 context handles a certain object.  Since the @code{MetronomeMark}
2593 object is handled in the @code{Score} context, property changes in the
2594 @code{Voice} context will not be noticed.  For more details, see
2595 @ruser{Modifying properties}.
2596
2597 If the @code{padding} property of an object is increased when that
2598 object is in a stack of objects being positioned according to
2599 their @code{outside-staff-priority}, then that object and all
2600 objects outside it are moved.
2601
2602
2603 @subheading right-padding
2604
2605 @cindex right-padding property
2606
2607 The @code{right-padding} property affects the spacing between the
2608 accidental and the note to which it applies.  It is not often
2609 required, but the default spacing may be wrong for certain special
2610 accidental glyphs or combination of glyphs used in some microtonal
2611 music.  These have to be entered by overriding the accidental
2612 stencil with a markup containing the desired symbol(s), like this:
2613
2614 @cindex Accidental, example of overriding
2615 @cindex text property, example
2616 @cindex stencil property, example
2617 @cindex AccidentalPlacement, example of overriding
2618 @cindex right-padding property, example
2619
2620 @lilypond[quote,ragged-right,verbatim]
2621 sesquisharp = \markup { \sesquisharp }
2622 \relative c'' {
2623   c4
2624   % This prints a sesquisharp but the spacing is too small
2625   \once \override Accidental
2626     #'stencil = #ly:text-interface::print
2627   \once \override Accidental #'text = #sesquisharp
2628   cis4 c
2629   % This improves the spacing
2630   \once \override Score.AccidentalPlacement #'right-padding = #0.6
2631   \once \override Accidental
2632     #'stencil = #ly:text-interface::print
2633   \once \override Accidental #'text = #sesquisharp
2634   cis4 |
2635 }
2636 @end lilypond
2637
2638 @noindent
2639 This necessarily uses an override for the accidental stencil which
2640 will not be covered until later.  The stencil type must be a
2641 procedure, here changed to print the contents of the @code{text}
2642 property of @code{Accidental}, which itself is set to be a
2643 sesquisharp sign.  This sign is then moved further away from the
2644 note head by overriding @code{right-padding}.
2645
2646 @noindent
2647
2648 @subheading staff-padding property
2649
2650 @cindex aligning objects on a baseline
2651 @cindex objects, aligning on a baseline
2652
2653 @code{staff-padding} can be used to align objects such as dynamics
2654 along a baseline at a fixed height above the staff, rather than at a
2655 height dependent on the position of the note to which they are
2656 attached.  It is not a property of @code{DynamicText} but of
2657 @code{DynamicLineSpanner}.  This is because the baseline should apply
2658 equally to @strong{all} dynamics, including those created as extended
2659 spanners.  So this is the way to align the dynamic marks in the
2660 example taken from the previous section:
2661
2662 @cindex DynamicText, example of overriding
2663 @cindex extra-spacing-width property, example
2664 @cindex DynamicLineSpanner, example of overriding
2665 @cindex staff-padding property, example
2666
2667 @lilypond[quote,fragment,ragged-right,verbatim,relative=2]
2668 \dynamicUp
2669 % Extend width by 1 unit
2670 \override DynamicText #'extra-spacing-width = #'(-0.5 . 0.5)
2671 % Align dynamics to a base line 2 units above staff
2672 \override DynamicLineSpanner #'staff-padding = #2
2673 a4\f b\mf c\mp b\p
2674 @end lilypond
2675
2676
2677 @subheading self-alignment-X property
2678
2679 The following example shows how this can resolve the collision
2680 of a string fingering object with a note's stem by aligning the
2681 right edge with the reference point of the parent note:
2682
2683 @cindex StringNumber, example of overriding
2684 @cindex self-alignment-X property, example
2685
2686 @lilypond[quote,fragment,ragged-right,verbatim,relative=3]
2687 \voiceOne
2688 <a\2>
2689 \once \override StringNumber #'self-alignment-X = #RIGHT
2690 <a\2>
2691 @end lilypond
2692
2693 @subheading staff-position property
2694
2695 @cindex object collision within a staff
2696
2697 Multimeasure rests in one voice can collide with notes in another.
2698 Since these rests are typeset centered between the bar lines, it
2699 would require significant effort for LilyPond to figure out which
2700 other notes might collide with it, since all the current collision
2701 handling between notes and between notes and rests is done only
2702 for notes and rests that occur at the same time.  Here's an
2703 example of a collision of this type:
2704
2705 @lilypond[quote,verbatim,fragment,ragged-right, relative=1]
2706 << { c4 c c c } \\ { R1 } >>
2707 @end lilypond
2708
2709 The best solution here is to move the multimeasure rest down, since
2710 the rest is in voice two.  The default in @code{\voiceTwo} (i.e. in
2711 the second voice of a @code{<<@{...@} \\ @{...@}>>} construct) is that
2712 @code{staff-position} is set to -4 for MultiMeasureRest, so we need to
2713 move it, say, four half-staff spaces down to @w{@code{-8}}.
2714
2715 @cindex MultiMeasureRest, example of overriding
2716 @cindex staff-position property, example
2717
2718 @lilypond[quote,verbatim,fragment,ragged-right, relative=1]
2719 <<
2720   { c4 c c c }
2721   \\
2722   \override MultiMeasureRest #'staff-position = #-8
2723   { R1 }
2724 >>
2725 @end lilypond
2726
2727 This is better than using, for example, @code{extra-offset},
2728 because the ledger line above the rest is inserted automatically.
2729
2730 @subheading extra-offset property
2731
2732 @cindex positioning objects
2733 @cindex positioning grobs
2734 @cindex objects, positioning
2735 @cindex grobs, positioning
2736
2737 The @code{extra-offset} property provides complete control over the
2738 positioning of an object both horizontally and vertically.
2739
2740 In the following example, the second fingering is moved a little to
2741 the left, and 1.8 staff space downwards:
2742
2743 @cindex Fingering, example of overriding
2744 @cindex extra-offset property, example
2745
2746 @lilypond[quote,fragment,relative=1,verbatim]
2747 \stemUp
2748 f4-5
2749 \once \override Fingering #'extra-offset = #'(-0.3 . -1.8)
2750 f4-5
2751 @end lilypond
2752
2753
2754 @subheading positions property
2755
2756 @cindex controlling tuplets, slurs, phrasing slurs, and beams manually
2757 @cindex manually controlling tuplets, slurs, phrasing slurs, and beams
2758 @cindex tuplet beams, controlling manually
2759 @cindex slurs, controlling manually
2760 @cindex phrasing slurs, controlling manually
2761 @cindex beams, controlling manually
2762
2763 The @code{positions} property allows the position and slope of
2764 tuplets, slurs, phrasing slurs and beams to be controlled manually.
2765 Here's an example which has an ugly phrasing slur due to its trying to
2766 avoid the slur on the acciaccatura.
2767
2768 @lilypond[quote,verbatim,fragment,ragged-right,relative=1]
2769 r4 \acciaccatura e8\( d8 c~ c d c d\)
2770 @end lilypond
2771
2772 @noindent
2773 We could simply move the phrasing slur above the notes, and this
2774 would be the preferred solution:
2775
2776 @lilypond[quote,verbatim,fragment,ragged-right,relative=1]
2777 r4
2778 \phrasingSlurUp
2779 \acciaccatura e8\( d8 c~ c d c d\)
2780 @end lilypond
2781
2782 @noindent
2783 But if there were some reason why this could not be done the
2784 other alternative would be to move the left end of the phrasing
2785 slur down a little using the @code{positions} property.  This
2786 also resolves the rather nasty shape.
2787
2788 @cindex PhrasingSlur, example of overriding
2789 @cindex positions property, example
2790
2791 @lilypond[quote,verbatim,fragment,ragged-right,relative=1]
2792 r4
2793 \once \override PhrasingSlur #'positions = #'(-4 . -3)
2794 \acciaccatura e8\( d8 c~ c d c d\)
2795 @end lilypond
2796
2797 Here's a further example.  We see that the beams
2798 collide with the ties:
2799
2800 @lilypond[quote,verbatim,fragment,ragged-right]
2801 {
2802   \time 4/2
2803   <<
2804     { c'1 ~ c'2. e'8 f' }
2805     \\
2806     { e''8 e'' e'' e''  e'' e'' e'' e''  f''2 g'' }
2807   >>
2808   <<
2809     { c'1 ~ c'2. e'8 f' }
2810     \\
2811     { e''8 e'' e'' e''  e'' e'' e'' e''  f''2 g'' }
2812   >>
2813 }
2814 @end lilypond
2815
2816 @noindent
2817 This can be resolved by manually moving both ends of the beam
2818 up from their position at 1.81 staff-spaces below the center line to,
2819 say, 1:
2820
2821 @cindex Beam, example of overriding
2822 @cindex positions property, example
2823
2824 @lilypond[quote,verbatim,fragment,ragged-right]
2825 {
2826   \time 4/2
2827   <<
2828     { c'1 ~ c'2. e'8 f' }
2829     \\
2830     {
2831       \override Beam #'positions = #'(-1 . -1)
2832       e''8 e'' e'' e''  e'' e'' e'' e''  f''2 g''
2833     }
2834   >>
2835   <<
2836     { c'1 ~ c'2. e'8 f' }
2837     \\
2838     { e''8 e'' e'' e''  e'' e'' e'' e''  f''2 g'' }
2839   >>
2840 }
2841 @end lilypond
2842
2843 @noindent
2844 Note that the override continues to apply in the first voice of
2845 the second measure of eighth notes, but not to any of the beams in the
2846 second voice.
2847
2848 @subheading force-hshift property
2849
2850 We can now see how to apply the final corrections to the Chopin
2851 example introduced at the end of @ref{I'm hearing Voices}, which
2852 was left looking like this:
2853
2854 @lilypond[quote,verbatim,fragment,ragged-right]
2855 \new Staff \relative c'' {
2856   \key aes \major
2857   <<
2858     { c2 aes4. bes8 }
2859     \\
2860     { <ees, c>2 des }
2861     \\
2862     \\
2863     { aes'2 f4 fes }
2864   >> |
2865   <c ees aes c>1 |
2866 }
2867 @end lilypond
2868
2869 @noindent
2870 The inner note of the first chord (i.e. the A-flat in the fourth
2871 Voice) need not be shifted away from the note column of the higher
2872 note.  To correct this we set @code{force-hshift}, which is a property
2873 of @code{NoteColumn}, of this note to zero.
2874
2875 In the second chord we prefer the F to line up with the A and the
2876 lowest note to be positioned slightly right to avoid a collision of
2877 stems.  We achieve this by setting @code{force-hshift} in the
2878 @code{NoteColumn} of the low D-flat to move it to the right by half
2879 a staff-space.
2880
2881 Here's the final result:
2882
2883 @cindex NoteColumn, example of overriding
2884 @cindex force-hshift property, example
2885
2886 @lilypond[quote,verbatim,fragment,ragged-right]
2887 \new Staff \relative c'' {
2888   \key aes \major
2889   <<
2890     { c2 aes4. bes8 }
2891     \\
2892     {
2893       <ees, c>2
2894       \once \override NoteColumn #'force-hshift = #0.5
2895       des2
2896     }
2897     \\
2898     \\
2899     {
2900       \override NoteColumn #'force-hshift = #0
2901       aes'2 f4 fes
2902     }
2903   >> |
2904   <c ees aes c>1 |
2905 }
2906 @end lilypond
2907
2908
2909 @node Real music example
2910 @subsection Real music example
2911
2912 We end this section on Tweaks by showing the steps to be taken to
2913 deal with a tricky example which needs several tweaks to produce
2914 the desired output.  The example has been deliberately chosen to
2915 illustrate the use of the Notation Reference to resolve unusual
2916 problems with notation.  It is not representative of the more usual
2917 engraving process, so please do not let these difficulties put
2918 you off!  Fortunately, difficulties like these are not very common!
2919
2920 The example is from Chopin's Première Ballade, Op. 23, bars 6 to
2921 9, the transition from the opening Lento to Moderato.
2922 Here, first, is what we want the output to look like, but to avoid
2923 over-complicating the example too much we have left out the
2924 dynamics, fingering and pedalling.
2925
2926 @c The following should appear as music without code
2927 @c This example should not be indexed
2928 @c line-width ensures no break
2929 @lilypond[quote,ragged-right,line-width=6\in]
2930 rhMusic = \relative c'' {
2931   \new Voice {
2932     r2 c4.\( g8 |
2933     \once \override Tie #'staff-position = #3.5
2934     bes1~ |
2935     \bar "||"
2936     \time 6/4
2937     \mergeDifferentlyHeadedOn
2938     \mergeDifferentlyDottedOn
2939     bes2.^\markup { \bold "Moderato" } r8
2940     <<
2941       { c,8 d fis bes a }
2942       \new Voice {
2943         \voiceTwo
2944         c,8~
2945         % Reposition the c2 to the right of the merged note
2946         \once \override NoteColumn #'force-hshift = #1.0
2947         % Move the c2 out of the main note column
2948         % so the merge will work
2949         \shiftOnn
2950         c2
2951       }
2952       \new Voice {
2953         \voiceThree
2954         s8
2955         % Stem on the d2 must be down to permit merging
2956         \stemDown
2957         % Stem on the d2 should be invisible
2958         \once \override Stem #'transparent = ##t
2959         \once \override Flag #'transparent = ##t
2960         d2
2961       }
2962       \new Voice {
2963         \voiceFour
2964         s4 fis4.
2965       }
2966     >> |
2967     \mergeDifferentlyHeadedOff
2968     \mergeDifferentlyDottedOff
2969     g2.\)
2970   }
2971 }
2972
2973 lhMusic = \relative c' {
2974   r2 <c g ees>2( |
2975   <d g, d>1)\arpeggio |
2976   r2. d,,4 r4 r |
2977   r4
2978 }
2979
2980 \score {
2981   \new PianoStaff <<
2982     \new Staff = "RH"  <<
2983       \key g \minor
2984       \rhMusic
2985     >>
2986     \new Staff = "LH" <<
2987       \key g \minor
2988       \clef "bass"
2989       \lhMusic
2990     >>
2991   >>
2992 }
2993 @end lilypond
2994
2995 We note first that the right hand part in the third bar
2996 requires four voices.  These are the five beamed eighth notes,
2997 the tied C, the half-note D which is merged with the eighth note
2998 D, and the dotted quarter note F-sharp, which is also merged with
2999 the eighth note at the same pitch.  Everything else is in a single
3000 voice, so the easiest way is to introduce these extra three voices
3001 temporarily at the time they are needed.  If you have forgotten
3002 how to do this, look at @ref{I'm hearing Voices} and @ref{Explicitly
3003 instantiating voices}.  Here we choose to use explicitly instantiated
3004 voices for the polyphonic passage, as LilyPond is better able to
3005 avoid collisions if all voices are instantiated explicitly in this
3006 way.
3007
3008 So let us begin by entering the notes as two variables, setting up
3009 the staff structure in a score block, and seeing what LilyPond
3010 produces by default:
3011
3012 @c line-width ensures no break
3013 @lilypond[quote,verbatim,ragged-right,line-width=6\in]
3014 rhMusic = \relative c'' {
3015   \new Voice {
3016     r2 c4. g8 |
3017     bes1~ |
3018     \time 6/4
3019     bes2. r8
3020     % Start polyphonic section of four voices
3021     <<
3022       { c,8 d fis bes a }  % continuation of main voice
3023       \new Voice {
3024         \voiceTwo
3025         c,8~ c2
3026       }
3027       \new Voice {
3028         \voiceThree
3029         s8 d2
3030       }
3031       \new Voice {
3032         \voiceFour
3033         s4 fis4.
3034       }
3035     >> |
3036     g2.  % continuation of main voice
3037   }
3038 }
3039
3040 lhMusic = \relative c' {
3041   r2 <c g ees>2 |
3042   <d g, d>1 |
3043   r2. d,,4 r4 r |
3044   r4
3045 }
3046
3047 \score {
3048   \new PianoStaff <<
3049     \new Staff = "RH"  <<
3050       \key g \minor
3051       \rhMusic
3052     >>
3053     \new Staff = "LH" <<
3054       \key g \minor
3055       \clef "bass"
3056       \lhMusic
3057     >>
3058   >>
3059 }
3060 @end lilypond
3061
3062 All the notes are right, but the appearance is far from
3063 satisfactory.  The tie collides with the change in time signature,
3064 some notes are not merged together, and several notation elements
3065 are missing.  Let's first deal with the easier things.  We can
3066 easily add the left hand slur and the right hand phrasing slur,
3067 since these were all covered in the Tutorial.  Doing this gives:
3068
3069 @c line-width ensures no break
3070 @lilypond[quote,verbatim,ragged-right,line-width=6\in]
3071 rhMusic = \relative c'' {
3072   \new Voice {
3073     r2 c4.\( g8 |
3074     bes1~ |
3075     \time 6/4
3076     bes2. r8
3077     % Start polyphonic section of four voices
3078     <<
3079       { c,8 d fis bes a }  % continuation of main voice
3080       \new Voice {
3081         \voiceTwo
3082         c,8~ c2
3083       }
3084       \new Voice {
3085         \voiceThree
3086         s8 d2
3087       }
3088       \new Voice {
3089         \voiceFour
3090         s4 fis4.
3091       }
3092     >> |
3093     g2.\)  % continuation of main voice
3094   }
3095 }
3096
3097 lhMusic = \relative c' {
3098   r2 <c g ees>2( |
3099   <d g, d>1) |
3100   r2. d,,4 r4 r |
3101   r4
3102 }
3103
3104 \score {
3105   \new PianoStaff <<
3106     \new Staff = "RH"  <<
3107       \key g \minor
3108       \rhMusic
3109     >>
3110     \new Staff = "LH" <<
3111       \key g \minor
3112       \clef "bass"
3113       \lhMusic
3114     >>
3115   >>
3116 }
3117 @end lilypond
3118
3119 The first bar is now correct.  The second bar contains an arpeggio and
3120 is terminated by a double bar line.  How do we do these, as they have
3121 not been mentioned in this Learning Manual?  This is where we need to
3122 turn to the Notation Reference.  Looking up @q{arpeggio} and @q{bar
3123 line} in the index quickly shows us that an arpeggio is produced by
3124 appending @code{\arpeggio} to a chord, and a double bar line is
3125 produced by the @code{\bar "||"} command.  That's easily done.  We
3126 next need to correct the collision of the tie with the time signature.
3127 This is best done by moving the tie upwards.  Moving objects was
3128 covered earlier in @ref{Moving objects}, which says that objects
3129 positioned relative to the staff can be moved vertically by overriding
3130 their @code{staff-position} property, which is specified in half staff
3131 spaces relative to the center line of the staff.  So the following
3132 override placed just before the first tied note would move the tie up
3133 to 3.5 half staff spaces above the center line:
3134
3135 @code{\once \override Tie #'staff-position = #3.5}
3136
3137 This completes bar two, giving:
3138
3139 @c line-width ensures no break
3140 @lilypond[quote,verbatim,ragged-right,line-width=6\in]
3141 rhMusic = \relative c'' {
3142   \new Voice {
3143     r2 c4.\( g8 |
3144     \once \override Tie #'staff-position = #3.5
3145     bes1~ |
3146     \bar "||"
3147     \time 6/4
3148     bes2. r8
3149     % Start polyphonic section of four voices
3150     <<
3151       { c,8 d fis bes a }  % continuation of main voice
3152       \new Voice {
3153         \voiceTwo
3154         c,8~ c2
3155       }
3156       \new Voice {
3157         \voiceThree
3158         s8 d2
3159       }
3160       \new Voice {
3161         \voiceFour
3162         s4 fis4.
3163       }
3164     >> |
3165     g2.\)  % continuation of main voice
3166   }
3167 }
3168
3169 lhMusic = \relative c' {
3170   r2 <c g ees>2( |
3171   <d g, d>1)\arpeggio |
3172   r2. d,,4 r4 r |
3173   r4
3174 }
3175
3176 \score {
3177   \new PianoStaff <<
3178     \new Staff = "RH"  <<
3179       \key g \minor
3180       \rhMusic
3181     >>
3182     \new Staff = "LH" <<
3183       \key g \minor
3184       \clef "bass"
3185       \lhMusic
3186     >>
3187   >>
3188 }
3189 @end lilypond
3190
3191 On to bar three and the start of the Moderato section.  The tutorial
3192 showed how to add bold text with the @code{\markup} command, so
3193 adding @qq{Moderato} in bold is easy.  But how do we merge notes in
3194 different voices together?  This is where we need to turn again to
3195 the Notation Reference for help.  A search for @qq{merge} in the
3196 Notation Reference index quickly leads us to the commands for merging
3197 differently headed and differently dotted notes in
3198 @ruser{Collision resolution}.  In our example we need to merge both
3199 types of note for the duration of the polyphonic section in bar 3,
3200 so using the information we find in the Notation Reference we add
3201
3202 @example
3203 \mergeDifferentlyHeadedOn
3204 \mergeDifferentlyDottedOn
3205 @end example
3206
3207 @noindent
3208 to the start of that section and
3209
3210 @example
3211 \mergeDifferentlyHeadedOff
3212 \mergeDifferentlyDottedOff
3213 @end example
3214
3215 @noindent
3216 to the end, giving:
3217
3218 @c line-width ensures no break
3219 @lilypond[quote,ragged-right,line-width=6\in]
3220 rhMusic = \relative c'' {
3221   \new Voice {
3222     r2 c4.\( g8 |
3223     \once \override Tie #'staff-position = #3.5
3224     bes1~ |
3225     \bar "||"
3226     \time 6/4
3227     bes2.^\markup { \bold "Moderato" } r8
3228     \mergeDifferentlyHeadedOn
3229     \mergeDifferentlyDottedOn
3230     % Start polyphonic section of four voices
3231     <<
3232       { c,8 d fis bes a }  % continuation of main voice
3233       \new Voice {
3234         \voiceTwo
3235         c,8~ c2
3236       }
3237       \new Voice {
3238         \voiceThree
3239         s8 d2
3240       }
3241       \new Voice {
3242         \voiceFour
3243         s4 fis4.
3244       }
3245     >> |
3246     \mergeDifferentlyHeadedOff
3247     \mergeDifferentlyDottedOff
3248     g2.\)  % continuation of main voice
3249   }
3250 }
3251
3252 lhMusic = \relative c' {
3253   r2 <c g ees>2( |
3254   <d g, d>1)\arpeggio |
3255   r2. d,,4 r4 r |
3256   r4
3257 }
3258
3259 \score {
3260   \new PianoStaff <<
3261     \new Staff = "RH"  <<
3262       \key g \minor
3263       \rhMusic
3264     >>
3265     \new Staff = "LH" <<
3266       \key g \minor
3267       \clef "bass"
3268       \lhMusic
3269     >>
3270   >>
3271 }
3272 @end lilypond
3273
3274 These overrides have merged the two F-sharp notes, but not the two
3275 on D.  Why not?  The answer is there in the same section in the
3276 Notation Reference -- notes being merged must have stems in
3277 opposite directions and two notes cannot be merged successfully if
3278 there is a third note in the same note column.  Here the two D's
3279 both have upward stems and there is a third note -- the C.  We know
3280 how to change the stem direction using @code{\stemDown}, and
3281 the Notation Reference also says how to move the C -- apply a shift
3282 using one of the @code{\shift} commands.  But which one?
3283 The C is in voice two which has shift off, and the two D's are in
3284 voices one and three, which have shift off and shift on,
3285 respectively.  So we have to shift the C a further level still
3286 using @code{\shiftOnn} to avoid it interfering with the two D's.
3287 Applying these changes gives:
3288
3289 @cindex Tie, example of overriding
3290 @cindex staff-position property, example
3291
3292 @c line-width ensures no break
3293 @lilypond[quote,verbatim,ragged-right,line-width=6\in]
3294 rhMusic = \relative c'' {
3295   \new Voice {
3296     r2 c4.\( g8 |
3297     \once \override Tie #'staff-position = #3.5
3298     bes1~ |
3299     \bar "||"
3300     \time 6/4
3301     bes2.^\markup { \bold "Moderato" } r8
3302     \mergeDifferentlyHeadedOn
3303     \mergeDifferentlyDottedOn
3304     % Start polyphonic section of four voices
3305     <<
3306       { c,8 d fis bes a }  % continuation of main voice
3307       \new Voice {
3308         \voiceTwo
3309         % Move the c2 out of the main note column
3310         % so the merge will work
3311         c,8~ \shiftOnn c2
3312       }
3313       \new Voice {
3314         \voiceThree
3315         % Stem on the d2 must be down to permit merging
3316         s8 \stemDown d2
3317       }
3318       \new Voice {
3319         \voiceFour
3320         s4 fis4.
3321       }
3322     >> |
3323     \mergeDifferentlyHeadedOff
3324     \mergeDifferentlyDottedOff
3325     g2.\)  % continuation of main voice
3326   }
3327 }
3328
3329 lhMusic = \relative c' {
3330   r2 <c g ees>2( |
3331   <d g, d>1)\arpeggio |
3332   r2. d,,4 r4 r |
3333   r4
3334 }
3335
3336 \score {
3337   \new PianoStaff <<
3338     \new Staff = "RH"  <<
3339       \key g \minor
3340       \rhMusic
3341     >>
3342     \new Staff = "LH" <<
3343       \key g \minor
3344       \clef "bass"
3345       \lhMusic
3346     >>
3347   >>
3348 }
3349 @end lilypond
3350
3351 Nearly there.  Only two problems remain: The downward stem on the
3352 merged D should not be there, and the C would be better positioned
3353 to the right of the D's.  We know how to do both of these from the
3354 earlier tweaks: we make the stem transparent, and move the C with
3355 the @code{force-hshift} property.  Here's the final result:
3356
3357 @cindex NoteColumn, example of overriding
3358 @cindex force-hshift property, example
3359 @cindex Stem, example of overriding
3360 @cindex transparent property, example
3361
3362 @c line-width ensures no break
3363 @lilypond[quote,verbatim,ragged-right,line-width=6\in]
3364 rhMusic = \relative c'' {
3365   \new Voice {
3366     r2 c4.\( g8 |
3367     \once \override Tie #'staff-position = #3.5
3368     bes1~ |
3369     \bar "||"
3370     \time 6/4
3371     bes2.^\markup { \bold "Moderato" } r8
3372     \mergeDifferentlyHeadedOn
3373     \mergeDifferentlyDottedOn
3374     % Start polyphonic section of four voices
3375     <<
3376       { c,8 d fis bes a }  % continuation of main voice
3377       \new Voice {
3378         \voiceTwo
3379         c,8~
3380         % Reposition the c2 to the right of the merged note
3381         \once \override NoteColumn #'force-hshift = #1.0
3382         % Move the c2 out of the main note column
3383         % so the merge will work
3384         \shiftOnn
3385         c2
3386       }
3387       \new Voice {
3388         \voiceThree
3389         s8
3390         % Stem on the d2 must be down to permit merging
3391         \stemDown
3392         % Stem on the d2 should be invisible
3393         \once \override Stem #'transparent = ##t
3394         \once \override Flag #'transparent = ##t
3395         d2
3396       }
3397       \new Voice {
3398         \voiceFour
3399         s4 fis4.
3400       }
3401     >> |
3402     \mergeDifferentlyHeadedOff
3403     \mergeDifferentlyDottedOff
3404     g2.\)  % continuation of main voice
3405   }
3406 }
3407
3408 lhMusic = \relative c' {
3409   r2 <c g ees>2( |
3410   <d g, d>1)\arpeggio |
3411   r2. d,,4 r4 r |
3412   r4
3413 }
3414
3415 \score {
3416   \new PianoStaff <<
3417     \new Staff = "RH"  <<
3418       \key g \minor
3419       \rhMusic
3420     >>
3421     \new Staff = "LH" <<
3422       \key g \minor
3423       \clef "bass"
3424       \lhMusic
3425     >>
3426   >>
3427 }
3428 @end lilypond
3429
3430
3431 @node Further tweaking
3432 @section Further tweaking
3433
3434 @menu
3435 * Other uses for tweaks::
3436 * Using variables for tweaks::
3437 * Style sheets::
3438 * Other sources of information::
3439 * Advanced tweaks with Scheme::
3440 @end menu
3441
3442 @node Other uses for tweaks
3443 @subsection Other uses for tweaks
3444
3445 @cindex transparent property, use of
3446 @cindex objects, making invisible
3447 @cindex removing objects
3448 @cindex objects, removing
3449 @cindex hiding objects
3450 @cindex objects, hiding
3451 @cindex invisible objects
3452 @cindex objects, invisible
3453 @cindex tying notes across voices
3454
3455 @subheading Tying notes across voices
3456
3457 The following example demonstrates how to connect notes in
3458 different voices using ties.  Normally, only two notes in the
3459 same voice can be connected with ties.  By using two voices,
3460 with the tied notes in one of them
3461
3462 @lilypond[quote,fragment,relative=2]
3463 << { b8~ b\noBeam } \\ { b8[ g] } >>
3464 @end lilypond
3465
3466 @noindent
3467 and blanking the first up-stem in that voice, the tie appears to
3468 cross voices:
3469
3470 @cindex Stem, example of overriding
3471 @cindex transparent property, example
3472
3473 @lilypond[quote,fragment,relative=2,verbatim]
3474 <<
3475   {
3476     \once \override Stem #'transparent = ##t
3477     \once \override Flag #'transparent = ##t
3478     b8~ b\noBeam
3479   }
3480 \\
3481   { b8[ g] }
3482 >>
3483 @end lilypond
3484
3485 To make sure that the just-blanked stem doesn't squeeze the tie
3486 too much, we can lengthen the stem by setting the
3487 @code{length} to @code{8},
3488
3489 @lilypond[quote,fragment,relative=2,verbatim]
3490 <<
3491   {
3492     \once \override Stem #'transparent = ##t
3493     \once \override Flag #'transparent = ##t
3494     \once \override Stem #'length = #8
3495     b8~ b\noBeam
3496   }
3497 \\
3498   { b8[ g] }
3499 >>
3500 @end lilypond
3501
3502 @subheading Simulating a fermata in MIDI
3503
3504 @cindex stencil property, use of
3505 @cindex fermata, implementing in MIDI
3506
3507 For outside-staff objects it is usually better to override the
3508 object's @code{stencil} property rather than its @code{transparent}
3509 property when you wish to remove it from the printed output.
3510 Setting the @code{stencil} property of an object to @code{#f} will
3511 remove that object entirely from the printed output.  This means it
3512 has no effect on the placement of other objects placed relative to
3513 it.
3514
3515 For example, if we wished to change the metronome setting in order
3516 to simulate a fermata in the MIDI output we would not want the
3517 metronome markings to appear in the printed output, and we would
3518 not want it to influence the spacing between the two systems or
3519 the positions of adjacent annotations on the staff.  So setting
3520 its @code{stencil} property to @code{#f} would be the best way.
3521 We show here the effect of the two methods:
3522
3523 @cindex MetronomeMark, example of overriding
3524 @cindex transparent property, example
3525
3526 @lilypond[quote,verbatim,ragged-right]
3527 \score {
3528   \relative c'' {
3529     % Visible tempo marking
3530     \tempo 4=120
3531     a4 a a
3532     \once \override Score.MetronomeMark #'transparent = ##t
3533     % Invisible tempo marking to lengthen fermata in MIDI
3534     \tempo 4=80
3535     a4\fermata |
3536     % New tempo for next section
3537     \tempo 4=100
3538     a4 a a a |
3539   }
3540   \layout { }
3541   \midi { }
3542 }
3543 @end lilypond
3544
3545 @cindex MetronomeMark, example of overriding
3546 @cindex stencil property, example
3547
3548 @lilypond[quote,verbatim,ragged-right]
3549 \score {
3550   \relative c'' {
3551     % Visible tempo marking
3552     \tempo 4=120
3553     a4 a a
3554     \once \override Score.MetronomeMark #'stencil = ##f
3555     % Invisible tempo marking to lengthen fermata in MIDI
3556     \tempo 4=80
3557     a4\fermata |
3558     % New tempo for next section
3559     \tempo 4=100
3560     a4 a a a |
3561   }
3562   \layout { }
3563   \midi { }
3564 }
3565 @end lilypond
3566
3567 @noindent
3568 Both methods remove the metronome mark which lengthens the fermata
3569 from the printed output, and both affect the MIDI timing as
3570 required, but the transparent metronome mark in the first line
3571 forces the following tempo indication too high while the
3572 second (with the stencil removed) does not.
3573
3574 @seealso
3575 Music Glossary:
3576 @rglos{system}.
3577
3578 @node Using variables for tweaks
3579 @subsection Using variables for tweaks
3580
3581 @cindex variables, using for tweaks
3582 @cindex using variables for tweaks
3583 @cindex tweaks, using variables for
3584
3585 Override commands are often long and tedious to type, and they
3586 have to be absolutely correct.  If the same overrides are to be
3587 used many times it may be worth defining variables to hold them.
3588
3589 Suppose we wish to emphasize certain words in lyrics by printing
3590 them in bold italics.  The @code{\italic} and @code{\bold}
3591 commands only work within lyrics if they are embedded, together with
3592 the word or words to be modified, within a @code{\markup} block,
3593 which makes them tedious to enter.  The need to embed the words
3594 themselves prevents their use in simple variables.  As an
3595 alternative can we use @code{\override} and @code{\revert} commands?
3596
3597 @example
3598 @code{\override Lyrics . LyricText #'font-shape = #'italic}
3599 @code{\override Lyrics . LyricText #'font-series = #'bold}
3600
3601 @code{\revert Lyrics . LyricText #'font-shape}
3602 @code{\revert Lyrics . LyricText #'font-series}
3603 @end example
3604
3605 These would also be extremely tedious to enter if there were many
3606 words requiring emphasis.  But we @emph{can} define these as two
3607 variables and use those to bracket the words to be emphasized.
3608 Another advantage of using variables for these overrides is that
3609 the spaces around the dot are not necessary, since they are not
3610 being interpreted in @code{\lyricmode} directly.  Here's an example
3611 of this, although in practice  we would choose shorter names
3612 for the variables to make them quicker to type:
3613
3614 @cindex LyricText, example of overriding
3615 @cindex font-shape property, example
3616 @cindex font-series property, example
3617
3618 @lilypond[quote,verbatim]
3619 emphasize = {
3620   \override Lyrics.LyricText #'font-shape = #'italic
3621   \override Lyrics.LyricText #'font-series = #'bold
3622 }
3623
3624 normal = {
3625   \revert Lyrics.LyricText #'font-shape
3626   \revert Lyrics.LyricText #'font-series
3627 }
3628
3629 global = { \key c \major \time 4/4 \partial 4 }
3630
3631 SopranoMusic = \relative c' { c4 | e4. e8 g4 g    | a4   a   g  }
3632 AltoMusic    = \relative c' { c4 | c4. c8 e4 e    | f4   f   e  }
3633 TenorMusic   = \relative c  { e4 | g4. g8 c4.  b8 | a8 b c d e4 }
3634 BassMusic    = \relative c  { c4 | c4. c8 c4 c    | f8 g a b c4 }
3635
3636 VerseOne = \lyrics {
3637   E -- | ter -- nal \emphasize Fa -- ther, | \normal strong to save,
3638 }
3639
3640 VerseTwo = \lyricmode {
3641   O | \once \emphasize Christ, whose voice the | wa -- ters heard,
3642 }
3643
3644 VerseThree = \lyricmode {
3645   O | \emphasize Ho -- ly Spi -- rit, | \normal who didst brood
3646 }
3647
3648 VerseFour = \lyricmode {
3649   O | \emphasize Tri -- ni -- ty \normal of | love and pow'r
3650 }
3651
3652 \score {
3653   \new ChoirStaff <<
3654     \new Staff <<
3655       \clef "treble"
3656       \new Voice = "Soprano"  { \voiceOne \global \SopranoMusic }
3657       \new Voice = "Alto" { \voiceTwo \AltoMusic }
3658       \new Lyrics \lyricsto "Soprano" { \VerseOne }
3659       \new Lyrics \lyricsto "Soprano" { \VerseTwo }
3660       \new Lyrics \lyricsto "Soprano" { \VerseThree }
3661       \new Lyrics \lyricsto "Soprano" { \VerseFour }
3662     >>
3663     \new Staff <<
3664       \clef "bass"
3665       \new Voice = "Tenor" { \voiceOne \TenorMusic }
3666       \new Voice = "Bass"  { \voiceTwo \BassMusic }
3667     >>
3668   >>
3669 }
3670 @end lilypond
3671
3672
3673 @node Style sheets
3674 @subsection Style sheets
3675
3676 The output that LilyPond produces can be heavily modified; see
3677 @ref{Tweaking output}, for details.  But what if you have many
3678 input files that you want to apply your tweaks to?  Or what if you
3679 simply want to separate your tweaks from the actual music?  This
3680 is quite easy to do.
3681
3682 Let's look at an example.  Don't worry if you don't understand
3683 the parts with all the @code{#()}.  This is explained in
3684 @ref{Advanced tweaks with Scheme}.
3685
3686 @lilypond[quote,verbatim,ragged-right]
3687 mpdolce =
3688 #(make-dynamic-script
3689   #{ \markup { \hspace #0
3690                \translate #'(5 . 0)
3691                \line { \dynamic "mp"
3692                        \text \italic "dolce" } }
3693   #})
3694
3695 inst =
3696 #(define-music-function
3697      (parser location string)
3698      (string?)
3699    #{ ^\markup \bold \box #string #})
3700
3701 \relative c'' {
3702   \tempo 4=50
3703   a4.\mpdolce d8 cis4--\glissando a |
3704   b4 bes a2 |
3705   \inst "Clarinet"
3706   cis4.\< d8 e4 fis |
3707   g8(\! fis)-. e( d)-. cis2 |
3708 }
3709 @end lilypond
3710
3711 Let's do something about the @code{mpdolce} and @code{inst} definitions.
3712 They produce the output we desire, but we might want to use them in
3713 another piece.  We could simply copy-and-paste them at the top of every
3714 file, but that's an annoyance.  It also leaves those definitions in our
3715 input files, and I personally find all the @code{#()} somewhat ugly.
3716 Let's hide them in another file:
3717
3718 @example
3719 %%% save this to a file called "definitions.ily"
3720 mpdolce =
3721 #(make-dynamic-script
3722   #@{ \markup @{ \hspace #0
3723                \translate #'(5 . 0)
3724                \line @{ \dynamic "mp"
3725                        \text \italic "dolce" @} @}
3726   #@})
3727
3728 inst =
3729 #(define-music-function
3730      (parser location string)
3731      (string?)
3732    #@{ ^\markup \bold \box #string #@})
3733 @end example
3734
3735 We will refer to this file using the @code{\include} command near
3736 the top of the music file.  (The extension @file{.ily} is used to
3737 distinguish this included file, which is not meant to be compiled
3738 on its own, from the main file.)
3739 Now let's modify our music (let's save this file as @file{music.ly}).
3740
3741 @c  We have to do this awkward example/lilypond-non-verbatim
3742 @c  because we can't do the \include stuff in the manual.
3743
3744 @example
3745 \include "definitions.ily"
3746
3747 \relative c'' @{
3748   \tempo 4=50
3749   a4.\mpdolce d8 cis4--\glissando a |
3750   b4 bes a2 |
3751   \inst "Clarinet"
3752   cis4.\< d8 e4 fis |
3753   g8(\! fis)-. e( d)-. cis2 |
3754 @}
3755 @end example
3756
3757 @lilypond[quote,ragged-right]
3758 mpdolce =
3759 #(make-dynamic-script
3760   #{ \markup { \hspace #0
3761                \translate #'(5 . 0)
3762                \line { \dynamic "mp"
3763                        \text \italic "dolce" } }
3764   #})
3765
3766 inst =
3767 #(define-music-function
3768      (parser location string)
3769      (string?)
3770    #{ ^\markup \bold \box #string #})
3771
3772 \relative c'' {
3773   \tempo 4=50
3774   a4.\mpdolce d8 cis4--\glissando a |
3775   b4 bes a2 |
3776   \inst "Clarinet"
3777   cis4.\< d8 e4 fis |
3778   g8(\! fis)-. e( d)-. cis2 |
3779 }
3780 @end lilypond
3781
3782 That looks better, but let's make a few changes.  The glissando is hard
3783 to see, so let's make it thicker and closer to the note heads.  Let's
3784 put the metronome marking above the clef, instead of over the first
3785 note.  And finally, my composition professor hates @q{C} time signatures,
3786 so we'd better make that @q{4/4} instead.
3787
3788 Don't change @file{music.ly}, though.  Replace our @file{definitions.ily}
3789 with this:
3790
3791 @example
3792 %%%  definitions.ily
3793 mpdolce =
3794 #(make-dynamic-script
3795   #@{ \markup @{ \hspace #0
3796                \translate #'(5 . 0)
3797                \line @{ \dynamic "mp"
3798                        \text \italic "dolce" @} @}
3799   #@})
3800
3801 inst =
3802 #(define-music-function
3803      (parser location string)
3804      (string?)
3805    #@{ ^\markup \bold \box #string #@})
3806
3807 \layout@{
3808   \context @{
3809     \Score
3810     \override MetronomeMark #'extra-offset = #'(-9 . 0)
3811     \override MetronomeMark #'padding = #'3
3812   @}
3813   \context @{
3814     \Staff
3815     \override TimeSignature #'style = #'numbered
3816   @}
3817   \context @{
3818     \Voice
3819     \override Glissando #'thickness = #3
3820     \override Glissando #'gap = #0.1
3821   @}
3822 @}
3823 @end example
3824
3825 @lilypond[quote,ragged-right]
3826 mpdolce =
3827 #(make-dynamic-script
3828   #{ \markup { \hspace #0
3829                \translate #'(5 . 0)
3830                \line { \dynamic "mp"
3831                        \text \italic "dolce" } }
3832   #})
3833
3834 inst =
3835 #(define-music-function
3836      (parser location string)
3837      (string?)
3838    #{ ^\markup \bold \box #string #})
3839
3840 \layout{
3841   \context {
3842     \Score
3843     \override MetronomeMark #'extra-offset = #'(-9 . 0)
3844     \override MetronomeMark #'padding = #'3
3845   }
3846   \context {
3847     \Staff
3848     \override TimeSignature #'style = #'numbered
3849   }
3850   \context {
3851     \Voice
3852     \override Glissando #'thickness = #3
3853     \override Glissando #'gap = #0.1
3854   }
3855 }
3856
3857 \relative c'' {
3858   \tempo 4=50
3859   a4.\mpdolce d8 cis4--\glissando a |
3860   b4 bes a2 |
3861   \inst "Clarinet"
3862   cis4.\< d8 e4 fis |
3863   g8(\! fis)-. e( d)-. cis2 |
3864 }
3865 @end lilypond
3866
3867 That looks nicer!  But now suppose that I want to publish this
3868 piece.  My composition professor doesn't like @q{C} time
3869 signatures, but I'm somewhat fond of them.  Let's copy the
3870 current @file{definitions.ily} to @file{web-publish.ily} and
3871 modify that.  Since this music is aimed at producing a pdf which
3872 will be displayed on the screen, we'll also increase the
3873 overall size of the output.
3874
3875 @example
3876 %%%  definitions.ily
3877 mpdolce =
3878 #(make-dynamic-script
3879   #@{ \markup @{ \hspace #0
3880                \translate #'(5 . 0)
3881                \line @{ \dynamic "mp"
3882                        \text \italic "dolce" @} @}
3883   #@})
3884
3885 inst =
3886 #(define-music-function
3887      (parser location string)
3888      (string?)
3889    #@{ ^\markup \bold \box #string #@})
3890
3891 #(set-global-staff-size 23)
3892
3893 \layout@{
3894   \context @{
3895     \Score
3896     \override MetronomeMark #'extra-offset = #'(-9 . 0)
3897     \override MetronomeMark #'padding = #'3
3898   @}
3899   \context @{
3900     \Staff
3901   @}
3902   \context @{
3903     \Voice
3904     \override Glissando #'thickness = #3
3905     \override Glissando #'gap = #0.1
3906   @}
3907 @}
3908 @end example
3909
3910 @lilypond[quote,ragged-right]
3911 mpdolce =
3912 #(make-dynamic-script
3913   #{ \markup { \hspace #0
3914                \translate #'(5 . 0)
3915                \line { \dynamic "mp"
3916                        \text \italic "dolce" } }
3917   #})
3918
3919 inst =
3920 #(define-music-function
3921      (parser location string)
3922      (string?)
3923    #{ ^\markup \bold \box #string #})
3924
3925 #(set-global-staff-size 23)
3926
3927 \layout{
3928   \context { \Score
3929     \override MetronomeMark #'extra-offset = #'(-9 . 0)
3930     \override MetronomeMark #'padding = #'3
3931   }
3932   \context { \Voice
3933     \override Glissando #'thickness = #3
3934     \override Glissando #'gap = #0.1
3935   }
3936 }
3937
3938 \relative c'' {
3939   \tempo 4=50
3940   a4.\mpdolce d8 cis4--\glissando a |
3941   b4 bes a2 |
3942   \inst "Clarinet"
3943   cis4.\< d8 e4 fis |
3944   g8(\! fis)-. e( d)-. cis2 |
3945 }
3946 @end lilypond
3947
3948 Now in our music, I simply replace
3949 @code{\include "definitions.ily"} with
3950 @code{\include "web-publish.ily"}.  Of course, we could make this
3951 even more convenient.  We could make a @file{definitions.ily} file which
3952 contains only the definitions of @code{mpdolce} and @code{inst}, a
3953 @file{web-publish.ily} file which contains only the @code{\layout}
3954 section listed above, and a @file{university.ily} file which
3955 contains only the tweaks to produce the output that my professor
3956 prefers.  The top of @file{music.ly} would then look like this:
3957
3958 @example
3959 \include "definitions.ily"
3960
3961 %%%  Only uncomment one of these two lines!
3962 \include "web-publish.ily"
3963 %\include "university.ily"
3964 @end example
3965
3966 This approach can be useful even if you are only producing
3967 one set of parts.  I use half a dozen different
3968 @q{style sheet} files for my projects.  I begin every music
3969 file with @code{\include "../global.ily"}, which contains
3970
3971 @example
3972 %%%   global.ily
3973 \version @w{"@version{}"}
3974
3975 #(ly:set-option 'point-and-click #f)
3976
3977 \include "../init/init-defs.ly"
3978 \include "../init/init-layout.ly"
3979 \include "../init/init-headers.ly"
3980 \include "../init/init-paper.ly"
3981 @end example
3982
3983
3984 @node Other sources of information
3985 @subsection Other sources of information
3986
3987 The Internals Reference documentation contains a lot of information
3988 about LilyPond, but even more information can be gathered by
3989 looking at the internal LilyPond files.  To explore these, you must
3990 first find the directory appropriate to your system.  The location
3991 of this directory depends (a) on whether you obtained LilyPond
3992 by downloading a precompiled binary from lilypond.org
3993 or whether you installed it from a package manager (i.e.
3994 distributed with Linux, or installed under fink or cygwin) or
3995 compiled it from source, and (b) on which operating system it is
3996 being used:
3997
3998 @strong{Downloaded from lilypond.org}
3999
4000 @itemize @bullet
4001 @item Linux
4002
4003 Navigate to
4004 @example
4005 @file{@var{INSTALLDIR}/lilypond/usr/@/share/lilypond/current/}
4006 @end example
4007
4008 @item MacOS X
4009
4010 Navigate to
4011 @example
4012 @file{@var{INSTALLDIR}/LilyPond.app/Contents/@/Resources/share/lilypond/current/}
4013 @end example
4014
4015 by either @code{cd}-ing into this directory from the
4016 Terminal, or control-clicking on the LilyPond application and
4017 selecting @q{Show Package Contents}.
4018
4019 @item Windows
4020
4021 Using Windows Explorer, navigate to
4022 @example
4023 @file{@var{INSTALLDIR}/LilyPond/usr/@/share/lilypond/current/}
4024 @end example
4025
4026 @end itemize
4027
4028 @strong{Installed from a package manager or compiled from source}
4029
4030 Navigate to
4031 @file{@var{PREFIX}/share/lilypond/@var{X.Y.Z}/}, where
4032 @var{PREFIX} is set by your package manager or @code{configure}
4033 script, and @var{X.Y.Z} is the LilyPond version number.
4034
4035 @smallspace
4036
4037 Within this directory the two interesting subdirectories are
4038
4039 @itemize
4040 @item @file{ly/} - contains files in LilyPond format
4041 @item @file{scm/} - contains files in Scheme format
4042 @end itemize
4043
4044 Let's begin by looking at some files in @file{ly/}.
4045 Open @file{ly/property-init.ly} in a text editor.  The one
4046 you normally use for @code{.ly} files will be fine.  This file
4047 contains the definitions of all the standard LilyPond predefined
4048 commands, such as @code{\stemUp} and @code{\slurDotted}.  You will
4049 see that these are nothing more than definitions of variables
4050 containing one or a group of @code{\override} commands.  For
4051 example, @code{/tieDotted} is defined to be:
4052
4053 @example
4054 tieDotted = @{
4055   \override Tie #'dash-period = #0.75
4056   \override Tie #'dash-fraction = #0.1
4057 @}
4058 @end example
4059
4060 If you do not like the default values these predefined commands can
4061 be redefined easily, just like any other variable, at the
4062 head of your input file.
4063
4064 The following are the most useful files to be found in
4065 @file{ly/}:
4066
4067 @multitable @columnfractions .4 .6
4068 @headitem Filename
4069   @tab Contents
4070 @item @file{ly/engraver-init.ly}
4071   @tab Definitions of engraver Contexts
4072 @item @file{ly/paper-defaults-init.ly}
4073   @tab Specifications of paper-related defaults
4074 @item @file{ly/performer-init.ly}
4075   @tab Definitions of performer Contexts
4076 @item @file{ly/property-init.ly}
4077   @tab Definitions of all common predefined commands
4078 @item @file{ly/spanner-init.ly}
4079   @tab Definitions of spanner-related predefined commands
4080 @end multitable
4081
4082 Other settings (such as the definitions of markup commands) are
4083 stored as @file{.scm} (Scheme) files.  The Scheme programming
4084 language is used to provide a programmable interface into
4085 LilyPond internal operation.  Further explanation of these files
4086 is currently outside the scope of this manual, as a knowledge of
4087 the Scheme language is required.  Users should be warned that
4088 a substantial amount of technical knowledge or time is required
4089 to understand Scheme and these files (see @rextend{Scheme tutorial}).
4090
4091 If you have this knowledge, the Scheme files which may be of
4092 interest are:
4093
4094 @multitable @columnfractions .4 .6
4095 @headitem Filename
4096   @tab Contents
4097 @item @file{scm/auto-beam.scm}
4098   @tab Sub-beaming defaults
4099 @item @file{scm/define-grobs.scm}
4100   @tab Default settings for grob properties
4101 @item @file{scm/define-markup-commands.scm}
4102   @tab Specify all markup commands
4103 @item @file{scm/midi.scm}
4104   @tab Default settings for MIDI output
4105 @item @file{scm/output-lib.scm}
4106   @tab Settings that affect appearance of frets, colors,
4107        accidentals, bar lines, etc
4108 @item @file{scm/parser-clef.scm}
4109   @tab Definitions of supported clefs
4110 @item @file{scm/script.scm}
4111   @tab Default settings for articulations
4112 @end multitable
4113
4114
4115 @node Advanced tweaks with Scheme
4116 @subsection Advanced tweaks with Scheme
4117
4118 Although many things are possible with the @code{\override} and
4119 @code{\tweak} commands, an even more powerful way of modifying
4120 the action of LilyPond is available through a programmable
4121 interface to the LilyPond internal operation.  Code written in
4122 the Scheme programming language can be incorporated directly in
4123 the internal operation of LilyPond.  Of course, at least a basic
4124 knowledge of programming in Scheme is required to do this, and an
4125 introduction is provided in the @rextend{Scheme tutorial}.
4126
4127 As an illustration of one of the many possibilities, instead of
4128 setting a property to a constant it can be set to a Scheme
4129 procedure which is then called whenever that property is accessed
4130 by LilyPond.  The property can then be set dynamically to a value
4131 determined by the procedure at the time it is called.  In this
4132 example we color the note head in accordance with its position on
4133 the staff.
4134
4135 @cindex x11-color function, example of using
4136 @cindex NoteHead, example of overriding
4137 @cindex color property, setting to Scheme procedure
4138
4139 @lilypond[quote,verbatim,ragged-right]
4140 #(define (color-notehead grob)
4141    "Color the notehead according to its position on the staff."
4142    (let ((mod-position (modulo (ly:grob-property grob 'staff-position)
4143                                7)))
4144      (case mod-position
4145        ;;   Return rainbow colors
4146        ((1) (x11-color 'red    ))  ; for C
4147        ((2) (x11-color 'orange ))  ; for D
4148        ((3) (x11-color 'yellow ))  ; for E
4149        ((4) (x11-color 'green  ))  ; for F
4150        ((5) (x11-color 'blue   ))  ; for G
4151        ((6) (x11-color 'purple ))  ; for A
4152        ((0) (x11-color 'violet ))  ; for B
4153        )))
4154
4155 \relative c' {
4156   % Arrange to obtain color from color-notehead procedure
4157   \override NoteHead #'color = #color-notehead
4158   a2 b | c2 d | e2 f | g2 a |
4159 }
4160 @end lilypond
4161
4162 Further examples showing the use of these programmable interfaces
4163 can be found in @rextend{Callback functions}.
4164
4165
4166