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