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