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