]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/user/changing-defaults.itely
(INFOINSTALL):
[lilypond.git] / Documentation / user / changing-defaults.itely
1 @c -*-texinfo-*-
2 @node Changing defaults
3 @chapter Changing defaults
4
5
6 The purpose of LilyPond's design is to provide the finest output
7 quality as a default. Nevertheless, it may happen that you need to
8 change that default layout.  The layout is controlled through a large
9 number of proverbial ``knobs and switches.''  This chapter does not
10 list each and every knob. Rather, it outlines what groups of controls
11 are available, and it explains how to lookup which knob to use for a
12 certain effect.
13
14 The controls are available for tuning are described in a separate
15 document, the @internalsref{Program reference} manual. This manual
16 lists all different variables, functions and options available in
17 LilyPond. It is available as a HTML document, which is available
18 @uref{http://lilypond.org/doc/Documentation/user/out-www/lilypond-internals/,on-line},
19 but is also included with the LilyPond documentation package.
20
21 There are three areas where the default settings may be changed:
22
23 @itemize @bullet
24 @item Output: changing the appearance of individual
25   objects. For example, changing stem directions, or the location of
26   subscripts.
27   
28 @item Context: changing aspects of the translation from music events to
29   notation. For example, giving each staff a separate time signature. 
30   
31 @item Global layout: changing the appearance of the spacing, line
32   breaks and page dimensions.
33 @end itemize
34
35 Then, there are separate systems for typesetting text (like
36 @emph{ritardando}) and selecting different fonts. This chapter also
37 discusses these.
38
39 Internally, LilyPond uses Scheme (a LISP dialect) to provide
40 infrastructure.  Overriding layout decisions in effect accesses the
41 program internals, so it is necessary to learn a (very small) subset
42 of Scheme. That is why this chapter starts with a short tutorial on
43 entering numbers, lists, strings and symbols in Scheme.
44
45
46 @menu
47 * Scheme tutorial::             
48 * Interpretation contexts::     
49 * Tuning output::               
50 * Fonts::                       
51 * Text markup::                 
52 * Global layout::               
53 * Output details::              
54 @end menu
55
56 @node Scheme tutorial
57 @section Scheme tutorial
58
59 @cindex Scheme
60 @cindex GUILE
61 @cindex Scheme, in-line code
62 @cindex accessing Scheme
63 @cindex evaluating Scheme
64 @cindex LISP
65
66 LilyPond uses the Scheme programming language, both as part of the
67 input syntax, and as internal mechanism to glue together modules of
68 the program. This section is a very brief overview of entering data in
69 Scheme.@footnote{If you want to know more about Scheme, see
70 @uref{http://www.schemers.org}.}
71
72 The most basic thing of a language is data: numbers, character
73 strings, lists, etc. Here is a list of data types that are relevant to
74 LilyPond input.
75
76 @table @asis
77 @item Booleans
78   Boolean values are True or False. The Scheme for True is @code{#t}
79   and False is @code{#f}.
80 @item Numbers
81   Numbers are entered in the standard fashion,
82   @code{1} is the (integer) number one, while @code{-1.5} is a
83   floating point number (a non-integer number). 
84 @item Strings
85   Strings are enclosed in double quotes,
86   @example
87     "this is a string"
88   @end example
89
90   Strings may span several lines
91   @example
92     "this
93     is
94     a string"
95   @end example
96
97   Quotation marks and newlines can also be added with so-called escape
98   sequences. The string @code{a said "b"} is entered as
99   @example
100     "a said \"b\""
101   @end example
102
103   Newlines and backslashes are escaped with @code{\n} and @code{\\}
104 respectively.
105 @end table
106
107
108 In a music file, snippets of Scheme code are introduced with the hash
109 mark @code{#}. So, the previous examples translated in LilyPondese are
110
111 @example
112   ##t ##f 
113   #1 #-1.5
114   #"this is a string"
115   #"this
116   is
117   a string"
118 @end example
119
120 For the rest of this section, we will assume that the data is entered
121 in a music file, so we add @code{#}s everywhere.
122
123 Scheme can be used to do calculations. It uses @emph{prefix}
124 syntax. Adding 1 and 2 is written as @code{(+ 1 2)} rather than the
125 traditional 1+2.
126
127 @lisp
128   #(+ 1 2)
129    @result{} #3 
130 @end lisp
131
132 The arrow @result{} shows that the result of evaluating @code{(+ 1 2)}
133 is @code{3}.  Calculations may be nested: the result of a function may
134 be used for another calculation.
135
136 @lisp
137   #(+ 1 (* 3 4))
138    @result{} #(+ 1 12) 
139    @result{} #13
140 @end lisp
141
142 These calculations are examples of evaluations: an expression like
143 @code{(* 3 4)} is replaced by its value @code{12}. A similar thing
144 happens with variables. After defining a variable  
145
146 @example
147   twelve = #12 
148 @end example
149
150 variables can also be used in expressions, here
151
152 @example
153   twentyFour = #(* 2 twelve) 
154 @end example 
155
156 the number 24 is stored in the variable @code{twentyFour}.
157
158 The @emph{name} of a variable is also an expression, similar to a
159 number or a string. It is entered as
160
161 @example
162   #'twentyFour
163 @end example
164
165 The quote mark @code{'} prevents Scheme interpreter from substituting
166 @code{24} for the @code{twentyFour}. Instead, we get the name
167 @code{twentyFour}.
168
169 This syntax will be used very frequently, since many of the layout
170 tweaks involve assigning (Scheme) values to internal variables, for
171 example
172
173 @example
174   \override Stem #'thickness = #2.6
175 @end example
176
177 This instruction adjusts the appearance of stems. The value @code{2.6}
178 is put into a the @code{thickness} variable of a @code{Stem}
179 object. This makes stems almost twice as thick as their normal size.
180 To distinguish between variables defined in input files (like
181 @code{twentyFour} in the example above), and internal variables, we
182 will call the latter ``properties.'' So, the stem object has a
183 @code{thickness} property.
184
185 Two-dimensional offsets (X and Y coordinates) as well as object sizes
186 (intervals with a left and right point) are entered as @code{pairs}. A
187 pair@footnote{In Scheme terminology, the pair is called @code{cons},
188 and its two elements are called car and cdr respectively.}  is entered
189 as @code{(first . second)}, and like symbols, they must be quoted,
190
191 @example
192   \override TextScript #'extra-offset = #'(1 . 2)  
193 @end example 
194
195 This assigns the pair (1, 2) to @code{extra-offset} variable of the
196 TextScript object. This moves the object 1 staff space to the right,
197 and 2 spaces up.
198
199 The two elements of a pair may be arbitrary values, for example
200
201 @example
202   #'(1 . 2)
203   #'(#t . #f)
204   #'("blah-blah" . 3.14159265)
205 @end example
206
207 A list is entered by enclosing its elements in parentheses, and adding
208 a quote. For example,
209 @example
210   #'(1 2 3)
211   #'(1 2 "string" #f)
212 @end example
213
214 We have been using lists all along.  A calculation, like @code{(+ 1
215 2)} is also a list (containing the symbol @code{+} and the numbers 1
216 and 2). Normally lists are interpreted as calculations, and the Scheme
217 interpreter substitutes the outcome of the calculation. To enter a
218 list, we stop evaluation. This is done by quoting the list with a
219 quote @code{'} symbol.  For calculations, do not use a quote.
220
221 Inside a quoted list or pair, there is no need to quote anymore.  The
222 following is a pair of symbols, a list of symbols and a list of lists
223 respectively,
224
225 @example
226   #'(stem . head)
227   #'(staff clef key-signature)
228   #'((1) (2))
229 @end example
230
231
232 @node Interpretation contexts
233 @section Interpretation contexts
234
235 When music is printed, a lot of things notation elements must be added
236 to the input, which is often bare bones.  For example, compare the
237 input and output of the following example
238
239 @lilypond[verbatim,relative=2]
240   cis4 cis2. g4
241 @end lilypond
242
243 The input is rather sparse, but in the output, bar lines, accidentals,
244 clef and time signature are added. LilyPond @emph{interprets} the
245 input. During this step, the musical information is inspected in time
246 order, similar to reading a score from left to right. While reading,
247 the program remembers where measure boundaries are, and what pitches
248 need explicit accidentals.
249
250 This is contextual information. and it can be present on several
251 levels.  For example, the effect of an accidental is limited to a
252 single stave, while a bar line must be synchronized across the entire
253 score.  To match this hierarchy, LilyPond's interpretation step is
254 hierarchical.  There are interpretation contexts, like
255 @context{Voice}, Staff and Score, and each level can maintain its own
256 properties.
257
258 Full description of all available contexts is in the program
259 reference, see
260 @ifhtml
261 @internalsref{Contexts}
262 @end ifhtml
263 @ifnothtml 
264 Translation @arrow{} Context.
265 @end ifnothtml
266
267 @c [TODO: describe propagation]
268
269
270 @menu
271 * Creating contexts::           
272 * Changing context properties on the fly ::  
273 * Modifying context plug-ins::  
274 * Layout tunings within contexts::  
275 * Changing context default settings::  
276 * Defining new  contexts::      
277 * Which properties to change::  
278 @end menu
279
280 @node Creating contexts
281 @subsection Creating contexts
282
283 For scores with only one voice and one staff, correct contexts are
284 created automatically. For more complex scores, it is necessary to
285 instantiate them by hand.  There are three commands to do this.
286
287 The easiest command is @code{\new}, and it also the quickest to type.
288 It is prepended to a  music expression, for example
289
290 @example
291   \new @var{type} @var{music expression}
292 @end example
293
294 @noindent
295 where @var{type} is a context name (like @code{Staff} or
296 @code{Voice}).  This command creates a new context, and starts
297 interpreting @var{music expression} with that.
298
299 A practical application of @code{\new} is a score with many
300 staves. Each part that should be on its own staff, gets a @code{\new
301 Staff}.
302
303 @lilypond[verbatim,relative=2,raggedright]
304   << \new Staff { c4 c }
305      \new Staff { d4 d }
306   >>
307 @end lilypond
308
309 Like @code{\new}, the @code{\context} command also directs a music
310 expression to a context object, but gives the context an extra name. The
311 syntax is
312
313 @example
314   \context @var{type} = @var{id} @var{music}
315 @end example
316
317 This form will search for an existing context of type @var{type}
318 called @var{id}. If that context does not exist yet, it is created.
319 This is useful if the context referred to later on. For example, when
320 setting lyrics the melody is in a named context
321
322 @example
323  \context Voice = "@b{tenor}" @var{music}
324 @end example
325
326 @noindent
327 so the texts can be properly aligned to its notes,
328
329 @example
330 \new Lyrics \lyricsto "@b{tenor}" @var{lyrics} 
331 @end example
332
333 @noindent
334
335 Another possibility is funneling two different music expressions into
336 one context. In the following example, articulations and notes are
337 entered separately,
338
339 @verbatim
340 music = \notes { c4 c4 }
341 arts = \notes  { s4-. s4-> }
342 @end verbatim
343
344 They are combined by sending both to the same @context{Voice} context,
345
346 @verbatim
347   << \new Staff \context Voice = "A" \music
348      \context Voice = "A" \arts
349   >>
350 @end verbatim
351 @lilypond[raggedright]
352 music = \notes { c4 c4 }
353 arts = \notes  { s4-. s4-> }
354 \score {
355        \notes \relative c''  << \new Staff \context Voice = "A" \music
356      \context Voice = "A" \arts
357   >>
358
359 @end lilypond
360
361
362
363 The third command for creating contexts is
364 @example
365   \context @var{type} @var{music}
366 @end example
367
368
369 @noindent
370 This is similar to @code{\context} with @code{= @var{id}}, but matches
371 any context of type @var{type}, regardless of its given name.
372
373 This variant is used with music expressions that can be interpreted at
374 several levels. For example, the @code{\applyoutput} command (see
375 @ref{Running a function on all layout objects}). Without an explicit
376 @code{\context}, it is usually is applied to @context{Voice}
377
378 @example
379   \applyoutput #@var{function}   % apply to Voice
380 @end example
381
382 To have it interpreted at @context{Score} or @context{Staff} level use
383 these forms
384
385 @example
386   \context Score \applyoutput #@var{function}
387   \context Staff \applyoutput #@var{function}
388 @end example
389
390
391 @node Changing context properties on the fly 
392 @subsection Changing context properties  on the fly
393
394 Each context can have different @emph{properties}, variables contained
395 in that context. They can be changed during the interpretation step.
396 This is achieved by inserting the @code{\set} command in the music,
397
398 @quotation
399   @code{\set } @var{context}@code{.}@var{prop}@code{ = #}@var{value} 
400 @end quotation
401
402 For example,
403 @lilypond[verbatim,relative=2]
404   R1*2 
405   \set Score.skipBars = ##t
406   R1*2
407 @end lilypond
408
409 This command skips measures that have no notes. The result is that
410 multi rests are condensed.  The value assigned is a Scheme object. In
411 this case, it is @code{#t}, the boolean True value.
412
413 If the @var{context} argument is left out, then the current bottom-most
414 context (typically @context{ChordNames}, @context{Voice} or
415 @context{Lyrics}) is used.  In this example,
416
417 @lilypond[verbatim,relative=2]
418   c8 c c c
419   \set autoBeaming = ##f
420   c8 c c c
421 @end lilypond
422
423 @noindent
424 the @var{context} argument to @code{\set} is left out, and the current
425 @internalsref{Voice} is used.
426
427 Contexts are hierarchical, so if a bigger context was specified, for
428 example @context{Staff}, then the change would also apply to all
429 @context{Voice}s in the current stave. The change is applied
430 `on-the-fly', during the music, so that the setting only affects the
431 second group of eighth notes.
432
433 There is also an @code{\unset} command,
434 @quotation
435   @code{\set }@var{context}@code{.}@var{prop}
436 @end quotation
437
438 @noindent
439 which removes the definition of @var{prop}. This command only removes
440 the definition if it is set in @var{context}. In
441
442 @example
443   \set Staff.autoBeaming = ##f
444   \unset Voice.autoBeaming
445 @end example
446
447 @noindent
448 the current @context{Voice} does not have the property, and the
449 definition at @context{Staff} level remains intact. Like @code{\set},
450 the @var{context} argument does not have to be specified for a bottom
451 context.
452
453 Settings that should only apply to a single time-step can be entered
454 easily with @code{\once}, for example in
455
456 @lilypond[verbatim,relative=2]
457   c4
458   \once \set fontSize = #4.7
459   c4
460   c4
461 @end lilypond
462
463 the property @code{fontSize} is unset automatically after the second
464 note.
465
466 A full description of all available context properties is in the
467 program reference, see
468 @ifhtml
469 @internalsref{Tunable-context-properties}.
470 @end ifhtml
471 @ifnothtml
472 Translation @arrow{} Tunable context properties.
473 @end ifnothtml
474
475
476 @node Modifying context plug-ins
477 @subsection Modifying context plug-ins
478
479 Notation contexts (like Score and Staff) not only store properties,
480 they also contain plug-ins, called ``engravers'' that create notation
481 elements. For example, the Voice context contains a
482 @code{Note_head_engraver} and the Staff context contains a
483 @code{Key_signature_engraver}.
484
485 For a full a description of each plug-in, see 
486 @ifhtml
487 @internalsref{Engravers}
488 @end ifhtml
489 @ifnothtml
490 Program reference @arrow Translation @arrow{} Engravers.
491 @end ifnothtml
492 Every context described in
493 @ifhtml
494 @internalsref{Contexts}
495 @end ifhtml
496 @ifnothtml 
497 Program reference @arrow Translation @arrow{} Context.
498 @end ifnothtml
499 lists the engravers used for that context.
500
501
502 It can be useful to shuffle around these plug-ins. This is done by
503 starting a new context, with @code{\new} or @code{\context}, and
504 modifying it like this, 
505
506 @example
507  \new @var{context} \with @{
508    \consists @dots{}
509    \consists @dots{}
510    \remove  @dots{}
511    \remove @dots{}
512    @emph{etc.}
513  @}
514  @var{..music..}
515 @end example
516
517 where the @dots{} should be the name of an engraver. Here is a simple
518 example which removes @code{Time_signature_engraver} and
519 @code{Clef_engraver} from a @code{Staff} context,
520
521 @lilypond[relative=1, verbatim]
522 << \new Staff {
523     f2 g
524   }
525   \new Staff \with {
526      \remove "Time_signature_engraver"
527      \remove "Clef_engraver"
528   } {
529     f2 g2
530   }
531 >>
532 @end lilypond
533
534 In the second stave there are no time signature or clef symbols.  This
535 is a rather crude method of making objects disappear, it will affect
536 the entire staff. The spacing will be adversely influenced too. A more
537 sophisticated methods of blanking objects is shown in @ref{Common
538 tweaks}.
539
540 The next example shows a practical application.  Bar lines and time
541 signatures are normally synchronized across the score.  This is done
542 by the @code{Timing_engraver}. This plug-in keeps an administration of
543 time signature, location within the measure, etc. By moving the
544 @code{Timing_engraver} engraver from Score to Staff context, we can
545 have score where each staff has its own time signature.
546
547 @cindex polymetric scores
548
549
550 @lilypond[relative=1,raggedright,verbatim]
551 \new Score \with {
552   \remove "Timing_engraver"
553 } <<
554   \new Staff \with {
555     \consists "Timing_engraver"
556   } {
557       \time 3/4
558       c4 c c c c c
559   }
560   \new Staff \with {
561     \consists "Timing_engraver"
562   } {
563        \time 2/4
564        c4 c c c c c
565   }
566 >>
567 @end lilypond
568
569
570 @node Layout tunings within contexts
571 @subsection Layout tunings within contexts
572
573 Each context is responsible for creating certain types of graphical
574 objects. The settings used for printing these objects are also stored by
575 context. By changing these settings, the appearance of objects can be
576 altered.
577  
578 The syntax for this is
579
580 @example
581   \override @var{context}.@var{name}@code{ #'}@var{property} = #@var{value}
582 @end example
583
584 Here @var{name} is the name of a graphical object, like @code{Stem} or
585 @code{NoteHead}.  @var{property} is an internal variable of the
586 formatting system (`grob property' or `layout property'). It is a
587 symbol, so it must be quoted. The subsection @ref{Constructing a
588 tweak} explains what to fill in for @var{name}, @var{property} and
589 @var{value}. Here we only discuss functionality of this command.
590
591 The command
592
593 @verbatim
594   \override Staff.Stem #'thickness = #4.0 
595 @end verbatim
596
597 @noindent
598 makes stems thicker (the default is 1.3, with staff line thickness as a
599 unit). Since the command specifies @context{Staff} as context, it only
600 applies to the current staff. Other staves will keep their normal
601 appearance.  Here we see the command in action:
602
603 @lilypond[verbatim,relative=2]
604   c4
605   \override Staff.Stem #'thickness = #4.0 
606   c4
607   c4
608   c4
609 @end lilypond
610
611 The @code{\override} command is executed during the interpreting phase,
612 and changes the definition of the @code{Stem} within
613 @context{Staff}. After the command all stems are thickened.
614
615 Analogous to @code{\set}, the @var{context} argument may be left out,
616 causing it to default to @context{Voice} and adding @code{\once} applies
617 the change during only one timestep
618
619 @lilypond[verbatim,relative=2]
620   c4
621   \once \override Stem #'thickness = #4.0 
622   c4
623   c4 
624 @end lilypond
625
626 The @code{\override} must be done before the object is
627 started. Therefore, when altering @emph{Spanner} objects, like slurs or
628 beams, the @code{\override} command must be executed at the moment that
629 the object is created. In this example,
630
631
632 @lilypond[verbatim,relative=2]
633   \override Slur #'thickness = #3.0
634   c8[( c
635   \override Beam #'thickness = #0.6
636   c8 c]) 
637 @end lilypond
638
639 @noindent
640 the slur is fatter and the beam is not. This is because the command for
641 @code{Beam} comes after the Beam is started. Therefore it has no effect.
642
643 Analogous to @code{\unset}, the @code{\revert} command for a context
644 undoes a @code{\override} command; like with @code{\unset}, it only
645 affects settings that were made in the same context. In other words, the
646 @code{\revert} in the next example does not do anything.
647
648 @verbatim
649   \override Voice.Stem #'thickness = #4.0
650   \revert Staff.Stem #'thickness
651 @end verbatim
652
653
654
655
656 @seealso
657
658 Internals: @internalsref{OverrideProperty}, @internalsref{RevertProperty},
659 @internalsref{PropertySet}, @internalsref{All-backend-properties}, and
660 @internalsref{All-layout-objects}.
661
662
663 @refbugs
664
665 The back-end is not very strict in type-checking object properties.
666 Cyclic references in Scheme values for properties can cause hangs
667 and/or crashes.
668
669
670 @node Changing context default settings
671 @subsection Changing context default settings
672
673 The adjustments of the previous chapters can also be entered separate
674 from the music, in the @code{\paper} block,
675
676 @example
677   \paper @{
678      @dots{}
679      \context @{
680         \StaffContext
681
682         \set fontSize = #-2
683         \override Stem #'thickness
684         \remove "Time_signature_engraver"
685       @}
686    @}
687 @end example
688
689 This
690 @example
691   \StaffContext
692 @end example
693
694 @noindent
695 takes the existing definition @context{Staff} from the identifier
696 @code{StaffContext}. This works analogously other contexts, so the
697 existing definition  of @code{Voice} is in 
698 @code{\VoiceContext}.
699
700 The statements
701 @example
702         \set fontSize = #-2
703         \override Stem #'thickness
704         \remove "Time_signature_engraver"
705 @end example
706
707 @noindent
708 affect all staves in the score.
709
710 The @code{\set} keyword is optional within the @code{\paper} block, so
711
712 @example
713   fontSize = #-2
714 @end example
715
716 @noindent
717 will also work.
718
719
720
721 @refbugs
722
723 It is not possible to collect changes in a variable, and apply them to
724 one @code{\context} definition by referencing that variable.
725
726
727 @node Defining new  contexts
728 @subsection Defining new  contexts
729
730 Specific contexts, like @context{Staff} and @code{Voice} are made of
731 simple building blocks, and it is possible to compose engraver
732 plug-ins in different combinations, thereby creating new types of
733 contexts.
734
735 The next example shows how to build a different type of
736 @context{Voice} context from scratch.  It will be similar to
737 @code{Voice}, but print centered slash noteheads only. It can be used
738 to indicate improvisation in Jazz pieces,
739
740 @lilypond[raggedright]
741   \paper { \context {
742     \name ImproVoice
743     \type "Engraver_group_engraver"
744     \consists "Note_heads_engraver"
745     \consists "Text_engraver"
746     \consists Pitch_squash_engraver
747     squashedPosition = #0
748     \override NoteHead #'style = #'slash
749     \override Stem #'transparent = ##t
750     \alias Voice
751   }
752   \context { \StaffContext
753     \accepts "ImproVoice"
754   }}
755   \score { \notes \relative c'' {
756     a4 d8 bes8 \new ImproVoice { c4^"ad lib" c 
757      c4 c^"undress" c_"while playing :)" c } 
758     a1 
759   }}
760 @end lilypond
761
762
763 These settings are again done within a @code{\context} block inside a
764 @code{\paper} block,
765
766 @example
767   \paper @{
768     \context @{
769       @dots{}
770     @}
771   @}
772 @end example
773
774 In the following discussion, the example input shown should go on the
775 @dots{} of the previous fragment.
776
777 First, name the context gets a name. Instead of @context{Voice} it
778 will be called @context{ImproVoice},
779
780 @verbatim
781   \name ImproVoice
782 @end verbatim
783
784 Since it is similar to the @context{Voice}, we want commands that work
785 on (existing) @context{Voice}s to remain working. This is achieved by
786 giving the new context an alias @context{Voice},
787
788 @verbatim
789   \alias Voice
790 @end verbatim
791
792 The context will print notes, and instructive texts
793
794 @verbatim
795   \consists Note_heads_engraver
796   \consists Text_engraver
797 @end verbatim
798
799 but only on the center line,
800
801 @verbatim
802   \consists Pitch_squash_engraver
803   squashedPosition = #0
804 @end verbatim
805
806 The @internalsref{Pitch_squash_engraver} modifies note heads (created
807 by @internalsref{Note_heads_engraver}) and sets their vertical
808 position to the value of @code{squashedPosition}, in this case
809 @code{0}, the center line.
810
811 The notes look like a  slash, without a stem,
812
813 @verbatim
814     \override NoteHead #'style = #'slash
815     \override Stem #'transparent = ##t
816 @end verbatim
817
818
819 All these plug-ins have to cooperate, and this is achieved with a
820 special plug-in, which must be marked with the keyword @code{\type}.
821 This should always be @internalsref{Engraver_group_engraver},
822
823 @example
824  \type "Engraver_group_engraver"
825 @end example
826
827 Put together, we get
828
829 @verbatim
830   \context {
831     \name ImproVoice
832     \type "Engraver_group_engraver"
833     \consists "Note_heads_engraver"
834     \consists "Text_script_engraver"
835     \consists Pitch_squash_engraver
836     squashedPosition = #0
837     \override NoteHead #'style = #'slash
838     \override Stem #'transparent = ##t
839     \alias Voice
840   }
841 @end verbatim
842
843 Contexts form hierarchies. We want to hang the @context{ImproVoice}
844 under @context{Staff}, just like normal @code{Voice}s. Therefore, we
845 modify the @code{Staff} definition with the @code{\accepts}
846 command,@footnote{The opposite of @code{\accepts} is @code{\denies},
847 which is sometimes when reusing existing context definitions. }
848
849
850
851 @verbatim
852   \context {
853     \StaffContext
854     \accepts ImproVoice    
855   }
856 @end verbatim 
857
858 Putting both into a @code{\paper} block, like
859
860 @example
861   \paper @{
862     \context @{
863       \name ImproVoice
864       @dots{}
865     @}
866   \context @{
867     \StaffContext
868     \accepts "ImproVoice"
869   @}
870 @}
871 @end example
872
873 Then the output at the start of this subsection can be entered as
874
875 @verbatim
876 \score {
877   \notes \relative c'' {
878      a4 d8 bes8
879      \new ImproVoice {
880        c4^"ad lib" c 
881        c4 c^"undress"
882        c c_"while playing :)"
883      }
884      a1 
885   }
886 }
887 @end verbatim
888   
889
890     
891 @node Which properties to change
892 @subsection Which properties to change
893
894
895 There are many different properties.  Not all of them are listed in
896 this manual. However, the program reference lists them all in the
897 section @internalsref{Context-properties}, and most properties are
898 demonstrated in one of the
899 @ifhtml
900 @uref{../../../input/test/out-www/collated-files.html,tips-and-tricks}
901 @end ifhtml
902 @ifnothtml
903 tips-and-tricks
904 @end ifnothtml
905 examples.
906
907
908 @node Tuning output
909 @section Tuning output
910
911 In the previous section, we have already touched on a command that
912 changes layout details, the @code{\override} command. In this section,
913 we will look at in more detail how to use the command in practice.
914 First, we will give a a few versatile commands, which are sufficient
915 for many situations. The next section will discuss general use of
916 @code{\override}.
917
918
919
920 -nmost adjustments simply
921
922
923
924 The commands changes 
925
926
927 There are situations where default layout decisions are not
928 sufficient.  In this section we discuss ways to override these
929 defaults.
930
931 Formatting is internally done by manipulating so called objects
932 (graphic objects). Each object carries with it a set of properties
933 (object or layout properties) specific to that object.  For example, a
934 stem object has properties that specify its direction, length and
935 thickness.
936
937 The most direct way of tuning the output is by altering the values of
938 these properties. There are two ways of doing that: first, you can
939 temporarily change the definition of one type of object, thus
940 affecting a whole set of objects.  Second, you can select one specific
941 object, and set a layout property in that object.
942
943 Do not confuse layout properties with translation
944 properties. Translation properties always use a mixed caps style
945 naming, and are manipulated using @code{\set} and @code{\unset}: 
946 @example
947   \set Context.propertyName = @var{value}
948 @end example
949
950 Layout properties are use Scheme style variable naming, i.e.  lower
951 case words separated with dashes. They are symbols, and should always
952 be quoted using @code{#'}.  For example, this could be an imaginary
953 layout property name:
954 @example
955   #'layout-property-name
956 @end example
957
958
959 @menu
960 * Common tweaks::               
961 * Constructing a tweak::        
962 * Navigating the program reference::  
963 * Layout interfaces::           
964 * Determining the grob property::  
965 @end menu
966
967
968
969 @node Common tweaks
970 @subsection Common tweaks
971
972 Some overrides are so common that predefined commands are provided as
973 a short cut.  For example, @code{\slurUp} and @code{\stemDown}. These
974 commands are described in
975 @ifhtml
976 the
977 @end ifhtml
978 @ref{Notation manual}, under the sections for slurs and stems
979 respectively.
980
981 The exact tuning possibilities for each type of layout object are
982 documented in the program reference of the respective
983 object. However, many layout objects share properties, which can be
984 used to apply generic tweaks.  We mention a couple of these:
985
986 @itemize @bullet
987 @item The @code{extra-offset} property, which
988 @cindex @code{extra-offset}
989 has a pair of numbers as value, moves around objects in the printout.
990 The first number controls left-right movement; a positive number will
991 move the object to the right.  The second number controls up-down
992 movement; a positive number will move it higher.  The units of these
993 offsets are staff-spaces.  The @code{extra-offset} property is a
994 low-level feature: the formatting engine is completely oblivious to
995 these offsets.
996
997 In the following example, the second fingering is moved a little to
998 the left, and 1.8 staff space downwards:
999
1000 @cindex setting object properties
1001
1002 @lilypond[relative=1,verbatim]
1003 \stemUp
1004 f-5
1005 \once \override Fingering
1006     #'extra-offset = #'(-0.3 . -1.8) 
1007 f-5
1008 @end lilypond
1009
1010 @item
1011 Setting the @code{transparent} property will cause an object to be printed
1012 in `invisible ink': the object is not printed, but all its other
1013 behavior is retained. The object still takes up space, it takes part in
1014 collisions, and slurs, and ties and beams can be attached to it.
1015
1016 @cindex transparent objects
1017 @cindex removing objects
1018 @cindex hiding objects
1019 @cindex invisible objects
1020 The following example demonstrates how to connect different voices
1021 using ties. Normally, ties only connect two notes in the same
1022 voice. By introducing a tie in a different voice,
1023
1024 @lilypond[fragment,relative=2]
1025   << {
1026       b8~ b8\noBeam
1027   } \\ {
1028        b[ g8]
1029   } >>
1030 @end lilypond
1031
1032 @noindent
1033 and blanking a stem in that voice, the tie appears to cross voices:
1034
1035 @lilypond[fragment,relative=2,verbatim]
1036   << {
1037       \once \override Stem #'transparent = ##t
1038       b8~ b8\noBeam
1039   } \\ {
1040        b[ g8]
1041   } >>
1042 @end lilypond
1043
1044 @item
1045 The @code{padding} property for objects with
1046 @cindex @code{padding}
1047 @code{side-position-interface} can be set to increase distance between
1048 symbols that are printed above or below notes. We only give an
1049 example; a more elaborate explanation is in @ref{Constructing a
1050 tweak}:
1051
1052 @lilypond[relative=1,verbatim]
1053   c2\fermata
1054   \override Script #'padding = #3
1055   b2\fermata
1056 @end lilypond
1057
1058 @end itemize
1059
1060 More specific overrides are also possible.  The following section
1061 discusses in depth how to figure out these statements for yourself.
1062
1063
1064 @node Constructing a tweak
1065 @subsection Constructing a tweak
1066
1067 The general procedure of changing output, that is, entering
1068 a command like
1069
1070 @example
1071         \override Voice.Stem #'thickness = #3.0
1072 @end example
1073
1074 @noindent
1075 means that we have to determine these bits of information:
1076
1077 @itemize
1078 @item The context, here: @context{Voice}.
1079 @item The layout object, here @code{Stem}.
1080 @item The layout property, here @code{thickness}
1081 @item A sensible value, here @code{3.0}
1082 @end itemize  
1083
1084
1085 @cindex internal documentation
1086 @cindex finding graphical objects
1087 @cindex graphical object descriptions 
1088 @cindex tweaking
1089 @cindex @code{\override}
1090 @cindex @code{\set}
1091 @cindex internal documentation
1092
1093 We demonstrate how to glean this information from the notation manual
1094 and the program reference.
1095
1096 The program reference is a set of HTML pages, which is part of the
1097 documentation package. On Unix systems, it is is typically in
1098 @file{/usr/share/doc/lilypond}, if you have them, it is best to
1099 bookmark them in your webbrowser, because you will need them.  They
1100 are also available on the web: go to the
1101 @uref{http://lilypond.org,LilyPond website}, click ``Documentation'',
1102 select the correct version, and then click ``Program reference.''
1103
1104 If you have them, use the local HTML files.  They will load faster,
1105 and they are exactly matched to LilyPond version installed.
1106  
1107
1108 @node Navigating the program reference
1109 @subsection Navigating the program reference
1110
1111 Suppose we want to move the fingering indication in the fragment
1112 below:
1113
1114 @lilypond[relative=2,verbatim]
1115 c-2
1116 \stemUp
1117 f
1118 @end lilypond
1119
1120 If you visit the documentation of @code{Fingering} (in @ref{Fingering
1121 instructions}), you will notice that there is written:
1122
1123 @quotation
1124 @seealso
1125
1126 Program reference: @internalsref{FingerEvent} and @internalsref{Fingering}.
1127
1128 @end quotation
1129
1130 This  fragments points to two parts of the program reference: a page
1131 on @code{FingerEvent} and @code{Fingering}.
1132
1133 The page on  @code{FingerEvent} describes the properties of the  music
1134 expression for the input @code{-2}. The page contains many links
1135 forward.  For example, it says
1136
1137 @quotation
1138   Accepted by: @internalsref{Fingering_engraver},
1139 @end quotation 
1140
1141 @noindent
1142 That link brings us to the documentation for the Engraver, the
1143 plug-in, which says
1144
1145 @quotation
1146   This engraver creates the following layout objects: @internalsref{Fingering}.
1147 @end quotation
1148
1149 In other words, once the @code{FingerEvent}s are interpreted, the
1150 @code{Fingering_engraver} plug-in will process them.
1151 The @code{Fingering_engraver} is also listed to create
1152 @internalsref{Fingering} objects,
1153
1154
1155   Lo and behold, that is also the
1156 second bit of information listed under @b{See also} in the Notation
1157 manual. By clicking around in the program reference, we can follow the
1158 flow of information within the program, either forward (like we did
1159 here), or backwards, following links like this:
1160
1161 @itemize @bullet
1162
1163 @item @internalsref{Fingering}:
1164   @internalsref{Fingering} objects are created by:
1165   @b{@internalsref{Fingering_engraver}}
1166
1167 @item @internalsref{Fingering_engraver}:
1168 Music types accepted: @b{@internalsref{fingering-event}}
1169 @item @internalsref{fingering-event}:
1170 Music event type @code{fingering-event} is in Music objects of type
1171 @b{@internalsref{FingerEvent}}
1172 @end itemize
1173
1174 This path goes against the flow of information in the program: it
1175 starts from the output, and ends at the input event.
1176
1177 The program reference can also be browsed like a normal document.  It
1178 contains a chapter on @internalsref{Music definitions}, on
1179 @internalsref{Translation}, and the @internalsref{Backend}. Every
1180  chapter lists all the definitions used, and all properties that may
1181  be tuned. 
1182
1183  
1184 @node Layout interfaces
1185 @subsection Layout interfaces
1186
1187 @internalsref{Fingering} is a layout object. Such an object is a
1188 symbol within the score. It has properties, which store numbers (like
1189 thicknesses and directions), but also pointers to related objects.
1190 A layout object is also called @emph{grob},
1191 @cindex grob
1192 which is short for Graphical Object.
1193
1194
1195 The page for @code{Fingering} lists the definitions for the
1196 @code{Fingering} object. For example, the page says
1197
1198 @quotation
1199   @code{padding} (dimension, in staff space):
1200   
1201   @code{0.6}
1202 @end quotation
1203
1204 which means that the number will be kept at a distance of at least 0.6
1205 of the note head.
1206
1207
1208 Each layout object may have several functions as a notational or
1209 typographical element. For example, the Fingering object
1210 has the following aspects
1211
1212 @itemize @bullet
1213 @item Its size is independent of the horizontal spacing, unlike slurs or beams
1214
1215 @item It is a piece of text. Granted, it's usually  a very short text.
1216
1217 @item That piece of text is set in a font, unlike slurs or beams.
1218 @item Horizontally, the center of the symbol should be aligned to the
1219 center of the notehead
1220 @item Vertically, the symbol is placed next to the note and the staff.
1221
1222 @item The
1223  vertical position is also coordinated with other super and subscript
1224 symbols
1225 @end itemize
1226
1227 Each of these aspects is captured in a so-called @emph{interface},
1228 which are listed on the @internalsref{Fingering} page at the bottom
1229
1230 @quotation
1231 This object supports the following interfaces:
1232 @internalsref{item-interface},
1233 @internalsref{self-alignment-interface},
1234 @internalsref{side-position-interface}, @internalsref{text-interface},
1235 @internalsref{text-script-interface}, @internalsref{font-interface},
1236 @internalsref{finger-interface} and @internalsref{grob-interface}
1237 @end quotation
1238
1239 Clicking any of the links will take you to the page of the respective
1240 object interface.  Each interface has a number of properties.  Some of
1241 them are not user-serviceable (``Internal properties''), but others
1242 are.
1243
1244 We have been talking of `the' @code{Fingering} object, but actually it
1245 does  not amount to much. The initialization file
1246 @file{scm/define-grobs.scm} shows the soul of the `object',
1247
1248 @verbatim
1249    (Fingering
1250      . (
1251         (print-function . ,Text_item::print)
1252         (padding . 0.6)
1253         (staff-padding . 0.6)
1254         (self-alignment-X . 0)
1255         (self-alignment-Y . 0)
1256         (script-priority . 100)
1257         (font-encoding . number)
1258         (font-size . -5)
1259         (meta . ((interfaces . (finger-interface font-interface
1260                text-script-interface text-interface
1261                side-position-interface self-alignment-interface
1262                item-interface))))
1263   ))
1264 @end verbatim
1265
1266 as you can see, @code{Fingering} is nothing more than a bunch of
1267 variable settings, and the webpage is directly generated from this
1268 definition.
1269
1270 @node Determining the grob property
1271 @subsection Determining the grob property
1272
1273
1274 Recall that we wanted to change the position of the @b{2} in 
1275
1276 @lilypond[relative=2,verbatim]
1277 c-2
1278 \stemUp
1279 f
1280 @end lilypond
1281
1282 Since the @b{2} is vertically positioned next to its note, we have to
1283 meddle with the interface associated with this positioning. This is
1284 done by @code{side-position-interface}. The page for this interface says
1285
1286 @quotation
1287 @code{side-position-interface}
1288
1289   Position a victim object (this one) next to other objects (the
1290   support).  The property @code{direction} signifies where to put the
1291   victim object relative to the support (left or right, up or down?)
1292 @end quotation
1293
1294 @cindex padding
1295 @noindent
1296 below this description, the variable @code{padding} is described as
1297 @quotation
1298 @table @code
1299 @item padding
1300  (dimension, in staff space)
1301
1302  add this much extra space between objects that are next to each
1303   other. 
1304 @end table
1305 @end quotation
1306
1307 By increasing the value of @code{padding}, we can move away the
1308 fingering.  The following command inserts 3 staff spaces of white
1309 between the note and the fingering:
1310 @example
1311 \once \override Fingering #'padding = #3
1312 @end example
1313
1314 Inserting this command before the Fingering object is created,
1315 i.e. before @code{c2}, yields the following result:
1316
1317 @lilypond[relative=2,fragment,verbatim]
1318 \once \override Fingering
1319     #'padding = #3
1320 c-2
1321 \stemUp
1322 f
1323 @end lilypond
1324
1325
1326 In this case, the context for this tweak is @context{Voice}, which
1327 does not have to be specified for @code{\override}.  This fact can
1328 also be deduced from the program reference, for the page for the
1329 @internalsref{Fingering_engraver} plug-in says
1330
1331 @quotation
1332   Fingering_engraver is part of contexts: @dots{} @b{@internalsref{Voice}}
1333 @end quotation
1334
1335
1336 @node Fonts
1337 @section Fonts
1338
1339 @menu
1340 * Selecting font sizes::        
1341 * Font selection::              
1342 @end menu
1343
1344
1345
1346 @node Selecting font sizes
1347 @subsection Selecting font sizes
1348
1349 The most common thing to change about the appearance of fonts is their
1350 size. The font size of any context can be easily changed by setting
1351 the @code{fontSize} property for that context.  Its value is a number:
1352 negative numbers make the font smaller, positive numbers larger. An
1353 example is given below:
1354 @c
1355 @lilypond[fragment,relative=1,verbatim]
1356   c4 c4 \set fontSize = #-3
1357   f4 g4
1358 @end lilypond
1359 This command will set @code{font-size} (see below) in all layout
1360 objects in the current context. It does not change the size of
1361 variable symbols, such as beams or slurs.
1362
1363 The font size is set by modifying the @code{font-size} property.  Its
1364 value is a number indicating the size relative to the standard size.
1365 Each step up is an increase of approximately 12% of the font size. Six
1366 steps is exactly a factor two. The Scheme function @code{magstep}
1367 converts a @code{font-size} number to a scaling factor.
1368
1369 LilyPond has fonts in different design sizes: the music fonts for
1370 smaller sizes are chubbier, while the text fonts are relatively wider.
1371 Font size changes are achieved by scaling the design size that is
1372 closest to the desired size.
1373
1374 The @code{font-size} mechanism does not work for fonts selected
1375 through @code{font-name}. These may be scaled with
1376 @code{font-magnification}.
1377
1378
1379 One of the uses of @code{fontSize} is to get smaller symbols for cue
1380 notes. An elaborate example of those is in
1381 @inputfileref{input/test,cue-notes.ly}.
1382
1383 @cindex @code{font-style}
1384
1385 @refcommands
1386
1387 The following commands set @code{fontSize} for the current voice.
1388
1389 @cindex @code{\tiny}
1390 @code{\tiny}, 
1391 @cindex @code{\small}
1392 @code{\small}, 
1393 @cindex @code{\normalsize}
1394 @code{\normalsize}.
1395
1396
1397
1398 @cindex magnification
1399 @cindex cue notes
1400
1401
1402 @node Font selection
1403 @subsection Font selection
1404
1405 Font selection for the standard fonts, @TeX{}'s Computer Modern fonts,
1406 can also be adjusted with a more fine-grained mechanism.  By setting
1407 the object properties described below, you can select a different font;
1408 all three mechanisms work for every object that supports
1409 @code{font-interface}:
1410
1411
1412 @itemize @bullet
1413 @item @code{font-encoding}
1414 is a symbol that sets layout of the glyphs. Choices include
1415 @code{text} for normal text, @code{braces} (for piano staff braces),
1416 @code{music} (the standard music font, including ancient glyphs),
1417 @code{dynamic} (for dynamic signs) and @code{number} for the number
1418 font.
1419
1420
1421 @item @code{font-family}
1422  is a symbol indicating the general class of the typeface.  Supported are
1423 @code{roman} (Computer Modern), @code{sans} and @code{typewriter}
1424   
1425 @item @code{font-shape}
1426   is a symbol indicating the shape of the font, there are typically
1427 several font shapes available for each font family. Choices are
1428 @code{italic}, @code{caps} and @code{upright}.
1429
1430 @item @code{font-series}
1431 is a  symbol indicating the series of the font. There are typically several
1432 font series for each font family and shape. Choices are @code{medium}
1433 and @code{bold}. 
1434
1435 @end itemize
1436
1437 Fonts selected in the way sketched above come from a predefined style
1438 sheet.
1439
1440  The font used for printing a object can be selected by setting
1441 @code{font-name}, e.g.
1442 @example
1443   \override Staff.TimeSignature
1444       #'font-name = #"cmr17"
1445 @end example
1446
1447 @noindent
1448 Any font can be used, as long as it is available to @TeX{}. Possible
1449 fonts include foreign fonts or fonts that do not belong to the
1450 Computer Modern font family.  The size of fonts selected in this way
1451 can be changed with the @code{font-magnification} property.  For
1452 example, @code{2.0} blows up all letters by a factor 2 in both
1453 directions.
1454
1455 @cindex font size
1456 @cindex font magnification
1457
1458
1459
1460 @seealso
1461
1462 Init files: @file{ly/declarations-init.ly} contains hints how new
1463 fonts may be added to LilyPond.
1464
1465 @refbugs
1466
1467 No style sheet is provided for other fonts besides the @TeX{}
1468 Computer Modern family.
1469
1470 @cindex font selection
1471 @cindex font magnification
1472 @cindex @code{font-interface}
1473
1474
1475 @node Text markup
1476 @section Text markup
1477 @cindex text markup
1478 @cindex markup text
1479
1480
1481 @cindex typeset text
1482
1483 LilyPond has an internal mechanism to typeset texts. You can access it
1484 with the keyword @code{\markup}. Within markup mode, you can enter texts
1485 similar to lyrics: simply enter them, surrounded by spaces:
1486 @cindex markup
1487
1488 @lilypond[verbatim,fragment,relative=1]
1489  c1^\markup { hello }
1490  c1_\markup { hi there }
1491  c1^\markup { hi \bold there, is \italic anyone home? }
1492 @end lilypond
1493
1494 @cindex font switching
1495
1496 The markup in the example demonstrates font switching commands.  The
1497 command @code{\bold} and @code{\italic} only apply to the first
1498 following word; enclose a set of texts with braces to apply a command
1499 to more words:
1500 @example
1501   \markup @{ \bold @{ hi there @} @}
1502 @end example
1503
1504 @noindent
1505 For clarity, you can also do this for single arguments, e.g.
1506
1507 @verbatim
1508   \markup { is \italic { anyone } home }
1509 @end verbatim
1510
1511 @cindex font size, texts
1512
1513
1514 In markup mode you can compose expressions, similar to mathematical
1515 expressions, XML documents and music expressions.  The braces group
1516 notes into horizontal lines. Other types of lists also exist: you can
1517 stack expressions grouped with @code{<}, and @code{>} vertically with
1518 the command @code{\column}. Similarly, @code{\center-align} aligns
1519 texts by their center lines:
1520
1521 @lilypond[verbatim,fragment,relative=1]
1522  c1^\markup { \column < a bbbb c > }
1523  c1^\markup { \center-align < a bbbb c > }
1524  c1^\markup { \line < a b c > }
1525 @end lilypond
1526
1527
1528 Markups can be stored in variables, and these variables
1529 may be attached to notes, like
1530 @verbatim
1531 allegro = \markup { \bold \large { Allegro } }
1532 \notes { a^\allegro b c d }
1533 @end verbatim
1534
1535
1536 Some objects have alignment procedures of their own, which cancel out
1537 any effects of alignments applied to their markup arguments as a
1538 whole.  For example, the @internalsref{RehearsalMark} is horizontally
1539 centered, so using @code{\mark \markup @{ \left-align .. @}} has no
1540 effect.
1541
1542 Similarly, for moving whole texts over notes with
1543 @code{\raise}, use the following trick:
1544 @example
1545   "" \raise #0.5 raised
1546 @end example
1547
1548 The text @code{raised} is now raised relative to the empty string
1549 @code{""} which is not visible.  Alternatively, complete objects can
1550 be moved with layout properties such as @code{padding} and
1551 @code{extra-offset}.
1552
1553
1554
1555 @seealso
1556
1557 Init files:  @file{scm/new-markup.scm}.
1558
1559
1560 @refbugs
1561
1562 Text layout is ultimately done by @TeX{}, which does kerning of
1563 letters.  LilyPond does not account for kerning, so texts will be
1564 spaced slightly too wide.
1565
1566 Syntax errors for markup mode are confusing.
1567
1568 Markup texts cannot be used in the titling of the @code{\header}
1569 field. Titles are made by La@TeX{}, so La@TeX{} commands should be used
1570 for formatting.
1571
1572
1573
1574 @menu
1575 * Overview of text markup commands::  
1576 @end menu
1577
1578 @node  Overview of text markup commands
1579 @subsection Overview of text markup commands
1580
1581 @include markup-commands.tely
1582
1583
1584 @node Global layout
1585 @section Global layout
1586
1587 The global layout determined by three factors: the page layout, the
1588 line breaks and the spacing. These all influence each other. The
1589 choice of spacing determines how densely each system of music is set,
1590 which influences where line breaks breaks are chosen, and thus
1591 ultimately how many pages a piece of music takes. This section
1592 explains how to tune the algorithm for spacing.
1593
1594 Globally spoken, this procedure happens in three steps: first,
1595 flexible distances (``springs'') are chosen, based on durations. All
1596 possible line breaking combination are tried, and the one with the
1597 best results---a layout that has uniform density and requires as
1598 little stretching or cramping as possible---is chosen. When the score
1599 is processed by @TeX{}, each page is filled with systems, and page breaks
1600 are chosen whenever the page gets full.
1601
1602
1603
1604 @menu
1605 * Setting global staff size::   
1606 * Vertical spacing::            
1607 * Horizontal spacing::          
1608 * Line breaking::               
1609 * Page layout::                 
1610 @end menu
1611
1612
1613 @node Setting global staff size
1614 @subsection Setting global staff size
1615
1616 @cindex font size, setting
1617 @cindex staff size, setting
1618 @cindex @code{paper} file
1619
1620 The Feta font provides musical symbols at eight  different
1621 sizes. Each font is tuned for a different staff size: at smaller sizes
1622 the font gets heavier, to match the relatively heavier staff lines.
1623 The recommended font sizes are listed in the following table:
1624
1625 @multitable @columnfractions  .25 .25 .25 .25
1626
1627 @item @b{font name}
1628 @tab @b{staff height (pt)}
1629 @tab @b{staff height (mm)}
1630 @tab @b{use}
1631
1632 @item feta11
1633 @tab 11.22
1634 @tab 3.9 
1635 @tab pocket scores
1636
1637 @item feta13
1638 @tab 12.60
1639 @tab 4.4
1640 @tab
1641
1642 @item feta14
1643 @tab 14.14
1644 @tab 5.0
1645 @tab 
1646
1647 @item feta16
1648 @tab 15.87
1649 @tab 5.6
1650 @tab 
1651
1652 @item feta18
1653 @tab 17.82
1654 @tab 6.3
1655 @tab song books
1656
1657 @item feta20
1658 @tab 17.82
1659 @tab 7.0
1660 @tab standard parts 
1661
1662 @item feta23
1663 @tab 22.45 
1664 @tab 7.9
1665 @tab 
1666
1667 @item feta20
1668 @tab 25.2 
1669 @tab 8.9
1670 @tab
1671 @c modern rental material  ?
1672
1673 @end multitable
1674
1675 These fonts are available in any sizes. The context property
1676 @code{fontSize} and the layout property @code{staff-space} (in
1677 @internalsref{StaffSymbol}) can be used to tune size for individual
1678 staves. The size of individual staves are relative to the global size,
1679 which can be set   in the following manner:
1680
1681 @example
1682   #(set-global-staff-size 14)
1683 @end example
1684
1685 This sets the global default size to 14pt staff height, and scales all
1686 fonts accordingly.
1687
1688 @seealso
1689
1690 This manual: @ref{Selecting font sizes}.
1691
1692
1693
1694 @menu
1695 * Vertical spacing::            
1696 * Horizontal spacing::          
1697 * Line breaking::               
1698 * Page layout::                 
1699 @end menu
1700
1701 @node Vertical spacing
1702 @subsection Vertical spacing
1703
1704 @cindex vertical spacing
1705 @cindex distance between staves
1706 @cindex staff distance
1707 @cindex between staves, distance
1708 @cindex staves per page
1709 @cindex space between staves
1710
1711 The height of each system is determined automatically by LilyPond, to
1712 keep systems from bumping into each other, some minimum distances are
1713 set.  By changing these, you can put staves closer together, and thus
1714 put more  systems onto one page.
1715
1716 Normally staves are stacked vertically. To make
1717 staves maintain a distance, their vertical size is padded. This is
1718 done with the property @code{minimumVerticalExtent}. It takes a pair
1719 of numbers, so if you want to make it smaller from its, then you could
1720 set
1721 @example
1722   \set Staff.minimumVerticalExtent = #'(-4 . 4)
1723 @end example
1724 This sets the vertical size of the current staff to 4 staff spaces on
1725 either side of the center staff line.  The argument of
1726 @code{minimumVerticalExtent} is interpreted as an interval, where the
1727 center line is the 0, so the first number is generally negative.  The
1728 staff can be made larger at the bottom by setting it to @code{(-6
1729 . 4)}.
1730
1731 The piano staves are handled a little differently: to make cross-staff
1732 beaming work correctly, it is necessary that the distance between staves
1733 is fixed beforehand.  This is also done with a
1734 @internalsref{VerticalAlignment} object, created in
1735 @internalsref{PianoStaff}. In this object the distance between the
1736 staves is fixed by setting @code{forced-distance}. If you want to
1737 override this, use a @code{\context} block as follows:
1738 @example
1739   \paper @{
1740     \context @{
1741       \PianoStaffContext
1742       \override VerticalAlignment #'forced-distance = #9
1743     @}
1744     @dots{}
1745   @}
1746 @end example
1747 This would bring the staves together at a distance of 9 staff spaces,
1748 measured from the center line of each staff.
1749
1750 @seealso
1751
1752 Internals: Vertical alignment of staves is handled by the
1753 @internalsref{VerticalAlignment} object.
1754
1755
1756
1757
1758 @node Horizontal spacing
1759 @subsection Horizontal Spacing
1760
1761 The spacing engine translates differences in durations into
1762 stretchable distances (``springs'') of differing lengths. Longer
1763 durations get more space, shorter durations get less.  The shortest
1764 durations get a fixed amount of space (which is controlled by
1765 @code{shortest-duration-space} in the @internalsref{SpacingSpanner} object). 
1766 The longer the duration, the more space it gets: doubling a
1767 duration adds a fixed amount (this amount is controlled by
1768 @code{spacing-increment}) of space to the note.
1769
1770 For example, the following piece contains lots of half, quarter and
1771 8th notes, the eighth note is followed by 1 note head width (NHW). 
1772 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
1773 @lilypond[fragment,verbatim,relative=1] c2 c4. c8 c4. c8 c4. c8 c8
1774 c8 c4 c4 c4
1775 @end lilypond
1776
1777 Normally, @code{shortest-duration-space} is set to 1.2, which is the
1778 width of a note head, and @code{shortest-duration-space} is set to
1779 2.0, meaning that the shortest note gets 2 NHW (i.e. 2 times
1780 @code{shortest-duration-space}) of space. For normal notes, this space
1781 is always counted from the left edge of the symbol, so the shortest
1782 notes are generally followed by one NHW of space.
1783
1784 If one would follow the above procedure exactly, then adding a single
1785 32th note to a score that uses 8th and 16th notes, would widen up the
1786 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
1787 thus adding 1 NHW to every note. To prevent this, the
1788 shortest duration for spacing is not the shortest note in the score,
1789 but the most commonly found shortest note.  Notes that are even
1790 shorter this are followed by a space that is proportional to their
1791 duration relative to the common shortest note.  So if we were to add
1792 only a few 16th notes to the example above, they would be followed by
1793 half a NHW:
1794
1795 @lilypond[fragment,verbatim,relative=2]
1796  c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
1797 @end lilypond
1798
1799 The most common shortest duration is determined as follows: in every
1800 measure, the shortest duration is determined. The most common short
1801 duration, is taken as the basis for the spacing, with the stipulation
1802 that this shortest duration should always be equal to or shorter than
1803 1/8th note. The shortest duration is printed when you run lilypond
1804 with @code{--verbose}.  These durations may also be customized. If you
1805 set the @code{common-shortest-duration} in
1806 @internalsref{SpacingSpanner}, then this sets the base duration for
1807 spacing. The maximum duration for this base (normally 1/8th), is set
1808 through @code{base-shortest-duration}.
1809
1810 @cindex @code{common-shortest-duration}
1811 @cindex @code{base-shortest-duration}
1812 @cindex @code{stem-spacing-correction}
1813 @cindex @code{spacing}
1814
1815 In the introduction it was explained that stem directions influence
1816 spacing. This is controlled with @code{stem-spacing-correction}
1817 property in @internalsref{NoteSpacing}, which are generated for every
1818 @internalsref{Voice} context. The @code{StaffSpacing} object
1819 (generated at @internalsref{Staff} context) contains the same property
1820 for controlling the stem/bar line spacing. The following example
1821 shows these corrections, once with default settings, and once with
1822 exaggerated corrections:
1823
1824 @lilypond
1825     \score { \notes {
1826       c'4 e''4 e'4 b'4 |
1827       b'4 e''4 b'4 e''4|
1828       \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
1829       \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
1830       c'4 e''4 e'4 b'4 |
1831       b'4 e''4 b'4 e''4|      
1832     }
1833     \paper { raggedright = ##t } }
1834 @end lilypond
1835
1836 @cindex SpacingSpanner, overriding properties
1837
1838 Properties of the  @internalsref{SpacingSpanner} must be overridden
1839 from the @code{\paper} block, since the @internalsref{SpacingSpanner} is
1840 created before any property commands are interpreted.
1841 @example
1842 \paper @{ \context  @{
1843   \ScoreContext
1844   \override SpacingSpanner #'spacing-increment = #3.0
1845 @} @}
1846 @end example
1847
1848
1849 @seealso
1850
1851 Internals: @internalsref{SpacingSpanner}, @internalsref{NoteSpacing},
1852 @internalsref{StaffSpacing}, @internalsref{SeparationItem}, and
1853 @internalsref{SeparatingGroupSpanner}.
1854
1855 @refbugs
1856
1857 Spacing is determined on a score wide basis. If you have a score that
1858 changes its character (measured in durations) halfway during the
1859 score, the part containing the longer durations will be spaced too
1860 widely.
1861
1862 There is no convenient mechanism to manually override spacing.
1863
1864
1865
1866 @menu
1867 * Line breaking::               
1868 * Page layout::                 
1869 @end menu
1870
1871 @node Line breaking
1872 @subsection Line breaking
1873
1874 @cindex line breaks
1875 @cindex breaking lines
1876
1877 Line breaks are normally computed automatically. They are chosen such
1878 that lines look neither cramped nor loose, and that consecutive lines
1879 have similar density.
1880
1881 Occasionally you might want to override the automatic breaks; you can
1882 do this by  specifying @code{\break}. This will force a line break at
1883 this point.  Line breaks can only occur at places where there are bar
1884 lines.  If you want to have a line break where there is no bar line,
1885 you can force an invisible bar line by entering @code{\bar
1886 ""}. Similarly, @code{\noBreak} forbids a line break at a 
1887 point.
1888
1889
1890 @cindex regular line breaks
1891 @cindex four bar music. 
1892
1893 For line breaks at regular intervals  use @code{\break} separated by
1894 skips and repeated with @code{\repeat}:
1895 @example
1896 <<  \repeat unfold 7 @{
1897          s1 \noBreak s1 \noBreak
1898          s1 \noBreak s1 \break  @}
1899    @emph{the real music}
1900 >> 
1901 @end  example
1902
1903 @noindent
1904 This makes the following 28 measures (assuming 4/4 time) be broken every
1905 4 measures, and only there.
1906
1907 @refcommands
1908
1909 @code{\break}, @code{\noBreak}
1910 @cindex @code{\break}
1911 @cindex @code{\noBreak}
1912
1913 @seealso
1914
1915 Internals: @internalsref{BreakEvent}.
1916
1917
1918 @node Page layout
1919 @subsection Page layout
1920
1921 @cindex page breaks
1922 @cindex breaking pages
1923
1924 @cindex @code{indent}
1925 @cindex @code{linewidth}
1926
1927 The most basic settings influencing the spacing are @code{indent} and
1928 @code{linewidth}. They are set in the @code{\paper} block. They
1929 control the indentation of the first line of music, and the lengths of
1930 the lines.
1931
1932 If  @code{raggedright} is set to true in the @code{\paper}
1933 block, then the lines are justified at their natural length. This
1934 useful for short fragments, and for checking how tight the natural
1935 spacing is.
1936
1937 @cindex page layout
1938 @cindex vertical spacing
1939
1940 The option @code{raggedlast} is similar to @code{raggedright}, but
1941 only affects the last line of the piece. No restrictions are put on
1942 that line. The result is similar to formatting paragraphs. In a
1943 paragraph, the last line simply takes its natural length.
1944
1945 The page layout process happens outside the LilyPond formatting
1946 engine: variables controlling page layout are passed to the output,
1947 and are further interpreted by @code{lilypond} wrapper program. It
1948 responds to the following variables in the @code{\paper} block.  The
1949 spacing between systems is controlled with @code{interscoreline}, its
1950 default is 16pt.  The distance between the score lines will stretch in
1951 order to fill the full page @code{interscorelinefill} is set to a
1952 positive number.  In that case @code{interscoreline} specifies the
1953 minimum spacing.
1954
1955 @cindex @code{textheight}
1956 @cindex @code{interscoreline}
1957 @cindex @code{interscorelinefill}
1958
1959 If the variable @code{lastpagefill} is defined,
1960 @c fixme: this should only be done if lastpagefill= #t 
1961 systems are evenly distributed vertically on the last page.  This
1962 might produce ugly results in case there are not enough systems on the
1963 last page.  The @command{lilypond-book} command ignores
1964 @code{lastpagefill}.  See @ref{lilypond-book manual} for more
1965 information.
1966
1967 @cindex @code{lastpagefill}
1968
1969 Page breaks are normally computed by @TeX{}, so they are not under
1970 direct control of LilyPond.  However, you can insert a commands into
1971 the @file{.tex} output to instruct @TeX{} where to break pages.  This
1972 is done by setting the @code{between-systems-strings} on the
1973 @internalsref{NonMusicalPaperColumn} where the system is broken.
1974 An example is shown in @inputfileref{input/regression,between-systems.ly}.
1975 The predefined command @code{\newpage} also does this.
1976
1977 @cindex paper size
1978 @cindex page size
1979 @cindex @code{papersize}
1980
1981 To change the paper size, there are two commands,
1982 @example
1983         #(set-default-paper-size "a4")
1984         \paper@{
1985            #(set-paper-size "a4")
1986         @}
1987 @end example
1988 The second one sets the size of the @code{\paper} block that it's in.
1989
1990 @refcommands
1991
1992 @cindex @code{\newpage}
1993 @code{\newpage}. 
1994
1995
1996 @seealso
1997
1998 In this manual: @ref{Invoking lilypond}.
1999
2000 Examples: @inputfileref{input/regression,between-systems.ly}.
2001
2002 Internals: @internalsref{NonMusicalPaperColumn}.
2003
2004 @refbugs
2005
2006 LilyPond has no concept of page layout, which makes it difficult to
2007 reliably choose page breaks in longer pieces.
2008
2009
2010
2011
2012 @node Output details
2013 @section Output details
2014
2015 The default output format is La@TeX{}, which should be run
2016 through La@TeX{}.  Using the option @option{-f}
2017 (or @option{--format}) other output formats can be selected also, but
2018  none of them work reliably.
2019
2020 Now the music is output system by system (a `system' consists of all
2021 staves belonging together).  From @TeX{}'s point of view, a system is an
2022 @code{\hbox} which contains a lowered @code{\vbox} so that it is centered
2023 vertically on the baseline of the text.  Between systems,
2024 @code{\interscoreline} is inserted vertically to have stretchable space.
2025 The horizontal dimension of the @code{\hbox} is given by the
2026 @code{linewidth} parameter from LilyPond's @code{\paper} block.
2027
2028 After the last system LilyPond emits a stronger variant of
2029 @code{\interscoreline} only if the macro
2030 @code{\lilypondpaperlastpagefill} is not defined (flushing the systems
2031 to the top of the page).  You can avoid that by setting the variable
2032 @code{lastpagefill} in LilyPond's @code{\paper} block.
2033
2034 It is possible to fine-tune the vertical offset further by defining the
2035 macro @code{\lilypondscoreshift}:
2036
2037 @example
2038 \def\lilypondscoreshift@{0.25\baselineskip@}
2039 @end example
2040
2041 @noindent
2042 where @code{\baselineskip} is the distance from one text line to the next.
2043
2044 Here an example how to embed a small LilyPond file @code{foo.ly} into
2045 running La@TeX{} text without using the @code{lilypond-book} script
2046 (@pxref{lilypond-book manual}):
2047
2048 @example
2049 \documentclass@{article@}
2050
2051 \def\lilypondpaperlastpagefill@{@}
2052 \lineskip 5pt
2053 \def\lilypondscoreshift@{0.25\baselineskip@}
2054
2055 \begin@{document@}
2056 This is running text which includes an example music file
2057 \input@{foo.tex@}
2058 right here.
2059 \end@{document@}
2060 @end example
2061
2062 The file @file{foo.tex} has been simply produced with
2063
2064 @example
2065   lilypond-bin foo.ly
2066 @end example
2067
2068 The call to @code{\lineskip} assures that there is enough vertical space
2069 between the LilyPond box and the surrounding text lines.
2070