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