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