]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/user/spacing.itely
f7382e571ab8fa95df9db1558384c009636f0e69
[lilypond.git] / Documentation / user / spacing.itely
1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @c This file is part of lilypond.tely
3 @ignore
4     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
5
6     When revising a translation, copy the HEAD committish of the
7     version that you are working on.  See TRANSLATION for details.
8 @end ignore
9
10 @c A menu is needed before every deeper *section nesting of @node's; run
11 @c     M-x texinfo-all-menus-update
12 @c to automatically fill in these menus before saving changes
13
14 @node Spacing issues
15 @chapter Spacing issues
16
17 The global paper layout is determined by three factors: the page layout, the
18 line breaks, and the spacing.  These all influence each other.  The
19 choice of spacing determines how densely each system of music is set.
20 This influences where line breaks are chosen, and thus ultimately, how
21 many pages a piece of music takes.
22
23 Globally speaking, this procedure happens in four steps: first,
24 flexible distances (@q{springs}) are chosen, based on durations.  All
25 possible line breaking combinations are tried, and a @q{badness} score
26 is calculated for each. Then the height of each possible system is
27 estimated. Finally, a page breaking and line breaking combination is chosen
28 so that neither the horizontal nor the vertical spacing is too cramped
29 or stretched.
30
31 @menu
32 * Paper and pages::             
33 * Music layout::                
34 * Displaying spacing::          
35 * Breaks::                      
36 * Vertical spacing::            
37 * Horizontal spacing::          
38 @end menu
39
40
41 @node Paper and pages
42 @section Paper and pages
43
44 This section deals with the boundaries that define the area
45 that music can be printed inside.
46
47 @menu
48 * Paper size::                  
49 * Page formatting::             
50 @end menu
51
52
53 @node Paper size
54 @subsection Paper size
55
56 @cindex paper size
57 @cindex page size
58 @funindex papersize
59
60 To change the paper size, there are two commands,
61 @example
62 #(set-default-paper-size "a4")
63 \paper @{
64   #(set-paper-size "a4")
65 @}
66 @end example
67
68 The first command sets the size of all pages.  The second command sets the
69 size
70 of the pages that the @code{\paper} block applies to -- if the @code{\paper}
71 block is at the top of the file, then it will apply to all pages.  If the
72 @code{\paper} block is inside a @code{\book}, then the paper size will only
73 apply to that book.
74
75 Support for the following paper sizes are included by default,
76 @code{a6}, @code{a5}, @code{a4}, @code{a3}, @code{legal}, @code{letter},
77 @code{11x17} (also known as tabloid).
78
79 Extra sizes may be added by editing the definition for
80 @code{paper-alist} in the initialization file @file{scm/paper.scm}.
81
82 @cindex orientation
83 @cindex landscape
84
85 If the symbol @code{landscape} is supplied as an argument to
86 @code{set-default-paper-size}, the pages will be rotated by 90 degrees,
87 and wider line widths will be set correspondingly.
88
89 @example
90 #(set-default-paper-size "a6" 'landscape)
91 @end example
92
93 Setting the paper size will adjust a number of @code{\paper} variables
94 (such as margins).  To use a particular paper size with altered
95 @code{\paper} variables, set the paper size before setting the variables.
96
97
98 @node Page formatting
99 @subsection Page formatting
100
101 @cindex page formatting
102 @cindex margins
103 @cindex header, page
104 @cindex footer, page
105
106 LilyPond will do page layout, set margins, and add headers and
107 footers to each page.
108
109 The default layout responds to the following settings in the
110 @code{\paper} block.
111
112 @funindex \paper
113
114 @quotation
115 @table @code
116 @funindex first-page-number
117 @item first-page-number
118 The value of the page number of the first page.  Default is@tie{}1.
119
120 @funindex print-first-page-number
121 @item print-first-page-number
122 If set to true, will print the page number in the first page.  Default is
123 false.
124
125 @funindex print-page-number
126 @item print-page-number
127 If set to false, page numbers will not be printed. Default is true.
128
129 @funindex paper-width
130 @item paper-width
131 The width of the page. The default is taken from the current paper size,
132 see @ref{Paper size}. 
133
134 @funindex paper-height
135 @item paper-height
136 The height of the page. The default is taken from the current paper size,
137 see @ref{Paper size}. 
138
139 @funindex top-margin
140 @item top-margin
141 Margin between header and top of the page. Default is@tie{}5mm.
142
143 @funindex bottom-margin
144 @item bottom-margin
145 Margin between footer and bottom of the page. Default is@tie{}6mm.
146
147 @funindex left-margin
148 @item left-margin
149 Margin between the left side of the page and the beginning of the
150 music. Unset by default, which means that the margins is determined
151 based on the @code{paper-width} and @code{line-width} to center the
152 score on the paper. 
153
154 @funindex line-width
155 @item line-width
156 The length of the systems. Default is @code{paper-width} minus @tie{}20mm.
157
158 @funindex head-separation
159 @item head-separation
160 Distance between the top-most music system and the page header. Default
161 is@tie{}4mm. 
162
163 @funindex foot-separation
164 @item foot-separation
165 Distance between the bottom-most music system and the page
166 footer. Default is@tie{}4mm.
167
168 @funindex page-top-space
169 @item page-top-space
170 Distance from the top of the printable area to the center of the first
171 staff. This only works for staves which are vertically small. Big staves
172 are set with the top of their bounding box aligned to the top of the
173 printable area. Default is@tie{}12mm.
174
175 @funindex ragged-bottom
176 @item ragged-bottom
177 If set to true, systems will not be spread vertically across the page.  This
178 does not affect the last page. Default is false.
179
180 This should be set to true for pieces that have only two or three
181 systems per page, for example orchestral scores.
182
183 @funindex ragged-last-bottom
184 @item ragged-last-bottom
185 If set to false, systems will be spread vertically to fill the last
186 page. Default is true.
187
188 Pieces that amply fill two pages or more should have this set to
189 true.
190
191 @funindex system-count
192 @item system-count
193 This variable, if set, specifies into how many lines a score should be
194 broken. Unset by default.
195
196 @funindex between-system-space
197 @item between-system-space
198 This dimensions determines the distance between systems.  It is the
199 ideal distance between the center of the bottom staff of one system
200 and the center of the top staff of the next system. Default is@tie{}20mm.
201
202 Increasing this will provide a more even appearance of the page at the
203 cost of using more vertical space.
204
205 @funindex between-system-padding
206 @item between-system-padding
207 This dimension is the minimum amount of white space that will always
208 be present between the bottom-most symbol of one system, and the
209 top-most of the next system. Default is@tie{}4mm.
210
211 Increasing this will put systems whose bounding boxes almost touch
212 farther apart.
213
214 @funindex page-breaking-between-system-padding
215 @item page-breaking-between-system-padding
216 This variable tricks the page breaker into thinking that
217 @code{between-system-padding} is set to something different than it
218 really is. For example, if this variable is set to something substantially
219 larger than @code{between-system-padding}, then the page-breaker will put
220 fewer systems on each page.
221
222 @funindex horizontal-shift
223 @item horizontal-shift
224 All systems (including titles and system separators) are shifted by
225 this amount to the right. Page markup, such as headers and footers are
226 not affected by this. The purpose of this variable is to make space
227 for instrument names at the left. Default is@tie{}0.
228
229 @funindex after-title-space
230 @item after-title-space
231 Amount of space between the title and the first system. Default is@tie{}5mm.
232
233 @funindex before-title-space
234 @item before-title-space
235 Amount of space between the last system of the previous piece and the
236 title of the next. Default is@tie{}10mm.
237
238 @funindex between-title-space
239 @item between-title-space
240 Amount of space between consecutive titles (e.g., the title of the
241 book and the title of a piece). Default is@tie{}2mm.
242
243 @funindex printallheaders
244 @item printallheaders
245 Setting this to #t will print all headers for each \score in the
246 output.  Normally only the piece and opus \headers are printed.
247
248 @funindex systemSeparatorMarkup
249 @item systemSeparatorMarkup
250 This contains a markup object, which will be inserted between
251 systems.  This is often used for orchestral scores. Unset by default.
252
253 The markup command @code{\slashSeparator} is provided as a sensible
254 default,  for example
255
256 @lilypond[ragged-right]
257 #(set-default-paper-size "a6" 'landscape)
258 \book {
259   \score {
260     \relative { c1 \break c1 }
261   }
262   \paper {
263     systemSeparatorMarkup = \slashSeparator
264   }
265 }
266 @end lilypond
267
268 @funindex blank-page-force
269 @item blank-page-force
270 The penalty for having a blank page in the middle of a
271 score. This is not used by @code{ly:optimal-breaking} since it will
272 never consider blank pages in the middle of a score. Default value
273 is 10.
274
275 @funindex blank-last-page-force
276 @item blank-last-page-force
277 The penalty for ending the score on an odd-numbered page.
278 Default value is 0.
279
280 @funindex page-spacing-weight
281 @item page-spacing-weight
282 The relative importance of page (vertical) spacing and line (horizontal)
283 spacing. High values will make page spacing more important. Default
284 value is 10.
285
286 @funindex auto-first-page-number
287 @item auto-first-page-number
288 The page breaking algorithm is affected by the first page number being
289 odd or even.  If this variable is set to #t, the page breaking algorithm
290 will decide whether to start with an odd or even number.  This will 
291 result in the first page number remaining as is or being increased by one.
292
293 @end table
294 @end quotation
295
296
297 @commonprop
298
299 The header and footer are created by the functions make-footer and
300 make-header, defined in \paper. The default implementations are in
301 ly/paper-defaults.ly and ly/titling-init.ly.
302
303 The page layout itself is done by two functions in the \paper block,
304 page-music-height and page-make-stencil. The former tells the
305 line-breaking algorithm how much space can be spent on a page, the
306 latter creates the actual page given the system to put on it.
307
308 You can define paper block values in Scheme. In that case mm, in, pt,
309 and cm are variables defined in paper-defaults.ly with values in
310 millimeters. That is why the value 2 cm must be multiplied in the
311 example
312
313 @example
314 \paper @{
315  #(define bottom-margin (* 2 cm))
316 @}
317 @end example
318
319
320 Example:
321
322 @example
323 \paper@{
324   paper-width = 2\cm
325   top-margin = 3\cm
326   bottom-margin = 3\cm
327   ragged-last-bottom = ##t
328 @}
329 @end example
330
331 This second example centers page numbers at the bottom of every page. 
332
333 @example
334 \paper @{
335   print-page-number = ##t
336   print-first-page-number = ##t
337   oddHeaderMarkup = \markup \fill-line @{ " " @}
338   evenHeaderMarkup = \markup \fill-line @{ " " @}
339   oddFooterMarkup = \markup @{ \fill-line @{
340      \bold \fontsize #3 \on-the-fly #print-page-number-check-first
341      \fromproperty #'page:page-number-string @} @}
342   evenFooterMarkup = \markup @{ \fill-line @{
343      \bold \fontsize #3 \on-the-fly #print-page-number-check-first
344      \fromproperty #'page:page-number-string @} @}
345 @} 
346 @end example
347
348 You can also define these values in Scheme.  In that case @code{mm},
349 @code{in}, @code{pt}, and @code{cm} are variables defined in
350 @file{paper-defaults.ly} with values in millimeters.  That is why the
351 value must be multiplied in the example
352
353 @example
354 \paper @{
355   #(define bottom-margin (* 2 cm))
356 @}
357 @end example
358
359 The header and footer are created by the functions @code{make-footer}
360 and @code{make-header}, defined in @code{\paper}.  The default
361 implementations are in @file{ly/@/paper@/-defaults@/.ly} and
362 @file{ly/@/titling@/-init@/.ly}.
363
364 The page layout itself is done by two functions in the
365 @code{\paper} block, @code{page-music-height} and
366 @code{page-make-stencil}.  The former tells the line-breaking algorithm
367 how much space can be spent on a page, the latter creates the actual
368 page given the system to put on it.
369
370
371 @refbugs
372
373 The option right-margin is defined but doesn't set the right margin
374 yet.  The value for the right margin has to be defined adjusting the
375 values of @code{left-margin} and @code{line-width}.
376
377 The default page header puts the page number and the @code{instrument}
378 field from the @code{\header} block on a line.
379
380 The titles (from the @code{\header@{@}} section) are treated as a
381 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
382 add space between the titles and the first system of the score.
383
384
385 @node Music layout
386 @section Music layout
387
388 @menu
389 * Setting the staff size::      
390 * Score layout::                
391 @end menu
392
393
394 @node Setting the staff size
395 @subsection Setting the staff size
396
397 @cindex font size, setting
398 @cindex staff size, setting
399 @funindex layout file
400
401 To set the staff size globally for all scores in a file (or
402 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
403
404 @example
405 #(set-global-staff-size 14)
406 @end example
407
408 @noindent
409 This sets the global default size to 14pt staff height and scales all
410 fonts accordingly.
411
412 To set the staff size individually for each score, use 
413 @example
414 \score@{
415   ...
416   \layout@{
417   #(layout-set-staff-size 15)
418   @}
419 @}
420 @end example
421
422 The Feta font provides musical symbols at eight different
423 sizes.  Each font is tuned for a different staff size: at a smaller size
424 the font becomes heavier, to match the relatively heavier staff lines.
425 The recommended font sizes are listed in the following table:
426
427 @quotation
428 @multitable @columnfractions .15 .2 .22 .2
429
430 @item @b{font name}
431 @tab @b{staff height (pt)}
432 @tab @b{staff height (mm)}
433 @tab @b{use}
434
435 @item feta11
436 @tab 11.22
437 @tab 3.9
438 @tab pocket scores
439
440 @item feta13
441 @tab 12.60
442 @tab 4.4
443 @tab
444
445 @item feta14
446 @tab 14.14
447 @tab 5.0
448 @tab
449
450 @item feta16
451 @tab 15.87
452 @tab 5.6
453 @tab
454
455 @item feta18
456 @tab 17.82
457 @tab 6.3
458 @tab song books
459
460 @item feta20
461 @tab 20
462 @tab 7.0
463 @tab standard parts
464
465 @item feta23
466 @tab 22.45
467 @tab 7.9
468 @tab
469
470 @item feta26
471 @tab 25.2
472 @tab 8.9
473 @tab
474 @c modern rental material?
475
476 @end multitable
477 @end quotation
478
479 These fonts are available in any sizes.  The context property
480 @code{fontSize} and the layout property @code{staff-space} (in
481 @internalsref{StaffSymbol}) can be used to tune the size for individual
482 staves.  The sizes of individual staves are relative to the global size.
483
484 @example
485
486 @end example
487
488 @seealso
489
490 This manual: @ref{Selecting notation font size}.
491
492
493 @node Score layout
494 @subsection Score layout
495
496 @funindex \layout
497
498 While @code{\paper} contains settings that relate to the page formatting
499 of the whole document, @code{\layout} contains settings for score-specific
500 layout.
501
502 @example
503 \layout @{
504   indent = 2.0\cm
505   \context @{ \Staff
506     \override VerticalAxisGroup #'minimum-Y-extent = #'(-6 . 6)
507   @}
508   \context @{ \Voice
509     \override TextScript #'padding = #1.0
510     \override Glissando #'thickness = #3
511   @}
512 @}
513 @end example
514
515
516 @seealso
517
518 This manual: @ref{Changing context default settings}.
519
520
521 @node Displaying spacing
522 @section Displaying spacing
523
524 @funindex annotate-spacing
525 @cindex Spacing, display of properties
526
527 To graphically display the dimensions of vertical properties that may
528 be altered for page formatting, set @code{annotate-spacing} in the
529 @code{\paper} block, like this
530
531
532 @lilypond[verbatim]
533 #(set-default-paper-size "a6" 'landscape)
534
535 \book {
536   \score { { c4 } }
537   \paper { annotate-spacing = ##t }
538 }
539 @end lilypond
540
541 @c need to have \book{} otherwise we get  the separate systems. -hwn
542
543 @noindent
544 @c  FIXME: really bad vagueness due to bug in annotate-spacing.  -gp
545 Some unit dimensions are measured in staff spaces, while others
546 are measured in millimeters.
547 The pairs
548 (@var{a},@var{b}) are intervals, where @var{a} is the lower edge and
549 @var{b} the upper edge of the interval.
550
551
552 @node Breaks
553 @section Breaks
554
555 @menu
556 * Line breaking::               
557 * Page breaking::               
558 * Optimal page breaking::       
559 * Optimal page turning::        
560 * Minimal page breaking::        
561 * Explicit breaks::             
562 * Using an extra voice for breaks::  
563 @end menu
564
565 @node Line breaking
566 @subsection Line breaking
567
568 @cindex line breaks
569 @cindex breaking lines
570
571 Line breaks are normally computed automatically.  They are chosen so
572 that lines look neither cramped nor loose, and that consecutive lines
573 have similar density.
574
575 Occasionally you might want to override the automatic breaks; you can
576 do this by specifying @code{\break}.  This will force a line break at
577 this point.  Line breaks can only occur at places where there are bar
578 lines.  If you want to have a line break where there is no bar line,
579 you can force an invisible bar line by entering @code{\bar
580 ""}.  Similarly, @code{\noBreak} forbids a line break at a
581 point.
582
583
584 @cindex regular line breaks
585 @cindex four bar music.
586
587 For line breaks at regular intervals use @code{\break} separated by
588 skips and repeated with @code{\repeat}:
589 @example
590 << \repeat unfold 7 @{
591          s1 \noBreak s1 \noBreak
592          s1 \noBreak s1 \break @}
593    @emph{the real music}
594 >>
595 @end example
596
597 @noindent
598 This makes the following 28 measures (assuming 4/4 time) be broken every
599 4 measures, and only there.
600
601 @refcommands
602
603 @code{\break}, and @code{\noBreak}.
604 @funindex \break
605 @funindex \noBreak
606
607 @seealso
608
609 Internals: @internalsref{LineBreakEvent}.
610
611 A linebreaking configuration can be saved as a @code{.ly} file
612 automatically.  This allows vertical alignments to be stretched to
613 fit pages in a second formatting run.  This is fairly new and
614 complicated.  More details are available in
615 @lsrdir{spacing}
616
617 @refbugs
618
619 Line breaks can only occur if there is a @q{proper} bar line.  A note
620 which is hanging over a bar line is not proper, such as
621
622 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
623 c4 c2 << c2 {s4 \break } >>  % this does nothing
624 c2 c4 |           % a break here would work
625 c4 c2 c4 ~ \break % as does this break
626 c4 c2 c4
627 @end lilypond
628
629 This can be avoided by removing the @code{Forbid_line_break_engraver}.
630 Note that manually forced line breaks have to be added in parallel
631 with the music.
632
633 @lilypond[quote,ragged-right,verbatim]
634 \new Voice \with {
635   \remove Forbid_line_break_engraver
636 } {
637   c4 c2 << c2 {s4 \break } >>  % now the break is allowed
638   c2 c4 
639 }
640 @end lilypond
641
642 Similarly, line breaks are normally forbidden when beams cross bar
643 lines.  This behavior can be changed by setting 
644 @code{\override Beam #'breakable = ##t}.
645
646
647 @node Page breaking
648 @subsection Page breaking
649
650 The default page breaking may be overriden by inserting
651 @code{\pageBreak} or @code{\noPageBreak} commands.  These commands are
652 analogous to @code{\break} and @code{\noBreak}.  They should be
653 inserted at a bar line.  These commands force and forbid a page-break
654 from happening.  Of course, the @code{\pageBreak} command also forces
655 a line break.
656
657 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
658 inserted at top-level, between scores and top-level markups.
659
660 Page breaks are computed by the @code{page-breaking} function.  LilyPond
661 provides three algorithms for computing page breaks,
662 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
663 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
664 but the value can be changed in the @code{\paper} block:
665
666 @example
667 \paper@{
668   #(define page-breaking ly:page-turn-breaking)
669 @}
670 @end example
671
672 The old page breaking algorithm is called
673 @code{optimal-page-breaks}. If you are having trouble with the new page
674 breakers, you can enable the old one as a workaround.
675
676 @refcommands
677
678 @funindex \pageBreak
679 @code{\pageBreak}
680 @funindex \noPageBreak
681 @code{\noPageBreak}
682
683
684 @node Optimal page breaking
685 @subsection Optimal page breaking
686
687 @funindex ly:optimal-breaking
688
689 The @code{ly:optimal-breaking} function is LilyPond's default method of
690 determining page breaks. It attempts to find a page breaking that minimizes
691 cramping and stretching, both horizontally and vertically. Unlike
692 @code{ly:page-turn-breaking}, it has no concept of page turns.
693
694
695 @node Optimal page turning
696 @subsection Optimal page turning
697
698 @funindex ly:page-turn-breaking
699
700 Often it is necessary to find a page breaking configuration so that there is
701 a rest at the end of every second page. This way, the musician can turn the
702 page without having to miss notes. The @code{ly:page-turn-breaking} function
703 attempts to find a page breaking minimizing cramping and stretching, but with
704 the additional restriction that it is only allowed to introduce page turns
705 in specified places.
706
707 There are two steps to using this page breaking function. First, you
708 must enable it in the @code{\paper} block, as explained in @ref{Page
709 breaking}. Then you must tell the function where you would like to allow
710 page breaks.
711
712 There are two ways to achieve the second step. First, you can specify each
713 potential page turn manually, by inserting @code{\allowPageTurn} into your
714 input file at the appropriate places.
715
716 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
717 Voice context. The @code{Page_turn_engraver} will scan the context for
718 sections without notes (note that it does not scan for rests; it scans for
719 the absence of notes. This is so that single-staff polyphony with rests in one
720 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
721 a sufficiently long section without notes, the @code{Page_turn_engraver} will
722 insert an @code{\allowPageTurn} at the final barline in that section, unless
723 there is a @q{special} barline (such as a double bar), in which case the
724 @code{\allowPageTurn} will be inserted at the final @q{special} barline in
725 the section.
726
727 @funindex minimumPageTurnLength
728 The @code{Page_turn_engraver} reads the context property
729 @code{minimumPageTurnLength} to determine how long a note-free section must
730 be before a page turn is considered. The default value for
731 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
732 to disable page turns, you can set it to something very large.
733
734 @example
735 \new Staff \with @{ \consists "Page_turn_engraver" @}
736 @{
737   a4 b c d |
738   R1 | % a page turn will be allowed here
739   a4 b c d |
740   \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
741   R1 | % a page turn will not be allowed here
742   a4 b r2 |
743   R1*2 | % a page turn will be allowed here
744   a1
745 @}
746 @end example
747
748 @funindex minimumRepeatLengthForPageTurn
749 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
750 turn during the repeat if there is enough time at the beginning and end of the
751 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
752 page turns if the repeat is very short. If you set the context property
753 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
754 only allow turns in repeats whose duration is longer than this value.
755
756 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
757 @code{\allowPageTurn}, may also be used at top-level, between scores and
758 top-level markups.
759
760 @refcommands
761
762 @funindex \pageTurn
763 @code{\pageTurn}
764 @funindex \noPageTurn
765 @code{\noPageTurn}
766 @funindex \allowPageTurn
767 @code{\allowPageTurn}
768
769 @refbugs
770
771 There should only be one @code{Page_turn_engraver} in a score. If there is more
772 than one, they will interfere with each other.
773
774 @node Minimal page breaking
775 @subsection Minimal page breaking
776
777 @funindex ly:minimal-breaking
778
779 The @code{ly:minimal-breaking} function performs minimal computations to
780 calculate the page breaking: it fills a page with as many systems as
781 possible before moving to the next one.  Thus, it may be prefered for
782 scores with many pages, where the other page breaking functions could be
783 too slow or memory demanding, or a lot of texts.  It is enabled using:
784
785 @example
786 \paper @{
787   #(define page-breaking ly:minimal-breaking)
788 @}
789 @end example
790
791 @node Explicit breaks
792 @subsection Explicit breaks
793
794 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
795 commands.  There are two commands to override this behavior:
796
797 @example
798 \override NonMusicalPaperColumn #'line-break-permission = ##f
799 \override NonMusicalPaperColumn #'page-break-permission = ##f
800 @end example
801
802 When @code{line-break-permission} is overriden to false, Lily will insert
803 line breaks at explicit @code{\break} commands and nowhere else.  When
804 @code{page-break-permission} is overriden to false, Lily will insert
805 page breaks at explicit @code{\pageBreak} commands and nowhere else.
806
807 @lilypond[quote,verbatim]
808 \paper {
809   indent = #0
810   ragged-right = ##t
811   ragged-bottom = ##t
812 }
813
814 \score {
815   \new Score \with {
816     \override NonMusicalPaperColumn #'line-break-permission = ##f
817     \override NonMusicalPaperColumn #'page-break-permission = ##f
818   } {
819     \new Staff {
820       \repeat unfold 2 { c'8 c'8 c'8 c'8 } \break
821       \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
822       \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
823       \repeat unfold 8 { c'8 c'8 c'8 c'8 } \pageBreak
824       \repeat unfold 8 { c'8 c'8 c'8 c'8 } \break
825       \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
826       \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
827       \repeat unfold 2 { c'8 c'8 c'8 c'8 }
828     }
829   }
830 }
831 @end lilypond
832
833
834 @node Using an extra voice for breaks
835 @subsection Using an extra voice for breaks
836
837 Line- and page-breaking information usually appears within note entry directly.
838
839 @example
840 \new Score @{
841   \new Staff @{
842     \repeat unfold 2 @{ c'4 c'4 c'4 c'4 @}
843     \break
844     \repeat unfold 3 @{ c'4 c'4 c'4 c'4 @}
845   @}
846 @}
847 @end example
848
849 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
850 music entry with information that specifies how music should lay out
851 on the page.  You can keep music entry and line- and page-breaking
852 information in two separate places by introducing an extra voice to 
853 contain the  breaks.  This extra voice
854 contains only skips together with @code{\break}, @code{pageBreak} and other
855 breaking layout information.
856
857 @lilypond[quote,verbatim]
858 \new Score {
859   \new Staff <<
860      \new Voice {
861         s1 * 2 \break
862         s1 * 3 \break
863         s1 * 6 \break
864         s1 * 5 \break
865      }
866      \new Voice {
867         \repeat unfold 2 { c'4 c'4 c'4 c'4 }
868         \repeat unfold 3 { c'4 c'4 c'4 c'4 }
869         \repeat unfold 6 { c'4 c'4 c'4 c'4 }
870         \repeat unfold 5 { c'4 c'4 c'4 c'4 }
871      }
872   >>
873 }
874 @end lilypond
875
876 This pattern becomes especially helpful when overriding
877 @code{line-break-system-details} and the other useful but long properties of
878 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
879
880 @lilypond[quote,verbatim]
881 \new Score {
882   \new Staff <<
883      \new Voice {
884
885         \overrideProperty "Score.NonMusicalPaperColumn"
886         #'line-break-system-details #'((Y-offset . 0))
887         s1 * 2 \break
888
889         \overrideProperty "Score.NonMusicalPaperColumn"
890         #'line-break-system-details #'((Y-offset . 35))
891         s1 * 3 \break
892
893         \overrideProperty "Score.NonMusicalPaperColumn"
894         #'line-break-system-details #'((Y-offset . 70))
895         s1 * 6 \break
896
897         \overrideProperty "Score.NonMusicalPaperColumn"
898         #'line-break-system-details #'((Y-offset . 105))
899         s1 * 5 \break
900      }
901      \new Voice {
902         \repeat unfold 2 { c'4 c'4 c'4 c'4 }
903         \repeat unfold 3 { c'4 c'4 c'4 c'4 }
904         \repeat unfold 6 { c'4 c'4 c'4 c'4 }
905         \repeat unfold 5 { c'4 c'4 c'4 c'4 }
906      }
907   >>
908 }
909 @end lilypond
910
911
912 @node Vertical spacing
913 @section Vertical spacing
914
915 @cindex vertical spacing
916 @cindex spacing, vertical
917
918 Vertical spacing is controlled by three things: the amount of
919 space available (i.e., paper size and margins), the amount of
920 space between systems, and the amount of space between
921 staves inside a system.
922
923 @menu
924 * Vertical spacing inside a system::  
925 * Vertical spacing between systems::  
926 * Explicit staff and system positioning::  
927 * Two-pass vertical spacing::   
928 * Vertical collision avoidance::  
929 @end menu
930
931
932 @node Vertical spacing inside a system
933 @subsection Vertical spacing inside a system
934
935 @cindex distance between staves
936 @cindex staff distance
937 @cindex space between staves
938 @cindex space inside systems
939
940 The height of each system is determined automatically.  To prevent
941 staves from bumping into each other, some minimum distances are set.
942 By changing these, you can put staves closer together.  This
943 reduces the amount of space each system requires, and may result
944 in having more systems per page.
945
946 Normally staves are stacked vertically.  To make staves maintain a
947 distance, their vertical size is padded.  This is done with the
948 property @code{minimum-Y-extent}.  When applied to a
949 @internalsref{VerticalAxisGroup}, it controls the size of a horizontal
950 line, such as a staff or a line of lyrics.  @code{minimum-Y-extent}
951 takes a pair of numbers, so
952 if you want to make it smaller than its default @code{#'(-4 . 4)}
953 then you could set
954
955 @example
956 \override Staff.VerticalAxisGroup #'minimum-Y-extent = #'(-3 . 3)
957 @end example
958
959 @noindent
960 This sets the vertical size of the current staff to 3 staff spaces on
961 either side of the center staff line.  The value @code{(-3 . 3)} is
962 interpreted as an interval, where the center line is the 0, so the
963 first number is generally negative.  The numbers need not match;
964 for example, the staff can be made larger at the bottom by setting
965 it to @code{(-6 . 4)}.
966
967 After page breaks are determined, the vertical spacing within each
968 system is reevaluated in order to fill the page more evenly; if a page
969 has space left over, systems are stretched in order to fill that space.
970 The amount of stretching can be configured though the @code{max-stretch}
971 property of the @internalsref{VerticalAlignment} grob. To disable this
972 stretching entirely, set @code{max-stretch} to zero.
973
974 In some situations, you may want to stretch most of a system while
975 leaving some parts fixed. For example, if a piano part occurs in the
976 middle of an orchestral score, you may want to leave the piano staves
977 close to each other while stretching the rest of the score. The
978 @code{keep-fixed-while-stretching} property of
979 @internalsref{VerticalAxisGroup} can be used to achieve this. When set
980 to @code{##t}, this property keeps its staff (or line of lyrics) from
981 moving relative to the one directly above it. In the example above,
982 you would override @code{keep-fixed-while-stretching} to @code{##t} in
983 the second piano staff:
984
985 @lilypond[verbatim]
986 #(set-default-paper-size "a6")
987 #(set-global-staff-size 14.0)
988
989 \book {
990 \paper {
991   ragged-last-bottom = ##f
992 }
993
994 \score {
995 \new GrandStaff
996 <<
997   \new StaffGroup
998   <<
999     \new Staff {c' d' e' f'}
1000     \new Staff {c' d' e' f'}
1001     \new Staff {c' d' e' f'}
1002   >>
1003
1004   \new PianoStaff
1005   <<
1006     \new Staff {c' d' e' f'}
1007     \new Staff \with {
1008       \override VerticalAxisGroup #'keep-fixed-while-stretching = ##t
1009     }
1010     {c' d' e' f'}
1011   >>
1012
1013   \new StaffGroup
1014   <<
1015     \new Staff {c' d' e' f'}
1016     \new Staff {c' d' e' f'}
1017   >>
1018 >>
1019 }
1020 }
1021 @end lilypond
1022
1023 @seealso
1024
1025 Internals: Vertical alignment of staves is handled by the
1026 @internalsref{VerticalAlignment} object. The context parameters
1027 specifying the vertical extent are described in connection with
1028 the @internalsref{Axis_group_engraver}.
1029
1030 Example files: @lsr{spacing,page-spacing.ly},
1031 @lsr{spacing,alignment-vertical-spacing.ly}.
1032
1033
1034 @node Vertical spacing between systems
1035 @subsection Vertical spacing between systems
1036
1037 Space between systems are controlled by four @code{\paper} variables,
1038
1039 @example
1040 \paper @{
1041   between-system-space = 1.5\cm
1042   between-system-padding = #1
1043   ragged-bottom=##f
1044   ragged-last-bottom=##f
1045 @}
1046 @end example
1047
1048 When only a couple of flat systems are placed on a page, the resulting
1049 vertical spacing may be non-eleguant: one system at the top of the page,
1050 and the other at the bottom, with a huge gap between them. To avoid this
1051 situation, the space added between the systems can be limited. This
1052 feature is activated by setting to @code{#t} the
1053 @code{page-limit-inter-system-space} variable in the @code{\paper}
1054 block. The paper variable @code{page-limit-inter-system-space-factor}
1055 determines how much the space can be increased: for instance, the value
1056 @code{1.3} means that the space can be 30% larger than what it would be
1057 on a ragged-bottom page.
1058
1059 In the following example, if the inter system space were not limited,
1060 the second system of page 1 would be placed at the page bottom. By
1061 activating the space limitation, the second system is placed closer to
1062 the first one. By setting @code{page-limit-inter-system-space-factor} to
1063 @code{1}, the spacing would the same as on a ragged-bottom page, like
1064 the last one.
1065
1066 @lilypond[verbatim]
1067 #(set-default-paper-size "a6")
1068 \book {
1069   \paper {
1070     page-limit-inter-system-space = ##t
1071     page-limit-inter-system-space-factor = 1.3
1072
1073     oddFooterMarkup = \markup "page bottom"
1074     evenFooterMarkup = \markup "page bottom"
1075     oddHeaderMarkup = \markup \fill-line {
1076       "page top" \fromproperty #'page:page-number-string }
1077     evenHeaderMarkup = \markup \fill-line {
1078       "page top" \fromproperty #'page:page-number-string }
1079   }
1080   \new Staff << \repeat unfold 4 { g'4 g' g' g' \break }
1081                 { s1*2 \pageBreak } >>
1082 }
1083 @end lilypond
1084
1085 @node Explicit staff and system positioning
1086 @subsection Explicit staff and system positioning
1087
1088 One way to understand the @code{VerticalAxisGroup} and @code{\paper}
1089 settings explained in the previous two sections is as a collection of
1090 different settings that primarily concern the amount of vertical padding
1091 different staves and systems running down the page.
1092
1093 It is possible to approach vertical spacing in a different way using
1094 @code{NonMusicalPaperColumn #'line-break-system-details}.  Where
1095 @code{VerticalAxisGroup} and @code{\paper} settings specify vertical padding,
1096 @code{NonMusicalPaperColumn #'line-break-system-details} specifies exact
1097 vertical positions on the page.
1098
1099 @code{NonMusicalPaperColumn #'line-break-system-details} accepts an associative
1100 list of five different settings:
1101
1102 @itemize 
1103 @item @code{X-offset}
1104 @item @code{Y-offset}
1105 @item @code{alignment-offsets}
1106 @item @code{alignment-extra-space}
1107 @item @code{fixed-alignment-extra-space}
1108 @end itemize
1109
1110 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
1111 below, can occur in any of three different places in an input file:
1112
1113 @itemize
1114 @item in the middle of note entry directly
1115 @item in a @code{\context} block
1116 @item in the @code{\with} block
1117 @end itemize
1118
1119 When we override @code{NonMusicalPaperColumn}, we use the usual
1120 @code{\override} command in @code{\context} blocks and in the
1121 @code{\with} block.  On the other hand, when we override
1122 @code{NonMusicalPaperColumn} in the middle of note entry,
1123 use the special @code{\overrideProperty} command.  Here are some
1124 example @code{NonMusicalPaperColumn} overrides with the special
1125 @code{\overrideProperty} command:
1126
1127 @example
1128 \overrideProperty NonMusicalPaperColumn
1129   #'line-break-system-details #'((X-offset . 20))
1130
1131 \overrideProperty NonMusicalPaperColumn
1132   #'line-break-system-details #'((Y-offset . 40))
1133
1134 \overrideProperty NonMusicalPaperColumn
1135   #'line-break-system-details #'((X-offset . 20) (Y-offset . 40))
1136
1137 \override NonMusicalPaperColumn
1138   #'line-break-system-details #'((alignment-offsets . (0 -15)))
1139
1140 \override NonMusicalPaperColumn
1141   #'line-break-system-details #'((X-offset . 20) (Y-offset . 40)
1142                                  (alignment-offsets . (0 -15)))
1143 @end example
1144
1145 To understand how each of these different settings work, we begin
1146 by looking at an example that includes no overrides at all.
1147
1148 @lilypond[quote,ragged-right]
1149 \new Score <<
1150   \new Staff <<
1151     \new Voice {
1152       s1 * 6 \break
1153       s1 * 6 \break
1154       s1 * 6 \break
1155     }
1156     \new Voice { \repeat unfold 18 { c'4 c'4 c'4 c'4 } }
1157   >>
1158   \new Staff {
1159     \repeat unfold 18 { d'4 d'4 d'4 d'4 }
1160   }
1161 >>
1162 @end lilypond
1163
1164 This score isolates line- and page-breaking information in a dedicated
1165 voice. This technique of creating a breaks voice will help keep layout
1166 separate from music entry as our example becomes more complicated.
1167 See @ref{Using an extra voice for breaks}.
1168
1169 Explicit @code{\breaks} evenly divide the music into six measures per
1170 line.  Vertical spacing results from LilyPond's defaults.  To set
1171 the vertical startpoint of each system explicitly, we can set
1172 the @code{Y-offset} pair in the @code{line-break-system-details}
1173 attribute of the @code{NonMusicalPaperColumn} grob:
1174
1175 @lilypond[quote,ragged-right]
1176 \new Score <<
1177   \new Staff <<
1178     \new Voice {
1179       \overrideProperty #"Score.NonMusicalPaperColumn"
1180         #'line-break-system-details #'((Y-offset . 0))
1181       s1 * 6 \break
1182       \overrideProperty #"Score.NonMusicalPaperColumn"
1183         #'line-break-system-details #'((Y-offset . 40))
1184       s1 * 6 \break
1185       \overrideProperty #"Score.NonMusicalPaperColumn"
1186         #'line-break-system-details #'((Y-offset . 80))
1187       s1 * 6 \break
1188     }
1189     \new Voice { \repeat unfold 18 { c'4 c'4 c'4 c'4 } }
1190   >>
1191   \new Staff {
1192     \repeat unfold 18 { d'4 d'4 d'4 d'4 }
1193   }
1194 >>
1195 @end lilypond
1196
1197 Note that @code{line-break-system-details} takes an associative list of
1198 potentially many values, but that we set only one value here.  Note,
1199 too, that the @code{Y-offset} property here determines the exact vertical
1200 position on the page at which each new system will render.
1201
1202 Now that we have set the vertical startpoint of each system
1203 explicitly, we can also set the vertical startpoint of each staff
1204 within each system manually.  We do this using the @code{alignment-offsets}
1205 subproperty of @code{line-break-system-details}.
1206
1207 @lilypond[quote,ragged-right]
1208 \new Score <<
1209   \new Staff <<
1210     \new Voice {
1211       \overrideProperty #"Score.NonMusicalPaperColumn"
1212         #'line-break-system-details #'((Y-offset . 20)
1213           (alignment-offsets . (0 -15)))
1214       s1 * 6 \break
1215       \overrideProperty #"Score.NonMusicalPaperColumn"
1216         #'line-break-system-details #'((Y-offset . 60)
1217           (alignment-offsets . (0 -15)))
1218       s1 * 6 \break
1219       \overrideProperty #"Score.NonMusicalPaperColumn"
1220         #'line-break-system-details #'((Y-offset . 100)
1221           (alignment-offsets . (0 -15)))
1222       s1 * 6 \break
1223     }
1224     \new Voice { \repeat unfold 18 { c'4 c'4 c'4 c'4 } }
1225   >>
1226   \new Staff {
1227     \repeat unfold 18 { d'4 d'4 d'4 d'4 }
1228   }
1229 >>
1230 @end lilypond
1231
1232 Note that here we assign two different values to the
1233 @code{line-break-system-details} attribute of the
1234 @code{NonMusicalPaperColumn} grob.  Though the
1235 @code{line-break-system-details} attribute alist accepts many
1236 additional spacing parameters (including, for example, a corresponding
1237 @code{X-offset} pair), we need only set the @code{Y-offset} and
1238 @code{alignment-offsets} pairs to control the vertical startpoint of
1239 every system and every staff.  Finally, note that @code{alignment-offsets}
1240 specifies the vertical positioning of staves but not of staff groups.
1241
1242 @lilypond[quote,ragged-right]
1243 \new Score <<
1244   \new Staff <<
1245     \new Voice {
1246       \overrideProperty #"Score.NonMusicalPaperColumn"
1247       #'line-break-system-details #'((Y-offset . 0)
1248         (alignment-offsets . (0 -30 -40)))
1249       s1 * 6 \break
1250       \overrideProperty #"Score.NonMusicalPaperColumn"
1251       #'line-break-system-details #'((Y-offset . 60)
1252         (alignment-offsets . (0 -10 -20)))
1253       s1 * 6 \break
1254       \overrideProperty #"Score.NonMusicalPaperColumn"
1255       #'line-break-system-details #'((Y-offset . 100)
1256         (alignment-offsets . (0 -10, -40)))
1257       s1 * 6 \break
1258     }
1259     \new Voice { \repeat unfold 18 { c'4 c'4 c'4 c'4 } }
1260   >>
1261   \new StaffGroup <<
1262     \new Staff {
1263       \repeat unfold 18 { d'4 d'4 d'4 d'4 }
1264     }
1265     \new Staff {
1266       \repeat unfold 18 { e'4 e'4 e'4 e'4 }
1267     }
1268   >>
1269 >>
1270 @end lilypond
1271
1272 Some points to consider:
1273
1274 @itemize
1275 @item When using @code{alignment-offsets}, lyrics count as a staff.
1276
1277 @item The units of the numbers passed to @code{X-offset},
1278 @code{Y-offset} and @code{alignment-offsets} are interpreted as multiples
1279 of the distance between adjacent staff lines.  Positive values move staves
1280 and lyrics up, negative values move staves and lyrics down.
1281
1282 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
1283 settings given here allow the positioning of staves and systems anywhere
1284 on the page, it is possible to violate paper or margin boundaries or even
1285 to print staves or systems on top of one another.  Reasonable values
1286 passed to these different settings will avoid this.
1287 @end itemize
1288
1289
1290 @node Two-pass vertical spacing
1291 @subsection Two-pass vertical spacing
1292
1293 Warning: two-pass vertical spacing is deprecated and will be removed in
1294 a future version of LilyPond. Systems are now stretched automatically
1295 in a single pass. See @ref{Vertical spacing inside a system}.
1296
1297 In order to automatically stretch systems so that they should fill the
1298 space left on a page, a two-pass technique can be used:
1299
1300 @enumerate
1301 @item In the first pass, the amount of vertical space used to increase
1302 the height of each system is computed and dumped to a file.
1303 @item In the second pass, spacing inside the systems are
1304 stretched according to the data in the page layout file.
1305 @end enumerate
1306
1307 The @code{ragged-bottom} property adds space between systems, while
1308 the two-pass technique adds space between staves inside a system.
1309
1310 To allow this behaviour, a @code{tweak-key} variable has to be set in
1311 each score @code{\layout} block, and the tweaks included in each score
1312 music, using the @code{\scoreTweak} music function.
1313
1314 @quotation
1315 @verbatim
1316 %% include the generated page layout file:
1317 \includePageLayoutFile
1318
1319 \score {
1320   \new StaffGroup <<
1321     \new Staff <<
1322       %% Include this score tweaks:
1323       \scoreTweak "scoreA"
1324       { \clef french c''1 \break c''1 }
1325     >>
1326     \new Staff { \clef soprano g'1 g'1 }
1327     \new Staff { \clef mezzosoprano e'1 e'1 }
1328     \new Staff { \clef alto g1 g1 }
1329     \new Staff { \clef bass c1 c1 }
1330   >>
1331   \header {
1332     piece = "Score with tweaks"
1333   }
1334   %% Define how to name the tweaks for this score:
1335   \layout { #(define tweak-key "scoreA") }
1336 }
1337 @end verbatim
1338 @end quotation
1339
1340 For the first pass, the @code{dump-tweaks} option should be set to
1341 generate the page layout file.
1342
1343 @example
1344 lilypond -dbackend=null -d dump-tweaks <file>.ly
1345 lilypond <file>.ly
1346 @end example
1347
1348
1349 @node Vertical collision avoidance
1350 @subsection Vertical collision avoidance
1351
1352 @funindex outside-staff-priority
1353 @funindex outside-staff-padding
1354 @funindex outside-staff-horizontal-padding
1355
1356 Intuitively, there are some objects in musical notation that belong
1357 to the staff and there are other objects that should be placed outside
1358 the staff.  Objects belonging outside the staff include things such as
1359 rehearsal marks, text and dynamic markings (from now on, these will
1360 be called outside-staff objects).  LilyPond's rule for the
1361 vertical placement of outside-staff objects is to place them as close
1362 to the staff as possible but not so close that they collide with
1363 another object.
1364
1365 LilyPond uses the @code{outside-staff-priority} property to determine
1366 whether a grob is an outside-staff object: if @code{outside-staff-priority}
1367 is a number, the grob is an outside-staff object.  In addition,
1368 @code{outside-staff-priority} tells LilyPond in which order the objects
1369 should be placed.
1370
1371 First, LilyPond places all the objects that do not belong outside
1372 the staff.  Then it sorts the outside-staff objects according to their
1373 @code{outside-staff-priority} (in increasing order).  One by one, LilyPond
1374 takes the outside-staff objects and places them so that they do
1375 not collide with any objects that have already been placed.  That
1376 is, if two outside-staff grobs are competing for the same space, the one
1377 with the lower @code{outside-staff-priority} will be placed closer to
1378 the staff.
1379
1380 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1381 c4_"Text"\pp
1382 r2.
1383 \once \override TextScript #'outside-staff-priority = #1
1384 c4_"Text"\pp % this time the text will be closer to the staff
1385 r2.
1386 % by setting outside-staff-priority to a non-number, we
1387 % disable the automatic collision avoidance
1388 \once \override TextScript #'outside-staff-priority = ##f
1389 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
1390 c4_"Text"\pp % now they will collide
1391 @end lilypond
1392
1393 The vertical padding between an outside-staff object and the
1394 previously-positioned grobs can be controlled with
1395 @code{outside-staff-padding}.
1396
1397 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1398 \once \override TextScript #'outside-staff-padding = #0
1399 a'^"This text is placed very close to the note"
1400 \once \override TextScript #'outside-staff-padding = #3
1401 c^"This text is padded away from the previous text"
1402 c^"This text is placed close to the previous text"
1403 @end lilypond
1404
1405 By default, outside-staff objects are placed without regard to
1406 their horizontal distance from the previously-posititioned grobs.  This
1407 can lead to situations in which objects are placed very close to each
1408 other horizontally.  Setting @code{outside-staff-horizontal-padding}
1409 causes an object to be offset vertically so that such a situation
1410 doesn't occur.
1411
1412 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1413 % the markup is too close to the following note
1414 c2^"Text"
1415 c''2
1416 % setting outside-staff-horizontal-padding fixes this
1417 R1
1418 \once \override TextScript #'outside-staff-horizontal-padding = #1
1419 c,,2^"Text"
1420 c''2
1421 @end lilypond
1422
1423
1424
1425 @node Horizontal spacing
1426 @section Horizontal Spacing
1427
1428 @cindex horizontal spacing
1429 @cindex spacing, horizontal
1430
1431 @menu
1432 * Horizontal spacing overview::  
1433 * New spacing area::            
1434 * Changing horizontal spacing::  
1435 * Line length::                 
1436 * Proportional notation::       
1437 @end menu
1438
1439
1440 @node Horizontal spacing overview
1441 @subsection Horizontal spacing overview
1442
1443 The spacing engine translates differences in durations into stretchable
1444 distances (@q{springs}) of differring lengths.  Longer durations get
1445 more space, shorter durations get less.  The shortest durations get a
1446 fixed amount of space (which is controlled by
1447 @code{shortest-duration-space} in the @internalsref{SpacingSpanner}
1448 object).  The longer the duration, the more space it gets: doubling a
1449 duration adds a fixed amount (this amount is controlled by
1450 @code{spacing-increment}) of space to the note.
1451
1452 For example, the following piece contains lots of half, quarter, and
1453 8th notes; the eighth note is followed by 1 note head width (NHW).
1454 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
1455
1456 @lilypond[quote,fragment,verbatim,relative=1]
1457 c2 c4. c8 c4. c8 c4. c8 c8
1458 c8 c4 c4 c4
1459 @end lilypond
1460
1461 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
1462 approximately the width of a note head, and
1463 @code{shortest-duration-space} is set to 2.0, meaning that the
1464 shortest note gets 2.4 staff space (2.0 times the
1465 @code{spacing-increment}) of horizontal space.  This space is counted
1466 from the left edge of the symbol, so the shortest notes are generally
1467 followed by one NHW of space.
1468
1469 If one would follow the above procedure exactly, then adding a single
1470 32nd note to a score that uses 8th and 16th notes, would widen up the
1471 entire score a lot.  The shortest note is no longer a 16th, but a 32nd,
1472 thus adding 1 NHW to every note.  To prevent this, the shortest
1473 duration for spacing is not the shortest note in the score, but rather
1474 the one which occurs most frequently.
1475
1476
1477 The most common shortest duration is determined as follows: in every
1478 measure, the shortest duration is determined.  The most common shortest
1479 duration is taken as the basis for the spacing, with the stipulation
1480 that this shortest duration should always be equal to or shorter than
1481 an 8th note.  The shortest duration is printed when you run
1482 @code{lilypond} with the @code{--verbose} option.
1483
1484 These durations may also be customized.  If you set the
1485 @code{common-shortest-duration} in @internalsref{SpacingSpanner}, then
1486 this sets the base duration for spacing.  The maximum duration for this
1487 base (normally an 8th), is set through @code{base-shortest-duration}.
1488
1489 @funindex common-shortest-duration
1490 @funindex base-shortest-duration
1491 @funindex stem-spacing-correction
1492 @funindex spacing
1493
1494 Notes that are even shorter than the common shortest note are
1495 followed by a space that is proportional to their duration relative to
1496 the common shortest note.  So if we were to add only a few 16th notes
1497 to the example above, they would be followed by half a NHW:
1498
1499 @lilypond[quote,fragment,verbatim,relative=2]
1500 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
1501 @end lilypond
1502
1503
1504 In the introduction (see @ref{Engraving}), it was explained that stem
1505 directions influence spacing.  This is controlled with the
1506 @code{stem-spacing-correction} property in the
1507 @internalsref{NoteSpacing}, object.  These are generated for every
1508 @internalsref{Voice} context.  The @code{StaffSpacing} object
1509 (generated in @internalsref{Staff} context) contains the same property
1510 for controlling the stem/bar line spacing.  The following example shows
1511 these corrections, once with default settings, and once with
1512 exaggerated corrections:
1513
1514 @lilypond[quote,ragged-right]
1515 {
1516   c'4 e''4 e'4 b'4 |
1517   b'4 e''4 b'4 e''4|
1518   \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
1519   \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
1520   c'4 e''4 e'4 b'4 |
1521   b'4 e''4 b'4 e''4|
1522 }
1523 @end lilypond
1524
1525 Proportional notation is supported; see @ref{Proportional notation}.
1526
1527
1528 @seealso
1529
1530 Internals: @internalsref{SpacingSpanner}, @internalsref{NoteSpacing},
1531 @internalsref{StaffSpacing}, @internalsref{SeparationItem}, and
1532 @internalsref{SeparatingGroupSpanner}.
1533
1534
1535 @refbugs
1536
1537 There is no convenient mechanism to manually override spacing.  The
1538 following work-around may be used to insert extra space into a score.
1539 @example
1540  \once \override Score.SeparationItem #'padding = #1
1541 @end example
1542
1543 No work-around exists for decreasing the amount of space.
1544
1545
1546 @node New spacing area
1547 @subsection New spacing area
1548
1549 New sections with different spacing parameters can be started with
1550 @code{newSpacingSection}.  This is useful when there are  
1551 sections with a different notions of long and short notes.
1552
1553 In the following example, the time signature change introduces a new
1554 section, and hence the 16ths notes are spaced wider.
1555
1556 @lilypond[relative,fragment,verbatim,quote]
1557 \time 2/4
1558 c4 c8 c 
1559 c8 c c4 c16[ c c8] c4
1560 \newSpacingSection
1561 \time 4/16
1562 c16[ c c8]
1563 @end lilypond
1564
1565
1566 The @code{\newSpacingSection} command creates a new
1567 @internalsref{SpacingSpanner} object, and hence new @code{\override}s
1568 may be used in that location.
1569
1570
1571 @node Changing horizontal spacing
1572 @subsection Changing horizontal spacing
1573
1574 Horizontal spacing may be altered with the
1575 @code{base-shortest-duration} property.  Here
1576 we compare the same music; once without altering
1577 the property, and then altered.  Larger values
1578 of @code{ly:make-moment} will produce smaller
1579 music.  Note that @code{ly:make-moment} constructs
1580 a duration, so @code{1 4} is a longer duration
1581 than @code{1 16}.
1582
1583 @lilypond[relative,verbatim,line-width=12\cm]
1584 \score {
1585   \relative c'' {
1586     g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
1587     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
1588     d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
1589     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
1590   }
1591 }
1592 @end lilypond
1593
1594 @lilypond[relative,verbatim,line-width=12\cm]
1595 \score {
1596   \relative c'' {
1597     g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
1598     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
1599     d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
1600     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
1601   }
1602   \layout {
1603     \context {
1604       \Score
1605       \override SpacingSpanner
1606                 #'base-shortest-duration = #(ly:make-moment 1 16)
1607     }
1608   }
1609 }
1610 @end lilypond
1611
1612
1613 @commonprop
1614
1615 By default, spacing in tuplets depends on various non-duration
1616 factors (such as accidentals, clef changes, etc).  To disregard
1617 such symbols and force uniform equal-duration spacing, use
1618 @code{Score.SpacingSpanner #'uniform-stretching}.  This
1619 property can only be changed at the beginning of a score,
1620
1621 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1622 \new Score \with {
1623   \override SpacingSpanner #'uniform-stretching = ##t
1624 } <<
1625   \new Staff{
1626     \times 4/5 {
1627       c8 c8 c8 c8 c8
1628     }
1629     c8 c8 c8 c8
1630   }
1631   \new Staff{
1632     c8 c8 c8 c8
1633     \times 4/5 {
1634       c8 c8 c8 c8 c8
1635     }
1636   }
1637 >>
1638 @end lilypond
1639
1640
1641 When @code{strict-note-spacing} is set, notes are spaced without
1642 regard for clefs, bar lines, and grace notes,
1643
1644 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1645 \override Score.SpacingSpanner #'strict-note-spacing = ##t
1646 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c]  c32[ c32] }
1647 @end lilypond
1648
1649
1650 @node Line length
1651 @subsection Line length
1652
1653 @cindex page breaks
1654 @cindex breaking pages
1655
1656 @funindex indent
1657 @funindex line-width
1658 @funindex ragged-right
1659 @funindex ragged-last
1660
1661 @c Although line-width can be set in \layout, it should be set in paper
1662 @c block, to get page layout right.
1663 @c Setting indent in \paper block makes not much sense, but it works.
1664
1665 @c Bit verbose and vague, use examples?
1666 The most basic settings influencing the spacing are @code{indent} and
1667 @code{line-width}.  They are set in the @code{\layout} block.  They
1668 control the indentation of the first line of music, and the lengths of
1669 the lines.
1670
1671 If @code{ragged-right} is set to true in the @code{\layout} block, then
1672 systems ends at their natural horizontal length, instead of being spread
1673 horizontally to fill the whole line.  This is useful for
1674 short fragments, and for checking how tight the natural spacing is.
1675
1676 @cindex page layout
1677 @cindex vertical spacing
1678
1679 The option @code{ragged-last} is similar to @code{ragged-right}, but
1680 only affects the last line of the piece.  No restrictions are put on
1681 that line.  The result is similar to formatting text paragraphs.  In a
1682 paragraph, the last line simply takes its natural horizontal length.
1683 @c Note that for text there are several options for the last line.
1684 @c While Knuth TeX uses natural length, lead typesetters use the same
1685 @c stretch as the previous line.  eTeX uses \lastlinefit to
1686 @c interpolate between both these solutions.
1687
1688 @example
1689 \layout @{
1690   indent = #0
1691   line-width = #150
1692   ragged-last = ##t
1693 @}
1694 @end example
1695
1696
1697 @node Proportional notation
1698 @subsection Proportional notation
1699
1700 LilyPond supports proportional notation, a type of horizontal spacing
1701 in which each note consumes an amount of horizontal space exactly
1702 equivalent to its rhythmic duration. This type of proportional spacing
1703 is comparable to horizontal spacing on top of graph paper. Some late
1704 20th- and early 21st-century scores use proportional notation to
1705 clarify complex rhythmic relationships or to faciliate the placement
1706 of timelines or other graphics directly in the score.
1707
1708 LilyPond supports five different settings for proportional notation,
1709 which may be used together or alone:
1710
1711 @itemize
1712 @item @code{proportionalNotationDuration}
1713 @item @code{uniform-stretching}
1714 @item @code{strict-note-spacing}
1715 @item @code{\remove Separating_line_group_engraver}
1716 @item @code{\override PaperColumn #'used = ##t}
1717 @end itemize
1718
1719 In the examples that follow, we explore these five different
1720 proportional notation settings and examine how these settings interact.
1721
1722 We start with the following one-measure example, which uses classical
1723 spacing with ragged-right turned on.
1724
1725 @lilypond[quote,verbatim,ragged-right]
1726 \new Score <<
1727   \new RhythmicStaff {
1728     c'2
1729     c'16 c'16 c'16 c'16
1730     \times 4/5 {
1731       c'16 c'16 c'16 c'16 c'16
1732     }
1733   }
1734 >>
1735 @end lilypond
1736
1737 Notice that the half note which begins the measure takes up far less
1738 than half of the horizontal space of the measure.  Likewise, the
1739 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
1740 which end the measure together take up far more than half the
1741 horizontal space of the measure.
1742
1743 In classical engraving, this spacing may be exactly what we want
1744 because we can borrow horizontal space from the half note and conserve
1745 horizontal space across the measure as a whole.
1746
1747 On the other hand, if we want to insert a measured timeline or other
1748 graphic above or below our score, we need proportional notation.  We
1749 turn proportional notation on with the proportionalNotationDuration
1750 setting.
1751
1752 @lilypond[quote,verbatim,ragged-right]
1753 \new Score \with {
1754   proportionalNotationDuration = #(ly:make-moment 1 20)
1755 } <<
1756   \new RhythmicStaff {
1757     c'2
1758     c'16 c'16 c'16 c'16
1759     \times 4/5 {
1760       c'16 c'16 c'16 c'16 c'16
1761     }
1762   }
1763 >>
1764 @end lilypond
1765
1766 The half note at the beginning of the measure and the faster notes in
1767 the second half of the measure now occupy equal amounts of horizontal
1768 space.  We could place a measured timeline or graphic above or below
1769 this example.
1770
1771 The @code{proportionalNotationDuration} setting is a context setting that
1772 lives in @context{Score}.  Recall that context settings appear in one of
1773 three locations in our input file -- in a @code{\with} block, in a
1774 @code{\context} block, or directly in music entry
1775 preceeded by the @code{\set} command.  As with all
1776 context settings, users can pick which of the three different
1777 locations they would like to set @code{proportionalNotationDuration}.
1778
1779 The @code{proportionalNotationDuration} setting takes a single argument,
1780 which is the reference duration against which all music will be
1781 spaced.  The LilyPond Scheme function make-moment takes two arguments
1782 -- a numerator and denominator which together express some fraction of
1783 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces a
1784 reference duration of a twentieth note. The values
1785 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
1786 @code{#(ly:make-moment 3 97)} are all possible as well.
1787
1788 How do we select the right reference duration to pass to
1789 @code{proportionalNotationDuration}?  Usually by a process of trial and error,
1790 beginning with a duration close to the fastest (or smallest) duration
1791 in the piece.  Smaller reference durations space music loosely; larger
1792 reference durations space music tightly.
1793
1794 @lilypond[quote,verbatim,ragged-right]
1795 \new Score \with {
1796   proportionalNotationDuration = #(ly:make-moment 1 8)
1797 } <<
1798   \new RhythmicStaff {
1799     c'2
1800     c'16 c'16 c'16 c'16
1801     \times 4/5 {
1802       c'16 c'16 c'16 c'16 c'16
1803     }
1804   }
1805 >>
1806
1807 \new Score \with {
1808   proportionalNotationDuration = #(ly:make-moment 1 16)
1809 } <<
1810   \new RhythmicStaff {
1811     c'2
1812     c'16 c'16 c'16 c'16
1813     \times 4/5 {
1814       c'16 c'16 c'16 c'16 c'16
1815     }
1816   }
1817 >>
1818
1819 \new Score \with {
1820   proportionalNotationDuration = #(ly:make-moment 1 32)
1821 } <<
1822   \new RhythmicStaff {
1823     c'2
1824     c'16 c'16 c'16 c'16
1825     \times 4/5 {
1826       c'16 c'16 c'16 c'16 c'16
1827     }
1828   }
1829 >>
1830 @end lilypond
1831
1832 Note that too large a reference duration -- such as the eighth note,
1833 above -- spaces music too tightly and can cause notehead collisions.
1834 Note also that proportional notation in general takes up more
1835 horizontal space that does classical spacing.  Proportional spacing
1836 provides rhythmic clarity at the expense of horizontal space.
1837
1838 Next we examine how to optimally space overlapping tuplets.
1839
1840 We start by examining what happens to our original example, with
1841 classical spacing, when we add a second staff with a different type of
1842 tuplet.
1843
1844 @lilypond[quote,verbatim,ragged-right]
1845 \new Score <<
1846   \new RhythmicStaff {
1847     c'2
1848     c'16 c'16 c'16 c'16
1849     \times 4/5 {
1850       c'16 c'16 c'16 c'16 c'16
1851     }
1852   }
1853   \new RhythmicStaff {
1854     \times 8/9 {
1855       c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
1856     }
1857   }
1858 >>
1859 @end lilypond
1860
1861 The spacing is bad because the evenly notes of the bottom staff do not
1862 stretch uniformly.  Classical engraving includes very few complex
1863 triplets and so classical engraving rules can generate this type of
1864 result.  Setting @code{proportionalNotationDuration} remedies this
1865 situation considerably.
1866
1867 @lilypond[quote,verbatim,ragged-right]
1868 \new Score \with {
1869   proportionalNotationDuration = #(ly:make-moment 1 20)
1870 } <<
1871   \new RhythmicStaff {
1872     c'2
1873     c'16 c'16 c'16 c'16
1874     \times 4/5 {
1875       c'16 c'16 c'16 c'16 c'16
1876     }
1877   }
1878   \new RhythmicStaff {
1879     \times 8/9 {
1880       c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
1881     }
1882   }
1883 >>
1884 @end lilypond
1885
1886 But if we look very carefully we can see that notes of the second half
1887 of the 9-tuplet space ever so slightly more widely than do the notes
1888 of the first half of the 9-tuplet.  To ensure uniform stretching, we
1889 turn on @code{uniform-stretching}, which is a property of
1890 @code{SpacingSpanner}.
1891
1892 @lilypond[quote,verbatim,ragged-right]
1893 \new Score \with {
1894   proportionalNotationDuration = #(ly:make-moment 1 20)
1895   \override SpacingSpanner #'uniform-stretching = ##t
1896 } <<
1897   \new RhythmicStaff {
1898     c'2
1899     c'16 c'16 c'16 c'16
1900     \times 4/5 {
1901       c'16 c'16 c'16 c'16 c'16
1902     }
1903   }
1904   \new RhythmicStaff {
1905     \times 8/9 {
1906       c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
1907     }
1908   }
1909 >>
1910 @end lilypond
1911
1912 Our two-staff example now spaces exactly, our rhythmic relationships
1913 are visually clear, and we can include a measured timeline or graphic
1914 if we want.
1915
1916 The @code{SpacingSpanner} is an abstract grob that lives in the
1917 @context{Score} context.  As with our settings of
1918 @code{proportionalNotationDuration},
1919 overrides to the @code{SpacingSpanner} can occur in any of three different
1920 places in our input file -- in the Score @code{\with} block, in a
1921 Score @code{\context} block, or in note entry directly.
1922
1923 There is by default only one @code{SpacingSpanner} per @code{Score}.  This
1924 means that, by default, @code{uniform-stretching} is either turned on for the
1925 entire score or turned off for the entire score.  We can, however,
1926 override this behavior and turn on different spacing features at
1927 different places in the score.  We do this with the command
1928 @code{\newSpacingSection}.  See @ref{New spacing area}, for more info.
1929
1930 Next we examine the effects of the @code{Separating_line_group_engraver} and
1931 see why proportional scores frequently remove this engraver.  The following
1932 example shows that there is a small amount of @qq{preferatory} space
1933 just before the first note in each system.
1934
1935 @lilypond[quote,verbatim,ragged-right]
1936 \paper {
1937   indent = #0
1938 }
1939
1940 \new Staff {
1941   c'1
1942   \break
1943   c'1
1944 }
1945 @end lilypond
1946
1947
1948 The amount of this preferatory space is the same whether after a time
1949 signature, a key signature or a clef.  @code{Separating_line_group_engraver}
1950 is responsible for this space.  Removing @code{Separating_line_group_engraver}
1951 reduces this space to zero.
1952
1953 @lilypond[quote,verbatim,ragged-right]
1954 \paper {
1955   indent = #0
1956 }
1957
1958 \new Staff \with {
1959   \remove Separating_line_group_engraver
1960 } {
1961   c'1
1962   \break
1963   c'1
1964 }
1965 @end lilypond
1966
1967 Nonmusical elements like time signatures, key signatures, clefs and
1968 accidentals are problemmatic in proportional notation.  None of these
1969 elements has rhythmic duration.  But all of these elements consume
1970 horizontal space.  Different proportional scores approach these
1971 problems differently.
1972
1973 It may be possible to avoid spacing problems with key signatures
1974 simply by not having any.  This is a valid option since most
1975 proportional scores are contemporary music.  The same may be true
1976 of time signatures, especially for those scores
1977 that include a measured timeline or other graphic.  But these scores
1978 are exceptional and most proportional scores include at least some
1979 time signatures.  Clefs and accidentals are even more essential.
1980
1981 So what strategies exist for spacing nonmusical elements in a
1982 proportional context?  One good option is the @code{strict-note-spacing}
1983 property of @code{SpacingSpanner}.  Compare the two scores below:
1984
1985 @lilypond[quote,verbatim,ragged-right]
1986 \new Staff {
1987   \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
1988   c''8
1989   c''8
1990   c''8
1991   \clef alto
1992   d'8
1993   d'2
1994 }
1995
1996 \new Staff {
1997   \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
1998   \override Score.SpacingSpanner #'strict-note-spacing = ##t
1999   c''8
2000   c''8
2001   c''8
2002   \clef alto
2003   d'8
2004   d'2
2005 }
2006 @end lilypond
2007
2008 Both scores are proportional, but the spacing in the first score is
2009 too loose because of the clef change.  The spacing of the second score
2010 remains strict, however, because @code{strict-note-spacing} is turned
2011 on.  Turning on @code{strict-note-spacing} causes the width of time
2012 signatures, key signatures and clefs to play no part in the spacing
2013 algorithm.  Accidentals are a different matter, however.  By default, all
2014 accidentals consume a little extra space, as the following pair of
2015 scores shows.
2016
2017 @lilypond[quote,verbatim,ragged-right]
2018 \new Staff {
2019   \set Score.proportionalNotationDuration = #(ly:make-moment 1 32)
2020   c'16
2021   c'16
2022   c'16
2023   c'16
2024   c'16
2025   c'16
2026   c'16
2027   c'16
2028 }
2029
2030 \new Staff {
2031   \set Score.proportionalNotationDuration = #(ly:make-moment 1 32)
2032   c'16
2033   cis'16
2034   c'16
2035   c'16
2036   c'16
2037   c'16
2038   c'16
2039   c'16
2040 }
2041 @end lilypond
2042
2043 Both scores are proportional but the second score exhibits spacing
2044 irregularities due to accidentals.  Turning on @code{strict-note-spacing}
2045 does not work for accidentals.  Instead,
2046 we override the @code{X-extent} of all accidentals to zero and then move the
2047 accidentals to the left of the notes they modify.
2048
2049 @lilypond[quote,verbatim,ragged-right]
2050 \new Staff {
2051   \set Score.proportionalNotationDuration = #(ly:make-moment 1 32)
2052   \override Accidental #'X-extent = #'(0 . 0)
2053   \override Accidental #'extra-offset = #'(-1 . 0)
2054   c'16
2055   cis'16
2056   c'16
2057   c'16
2058   c'16
2059   c'16
2060   c'16
2061   c'16
2062 }
2063 @end lilypond
2064
2065 In addition to the settings given here, there are other settings that
2066 frequently appear in proportional scores.  These include:
2067
2068 @itemize
2069 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
2070 @item @code{tupletFullLength = ##t}
2071 @item @code{\override Beam #'breakable = ##t}
2072 @item @code{\override Glissando #'breakable = ##t}
2073 @item @code{\override TextSpanner #'breakable = ##t}
2074 @item @code{\remove Forbid_line_break_engraver in the Voice context}
2075 @end itemize
2076
2077 These settings space grace notes strictly, extend tuplet brackets to
2078 mark both rhythmic start- and stop-points, and allow spanning elements
2079 to break across systems and pages.  See the respective parts of the manual
2080 for these related settings.
2081
2082