]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/notation/spacing.itely
070ba07bd0435f83bd1475cc71014c72db4f8c17
[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.16.0"
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 Two types of blocks can contain layout settings:
72 @code{\paper @{@dots{}@}} and @code{\layout @{@dots{}@}}.  The
73 @code{\paper} block contains page layout settings that are
74 expected to be the same for all scores in a book, such as the
75 paper height, or whether to print page numbers, etc.  See
76 @ref{Page layout}.  The @code{\layout} block contains score layout
77 settings, such as the number of systems to use, or the space
78 between staff-groups, etc.  See @ref{Score layout}.
79
80 @menu
81 * Page layout::
82 * Score layout::
83 * Breaks::
84 * Vertical spacing::
85 * Horizontal spacing::
86 * Fitting music onto fewer pages::
87 @end menu
88
89
90 @node Page layout
91 @section Page layout
92
93 This section discusses page layout options for the @code{\paper}
94 block.
95
96 @menu
97 * The \paper block::
98 * Paper size and automatic scaling::
99 * Fixed vertical spacing \paper variables::
100 * Flexible vertical spacing \paper variables::
101 * Horizontal spacing \paper variables::
102 * Other \paper variables::
103 @end menu
104
105
106 @node The \paper block
107 @subsection The @code{\paper} block
108
109 The @code{\paper} block can appear within a @code{\book} block,
110 but not within a @code{\score} block.  Settings in a @code{\paper}
111 block apply to the entire book, which may include multiple scores.
112 Settings that can appear in a @code{\paper} block include:
113
114 @itemize
115
116 @item
117 the @code{set-paper-size} scheme function,
118
119 @item
120 @code{\paper} variables used for customizing page layout, and
121
122 @item
123 markup definitions used for customizing the layout of headers,
124 footers, and titles.
125
126 @end itemize
127
128 The @code{set-paper-size} function is discussed in the next
129 section, @ref{Paper size and automatic scaling}.  The
130 @code{\paper} variables that deal with page layout are discussed
131 in later sections.  The markup definitions that deal with headers,
132 footers, and titles are discussed in
133 @ref{Custom titles headers and footers}.
134
135 Most @code{\paper} variables will only work in a @code{\paper}
136 block.  The few that will also work in a @code{\layout} block are
137 listed in @ref{The \layout block}.
138
139 Except when specified otherwise, all @code{\paper} variables that
140 correspond to distances on the page are measured in millimeters,
141 unless a different unit is specified by the user.  For example,
142 the following declaration sets @code{top-margin} to ten
143 millimeters:
144
145 @example
146 \paper @{
147   top-margin = 10
148 @}
149 @end example
150
151 To set it to @code{0.5} inches, use the @code{\in} unit suffix:
152
153 @example
154 \paper @{
155   top-margin = 0.5\in
156 @}
157 @end example
158
159 The available unit suffixes are @code{\mm}, @code{\cm},
160 @code{\in}, and @code{\pt}.  These units are simple values for
161 converting from millimeters; they are defined in
162 @file{ly/paper-defaults-init.ly}.  For the sake of clarity, when
163 using millimeters, the @code{\mm} is typically included in the
164 code, even though it is not technically necessary.
165
166 It is also possible to define @code{\paper} values using Scheme.
167 The Scheme equivalent of the above example is:
168
169 @example
170 \paper @{
171   #(define top-margin (* 0.5 in))
172 @}
173 @end example
174
175 @seealso
176 Notation Reference:
177 @ref{Paper size and automatic scaling},
178 @ref{Custom titles headers and footers},
179 @ref{The \layout block}.
180
181 Installed Files:
182 @file{ly/paper-defaults-init.ly}.
183
184
185 @node Paper size and automatic scaling
186 @subsection Paper size and automatic scaling
187
188 @cindex paper size
189 @cindex page size
190
191 @funindex \paper
192
193 @menu
194 * Setting the paper size::
195 * Automatic scaling to paper size::
196 @end menu
197
198
199 @node Setting the paper size
200 @unnumberedsubsubsec Setting the paper size
201
202 @q{A4} is the default value when no explicit paper size is set. However,
203 there are two functions that can be used to change it
204 @code{set-default-paper-size},
205
206 @example
207 #(set-default-paper-size "quarto")
208 @end example
209
210 which must always be placed at the toplevel scope. and
211 @code{set-paper-size},
212
213 @example
214 \paper @{
215   #(set-paper-size "tabloid")
216 @}
217 @end example
218
219 which must always be placed in a @code{\paper} block.
220
221 If the @code{set-default-paper-size} function is used in the toplevel
222 scope, it must come before the any @code{\paper} block.
223 @code{set-default-paper-size} sets the paper size for all pages,
224 whereas @code{set-paper-size} only sets the paper size for the pages
225 that the @code{\paper} block applies to.  For example, if the
226 @code{\paper} block is at the top of the file, then it will apply the
227 paper size to all pages.  If the @code{\paper} block is inside a
228 @code{\book}, then the paper size will only apply to that book.
229
230 When the @code{set-paper-size} function is used, it must be
231 placed @emph{before} any other functions used within the same
232 @code{\paper} block.  See @ref{Automatic scaling to paper size}.
233
234 Paper sizes are defined in @file{scm/paper.scm}, and while it is
235 possible to add custom sizes, they will be overwritten on subsequent
236 software updates.  The available paper sizes are listed in
237 @ref{Predefined paper sizes}.
238
239 @c An appendix entry exists for paper sizes but is not auto-generated
240
241 The following command can be used in the file to add a custom paper size
242 which can then be used with @code{set-default-paper-size} or
243 @code{set-paper-size} as appropriate,
244
245 @example
246 #(set! paper-alist (cons '("my size" . (cons (* 15 in) (* 3 in))) paper-alist))
247
248 \paper @{
249   #(set-paper-size "my size")
250 @}
251 @end example
252
253 The units @code{in} (inches), @code{cm} (centimeters) and @code{mm}
254 (millimeters) can all be used.
255
256 @cindex paper size, orientation
257 @cindex page, orientation
258 @cindex paper size, landscape
259
260 If the symbol @code{'landscape} is added to the paper size function,
261 pages will be rotated by 90 degrees, and wider line widths will be set
262 accordingly.
263
264 @example
265 #(set-default-paper-size "a6" 'landscape)
266 @end example
267
268 Swapping the paper dimensions @emph{without} having the print rotated
269 (like when printing to postcard size, or creating graphics for inclusion
270 rather than a standalone document) can be achieved by appending
271 @samp{landscape} to the name of the paper size itself:
272
273 @example
274 #(set-default-paper-size "a6landscape")
275 @end example
276
277 When the paper size ends with an explicit @samp{landscape} or
278 @samp{portrait}, the presence of a @code{'landscape} symbol @emph{only}
279 affects print orientation, not the paper dimensions used for layout.
280
281 @seealso
282 Notation Reference:
283 @ref{Automatic scaling to paper size},
284 @ref{Predefined paper sizes}.
285
286 Installed Files:
287 @file{scm/paper.scm}.
288
289
290 @node Automatic scaling to paper size
291 @unnumberedsubsubsec Automatic scaling to paper size
292
293 If the paper size is changed with one of the scheme functions
294 (@code{set-default-paper-size} or @code{set-paper-size}), the
295 values of several @code{\paper} variables are automatically scaled
296 to the new size.  To bypass the automatic scaling for a particular
297 variable, set the variable after setting the paper size.  Note
298 that the automatic scaling is not triggered by setting the
299 @code{paper-height} or @code{paper-width} variables, even though
300 @code{paper-width} can influence other values (this is separate
301 from scaling and is discussed below).  The
302 @code{set-default-paper-size} and @code{set-paper-size} functions
303 are described in @ref{Setting the paper size}.
304
305 The vertical dimensions affected by automatic scaling are
306 @code{top-margin} and @code{bottom-margin} (see
307 @ref{Fixed vertical spacing \paper variables}).  The horizontal
308 dimensions affected by automatic scaling are @code{left-margin},
309 @code{right-margin}, @code{inner-margin}, @code{outer-margin},
310 @code{binding-offset}, @code{indent}, and @code{short-indent} (see
311 @ref{Horizontal spacing \paper variables}).
312
313 The default values for these dimensions are set in
314 @file{ly/paper-defaults-init.ly}, using internal variables named
315 @code{top-margin-default}, @code{bottom-margin-default}, etc.
316 These are the values that result at the default paper size
317 @code{a4}.  For reference, with @code{a4} paper the
318 @code{paper-height} is @code{297\mm} and the @code{paper-width} is
319 @code{210\mm}.
320
321 @seealso
322 Notation Reference:
323 @ref{Fixed vertical spacing \paper variables},
324 @ref{Horizontal spacing \paper variables}.
325
326 Installed Files:
327 @file{ly/paper-defaults-init.ly},
328 @file{scm/paper.scm}.
329
330
331 @node Fixed vertical spacing \paper variables
332 @subsection Fixed vertical spacing @code{\paper} variables
333
334 @warning{Some @code{@bs{}paper} dimensions are automatically
335 scaled to the paper size, which may lead to unexpected behavior.
336 See @ref{Automatic scaling to paper size}.}
337
338 Default values (before scaling) are defined in
339 @file{ly/paper-defaults-init.ly}.
340
341 @table @code
342 @item paper-height
343 @funindex paper-height
344
345 The height of the page, unset by default.  Note that the automatic
346 scaling of some vertical dimensions is not affected by this.
347
348 @item top-margin
349 @funindex top-margin
350
351 The margin between the top of the page and the top of the
352 printable area.  If the paper size is modified, this dimension's
353 default value is scaled accordingly.
354
355 @item bottom-margin
356 @funindex bottom-margin
357
358 The margin between the bottom of the printable area and the bottom
359 of the page.  If the paper size is modified, this dimension's
360 default value is scaled accordingly.
361
362 @item ragged-bottom
363 @funindex ragged-bottom
364
365 If set to true, systems will not spread vertically down the page.
366 This does not affect the last page.  This should be set to true
367 for pieces that have only two or three systems per page, for
368 example orchestral scores.
369
370 @item ragged-last-bottom
371 @funindex ragged-last-bottom
372
373 If set to false, systems will spread vertically down the last
374 page.  Pieces that amply fill two pages or more should have this
375 set to false.  It also affects the last page of book parts, i.e.
376 parts of a book created with @code{\bookpart} blocks.
377
378 @end table
379
380 @seealso
381 Notation Reference:
382 @ref{Automatic scaling to paper size}.
383
384 Installed Files:
385 @file{ly/paper-defaults-init.ly}.
386
387 Snippets:
388 @rlsr{Spacing}.
389
390 @knownissues
391 The titles (from the @code{\header} block) are treated as a
392 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
393 add space between the titles and the first system of the score.
394
395 Explicitly defined paper-sizes will override any user-defined top or
396 bottom margin settings.
397
398
399 @node Flexible vertical spacing \paper variables
400 @subsection Flexible vertical spacing @code{\paper} variables
401
402 In most cases, it is preferable for the vertical distances between
403 certain items (such as margins, titles, systems, and separate
404 scores) to be flexible, so that they stretch and compress nicely
405 according to each situation.  A number of @code{\paper} variables
406 (listed below) are available to fine-tune the stretching behavior
407 of these dimensions.
408
409 Note that the @code{\paper} variables discussed in this section do
410 not control the spacing of staves within individual systems.
411 Within-system spacing is controlled by grob properties, with
412 settings typically entered inside a @code{\score} or
413 @code{\layout} block, and not inside a @code{\paper} block.  See
414 @ref{Flexible vertical spacing within systems}.
415
416 @menu
417 * Structure of flexible vertical spacing alists::
418 * List of flexible vertical spacing \paper variables::
419 @end menu
420
421
422 @node Structure of flexible vertical spacing alists
423 @unnumberedsubsubsec Structure of flexible vertical spacing alists
424
425 Each of the flexible vertical spacing @code{\paper} variables is
426 an alist (association list) containing four @emph{keys}:
427
428 @itemize
429
430 @item
431 @code{basic-distance} -- the vertical distance, measured in
432 staff-spaces, between the @emph{reference points} of the two
433 items, when no collisions would result, and no stretching or
434 compressing is in effect.  The reference point of a (title or
435 top-level) markup is its highest point, and the reference point of
436 a system is the vertical center of the nearest @code{StaffSymbol}
437 -- even if a non-staff line (such as a @code{Lyrics} context) is
438 in the way.  Values for @code{basic-distance} that are less than
439 either @code{padding} or @code{minimum-distance} are not
440 meaningful, since the resulting distance will never be less than
441 either @code{padding} or @code{minimum-distance}.
442
443 @item
444 @code{minimum-distance} -- the smallest allowable vertical
445 distance, measured in staff-spaces, between the reference points
446 of the two items, when compressing is in effect.  Values for
447 @code{minimum-distance} that are less than @code{padding} are not
448 meaningful, since the resulting distance will never be less than
449 @code{padding.}
450
451 @c TODO: explain skylines somewhere and xref to it from here.
452
453 @item
454 @code{padding} -- the minimum required amount of unobstructed
455 vertical whitespace between the bounding boxes (or skylines) of
456 the two items, measured in staff-spaces.
457
458 @item
459 @code{stretchability} -- a unitless measure of the dimension's
460 relative propensity to stretch.  If zero, the distance will not
461 stretch (unless collisions would result).  When positive, the
462 significance of a particular dimension's @code{stretchability}
463 value lies only in its relation to the @code{stretchability}
464 values of the other dimensions.  For example, if one dimension has
465 twice the @code{stretchability} of another, it will stretch twice
466 as easily.  Values should be non-negative and finite.  The value
467 @code{+inf.0} triggers a @code{programming_error} and is ignored,
468 but @code{1.0e7} can be used for an almost infinitely stretchable
469 spring.  If unset, the default value is set to
470 @code{basic-distance}.  Note that the dimension's propensity to
471 @emph{compress} cannot be directly set by the user and is equal to
472 (@code{basic-distance}@tie{}@minus{}@tie{}@code{minimum-distance}).
473
474 @end itemize
475
476 If a page has a ragged bottom, the resulting distance is the
477 largest of:
478
479 @itemize
480
481 @item
482 @code{basic-distance},
483
484 @item
485 @code{minimum-distance}, and
486
487 @item
488 @code{padding} plus the smallest distance necessary to eliminate
489 collisions.
490
491 @end itemize
492
493 For multi-page scores with a ragged bottom on the last page, the last
494 page uses the same spacing as the preceding page, provided there is
495 enough space for that.
496
497 Specific methods for modifying alists are discussed in
498 @ref{Modifying alists}.  The following example demonstrates the
499 two ways these alists can be modified.  The first declaration
500 updates one key-value individually, and the second completely
501 redefines the variable:
502
503 @example
504 \paper @{
505   system-system-spacing #'basic-distance = #8
506   score-system-spacing =
507     #'((basic-distance . 12)
508        (minimum-distance . 6)
509        (padding . 1)
510        (stretchability . 12))
511 @}
512 @end example
513
514
515 @node List of flexible vertical spacing \paper variables
516 @unnumberedsubsubsec List of flexible vertical spacing @code{\paper} variables
517
518 The names of these variables follow the format
519 @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}}
520 and @code{@var{lower}} are the items to be spaced.  Each distance
521 is measured between the reference points of the two items (see the
522 description of the alist structure above).  Note that in these
523 variable names, the term @q{@code{markup}} refers to both
524 @emph{title markups} (@code{bookTitleMarkup} or
525 @code{scoreTitleMarkup}) and @emph{top-level markups} (see
526 @ref{File structure}).  All distances are measured in
527 staff-spaces.
528
529 Default settings are defined in @file{ly/paper-defaults-init.ly}.
530
531 @c TODO: Where do headers/footers fit in? -mp
532
533 @table @code
534 @item markup-system-spacing
535 @funindex markup-system-spacing
536
537 the distance between a (title or top-level) markup and the system
538 that follows it.
539
540 @item score-markup-spacing
541 @funindex score-markup-spacing
542
543 the distance between the last system of a score and the (title or
544 top-level) markup that follows it.
545
546 @item score-system-spacing
547 @funindex score-system-spacing
548
549 the distance between the last system of a score and the first
550 system of the score that follows it, when no (title or top-level)
551 markup exists between them.
552
553 @item system-system-spacing
554 @funindex system-system-spacing
555
556 the distance between two systems in the same score.
557
558 @item markup-markup-spacing
559 @funindex markup-markup-spacing
560
561 the distance between two (title or top-level) markups.
562
563 @item last-bottom-spacing
564 @funindex last-bottom-spacing
565
566 the distance from the last system or top-level markup on a page to
567 the bottom of the printable area (i.e. the top of the bottom
568 margin).
569
570 @item top-system-spacing
571 @funindex top-system-spacing
572
573 the distance from the top of the printable area (i.e. the bottom
574 of the top margin) to the first system on a page, when there is no
575 (title or top-level) markup between the two.
576
577 @item top-markup-spacing
578 @funindex top-markup-spacing
579
580 the distance from the top of the printable area (i.e. the bottom
581 of the top margin) to the first (title or top-level) markup on a
582 page, when there is no system between the two.
583 @end table
584
585 @seealso
586 Notation Reference:
587 @ref{Flexible vertical spacing within systems}.
588
589 Installed Files:
590 @file{ly/paper-defaults-init.ly}.
591
592 Snippets:
593 @rlsr{Spacing}.
594
595
596 @node Horizontal spacing \paper variables
597 @subsection Horizontal spacing @code{\paper} variables
598
599 @warning{Some @code{@bs{}paper} dimensions are automatically
600 scaled to the paper size, which may lead to unexpected behavior.
601 See @ref{Automatic scaling to paper size}.}
602
603 @menu
604 * \paper variables for widths and margins::
605 * \paper variables for two-sided mode::
606 * \paper variables for shifts and indents::
607 @end menu
608
609
610 @node \paper variables for widths and margins
611 @unnumberedsubsubsec @code{\paper} variables for widths and margins
612
613 Default values (before scaling) that are not listed here are
614 defined in @file{ly/paper-defaults-init.ly}.
615
616 @table @code
617
618 @item paper-width
619 @funindex paper-width
620
621 The width of the page, unset by default.  While @code{paper-width}
622 has no effect on the automatic scaling of some horizontal
623 dimensions, it does influence the @code{line-width} variable.  If
624 both @code{paper-width} and @code{line-width} are set, then
625 @code{left-margin} and @code{right-margin} will also be updated.
626 Also see @code{check-consistency}.
627
628 @item line-width
629 @funindex line-width
630
631 The horizontal extent of the staff lines in unindented, non-ragged
632 systems, equal to
633 @code{(paper-width@tie{}@minus{}@tie{}left-margin@tie{}@minus{}@tie{}right-margin)}
634 when unset.  If @code{line-width} is set, and both
635 @code{left-margin} and @code{right-margin} are unset, then the
636 margins will be updated to center the systems on the page
637 automatically.  Also see @code{check-consistency}.  This variable
638 can also be set in a @code{\layout} block.
639
640 @item left-margin
641 @funindex left-margin
642
643 The margin between the left edge of the page and the start of the
644 staff lines in unindented systems.  If the paper size is modified,
645 this dimension's default value is scaled accordingly.  If
646 @code{left-margin} is unset, and both @code{line-width} and
647 @code{right-margin} are set, then @code{left-margin} is set to
648 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}right-margin)}.
649 If only @code{line-width} is set, then both margins are set to
650 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
651 and the systems are consequently centered on the page.  Also see
652 @code{check-consistency}.
653
654 @item right-margin
655 @funindex right-margin
656
657 The margin between the right edge of the page and the end of the
658 staff lines in non-ragged systems.  If the paper size is modified,
659 this dimension's default value is scaled accordingly.  If
660 @code{right-margin} is unset, and both @code{line-width} and
661 @code{left-margin} are set, then @code{right-margin} is set to
662 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}left-margin)}.
663 If only @code{line-width} is set, then both margins are set to
664 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
665 and the systems are consequently centered on the page.  Also see
666 @code{check-consistency}.
667
668 @item check-consistency
669 @funindex check-consistency
670
671 If set to true, print a warning if @code{left-margin},
672 @code{line-width}, and @code{right-margin} do not exactly add up
673 to @code{paper-width}, and replace each of these (except
674 @code{paper-width}) with its default value (scaled to the paper
675 size if necessary).  If set to false, ignore any inconsistencies
676 and allow systems to run off the edge of the page.
677
678 @item ragged-right
679 @funindex ragged-right
680
681 If set to true, systems will not fill the line width.  Instead,
682 systems end at their natural horizontal length.  Default:
683 @code{#t} for scores with only one system, and @code{#f} for
684 scores with two or more systems.  This variable can also be set in
685 a @code{\layout} block.
686
687 @item ragged-last
688 @funindex ragged-last
689
690 If set to true, the last system in the score will not fill the
691 line width.  Instead the last system ends at its natural
692 horizontal length.  Default: @code{#f}.  This variable can also be
693 set in a @code{\layout} block.
694
695 @end table
696
697 @seealso
698 Notation Reference:
699 @ref{Automatic scaling to paper size}.
700
701 Installed Files:
702 @file{ly/paper-defaults-init.ly}.
703
704 @knownissues
705 Explicitly defined paper-sizes will override any user-defined left or
706 right margin settings.
707
708
709 @node \paper variables for two-sided mode
710 @unnumberedsubsubsec @code{\paper} variables for two-sided mode
711
712 Default values (before scaling) are defined in
713 @file{ly/paper-defaults-init.ly}.
714
715 @table @code
716
717 @item two-sided
718 @funindex two-sided
719
720 @cindex gutter
721 @cindex binding gutter
722
723 If set to true, use @code{inner-margin}, @code{outer-margin} and
724 @code{binding-offset} to determine margins depending on whether
725 the page number is odd or even.  This overrides @code{left-margin}
726 and @code{right-margin}.
727
728 @item inner-margin
729 @funindex inner-margin
730
731 The margin all pages have at the inner side if they are part of a
732 book.  If the paper size is modified, this dimension's default
733 value is scaled accordingly.  Works only with @code{two-sided} set
734 to true.
735
736 @item outer-margin
737 @funindex outer-margin
738
739 The margin all pages have at the outer side if they are part of a
740 book.  If the paper size is modified, this dimension's default
741 value is scaled accordingly.  Works only with @code{two-sided} set
742 to true.
743
744 @item binding-offset
745 @funindex binding-offset
746
747 The amount @code{inner-margin} is increased to make sure nothing
748 will be hidden by the binding.  If the paper size is modified,
749 this dimension's default value is scaled accordingly.  Works only
750 with @code{two-sided} set to true.
751
752 @end table
753
754 @seealso
755 Notation Reference:
756 @ref{Automatic scaling to paper size}.
757
758 Installed Files:
759 @file{ly/paper-defaults-init.ly}.
760
761
762 @node \paper variables for shifts and indents
763 @unnumberedsubsubsec @code{\paper} variables for shifts and indents
764
765 Default values (before scaling) that are not listed here are
766 defined in @file{ly/paper-defaults-init.ly}.
767
768 @table @code
769
770 @item horizontal-shift
771 @funindex horizontal-shift
772
773 @c This default value is buried in the middle of page.scm.  -mp
774
775 The amount that all systems (including titles and system
776 separators) are shifted to the right.  Default: @code{0.0\mm}.
777
778 @item indent
779 @funindex indent
780
781 The level of indentation for the first system in a score.  If the
782 paper size is modified, this dimension's default value is scaled
783 accordingly.  This variable can also be set in a @code{\layout}
784 block.
785
786 @item short-indent
787 @funindex short-indent
788
789 The level of indentation for all systems in a score besides the
790 first system.  If the paper size is modified, this dimension's
791 default value is scaled accordingly.  This variable can also be
792 set in a @code{\layout} block.
793
794 @end table
795
796 @seealso
797 Notation Reference:
798 @ref{Automatic scaling to paper size}.
799
800 Installed Files:
801 @file{ly/paper-defaults-init.ly}.
802
803 Snippets:
804 @rlsr{Spacing}.
805
806
807 @node Other \paper variables
808 @subsection Other @code{\paper} variables
809
810 @menu
811 * \paper variables for line breaking::
812 * \paper variables for page breaking::
813 * \paper variables for page numbering::
814 * Miscellaneous \paper variables::
815 @end menu
816
817
818 @node \paper variables for line breaking
819 @unnumberedsubsubsec @code{\paper} variables for line breaking
820
821 @c TODO: Mention that ly:optimal-breaking is on by default? -mp
822
823 @table @code
824
825 @item max-systems-per-page
826 @funindex max-systems-per-page
827
828 The maximum number of systems that will be placed on a page.  This
829 is currently supported only by the @code{ly:optimal-breaking} algorithm.
830 Default: unset.
831
832 @item min-systems-per-page
833 @funindex min-systems-per-page
834
835 The minimum number of systems that will be placed on a page.  This
836 may cause pages to be overfilled if it is made too large.  This is
837 currently supported only by the @code{ly:optimal-breaking} algorithm.
838 Default: unset.
839
840 @item systems-per-page
841 @funindex systems-per-page
842
843 The number of systems that should be placed on each page.
844 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
845 Default: unset.
846
847 @item system-count
848 @funindex system-count
849
850 The number of systems to be used for a score.  Default: unset.
851 This variable can also be set in a @code{\layout} block.
852
853 @end table
854
855 @seealso
856 Notation Reference:
857 @ref{Line breaking}.
858
859
860 @node \paper variables for page breaking
861 @unnumberedsubsubsec @code{\paper} variables for page breaking
862
863 Default values not listed here are defined in
864 @file{ly/paper-defaults-init.ly}
865
866 @table @code
867
868 @item blank-after-score-page-force
869 @funindex blank-after-score-page-force
870
871 The penalty for having a blank page after the end of one score and
872 before the next.  By default, this is smaller than
873 @code{blank-page-force}, so that we prefer blank pages after
874 scores to blank pages within a score.
875
876 @item blank-last-page-force
877 @funindex blank-last-page-force
878
879 The penalty for ending the score on an odd-numbered page.
880
881 @item blank-page-force
882 @funindex blank-page-force
883
884 The penalty for having a blank page in the middle of a
885 score.  This is not used by @code{ly:optimal-breaking} since it will
886 never consider blank pages in the middle of a score.
887
888 @item page-breaking
889 @funindex page-breaking
890
891 The page-breaking algorithm to use.  Choices are
892 @code{ly:minimal-breaking}, @code{ly:page-turn-breaking}, and
893 @code{ly:optimal-breaking}.
894
895 @item page-breaking-system-system-spacing
896 @funindex page-breaking-system-system-spacing
897
898 Tricks the page breaker into thinking that
899 @code{system-system-spacing} is set to something different than
900 it really is.  For example, if
901 @code{page-breaking-system-system-spacing #'padding} is set to something
902 substantially larger than @code{system-system-spacing #'padding}, then the
903 page-breaker will put fewer systems on each page.  Default: unset.
904
905 @item page-count
906 @funindex page-count
907
908 The number of pages to be used for a score, unset by default.
909
910 @end table
911
912 @seealso
913 Notation Reference:
914 @ref{Page breaking},
915 @ref{Optimal page breaking},
916 @ref{Optimal page turning},
917 @ref{Minimal page breaking},
918 @ref{One-line page breaking}.
919
920 Installed Files:
921 @file{ly/paper-defaults-init.ly}.
922
923
924 @node \paper variables for page numbering
925 @unnumberedsubsubsec @code{\paper} variables for page numbering
926
927 Default values not listed here are defined in
928 @file{ly/paper-defaults-init.ly}
929
930 @table @code
931
932 @cindex page numbers, auto-numbering
933 @item auto-first-page-number
934 @funindex auto-first-page-number
935
936 The page breaking algorithm is affected by the first page number
937 being odd or even.  If set to true, the page breaking algorithm
938 will decide whether to start with an odd or even number.  This
939 will result in the first page number remaining as is or being
940 increased by one.  Default: @code{#f}.
941
942 @cindex page numbers, specify the first
943 @item first-page-number
944 @funindex first-page-number
945
946 The value of the page number on the first page.
947
948 @item print-first-page-number
949 @funindex print-first-page-number
950
951 If set to true, a page number is printed on the first page.
952
953 @cindex page numbers, suppress
954 @item print-page-number
955 @funindex print-page-number
956
957 If set to false, page numbers are not printed.
958
959 @end table
960
961 @seealso
962 Installed Files:
963 @file{ly/paper-defaults-init.ly}.
964
965 @knownissues
966 Odd page numbers are always on the right.  If you want the
967 music to start on page 1 there must be a blank page on the back
968 of the cover page so that page 1 is on the right hand side.
969
970
971 @node Miscellaneous \paper variables
972 @unnumberedsubsubsec Miscellaneous @code{\paper} variables
973
974 @table @code
975
976 @item page-spacing-weight
977 @funindex page-spacing-weight
978
979 The relative importance of page (vertical) spacing and line
980 (horizontal) spacing.  High values will make page spacing more
981 important.  Default: @code{10}.
982
983 @item print-all-headers
984 @funindex print-all-headers
985
986 If set to true, this will print all headers for each @code{\score}
987 in the output.  Normally only the @code{piece} and @code{opus}
988 header variables are printed.  Default: @code{#f}.
989
990 @item system-separator-markup
991 @funindex system-separator-markup
992
993 A markup object that is inserted between systems, often used for
994 orchestral scores.  Default: unset.  The @code{\slashSeparator}
995 markup, defined in @file{ly/titling-init.ly}, is provided as a
996 sensible default, for example:
997
998 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
999 #(set-default-paper-size "a8")
1000
1001 \book {
1002   \paper {
1003     system-separator-markup = \slashSeparator
1004   }
1005   \header {
1006     tagline = ##f
1007   }
1008   \score {
1009     \relative c'' { c1 \break c1 \break c1 }
1010   }
1011 }
1012 @end lilypond
1013
1014 @end table
1015
1016 @seealso
1017 Installed Files:
1018 @file{ly/titling-init.ly}.
1019
1020 Snippets:
1021 @rlsr{Spacing}.
1022
1023 @knownissues
1024 The default page header puts the page number and the @code{instrument}
1025 field from the @code{\header} block on a line.
1026
1027
1028 @node Score layout
1029 @section Score layout
1030
1031 This section discusses score layout options for the @code{\layout}
1032 block.
1033
1034 @menu
1035 * The \layout block::
1036 * Setting the staff size::
1037 @end menu
1038
1039
1040 @node The \layout block
1041 @subsection The @code{\layout} block
1042
1043 @funindex \layout
1044
1045 While the @code{\paper} block contains settings that relate to the
1046 page formatting of the whole document, the @code{\layout} block
1047 contains settings for score-specific layout.  To set score layout
1048 options globally, enter them in a toplevel @code{\layout} block.
1049 To set layout options for an individual score, enter them in a
1050 @code{\layout} block inside the @code{\score} block, after the
1051 music.  Settings that can appear in a @code{\layout} block
1052 include:
1053
1054 @itemize
1055 @item the @code{layout-set-staff-size} scheme function,
1056 @item context modifications in @code{\context} blocks, and
1057 @item @code{\paper} variables that affect score layout.
1058 @end itemize
1059
1060 The @code{layout-set-staff-size} function is discussed in the next
1061 section, @ref{Setting the staff size}.  Context modifications are
1062 discussed in a separate chapter; see
1063 @ref{Modifying context plug-ins} and
1064 @ref{Changing context default settings}.  The @code{\paper}
1065 variables that can appear in a @code{\layout} block are:
1066
1067 @itemize
1068
1069 @item
1070 @code{line-width}, @code{ragged-right} and @code{ragged-last}
1071 (see @ref{\paper variables for widths and margins})
1072
1073 @item
1074 @code{indent} and @code{short-indent}
1075 (see @ref{\paper variables for shifts and indents})
1076
1077 @item
1078 @code{system-count}
1079 (see @ref{\paper variables for line breaking})
1080
1081 @end itemize
1082
1083 Here is an example @code{\layout} block:
1084
1085 @example
1086 \layout @{
1087   indent = 2\cm
1088   \context @{
1089     \StaffGroup
1090     \override StaffGrouper #'staff-staff-spacing #'basic-distance = #8
1091   @}
1092   \context @{
1093     \Voice
1094     \override TextScript #'padding = #1
1095     \override Glissando #'thickness = #3
1096   @}
1097 @}
1098 @end example
1099
1100 Multiple @code{\layout} blocks can be entered as toplevel expressions.
1101 This can, for example, be useful if different settings are stored in
1102 separate files and included optionally.  Internally, when
1103 a @code{\layout} block is evaluated, a copy of the current
1104 @code{\layout} configuration is made, then any changes defined within
1105 the block are applied and the result is saved as the new current
1106 configuration.  From the user's perspective the @code{\layout} blocks
1107 are combined, but in conflicting situations (when the same property
1108 is changed in different blocks) the later definitions take precedence.
1109
1110 For example, if this block:
1111
1112 @example
1113 \layout @{
1114   \context @{
1115     \Voice
1116     \override TextScript #'color = #magenta
1117     \override Glissando #'thickness = #1.5
1118   @}
1119 @}
1120 @end example
1121
1122 is placed after the one from the preceding example the @code{'padding}
1123 and @code{'color} overrides for @code{TextScript} are combined, but
1124 the later @code{'thickness} override for @code{Glissando} replaces
1125 (or hides) the earlier one.
1126
1127 @code{\layout} blocks may be assigned to variables for reuse later,
1128 but the way this works is slightly but significantly different from
1129 writing them literally.
1130
1131 If a variable is defined like this:
1132
1133 @example
1134 layoutVariable = \layout @{
1135   \context @{
1136     \Voice
1137     \override NoteHead #'font-size = #4
1138   @}
1139 @}
1140 @end example
1141
1142 it will hold the current @code{\layout} configuration with the
1143 @code{NoteHead #'font-size} override added, but this combination
1144 is @emph{not} saved as the new current configuration.  Be aware
1145 that the @q{current configuration} is read when the variable is
1146 defined and not when it is used, so the content of the variable
1147 is dependent on its position in the source.
1148
1149 The variable can then be used inside another @code{\layout} block,
1150 for example:
1151
1152 @example
1153 \layout @{
1154   \layoutVariable
1155   \context @{
1156     \Voice
1157     \override NoteHead #'color = #red
1158   @}
1159 @}
1160 @end example
1161
1162 A @code{\layout} block containing a variable, as in the example above,
1163 does @emph{not} copy the current configuration but instead uses the
1164 content of @code{\layoutVariable} as the base configuration for the
1165 further additions.  This means that any changes defined between the
1166 definition and the use of the variable are lost.
1167
1168 If @code{layoutVariable} is defined (or @code{\include}d) immediately
1169 before being used, its content is just the current configuration plus
1170 the overrides defined within it.  So in the example above showing the
1171 use of @code{\layoutVariable} the final @code{\layout} block would
1172 consist of:
1173
1174 @example
1175   TextScript #'padding = #1
1176   TextScript #'color = #magenta
1177   Glissando #'thickness = #1.5
1178   NoteHead #' font-size = #4
1179   NoteHead #' color = #red
1180 @end example
1181
1182 plus the @code{indent} and the @code{StaffGrouper} overrides.
1183
1184 But if the variable had already been defined before the first
1185 @code{\layout} block the current configuration would now contain
1186 only
1187
1188 @example
1189   NoteHead #' font-size= #4 % (written in the variable definition)
1190   NoteHead #' color = #red % (added after the use of the variable)
1191 @end example
1192
1193 If carefully planned, @code{\layout} variables can be a valuable tool
1194 to structure the layout design of sources, and also to reset the
1195 @code{\layout} configuration to a known state.
1196
1197 @seealso
1198 Notation Reference:
1199 @ref{Changing context default settings}.
1200
1201 Snippets:
1202 @rlsr{Spacing}.
1203
1204
1205 @node Setting the staff size
1206 @subsection Setting the staff size
1207
1208 @cindex font size, setting
1209 @cindex staff size, setting
1210 @funindex layout file
1211
1212 The default @strong{staff size} is set to 20 points.
1213 This may be changed in two ways:
1214
1215 To set the staff size globally for all scores in a file (or
1216 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
1217
1218 @example
1219 #(set-global-staff-size 14)
1220 @end example
1221
1222 @noindent
1223 This sets the global default size to 14pt staff height and scales all
1224 fonts accordingly.
1225
1226 To set the staff size individually for each score, use
1227 @example
1228 \score@{
1229   @dots{}
1230   \layout @{
1231     #(layout-set-staff-size 15)
1232   @}
1233 @}
1234 @end example
1235
1236 The Feta font provides musical symbols at eight different
1237 sizes.  Each font is tuned for a different staff size: at a smaller size
1238 the font becomes heavier, to match the relatively heavier staff lines.
1239 The recommended font sizes are listed in the following table:
1240
1241 @quotation
1242 @multitable @columnfractions .15 .2 .22 .2
1243
1244 @item @b{font name}
1245 @tab @b{staff height (pt)}
1246 @tab @b{staff height (mm)}
1247 @tab @b{use}
1248
1249 @item feta11
1250 @tab 11.22
1251 @tab 3.9
1252 @tab pocket scores
1253
1254 @item feta13
1255 @tab 12.60
1256 @tab 4.4
1257 @tab
1258
1259 @item feta14
1260 @tab 14.14
1261 @tab 5.0
1262 @tab
1263
1264 @item feta16
1265 @tab 15.87
1266 @tab 5.6
1267 @tab
1268
1269 @item feta18
1270 @tab 17.82
1271 @tab 6.3
1272 @tab song books
1273
1274 @item feta20
1275 @tab 20
1276 @tab 7.0
1277 @tab standard parts
1278
1279 @item feta23
1280 @tab 22.45
1281 @tab 7.9
1282 @tab
1283
1284 @item feta26
1285 @tab 25.2
1286 @tab 8.9
1287 @tab
1288 @c modern rental material?
1289
1290 @end multitable
1291 @end quotation
1292
1293 These fonts are available in any sizes.  The context property
1294 @code{fontSize} and the layout property @code{staff-space} (in
1295 @rinternals{StaffSymbol}) can be used to tune the size for individual
1296 staves.  The sizes of individual staves are relative to the global size.
1297
1298 @seealso
1299 Notation Reference:
1300 @ref{Selecting notation font size}.
1301
1302 Snippets:
1303 @rlsr{Spacing}.
1304
1305 @knownissues
1306 @code{layout-set-staff-size} does not change the distance between the
1307 staff lines.
1308
1309
1310 @node Breaks
1311 @section Breaks
1312
1313 @menu
1314 * Line breaking::
1315 * Page breaking::
1316 * Optimal page breaking::
1317 * Optimal page turning::
1318 * Minimal page breaking::
1319 * One-line page breaking::
1320 * Explicit breaks::
1321 * Using an extra voice for breaks::
1322 @end menu
1323
1324
1325 @node Line breaking
1326 @subsection Line breaking
1327
1328 @cindex line breaks
1329 @cindex breaking lines
1330
1331 Line breaks are normally determined automatically.  They are chosen
1332 so that lines look neither cramped nor loose, and consecutive
1333 lines have similar density.
1334
1335 To manually force a line break at a bar line, use the
1336 @code{\break} command:
1337
1338 @lilypond[quote,ragged-right,relative=2,verbatim]
1339 c4 c c c | \break
1340 c4 c c c |
1341 @end lilypond
1342
1343 By default, a @code{\break} in the middle of a measure is ignored,
1344 and a warning is printed.  To force a line break in the middle of
1345 a measure, add an invisible bar line with @w{@samp{\bar ""}}:
1346
1347 @lilypond[quote,ragged-right,relative=2,verbatim]
1348 c4 c c
1349 \bar "" \break
1350 c |
1351 c4 c c c |
1352 @end lilypond
1353
1354 A @code{\break} occurring at a bar line is also ignored if the
1355 previous measure ends in the middle of a note, such as when a
1356 tuplet begins and ends in different measures.  To allow
1357 @code{\break} commands to work in these situations, remove the
1358 @code{Forbid_line_break_engraver} from the @code{Voice} context.
1359 Note that manually forced line breaks have to be added in parallel
1360 with the music:
1361
1362 @lilypond[quote,ragged-right,verbatim]
1363 \new Voice \with {
1364   \remove "Forbid_line_break_engraver"
1365 } \relative c'' {
1366   <<
1367     { c2. \times 2/3 { c4 c c } c2. | }
1368     { s1 | \break s1 | }
1369   >>
1370 }
1371 @end lilypond
1372
1373 Similarly, line breaks are normally forbidden when beams cross bar
1374 lines.  This behavior can be changed by setting
1375 @code{\override Beam #'breakable = ##t}:
1376
1377 @lilypond[quote,ragged-right,relative=2,verbatim]
1378 \override Beam #'breakable = ##t
1379 c2. c8[ c | \break
1380 c8 c] c2. |
1381 @end lilypond
1382
1383 The @code{\noBreak} command forbids a line break at the bar line
1384 where it is inserted.
1385
1386 The most basic settings influencing line spacing are @code{indent}
1387 and @code{line-width}.  They are set in the @code{\layout} block.
1388 They control the indentation of the first line of music, and the
1389 lengths of the lines.
1390
1391 If @code{ragged-right} is set to true in the @code{\layout} block,
1392 then systems end at their natural horizontal length, instead of
1393 being spread horizontally to fill the whole line.  This is useful
1394 for short fragments, and for checking how tight the natural
1395 spacing is.
1396
1397 @c TODO Check and add para on default for ragged-right
1398
1399 The option @code{ragged-last} is similar to @code{ragged-right},
1400 but affects only the last line of the piece.
1401
1402 @example
1403 \layout @{
1404   indent = 0\mm
1405   line-width = 150\mm
1406   ragged-last = ##t
1407 @}
1408 @end example
1409
1410
1411
1412 @cindex regular line breaks
1413 @cindex four bar music.
1414
1415 For line breaks at regular intervals use @code{\break} separated by
1416 skips and repeated with @code{\repeat}.  For example, this would
1417 cause the following 28 measures (assuming 4/4 time) to be broken
1418 every 4 measures, and only there:
1419
1420 @example
1421 <<
1422   \repeat unfold 7 @{
1423     s1 \noBreak s1 \noBreak
1424     s1 \noBreak s1 \break
1425   @}
1426   @{ @var{the actual music@dots{}} @}
1427 >>
1428 @end example
1429
1430
1431 @predefined
1432 @funindex \break
1433 @code{\break},
1434 @funindex \noBreak
1435 @code{\noBreak}.
1436 @endpredefined
1437
1438 @seealso
1439 Notation Reference:
1440 @ref{\paper variables for line breaking}.
1441
1442 Snippets:
1443 @rlsr{Spacing}.
1444
1445 Internals Reference:
1446 @rinternals{LineBreakEvent}.
1447
1448
1449 @node Page breaking
1450 @subsection Page breaking
1451
1452 The default page breaking may be overridden by inserting
1453 @code{\pageBreak} or @code{\noPageBreak} commands.  These commands are
1454 analogous to @code{\break} and @code{\noBreak}.  They should be
1455 inserted at a bar line.  These commands force and forbid a page-break
1456 from happening.  Of course, the @code{\pageBreak} command also forces
1457 a line break.
1458
1459 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1460 inserted at top-level, between scores and top-level markups.
1461
1462 There are also analogous settings to @code{ragged-right} and
1463 @code{ragged-last} which have the same effect on vertical spacing:
1464 @code{ragged-bottom} and @code{ragged-last-bottom}.  If set to
1465 @code{#t} the systems on all pages or just the last page
1466 respectively will not be justified vertically.  See
1467 @ref{Fixed vertical spacing \paper variables}.
1468
1469 Page breaks are computed by the @code{page-breaking} function.  LilyPond
1470 provides three algorithms for computing page breaks,
1471 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1472 @code{ly:minimal-breaking}.  The default is @code{ly:optimal-breaking},
1473 but the value can be changed in the @code{\paper} block:
1474
1475 @example
1476 \paper @{
1477   page-breaking = #ly:page-turn-breaking
1478 @}
1479 @end example
1480
1481 @funindex \bookpart
1482
1483 When a book has many scores and pages, the page breaking problem may be
1484 difficult to solve, requiring large processing time and memory.  To ease
1485 the page breaking process, @code{\bookpart} blocks are used to divide
1486 the book into several parts: the page breaking occurs separately on each
1487 part.  Different page breaking functions may also be used in different
1488 book parts.
1489
1490 @example
1491 \bookpart @{
1492   \header @{
1493     subtitle = "Preface"
1494   @}
1495   \paper @{
1496      %% In a part consisting mostly of text,
1497      %% ly:minimal-breaking may be preferred
1498      page-breaking = #ly:minimal-breaking
1499   @}
1500   \markup @{ @dots{} @}
1501   @dots{}
1502 @}
1503 \bookpart @{
1504   %% In this part, consisting of music, the default optimal
1505   %% page breaking function is used.
1506   \header @{
1507     subtitle = "First movement"
1508   @}
1509   \score @{ @dots{} @}
1510   @dots{}
1511 @}
1512 @end example
1513
1514
1515 @predefined
1516 @funindex \pageBreak
1517 @code{\pageBreak},
1518 @funindex \noPageBreak
1519 @code{\noPageBreak}.
1520 @endpredefined
1521
1522 @seealso
1523 Notation Reference:
1524 @ref{\paper variables for page breaking}.
1525
1526 Snippets:
1527 @rlsr{Spacing}.
1528
1529
1530 @node Optimal page breaking
1531 @subsection Optimal page breaking
1532
1533 @funindex ly:optimal-breaking
1534
1535 The @code{ly:optimal-breaking} function is LilyPond's default method of
1536 determining page breaks.  It attempts to find a page breaking that minimizes
1537 cramping and stretching, both horizontally and vertically.  Unlike
1538 @code{ly:page-turn-breaking}, it has no concept of page turns.
1539
1540 @seealso
1541 Snippets:
1542 @rlsr{Spacing}.
1543
1544
1545 @node Optimal page turning
1546 @subsection Optimal page turning
1547
1548 @funindex ly:page-turn-breaking
1549
1550 Often it is necessary to find a page breaking configuration so that there is
1551 a rest at the end of every second page.  This way, the musician can turn the
1552 page without having to miss notes.  The @code{ly:page-turn-breaking} function
1553 attempts to find a page breaking minimizing cramping and stretching, but with
1554 the additional restriction that it is only allowed to introduce page turns
1555 in specified places.
1556
1557 There are two steps to using this page breaking function.  First, you
1558 must enable it in the @code{\paper} block, as explained in @ref{Page
1559 breaking}.  Then you must tell the function where you would like to allow
1560 page breaks.
1561
1562 There are two ways to achieve the second step.  First, you can specify each
1563 potential page turn manually, by inserting @code{\allowPageTurn} into your
1564 input file at the appropriate places.
1565
1566 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1567 Voice context.  The @code{Page_turn_engraver} will scan the context for
1568 sections without notes (note that it does not scan for rests; it scans for
1569 the absence of notes.  This is so that single-staff polyphony with rests in one
1570 of the parts does not throw off the @code{Page_turn_engraver}).  When it finds
1571 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1572 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1573 there is a @q{special} bar line (such as a double bar), in which case the
1574 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1575 the section.
1576
1577 @funindex minimumPageTurnLength
1578 The @code{Page_turn_engraver} reads the context property
1579 @code{minimumPageTurnLength} to determine how long a note-free section must
1580 be before a page turn is considered.  The default value for
1581 @code{minimumPageTurnLength} is @code{(ly:make-moment 1 1)}.  If you want
1582 to disable page turns, you can set it to something very large.
1583
1584 @example
1585 \new Staff \with @{ \consists "Page_turn_engraver" @}
1586 @{
1587   a4 b c d |
1588   R1 | % a page turn will be allowed here
1589   a4 b c d |
1590   \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1591   R1 | % a page turn will not be allowed here
1592   a4 b r2 |
1593   R1*2 | % a page turn will be allowed here
1594   a1
1595 @}
1596 @end example
1597
1598 @funindex minimumRepeatLengthForPageTurn
1599 The @code{Page_turn_engraver} detects volta repeats.  It will only allow a page
1600 turn during the repeat if there is enough time at the beginning and end of the
1601 repeat to turn the page back.  The @code{Page_turn_engraver} can also disable
1602 page turns if the repeat is very short.  If you set the context property
1603 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1604 only allow turns in repeats whose duration is longer than this value.
1605
1606 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1607 @code{\allowPageTurn}, may also be used at top-level, between scores and
1608 top-level markups.
1609
1610 @predefined
1611 @funindex \pageTurn
1612 @code{\pageTurn},
1613 @funindex \noPageTurn
1614 @code{\noPageTurn},
1615 @funindex \allowPageTurn
1616 @code{\allowPageTurn}.
1617 @endpredefined
1618
1619 @seealso
1620 Snippets:
1621 @rlsr{Spacing}.
1622
1623 @knownissues
1624 There should only be one @code{Page_turn_engraver} in a score.  If there is more
1625 than one, they will interfere with each other.
1626
1627
1628 @node Minimal page breaking
1629 @subsection Minimal page breaking
1630
1631 @funindex ly:minimal-breaking
1632
1633 The @code{ly:minimal-breaking} function performs minimal computations to
1634 calculate the page breaking: it fills a page with as many systems as
1635 possible before moving to the next one.  Thus, it may be preferred for
1636 scores with many pages, where the other page breaking functions could be
1637 too slow or memory demanding, or a lot of texts.  It is enabled using:
1638
1639 @example
1640 \paper @{
1641   page-breaking = #ly:minimal-breaking
1642 @}
1643 @end example
1644
1645 @seealso
1646 Snippets:
1647 @rlsr{Spacing}.
1648
1649 @node One-line page breaking
1650 @subsection One-line page breaking
1651
1652 @funindex ly:one-line-breaking
1653
1654 The @code{ly:one-line-breaking} function is a special-purpose
1655 page breaking algorithm that puts each score on its own page,
1656 and on a single line.  This page breaking function does not
1657 typeset titles or margins; only the score will be displayed.
1658
1659 The page width will be adjusted so that
1660 the longest score fits on one line.  In particular,
1661 @code{paper-width}, @code{line-width} and @code{indent}
1662 variables in the @code{\paper} block will be ignored, although
1663 @code{left-margin} and @code{right-margin} will
1664 still be honored.  The height of the page will
1665 be left unmodified.
1666
1667 @node Explicit breaks
1668 @subsection Explicit breaks
1669
1670 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1671 commands.  There are two commands to override this behavior:
1672
1673 @example
1674 \override NonMusicalPaperColumn #'line-break-permission = ##f
1675 \override NonMusicalPaperColumn #'page-break-permission = ##f
1676 @end example
1677
1678 When @code{line-break-permission} is overridden to false, Lily will insert
1679 line breaks at explicit @code{\break} commands and nowhere else.  When
1680 @code{page-break-permission} is overridden to false, Lily will insert
1681 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1682
1683 @lilypond[quote,verbatim]
1684 \paper {
1685   indent = #0
1686   ragged-right = ##t
1687   ragged-bottom = ##t
1688 }
1689
1690 music = \relative c'' { c8 c c c }
1691
1692 \score {
1693   \new Staff {
1694     \repeat unfold 2 { \music } \break
1695     \repeat unfold 4 { \music } \break
1696     \repeat unfold 6 { \music } \break
1697     \repeat unfold 8 { \music } \pageBreak
1698     \repeat unfold 8 { \music } \break
1699     \repeat unfold 6 { \music } \break
1700     \repeat unfold 4 { \music } \break
1701     \repeat unfold 2 { \music }
1702   }
1703   \layout {
1704     \context {
1705       \Score
1706       \override NonMusicalPaperColumn #'line-break-permission = ##f
1707       \override NonMusicalPaperColumn #'page-break-permission = ##f
1708     }
1709   }
1710 }
1711 @end lilypond
1712
1713 @seealso
1714 Snippets:
1715 @rlsr{Spacing}.
1716
1717
1718 @node Using an extra voice for breaks
1719 @subsection Using an extra voice for breaks
1720
1721 Line- and page-breaking information usually appears within note entry directly.
1722
1723 @example
1724 music = \relative c'' @{ c4 c c c @}
1725
1726 \score @{
1727   \new Staff @{
1728     \repeat unfold 2 @{ \music @} \break
1729     \repeat unfold 3 @{ \music @}
1730   @}
1731 @}
1732 @end example
1733
1734 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1735 music entry with information that specifies how music should lay out
1736 on the page.  You can keep music entry and line- and page-breaking
1737 information in two separate places by introducing an extra voice to
1738 contain the  breaks.  This extra voice
1739 contains only skips together with @code{\break}, @code{pageBreak} and other
1740 breaking layout information.
1741
1742 @lilypond[quote,verbatim]
1743 music = \relative c'' { c4 c c c }
1744
1745 \score {
1746   \new Staff <<
1747     \new Voice {
1748       s1 * 2 \break
1749       s1 * 3 \break
1750       s1 * 6 \break
1751       s1 * 5 \break
1752     }
1753     \new Voice {
1754       \repeat unfold 2 { \music }
1755       \repeat unfold 3 { \music }
1756       \repeat unfold 6 { \music }
1757       \repeat unfold 5 { \music }
1758     }
1759   >>
1760 }
1761 @end lilypond
1762
1763 This pattern becomes especially helpful when overriding
1764 @code{line-break-system-details} and the other useful but long properties of
1765 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1766
1767 @lilypond[quote,verbatim]
1768 music = \relative c'' { c4 c c c }
1769
1770 \score {
1771   \new Staff <<
1772     \new Voice {
1773       \overrideProperty "Score.NonMusicalPaperColumn"
1774         #'line-break-system-details #'((Y-offset . 0))
1775       s1 * 2 \break
1776
1777       \overrideProperty "Score.NonMusicalPaperColumn"
1778         #'line-break-system-details #'((Y-offset . 35))
1779       s1 * 3 \break
1780
1781       \overrideProperty "Score.NonMusicalPaperColumn"
1782         #'line-break-system-details #'((Y-offset . 70))
1783       s1 * 6 \break
1784
1785       \overrideProperty "Score.NonMusicalPaperColumn"
1786         #'line-break-system-details #'((Y-offset . 105))
1787       s1 * 5 \break
1788     }
1789     \new Voice {
1790       \repeat unfold 2 { \music }
1791       \repeat unfold 3 { \music }
1792       \repeat unfold 6 { \music }
1793       \repeat unfold 5 { \music }
1794     }
1795   >>
1796 }
1797 @end lilypond
1798
1799 @seealso
1800 Notation Reference:
1801 @ref{Vertical spacing}.
1802
1803 Snippets:
1804 @rlsr{Spacing}.
1805
1806
1807 @node Vertical spacing
1808 @section Vertical spacing
1809
1810 @cindex vertical spacing
1811 @cindex spacing, vertical
1812
1813 Vertical spacing is controlled by three things: the amount of
1814 space available (i.e., paper size and margins), the amount of
1815 space between systems, and the amount of space between
1816 staves inside a system.
1817
1818 @menu
1819 * Flexible vertical spacing within systems::
1820 * Explicit staff and system positioning::
1821 * Vertical collision avoidance::
1822 @end menu
1823
1824
1825 @node Flexible vertical spacing within systems
1826 @subsection Flexible vertical spacing within systems
1827
1828 @cindex distance between staves
1829 @cindex staff distance
1830 @cindex space between staves
1831 @cindex space inside systems
1832
1833 Three separate mechanisms control the flexible vertical spacing
1834 within systems, one for each of the following categories:
1835
1836 @itemize
1837
1838 @item
1839 @emph{ungrouped staves},
1840
1841 @item
1842 @emph{grouped staves} (staves within a staff-group such as
1843 @code{ChoirStaff}, etc.), and
1844
1845 @item
1846 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1847 etc.).
1848
1849 @end itemize
1850
1851 @c TODO: Clarify this.  This almost implies that non-staff lines
1852 @c       have NO effect on the spacing between staves.  -mp
1853
1854 The height of each system is determined in two steps.  First, all
1855 of the staves are spaced according to the amount of space
1856 available.  Then, the non-staff lines are distributed between the
1857 staves.
1858
1859 Note that the spacing mechanisms discussed in this section only
1860 control the vertical spacing of staves and non-staff lines within
1861 individual systems.  The vertical spacing between separate
1862 systems, scores, markups, and margins is controlled by
1863 @code{\paper} variables, which are discussed in
1864 @ref{Flexible vertical spacing \paper variables}.
1865
1866 @menu
1867 * Within-system spacing properties::
1868 * Spacing of ungrouped staves::
1869 * Spacing of grouped staves::
1870 * Spacing of non-staff lines::
1871 @end menu
1872
1873
1874 @node Within-system spacing properties
1875 @unnumberedsubsubsec Within-system spacing properties
1876
1877 @funindex staff-affinity
1878 @funindex staffgroup-staff-spacing
1879 @funindex staff-staff-spacing
1880 @funindex nonstaff-unrelatedstaff-spacing
1881 @funindex nonstaff-relatedstaff-spacing
1882 @funindex nonstaff-nonstaff-spacing
1883 @funindex default-staff-staff-spacing
1884 @funindex minimum-Y-extent
1885 @funindex extra-offset
1886 @funindex self-alignment-X
1887 @funindex X-offset
1888 @funindex VerticalAxisGroup
1889
1890 The within-system vertical spacing mechanisms are controlled by
1891 two sets of grob properties.  The first set is associated with the
1892 @code{VerticalAxisGroup} grob, which is created by all staves and
1893 non-staff lines.  The second set is associated with the
1894 @code{StaffGrouper} grob, which can be created by staff-groups,
1895 but only if explicitly called.  These properties are described
1896 individually at the end of this section.
1897
1898 The names of these properties (except for @code{staff-affinity})
1899 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1900 @code{@var{item1}} and @code{@var{item2}} are the items to be
1901 spaced.  Note that @code{@var{item2}} is not necessarily below
1902 @code{@var{item1}}; for example,
1903 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1904 non-staff line if @code{staff-affinity} is @code{UP}.
1905
1906 Each distance is measured between the @emph{reference points} of
1907 the two items.  The reference point for a staff is the vertical
1908 center of its @code{StaffSymbol} (i.e. the middle line if
1909 @code{line-count} is odd; the middle space if @code{line-count} is
1910 even).  The reference points for individual non-staff lines are
1911 given in the following table:
1912
1913 @multitable {Non-staff line} {Reference point}
1914 @headitem Non-staff line @tab Reference point
1915 @item @code{ChordNames}  @tab baseline
1916 @item @code{NoteNames}   @tab baseline
1917 @item @code{Lyrics}      @tab baseline
1918 @item @code{Dynamics}    @tab vertical center
1919 @item @code{FiguredBass} @tab highest point
1920 @item @code{FretBoards}  @tab top line
1921 @end multitable
1922
1923 In the following image, horizontal lines indicate the positions
1924 of these reference points:
1925
1926 @lilypond[quote,noragged-right,line-width=110\mm]
1927 #(define zero-space '((padding . -inf.0) (basic-distance . 0)))
1928
1929 alignToZero = \with {
1930   \override VerticalAxisGroup #'nonstaff-relatedstaff-spacing = #zero-space
1931   \override VerticalAxisGroup #'nonstaff-nonstaff-spacing = #zero-space
1932 }
1933 lowerCaseChords = \with {
1934   chordNameLowercaseMinor = ##t
1935 }
1936 staffAffinityDown = \with {
1937   \override VerticalAxisGroup #'staff-affinity = #DOWN
1938 }
1939 labelContext =
1940 #(define-music-function
1941      (parser location context)
1942      (string?)
1943    #{ s1*0^\markup { \typewriter #context } #})
1944
1945 \layout {
1946   \context { \Dynamics    \alignToZero }
1947   \context { \FiguredBass \alignToZero }
1948   \context { \Lyrics      \alignToZero }
1949   \context { \NoteNames   \alignToZero \staffAffinityDown }
1950   \context { \ChordNames  \alignToZero
1951                           \staffAffinityDown
1952                           \lowerCaseChords }
1953   \context { \FretBoards  \alignToZero \staffAffinityDown }
1954   \context { \Score
1955     \override BarLine #'stencil = ##f
1956     \override DynamicText #'self-alignment-X = #-1
1957     \override FretBoard #'X-offset = #1.75
1958     \override InstrumentName #'minimum-Y-extent = #'(-2 . 2)
1959     \override InstrumentName #'extra-offset = #'(0 . -0.5)
1960     \override TextScript #'minimum-Y-extent = #'(-2 . 3)
1961     \override TimeSignature #'stencil = ##f
1962   }
1963 }
1964
1965 %% These contexts have reference points at the baseline:
1966 %%   ChordNames, NoteNames, and Lyrics
1967 <<
1968   \new ChordNames { \chords { g1:m } }
1969   \new NoteNames { s1 | g1 | }
1970   \new RhythmicStaff {
1971     \set RhythmicStaff.instrumentName = #"baseline "
1972     \textLengthOn
1973     \labelContext "ChordNames " s1 |
1974     \labelContext "NoteNames "  s1 |
1975     \labelContext "Lyrics"     s1 |
1976   }
1977   \new Lyrics { \lyrics { \skip 1*2 | ghijk1 | } }
1978 >>
1979
1980 %% The reference point for Dynamics is its vertical center
1981 <<
1982   \new RhythmicStaff {
1983     \set RhythmicStaff.instrumentName = #"vertical center "
1984     \labelContext "Dynamics" s1*3
1985   }
1986   \new Dynamics { s1\mp s\fp }
1987 >>
1988
1989 %% The reference point for FiguredBass is its highest point
1990 <<
1991   \new RhythmicStaff {
1992     \set RhythmicStaff.instrumentName = #"highest point "
1993     \labelContext "FiguredBass" s1
1994   }
1995   \new FiguredBass { \figuremode { <6 5>1 } }
1996 >>
1997
1998 %% The reference point for FretBoards is the top line
1999 \include "predefined-guitar-fretboards.ly"
2000 <<
2001   \new FretBoards { \chordmode { e1 } }
2002   \new RhythmicStaff {
2003     \set RhythmicStaff.instrumentName = #"top line "
2004     \labelContext "FretBoards " s1
2005   }
2006 >>
2007 @end lilypond
2008
2009 Each of the vertical spacing grob properties (except
2010 @code{staff-affinity}) uses the same alist structure as the
2011 @code{\paper} spacing variables discussed in
2012 @ref{Flexible vertical spacing \paper variables}.  Specific methods
2013 for modifying alists are discussed in @ref{Modifying alists}.
2014 Grob properties should be adjusted with an @code{\override} inside
2015 a @code{\score} or @code{\layout} block, and not inside a
2016 @code{\paper} block.
2017
2018 The following example demonstrates the two ways these alists can
2019 be modified.  The first declaration updates one key-value
2020 individually, and the second completely re-defines the property:
2021
2022 @example
2023 \new Staff \with @{
2024   \override VerticalAxisGroup #'default-staff-staff-spacing
2025        #'basic-distance = #10
2026 @} @{ @dots{} @}
2027
2028 \new Staff \with @{
2029   \override VerticalAxisGroup #'default-staff-staff-spacing =
2030     #'((basic-distance . 10)
2031        (minimum-distance . 9)
2032        (padding . 1)
2033        (stretchability . 10))
2034 @} @{ @dots{} @}
2035 @end example
2036
2037 To change any spacing settings globally, put them in the
2038 @code{\layout} block:
2039
2040 @example
2041 \layout @{
2042   \context @{
2043     \Staff
2044     \override VerticalAxisGroup #'default-staff-staff-spacing
2045          #'basic-distance = #10
2046   @}
2047 @}
2048 @end example
2049
2050 Standard settings for the vertical spacing grob properties are
2051 listed in @rinternals{VerticalAxisGroup} and
2052 @rinternals{StaffGrouper}.  Default overrides for specific types
2053 of non-staff lines are listed in the relevant context descriptions
2054 in @rinternals{Contexts}.
2055
2056
2057 @subsubheading Properties of the @code{VerticalAxisGroup} grob
2058
2059 @code{VerticalAxisGroup} properties are typically adjusted with an
2060 @code{\override} at the @code{Staff} level (or equivalent).
2061
2062 @table @code
2063 @item staff-staff-spacing
2064
2065 Used to determine the distance between the current staff and the
2066 staff just below it in the same system, even if one or more
2067 non-staff lines (such as @code{Lyrics}) are placed between the two
2068 staves.  Does not apply to the bottom staff of a system.
2069
2070 Initially, the @code{staff-staff-spacing} of a
2071 @code{VerticalAxisGroup} is a Scheme function that applies the
2072 properties of the @code{StaffGrouper} if the staff is part of a
2073 group, or the @code{default-staff-staff-spacing} of the staff
2074 otherwise.  This allows staves to be spaced differently when they
2075 are grouped.  For uniform spacing regardless of grouping, this
2076 function may be replaced by a flexible-spacing alist, using the
2077 complete-redefinition form of override shown above.
2078
2079 @item default-staff-staff-spacing
2080 A flexible-spacing alist defining the @code{staff-staff-spacing} used for
2081 ungrouped staves, unless @code{staff-staff-spacing} has been explicitly
2082 set with an @code{\override}.
2083
2084 @item staff-affinity
2085 The direction of the staff to use for spacing the current
2086 non-staff line.  Choices are @code{UP}, @code{DOWN}, and
2087 @code{CENTER}.  If @code{CENTER}, the non-staff line will be
2088 placed equidistant between the two nearest staves on either side,
2089 unless collisions or other spacing constraints prevent this.
2090 Adjacent non-staff lines should have non-increasing
2091 @code{staff-affinity} from top to bottom, e.g. a non-staff line
2092 set to @code{UP} should not immediately follow one that is set to
2093 @code{DOWN}.  Non-staff lines at the top of a system should use
2094 @code{DOWN}; those at the bottom should use @code{UP}.  Setting
2095 @code{staff-affinity} for a staff causes it to be treated as a
2096 non-staff line.  Setting @code{staff-affinity} to @code{#f} causes
2097 a non-staff line to be treated as a staff.  Setting
2098 @code{staff-affinity} to @code{UP}, @code{CENTER}, or @code{DOWN}
2099 causes a staff to be spaced as a non-staff line.
2100
2101 @item nonstaff-relatedstaff-spacing
2102 The distance between the current non-staff line and the nearest
2103 staff in the direction of @code{staff-affinity}, if there are no
2104 non-staff lines between the two, and @code{staff-affinity} is
2105 either @code{UP} or @code{DOWN}.  If @code{staff-affinity} is
2106 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
2107 for the nearest staves on @emph{both} sides, even if other
2108 non-staff lines appear between the current one and either of the
2109 staves.  This means that the placement of a non-staff line depends
2110 on both the surrounding staves and the surrounding non-staff lines.
2111 Setting the @code{stretchability} of one of these types of spacing to
2112 a small value will make that spacing dominate.  Setting the
2113 @code{stretchability} to a large value will make that spacing have
2114 little effect.
2115
2116 @item nonstaff-nonstaff-spacing
2117 The distance between the current non-staff line and the next
2118 non-staff line in the direction of @code{staff-affinity}, if both
2119 are on the same side of the related staff, and
2120 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
2121
2122 @item nonstaff-unrelatedstaff-spacing
2123 The distance between the current non-staff line and the staff in
2124 the opposite direction from @code{staff-affinity}, if there are no
2125 other non-staff lines between the two, and @code{staff-affinity}
2126 is either @code{UP} or @code{DOWN}.  This can be used, for
2127 example, to require a minimum amount of padding between a
2128 @code{Lyrics} line and the staff to which it does not belong.
2129 @end table
2130
2131
2132 @subsubheading Properties of the @code{StaffGrouper} grob
2133
2134 @code{StaffGrouper} properties are typically adjusted with an
2135 @code{\override} at the @code{StaffGroup} level (or equivalent).
2136
2137 @table @code
2138 @item staff-staff-spacing
2139 The distance between consecutive staves within the current
2140 staff-group.  The @code{staff-staff-spacing} property of an
2141 individual staff's @code{VerticalAxisGroup} grob can be
2142 overriden with different spacing settings for that staff.
2143
2144 @item staffgroup-staff-spacing
2145 The distance between the last staff of the current staff-group and
2146 the staff just below it in the same system, even if one or more
2147 non-staff lines (such as @code{Lyrics}) exist between the two
2148 staves.  Does not apply to the bottom staff of a system.  The
2149 @code{staff-staff-spacing} property of an individual staff's
2150 @code{VerticalAxisGroup} grob can be overriden with different
2151 spacing settings for that staff.
2152 @end table
2153
2154 @seealso
2155 Notation Reference:
2156 @ref{Flexible vertical spacing \paper variables},
2157 @ref{Modifying alists}.
2158
2159 Installed Files:
2160 @file{ly/engraver-init.ly},
2161 @file{scm/define-grobs.scm}.
2162
2163 Internals Reference:
2164 @rinternals{Contexts},
2165 @rinternals{VerticalAxisGroup},
2166 @rinternals{StaffGrouper}.
2167
2168
2169 @node Spacing of ungrouped staves
2170 @unnumberedsubsubsec Spacing of ungrouped staves
2171
2172 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
2173 @code{TabStaff}, etc.) are contexts that can contain one or more
2174 voice contexts, but cannot contain any other staves.
2175
2176 The following properties affect the spacing of @emph{ungrouped}
2177 staves:
2178
2179 @itemize
2180 @item @code{VerticalAxisGroup} properties:
2181 @itemize
2182 @item @code{default-staff-staff-spacing}
2183 @item @code{staff-staff-spacing}
2184 @end itemize
2185 @end itemize
2186
2187 These grob properties are described individually above; see
2188 @ref{Within-system spacing properties}.
2189
2190 Additional properties are involved for staves that are part of a
2191 staff-group; see @ref{Spacing of grouped staves}.
2192
2193 The following example shows how the @code{default-staff-staff-spacing}
2194 property can affect the spacing of ungrouped staves.
2195 The same overrides applied to @code{staff-staff-spacing} would
2196 have the same effect, but would also apply in cases where the staves
2197 are combined in a group or groups.
2198
2199 @lilypond[verbatim,quote,staffsize=16]
2200 \layout {
2201   \context {
2202     \Staff
2203     \override VerticalAxisGroup #'default-staff-staff-spacing =
2204       #'((basic-distance . 8)
2205          (minimum-distance . 7)
2206          (padding . 1))
2207   }
2208 }
2209
2210 <<
2211   % The very low note here needs more room than 'basic-distance
2212   % can provide, so the distance between this staff and the next
2213   % is determined by 'padding.
2214   \new Staff { b,2 r | }
2215
2216   % Here, 'basic-distance provides enough room, and there is no
2217   % need to compress the space (towards 'minimum-distance) to make
2218   % room for anything else on the page, so the distance between
2219   % this staff and the next is determined by 'basic-distance.
2220   \new Staff { \clef bass g2 r | }
2221
2222   % By setting 'padding to a negative value, staves can be made to
2223   % collide.  The lowest acceptable value for 'basic-distance is 0.
2224   \new Staff \with {
2225     \override VerticalAxisGroup #'default-staff-staff-spacing =
2226       #'((basic-distance . 3.5)
2227          (padding . -10))
2228   } { \clef bass g2 r | }
2229   \new Staff { \clef bass g2 r | }
2230 >>
2231 @end lilypond
2232
2233 @seealso
2234 Installed Files:
2235 @file{scm/define-grobs.scm}.
2236
2237 Snippets:
2238 @rlsr{Spacing}.
2239
2240 Internals Reference:
2241 @rinternals{VerticalAxisGroup}.
2242
2243
2244 @node Spacing of grouped staves
2245 @unnumberedsubsubsec Spacing of grouped staves
2246
2247 In orchestral and other large scores, it is common to place staves
2248 in groups.  The space between groups is typically larger than the
2249 space between staves of the same group.
2250
2251 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2252 etc.) are contexts that can contain one or more staves
2253 simultaneously.
2254
2255 The following properties affect the spacing of staves inside
2256 staff-groups:
2257
2258 @itemize
2259 @item @code{VerticalAxisGroup} properties:
2260 @itemize
2261 @item @code{staff-staff-spacing}
2262 @end itemize
2263 @item @code{StaffGrouper} properties:
2264 @itemize
2265 @item @code{staff-staff-spacing}
2266 @item @code{staffgroup-staff-spacing}
2267 @end itemize
2268 @end itemize
2269
2270 These grob properties are described individually above; see
2271 @ref{Within-system spacing properties}.
2272
2273 The following example shows how properties of the
2274 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2275
2276 @lilypond[verbatim,quote,staffsize=16]
2277 \layout {
2278   \context {
2279     \Score
2280     \override StaffGrouper #'staff-staff-spacing #'padding = #0
2281     \override StaffGrouper #'staff-staff-spacing #'basic-distance = #1
2282   }
2283 }
2284
2285 <<
2286   \new PianoStaff \with {
2287     \override StaffGrouper #'staffgroup-staff-spacing #'basic-distance = #20
2288   } <<
2289     \new Staff { c'1 }
2290     \new Staff { c'1 }
2291   >>
2292
2293   \new StaffGroup <<
2294     \new Staff { c'1 }
2295     \new Staff { c'1 }
2296   >>
2297 >>
2298 @end lilypond
2299
2300 @seealso
2301 Installed Files:
2302 @file{scm/define-grobs.scm}.
2303
2304 Snippets:
2305 @rlsr{Spacing}.
2306
2307 Internals Reference:
2308 @rinternals{VerticalAxisGroup},
2309 @rinternals{StaffGrouper}.
2310
2311
2312 @node Spacing of non-staff lines
2313 @unnumberedsubsubsec Spacing of non-staff lines
2314
2315 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2316 etc.) are contexts whose layout objects are engraved like staves
2317 (i.e. in horizontal lines within systems).  Specifically,
2318 non-staff lines are non-staff contexts that create the
2319 @code{VerticalAxisGroup} layout object.
2320
2321 The following properties affect the spacing of non-staff lines:
2322
2323 @itemize
2324 @item @code{VerticalAxisGroup} properties:
2325 @itemize
2326 @item @code{staff-affinity}
2327 @item @code{nonstaff-relatedstaff-spacing}
2328 @item @code{nonstaff-nonstaff-spacing}
2329 @item @code{nonstaff-unrelatedstaff-spacing}
2330 @end itemize
2331 @end itemize
2332
2333 These grob properties are described individually above; see
2334 @ref{Within-system spacing properties}.
2335
2336 The following example shows how the
2337 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2338 of consecutive non-staff lines.  Here, by setting the
2339 @code{stretchability} key to a very high value, the lyrics are
2340 able to stretch much more than usual:
2341
2342 @lilypond[verbatim,quote,staffsize=16]
2343 \layout {
2344   \context {
2345     \Lyrics
2346     \override VerticalAxisGroup
2347       #'nonstaff-nonstaff-spacing #'stretchability = #1000
2348   }
2349 }
2350
2351 \new StaffGroup
2352 <<
2353   \new Staff \with {
2354     \override VerticalAxisGroup #'staff-staff-spacing = #'((basic-distance . 30))
2355   } { c'1 }
2356   \new Lyrics \with {
2357     \override VerticalAxisGroup #'staff-affinity = #UP
2358   } \lyricmode { up }
2359   \new Lyrics \with {
2360     \override VerticalAxisGroup #'staff-affinity = #CENTER
2361   } \lyricmode { center }
2362   \new Lyrics \with {
2363     \override VerticalAxisGroup #'staff-affinity = #DOWN
2364   } \lyricmode { down }
2365   \new Staff { c'1 }
2366 >>
2367 @end lilypond
2368
2369 @seealso
2370 Installed Files:
2371 @file{ly/engraver-init.ly},
2372 @file{scm/define-grobs.scm}.
2373
2374 Snippets:
2375 @rlsr{Spacing}.
2376
2377 @c @lsr{spacing,page-spacing.ly},
2378 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2379
2380 Internals Reference:
2381 @rinternals{Contexts},
2382 @rinternals{VerticalAxisGroup}.
2383
2384
2385 @node Explicit staff and system positioning
2386 @subsection Explicit staff and system positioning
2387
2388 One way to understand the flexible vertical spacing mechanisms
2389 explained above is as a collection of settings that control the
2390 amount of vertical padding between staves and systems.
2391
2392 It is possible to approach vertical spacing in a different way
2393 using @code{NonMusicalPaperColumn #'line-break-system-details}.
2394 While the flexible vertical spacing mechanisms specify vertical
2395 padding, @code{NonMusicalPaperColumn #'line-break-system-details}
2396 can specify exact vertical positions on the page.
2397
2398 @code{NonMusicalPaperColumn #'line-break-system-details} accepts
2399 an associative list of three different settings:
2400
2401 @itemize
2402 @item @code{X-offset}
2403 @item @code{Y-offset}
2404 @item @code{alignment-distances}
2405 @end itemize
2406
2407 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2408 below, can occur in any of three different places in an input file:
2409
2410 @itemize
2411 @item in the middle of note entry directly
2412 @item in a @code{\context} block
2413 @item in the @code{\with} block
2414 @end itemize
2415
2416 When we override @code{NonMusicalPaperColumn}, we use the usual
2417 @code{\override} command in @code{\context} blocks and in the
2418 @code{\with} block.  On the other hand, when we override
2419 @code{NonMusicalPaperColumn} in the middle of note entry,
2420 use the special @code{\overrideProperty} command.  Here are some
2421 example @code{NonMusicalPaperColumn} overrides with the special
2422 @code{\overrideProperty} command:
2423
2424 @example
2425 \overrideProperty NonMusicalPaperColumn
2426   #'line-break-system-details #'((X-offset . 20))
2427
2428 \overrideProperty NonMusicalPaperColumn
2429   #'line-break-system-details #'((Y-offset . 40))
2430
2431 \overrideProperty NonMusicalPaperColumn
2432   #'line-break-system-details #'((X-offset . 20)
2433                                  (Y-offset . 40))
2434
2435 \overrideProperty NonMusicalPaperColumn
2436   #'line-break-system-details #'((alignment-distances . (15)))
2437
2438 \overrideProperty NonMusicalPaperColumn
2439   #'line-break-system-details #'((X-offset . 20)
2440                                  (Y-offset . 40)
2441                                  (alignment-distances . (15)))
2442 @end example
2443
2444 To understand how each of these different settings work, we begin
2445 by looking at an example that includes no overrides at all.
2446
2447 @c \book { } is required in these examples to ensure the spacing
2448 @c overrides can be seen between systems. -np
2449
2450 @lilypond[verbatim,quote,staffsize=16]
2451 \header { tagline = ##f }
2452 \paper { left-margin = 0\mm }
2453 \book {
2454   \score {
2455     <<
2456       \new Staff <<
2457         \new Voice {
2458           s1*5 \break
2459           s1*5 \break
2460           s1*5 \break
2461         }
2462         \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2463       >>
2464       \new Staff {
2465         \repeat unfold 15 { d'4 d' d' d' }
2466       }
2467     >>
2468   }
2469 }
2470 @end lilypond
2471
2472 This score isolates line- and page-breaking information in a dedicated
2473 voice.  This technique of creating a breaks voice will help keep layout
2474 separate from music entry as our example becomes more complicated.
2475 See @ref{Using an extra voice for breaks}.
2476
2477 Explicit @code{\breaks} evenly divide the music into six measures per
2478 line.  Vertical spacing results from LilyPond's defaults.  To set
2479 the vertical startpoint of each system explicitly, we can set
2480 the @code{Y-offset} pair in the @code{line-break-system-details}
2481 attribute of the @code{NonMusicalPaperColumn} grob:
2482
2483 @lilypond[verbatim,quote,staffsize=16]
2484 \header { tagline = ##f }
2485 \paper { left-margin = 0\mm }
2486 \book {
2487   \score {
2488     <<
2489       \new Staff <<
2490         \new Voice {
2491           \overrideProperty #"Score.NonMusicalPaperColumn"
2492             #'line-break-system-details #'((Y-offset . 0))
2493           s1*5 \break
2494           \overrideProperty #"Score.NonMusicalPaperColumn"
2495             #'line-break-system-details #'((Y-offset . 40))
2496           s1*5 \break
2497           \overrideProperty #"Score.NonMusicalPaperColumn"
2498             #'line-break-system-details #'((Y-offset . 80))
2499           s1*5 \break
2500         }
2501         \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2502       >>
2503       \new Staff {
2504         \repeat unfold 15 { d'4 d' d' d' }
2505       }
2506     >>
2507   }
2508 }
2509 @end lilypond
2510
2511 Note that @code{line-break-system-details} takes an associative list of
2512 potentially many values, but that we set only one value here.  Note,
2513 too, that the @code{Y-offset} property here determines the exact vertical
2514 position on the page at which each new system will render.
2515
2516 Now that we have set the vertical startpoint of each system
2517 explicitly, we can also set the vertical distances between staves
2518 within each system manually.  We do this using the @code{alignment-distances}
2519 subproperty of @code{line-break-system-details}.
2520
2521 @lilypond[verbatim,quote,staffsize=16]
2522 \header { tagline = ##f }
2523 \paper { left-margin = 0\mm }
2524 \book {
2525   \score {
2526     <<
2527       \new Staff <<
2528         \new Voice {
2529           \overrideProperty #"Score.NonMusicalPaperColumn"
2530             #'line-break-system-details #'((Y-offset . 20)
2531                                            (alignment-distances . (15)))
2532           s1*5 \break
2533           \overrideProperty #"Score.NonMusicalPaperColumn"
2534             #'line-break-system-details #'((Y-offset . 60)
2535                                            (alignment-distances . (15)))
2536           s1*5 \break
2537           \overrideProperty #"Score.NonMusicalPaperColumn"
2538             #'line-break-system-details #'((Y-offset . 100)
2539                                            (alignment-distances . (15)))
2540           s1*5 \break
2541         }
2542         \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2543       >>
2544       \new Staff {
2545         \repeat unfold 15 { d'4 d' d' d' }
2546       }
2547     >>
2548   }
2549 }
2550 @end lilypond
2551
2552 Note that here we assign two different values to the
2553 @code{line-break-system-details} attribute of the
2554 @code{NonMusicalPaperColumn} grob.  Though the
2555 @code{line-break-system-details} attribute alist accepts many
2556 additional spacing parameters (including, for example, a corresponding
2557 @code{X-offset} pair), we need only set the @code{Y-offset} and
2558 @code{alignment-distances} pairs to control the vertical startpoint of
2559 every system and every staff.  Finally, note that @code{alignment-distances}
2560 specifies the vertical positioning of staves but not of staff groups.
2561
2562 @lilypond[verbatim,quote,staffsize=16]
2563 \header { tagline = ##f }
2564 \paper { left-margin = 0\mm }
2565 \book {
2566   \score {
2567     <<
2568       \new Staff <<
2569         \new Voice {
2570           \overrideProperty #"Score.NonMusicalPaperColumn"
2571             #'line-break-system-details #'((Y-offset . 0)
2572                                            (alignment-distances . (30 10)))
2573           s1*5 \break
2574           \overrideProperty #"Score.NonMusicalPaperColumn"
2575             #'line-break-system-details #'((Y-offset . 60)
2576                                            (alignment-distances . (10 10)))
2577           s1*5 \break
2578           \overrideProperty #"Score.NonMusicalPaperColumn"
2579             #'line-break-system-details #'((Y-offset . 100)
2580                                            (alignment-distances . (10 30)))
2581           s1*5 \break
2582         }
2583         \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2584       >>
2585       \new StaffGroup <<
2586         \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2587         \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2588       >>
2589     >>
2590   }
2591 }
2592 @end lilypond
2593
2594 Some points to consider:
2595
2596 @itemize
2597 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2598 do not count as a staff.
2599
2600 @item The units of the numbers passed to @code{X-offset},
2601 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2602 of the distance between adjacent staff lines.  Positive values move staves
2603 and lyrics up, negative values move staves and lyrics down.
2604
2605 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
2606 settings given here allow the positioning of staves and systems anywhere
2607 on the page, it is possible to violate paper or margin boundaries or even
2608 to print staves or systems on top of one another.  Reasonable values
2609 passed to these different settings will avoid this.
2610 @end itemize
2611
2612 @seealso
2613 Snippets:
2614 @rlsr{Spacing}.
2615
2616
2617 @node Vertical collision avoidance
2618 @subsection Vertical collision avoidance
2619
2620 @funindex outside-staff-priority
2621 @funindex outside-staff-padding
2622 @funindex outside-staff-horizontal-padding
2623
2624 Intuitively, there are some objects in musical notation that belong
2625 to the staff and there are other objects that should be placed outside
2626 the staff.  Objects belonging outside the staff include things such as
2627 rehearsal marks, text and dynamic markings (from now on, these will
2628 be called outside-staff objects).  LilyPond's rule for the
2629 vertical placement of outside-staff objects is to place them as close
2630 to the staff as possible but not so close that they collide with
2631 another object.
2632
2633 LilyPond uses the @code{outside-staff-priority} property to determine
2634 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2635 is a number, the grob is an outside-staff object.  In addition,
2636 @code{outside-staff-priority} tells LilyPond in which order the objects
2637 should be placed.
2638
2639 First, LilyPond places all the objects that do not belong outside
2640 the staff.  Then it sorts the outside-staff objects according to their
2641 @code{outside-staff-priority} (in increasing order).  One by one, LilyPond
2642 takes the outside-staff objects and places them so that they do
2643 not collide with any objects that have already been placed.  That
2644 is, if two outside-staff grobs are competing for the same space, the one
2645 with the lower @code{outside-staff-priority} will be placed closer to
2646 the staff.
2647
2648 @lilypond[quote,ragged-right,relative=2,verbatim]
2649 c4_"Text"\pp
2650 r2.
2651 \once \override TextScript #'outside-staff-priority = #1
2652 c4_"Text"\pp % this time the text will be closer to the staff
2653 r2.
2654 % by setting outside-staff-priority to a non-number,
2655 % we disable the automatic collision avoidance
2656 \once \override TextScript #'outside-staff-priority = ##f
2657 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
2658 c4_"Text"\pp % now they will collide
2659 @end lilypond
2660
2661 The vertical padding between an outside-staff object and the
2662 previously-positioned grobs can be controlled with
2663 @code{outside-staff-padding}.
2664
2665 @lilypond[quote,ragged-right,relative=2,verbatim,staffsize=18]
2666 \once \override TextScript #'outside-staff-padding = #0
2667 a'^"This text is placed very close to the note"
2668 \once \override TextScript #'outside-staff-padding = #3
2669 c^"This text is padded away from the previous text"
2670 c^"This text is placed close to the previous text"
2671 @end lilypond
2672
2673
2674 By default, outside-staff objects are placed only to avoid
2675 a horizontal collision with previously-positioned grobs.  This
2676 can lead to situations in which objects are placed very close to each
2677 other horizontally.  The vertical spacing between staves can
2678 also be set so that outside staff objects are interleaved.
2679 Setting @code{outside-staff-horizontal-padding}
2680 causes an object to be offset vertically so that such a situation
2681 doesn't occur.
2682
2683 @lilypond[quote,ragged-right,relative=2,verbatim]
2684 % the markup is too close to the following note
2685 c4^"Text"
2686 c4
2687 c''2
2688 % setting outside-staff-horizontal-padding fixes this
2689 R1
2690 \once \override TextScript #'outside-staff-horizontal-padding = #1
2691 c,,4^"Text"
2692 c4
2693 c''2
2694 @end lilypond
2695
2696 @seealso
2697 Snippets:
2698 @rlsr{Spacing}.
2699
2700
2701 @node Horizontal spacing
2702 @section Horizontal spacing
2703
2704 @cindex horizontal spacing
2705 @cindex spacing, horizontal
2706
2707 @menu
2708 * Horizontal spacing overview::
2709 * New spacing area::
2710 * Changing horizontal spacing::
2711 * Line length::
2712 * Proportional notation::
2713 @end menu
2714
2715
2716 @node Horizontal spacing overview
2717 @subsection Horizontal spacing overview
2718
2719 The spacing engine translates differences in durations into stretchable
2720 distances (@q{springs}) of differing lengths.  Longer durations get
2721 more space, shorter durations get less.  The shortest durations get a
2722 fixed amount of space (which is controlled by
2723 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2724 object).  The longer the duration, the more space it gets: doubling a
2725 duration adds a fixed amount (this amount is controlled by
2726 @code{spacing-increment}) of space to the note.
2727
2728 For example, the following piece contains lots of half, quarter, and
2729 8th notes; the eighth note is followed by 1 note head width (NHW).
2730 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2731
2732 @lilypond[quote,verbatim,relative=1]
2733 c2 c4. c8 c4. c8 c4. c8 c8
2734 c8 c4 c4 c4
2735 @end lilypond
2736
2737 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2738 approximately the width of a note head, and
2739 @code{shortest-duration-space} is set to 2.0, meaning that the
2740 shortest note gets 2.4 staff space (2.0 times the
2741 @code{spacing-increment}) of horizontal space.  This space is counted
2742 from the left edge of the symbol, so the shortest notes are generally
2743 followed by one NHW of space.
2744
2745 If one would follow the above procedure exactly, then adding a single
2746 32nd note to a score that uses 8th and 16th notes, would widen up the
2747 entire score a lot.  The shortest note is no longer a 16th, but a 32nd,
2748 thus adding 1 NHW to every note.  To prevent this, the shortest
2749 duration for spacing is not the shortest note in the score, but rather
2750 the one which occurs most frequently.
2751
2752
2753 The most common shortest duration is determined as follows: in every
2754 measure, the shortest duration is determined.  The most common shortest
2755 duration is taken as the basis for the spacing, with the stipulation
2756 that this shortest duration should always be equal to or shorter than
2757 an 8th note.  The shortest duration is printed when you run
2758 @code{lilypond} with the @option{--verbose} option.
2759
2760 These durations may also be customized.  If you set the
2761 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2762 this sets the base duration for spacing.  The maximum duration for this
2763 base (normally an 8th), is set through @code{base-shortest-duration}.
2764
2765 @funindex common-shortest-duration
2766 @funindex base-shortest-duration
2767 @funindex stem-spacing-correction
2768 @funindex spacing
2769
2770 Notes that are even shorter than the common shortest note are
2771 followed by a space that is proportional to their duration relative to
2772 the common shortest note.  So if we were to add only a few 16th notes
2773 to the example above, they would be followed by half a NHW:
2774
2775 @lilypond[quote,verbatim,relative=2]
2776 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2777 @end lilypond
2778
2779
2780 In the @emph{Essay on automated music engraving}, it was explained
2781 that stem directions influence spacing (see
2782 @ressay{Optical spacing}).  This is controlled with the
2783 @code{stem-spacing-correction} property in the
2784 @rinternals{NoteSpacing}, object.  These are generated for every
2785 @rinternals{Voice} context.  The @code{StaffSpacing} object
2786 (generated in @rinternals{Staff} context) contains the same
2787 property for controlling the stem/bar line spacing.  The following
2788 example shows these corrections, once with default settings, and
2789 once with exaggerated corrections:
2790
2791 @lilypond[quote,ragged-right]
2792 {
2793   c'4 e''4 e'4 b'4 |
2794   b'4 e''4 b'4 e''4 |
2795   \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2796   \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2797   c'4 e''4 e'4 b'4 |
2798   b'4 e''4 b'4 e''4 |
2799 }
2800 @end lilypond
2801
2802 Proportional notation is supported; see @ref{Proportional notation}.
2803
2804 @seealso
2805 Essay on automated music engraving:
2806 @ressay{Optical spacing}.
2807
2808 Snippets:
2809 @rlsr{Spacing}.
2810
2811 Internals Reference:
2812 @rinternals{SpacingSpanner},
2813 @rinternals{NoteSpacing},
2814 @rinternals{StaffSpacing},
2815 @rinternals{NonMusicalPaperColumn}.
2816
2817 @knownissues
2818 There is no convenient mechanism to manually override spacing.  The
2819 following work-around may be used to insert extra space into a score,
2820 adjusting the padding value as necessary.
2821
2822 @example
2823  \override Score.NonMusicalPaperColumn #'padding = #10
2824 @end example
2825
2826 No work-around exists for decreasing the amount of space.
2827
2828
2829 @node New spacing area
2830 @subsection New spacing area
2831
2832 New sections with different spacing parameters can be started with
2833 @code{newSpacingSection}.  This is useful when there are
2834 sections with a different notions of long and short notes.
2835
2836 In the following example, the time signature change introduces a new
2837 section, and hence the 16ths notes are spaced wider.
2838
2839 @lilypond[relative=1,verbatim,quote]
2840 \time 2/4
2841 c4 c8 c
2842 c8 c c4 c16[ c c8] c4
2843 \newSpacingSection
2844 \time 4/16
2845 c16[ c c8]
2846 @end lilypond
2847
2848 The @code{\newSpacingSection} command creates a new
2849 @code{SpacingSpanner} object, and hence new @code{\override}s
2850 may be used in that location.
2851
2852 @seealso
2853 Snippets:
2854 @rlsr{Spacing}.
2855
2856 Internals Reference:
2857 @rinternals{SpacingSpanner}.
2858
2859
2860 @node Changing horizontal spacing
2861 @subsection Changing horizontal spacing
2862
2863 Horizontal spacing may be altered with the
2864 @code{base-shortest-duration} property.  Here
2865 we compare the same music; once without altering
2866 the property, and then altered.  Larger values
2867 of @code{ly:make-moment} will produce smaller
2868 music.  Note that @code{ly:make-moment} constructs
2869 a duration, so @code{1 4} is a longer duration
2870 than @code{1 16}.
2871
2872 @lilypond[verbatim,line-width=12\cm]
2873 \score {
2874   \relative c'' {
2875     g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2876     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2877     d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2878     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2879   }
2880 }
2881 @end lilypond
2882
2883 @lilypond[verbatim,line-width=12\cm]
2884 \score {
2885   \relative c'' {
2886     g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2887     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2888     d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2889     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2890   }
2891   \layout {
2892     \context {
2893       \Score
2894       \override SpacingSpanner
2895         #'base-shortest-duration = #(ly:make-moment 1 16)
2896     }
2897   }
2898 }
2899 @end lilypond
2900
2901
2902 @snippets
2903
2904 By default, spacing in tuplets depends on various non-duration
2905 factors (such as accidentals, clef changes, etc).  To disregard
2906 such symbols and force uniform equal-duration spacing, use
2907 @code{Score.SpacingSpanner #'uniform-stretching}.  This
2908 property can only be changed at the beginning of a score,
2909
2910 @lilypond[quote,ragged-right,verbatim]
2911 \score {
2912   <<
2913     \new Staff {
2914       \times 4/5 {
2915         c8 c8 c8 c8 c8
2916       }
2917       c8 c8 c8 c8
2918     }
2919     \new Staff {
2920       c8 c8 c8 c8
2921       \times 4/5 {
2922         c8 c8 c8 c8 c8
2923       }
2924     }
2925   >>
2926   \layout {
2927     \context {
2928       \Score
2929       \override SpacingSpanner #'uniform-stretching = ##t
2930     }
2931   }
2932 }
2933 @end lilypond
2934
2935 When @code{strict-note-spacing} is set, notes are spaced without
2936 regard for clefs, bar lines, and grace notes,
2937
2938 @lilypond[quote,ragged-right,relative=2,verbatim]
2939 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2940 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c]  c32[ c32] }
2941 @end lilypond
2942
2943 @seealso
2944 Snippets:
2945 @rlsr{Spacing}.
2946
2947
2948 @node Line length
2949 @subsection Line length
2950
2951 @cindex page breaks
2952 @cindex breaking pages
2953
2954 @funindex indent
2955 @funindex line-width
2956 @funindex ragged-right
2957 @funindex ragged-last
2958
2959 @c Although line-width can be set in \layout, it should be set in paper
2960 @c block, to get page layout right.
2961 @c Setting indent in \paper block makes not much sense, but it works.
2962
2963 @c Bit verbose and vague, use examples?
2964 The most basic settings influencing the spacing are @code{indent} and
2965 @code{line-width}.  They are set in the @code{\layout} block.  They
2966 control the indentation of the first line of music, and the lengths of
2967 the lines.
2968
2969 If @code{ragged-right} is set to true in the @code{\layout} block, then
2970 systems ends at their natural horizontal length, instead of being spread
2971 horizontally to fill the whole line.  This is useful for
2972 short fragments, and for checking how tight the natural spacing is.
2973 The normal default setting is false, but if the score has only one
2974 system the default value is true.
2975
2976 @cindex page layout
2977 @cindex vertical spacing
2978
2979 The option @code{ragged-last} is similar to @code{ragged-right}, but
2980 only affects the last line of the piece.  No restrictions are put on
2981 that line.  The result is similar to formatting text paragraphs.  In a
2982 paragraph, the last line simply takes its natural horizontal length.
2983 @c Note that for text there are several options for the last line.
2984 @c While Knuth TeX uses natural length, lead typesetters use the same
2985 @c stretch as the previous line.  eTeX uses \lastlinefit to
2986 @c interpolate between both these solutions.
2987
2988 @example
2989 \layout @{
2990   indent = #0
2991   line-width = #150
2992   ragged-last = ##t
2993 @}
2994 @end example
2995
2996 @seealso
2997 Snippets:
2998 @rlsr{Spacing}.
2999
3000
3001 @node Proportional notation
3002 @subsection Proportional notation
3003
3004 LilyPond supports proportional notation, a type of horizontal spacing
3005 in which each note consumes an amount of horizontal space exactly
3006 equivalent to its rhythmic duration.  This type of proportional spacing
3007 is comparable to horizontal spacing on top of graph paper.  Some late
3008 20th- and early 21st-century scores use proportional notation to
3009 clarify complex rhythmic relationships or to facilitate the placement
3010 of timelines or other graphics directly in the score.
3011
3012 LilyPond supports five different settings for proportional notation,
3013 which may be used together or alone:
3014
3015 @itemize
3016 @item @code{proportionalNotationDuration}
3017 @item @code{uniform-stretching}
3018 @item @code{strict-note-spacing}
3019 @item @code{\remove "Separating_line_group_engraver"}
3020 @item @code{\override PaperColumn #'used = ##t}
3021 @end itemize
3022
3023 In the examples that follow, we explore these five different
3024 proportional notation settings and examine how these settings interact.
3025
3026 We start with the following one-measure example, which uses classical
3027 spacing with ragged-right turned on.
3028
3029 @lilypond[quote,verbatim,ragged-right]
3030 \score {
3031   <<
3032     \new RhythmicStaff {
3033       c'2
3034       c'16 c'16 c'16 c'16
3035       \times 4/5 {
3036         c'16 c'16 c'16 c'16 c'16
3037       }
3038     }
3039   >>
3040 }
3041 @end lilypond
3042
3043 Notice that the half note which begins the measure takes up far less
3044 than half of the horizontal space of the measure.  Likewise, the
3045 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
3046 which end the measure together take up far more than half the
3047 horizontal space of the measure.
3048
3049 In classical engraving, this spacing may be exactly what we want
3050 because we can borrow horizontal space from the half note and conserve
3051 horizontal space across the measure as a whole.
3052
3053 On the other hand, if we want to insert a measured timeline or other
3054 graphic above or below our score, we need proportional notation.  We
3055 turn proportional notation on with the proportionalNotationDuration
3056 setting.
3057
3058 @lilypond[quote,verbatim,ragged-right]
3059 \score {
3060   <<
3061     \new RhythmicStaff {
3062       c'2
3063       c'16 c'16 c'16 c'16
3064       \times 4/5 {
3065         c'16 c'16 c'16 c'16 c'16
3066       }
3067     }
3068   >>
3069  \layout {
3070     \context {
3071       \Score
3072       proportionalNotationDuration = #(ly:make-moment 1 20)
3073     }
3074   }
3075 }
3076 @end lilypond
3077
3078 The half note at the beginning of the measure and the faster notes in
3079 the second half of the measure now occupy equal amounts of horizontal
3080 space.  We could place a measured timeline or graphic above or below
3081 this example.
3082
3083 The @code{proportionalNotationDuration} setting is a context setting
3084 that lives in @code{Score}.  Remember that context settings can appear
3085 in one of three locations within our input file -- in a @code{\with}
3086 block, in a @code{\context} block, or directly in music entry preceded
3087 by the @code{\set} command.  As with all context settings, users can
3088 pick which of the three different locations they would like to
3089 set @code{proportionalNotationDuration} in to.
3090
3091 The @code{proportionalNotationDuration} setting takes a single argument,
3092 which is the reference duration against that all music will be spaced.
3093 The LilyPond Scheme function @code{make-moment} takes two arguments
3094 -- a numerator and denominator which together express some fraction of
3095 a whole note.  The call @code{(ly:make-moment 1 20)} therefore produces
3096 a reference duration of a twentieth note.  Values such as
3097 @code{(ly:make-moment 1 16)}, @code{(ly:make-moment 1 8)}, and
3098 @code{(ly:make-moment 3 97)} are all possible as well.
3099
3100 How do we select the right reference duration to pass to
3101 @code{proportionalNotationDuration}?  Usually by a process of trial
3102 and error, beginning with a duration close to the fastest (or smallest)
3103 duration in the piece.  Smaller reference durations space music loosely;
3104 larger reference durations space music tightly.
3105
3106 @lilypond[quote,verbatim,ragged-right]
3107 \score {
3108   <<
3109     \new RhythmicStaff {
3110       c'2
3111       c'16 c'16 c'16 c'16
3112       \times 4/5 {
3113         c'16 c'16 c'16 c'16 c'16
3114       }
3115     }
3116   >>
3117   \layout {
3118     \context {
3119       \Score
3120       proportionalNotationDuration = #(ly:make-moment 1 8)
3121     }
3122   }
3123 }
3124
3125 \score {
3126   <<
3127     \new RhythmicStaff {
3128       c'2
3129       c'16 c'16 c'16 c'16
3130       \times 4/5 {
3131         c'16 c'16 c'16 c'16 c'16
3132       }
3133     }
3134   >>
3135   \layout {
3136     \context {
3137       \Score
3138       proportionalNotationDuration = #(ly:make-moment 1 16)
3139     }
3140   }
3141 }
3142
3143 \score {
3144   <<
3145     \new RhythmicStaff {
3146       c'2
3147       c'16 c'16 c'16 c'16
3148       \times 4/5 {
3149         c'16 c'16 c'16 c'16 c'16
3150       }
3151     }
3152   >>
3153   \layout {
3154     \context {
3155       \Score
3156       proportionalNotationDuration = #(ly:make-moment 1 32)
3157     }
3158   }
3159 }
3160 @end lilypond
3161
3162 Note that too large a reference duration -- such as the eighth note,
3163 above -- spaces music too tightly and can cause note head collisions.
3164 Also that proportional notation in general takes up more horizontal
3165 space than classical spacing.  Proportional spacing provides rhythmic
3166 clarity at the expense of horizontal space.
3167
3168 Next we examine how to optimally space overlapping tuplets.
3169
3170 We start by examining what happens to our original example, with
3171 classical spacing, when we add a second staff with a different type of
3172 tuplet.
3173
3174 @lilypond[quote,verbatim,ragged-right]
3175 \score {
3176   <<
3177     \new RhythmicStaff {
3178       c'2
3179       c'16 c'16 c'16 c'16
3180       \times 4/5 {
3181         c'16 c'16 c'16 c'16 c'16
3182       }
3183     }
3184     \new RhythmicStaff {
3185       \times 8/9 {
3186         c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3187       }
3188     }
3189   >>
3190 }
3191 @end lilypond
3192
3193 The spacing is bad because the evenly spaced notes of the bottom staff
3194 do not stretch uniformly.  Classical engravings include very few complex
3195 triplets and so classical engraving rules can generate this type of
3196 result.  Setting @code{proportionalNotationDuration} fixes this.
3197
3198 @lilypond[quote,verbatim,ragged-right]
3199 \score {
3200   <<
3201     \new RhythmicStaff {
3202       c'2
3203       c'16 c'16 c'16 c'16
3204       \times 4/5 {
3205         c'16 c'16 c'16 c'16 c'16
3206       }
3207     }
3208     \new RhythmicStaff {
3209       \times 8/9 {
3210         c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3211       }
3212     }
3213   >>
3214   \layout {
3215     \context {
3216       \Score
3217       proportionalNotationDuration = #(ly:make-moment 1 20)
3218     }
3219   }
3220 }
3221 @end lilypond
3222
3223 But if we look very carefully we can see that notes of the second half
3224 of the 9-tuplet space ever so slightly more widely than the notes
3225 of the first half of the 9-tuplet.  To ensure uniform stretching, we
3226 turn on @code{uniform-stretching}, which is a property of
3227 @code{SpacingSpanner}.
3228
3229 @lilypond[quote,verbatim,ragged-right]
3230 \score {
3231   <<
3232     \new RhythmicStaff {
3233       c'2
3234       c'16 c'16 c'16 c'16
3235       \times 4/5 {
3236         c'16 c'16 c'16 c'16 c'16
3237       }
3238     }
3239     \new RhythmicStaff {
3240       \times 8/9 {
3241         c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3242       }
3243     }
3244   >>
3245   \layout {
3246     \context {
3247       \Score
3248       proportionalNotationDuration = #(ly:make-moment 1 20)
3249       \override SpacingSpanner #'uniform-stretching = ##t
3250     }
3251   }
3252 }
3253 @end lilypond
3254
3255 Our two-staff example now spaces exactly, our rhythmic
3256 relationships are visually clear, and we can include a measured
3257 timeline or graphic if we want.
3258
3259 Note that the LilyPond's proportional notation package expects
3260 that all proportional scores set the SpacingSpanner's
3261 'uniform-stretching attribute to ##t.  Setting
3262 proportionalNotationDuration without also setting the
3263 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3264 example, cause Skips to consume an incorrect amount of horizontal
3265 space.
3266
3267 The SpacingSpanner is an abstract grob that lives in the Score
3268 context.  As with our settings of proportionalNotationDuration,
3269 overrides to the SpacingSpanner can occur in any of three
3270 different places in our input file â€“ in the Score \with block, in
3271 a Score \context block, or in note entry directly.
3272
3273 There is by default only one @code{SpacingSpanner} per @code{Score}.  This
3274 means that, by default, @code{uniform-stretching} is either turned on for the
3275 entire score or turned off for the entire score.  We can, however,
3276 override this behavior and turn on different spacing features at
3277 different places in the score.  We do this with the command
3278 @code{\newSpacingSection}.  See @ref{New spacing area}, for more info.
3279
3280 Next we examine the effects of the @code{Separating_line_group_engraver} and
3281 see why proportional scores frequently remove this engraver.  The following
3282 example shows that there is a small amount of @qq{prefatory} space
3283 just before the first note in each system.
3284
3285 @lilypond[quote,verbatim,ragged-right]
3286 \paper {
3287   indent = #0
3288 }
3289
3290 \new Staff {
3291   c'1
3292   \break
3293   c'1
3294 }
3295 @end lilypond
3296
3297
3298 The amount of this prefatory space is the same whether after a time
3299 signature, a key signature or a clef.  @code{Separating_line_group_engraver}
3300 is responsible for this space.  Removing @code{Separating_line_group_engraver}
3301 reduces this space to zero.
3302
3303 @lilypond[quote,verbatim,ragged-right]
3304 \paper {
3305   indent = #0
3306 }
3307
3308 \new Staff \with {
3309   \remove "Separating_line_group_engraver"
3310 } {
3311   c'1
3312   \break
3313   c'1
3314 }
3315 @end lilypond
3316
3317 non-musical elements like time signatures, key signatures, clefs and
3318 accidentals are problematic in proportional notation.  None of these
3319 elements has rhythmic duration.  But all of these elements consume
3320 horizontal space.  Different proportional scores approach these
3321 problems differently.
3322
3323 It may be possible to avoid spacing problems with key signatures
3324 simply by not having any.  This is a valid option since most
3325 proportional scores are contemporary music.  The same may be true
3326 of time signatures, especially for those scores
3327 that include a measured timeline or other graphic.  But these scores
3328 are exceptional and most proportional scores include at least some
3329 time signatures.  Clefs and accidentals are even more essential.
3330
3331 So what strategies exist for spacing non-musical elements in a
3332 proportional context?  One good option is the @code{strict-note-spacing}
3333 property of @code{SpacingSpanner}.  Compare the two scores below:
3334
3335 @lilypond[quote,verbatim,ragged-right]
3336 \new Staff {
3337   \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3338   c''8
3339   c''8
3340   c''8
3341   \clef alto
3342   d'8
3343   d'2
3344 }
3345
3346 \new Staff {
3347   \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3348   \override Score.SpacingSpanner #'strict-note-spacing = ##t
3349   c''8
3350   c''8
3351   c''8
3352   \clef alto
3353   d'8
3354   d'2
3355 }
3356 @end lilypond
3357
3358 Both scores are proportional, but the spacing in the first score
3359 is too loose because of the clef change.  The spacing of the second
3360 score remains strict, however, because strict-note-spacing is
3361 turned on.  Turning on strict-note-spacing causes the width of
3362 time signatures, key signatures, clefs and accidentals to play no
3363 part in the spacing algorithm.
3364
3365 In addition to the settings given here, there are other settings
3366 that frequently appear in proportional scores.  These include:
3367
3368 @itemize
3369 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
3370 @item @code{tupletFullLength = ##t}
3371 @item @code{\override Beam #'breakable = ##t}
3372 @item @code{\override Glissando #'breakable = ##t}
3373 @item @code{\override TextSpanner #'breakable = ##t}
3374 @item @code{\remove "Forbid_line_break_engraver" in the Voice context}
3375 @end itemize
3376
3377 These settings space grace notes strictly, extend tuplet brackets to
3378 mark both rhythmic start- and stop-points, and allow spanning elements
3379 to break across systems and pages.  See the respective parts of the manual
3380 for these related settings.
3381
3382 @seealso
3383 Notation Reference:
3384 @ref{New spacing area}.
3385
3386 Snippets:
3387 @rlsr{Spacing}.
3388
3389
3390 @node Fitting music onto fewer pages
3391 @section Fitting music onto fewer pages
3392
3393 Sometimes you can end up with one or two staves on a second
3394 (or third, or fourth@dots{}) page.  This is annoying, especially
3395 if you look at previous pages and it looks like there is plenty
3396 of room left on those.
3397
3398 When investigating layout issues, @code{annotate-spacing} is an
3399 invaluable tool.  This command prints the values of various layout
3400 spacing variables; for more details see the following section,
3401 @ref{Displaying spacing}.
3402
3403 @menu
3404 * Displaying spacing::
3405 * Changing spacing::
3406 @end menu
3407
3408
3409 @node Displaying spacing
3410 @subsection Displaying spacing
3411
3412 @funindex annotate-spacing
3413 @cindex spacing, display of layout
3414
3415 To graphically display the dimensions of vertical layout variables
3416 that may be altered for page formatting, set
3417 @code{annotate-spacing} in the @code{\paper} block:
3418
3419 @c need to have \book{} otherwise we get the separate systems. -hwn
3420 @lilypond[verbatim,quote]
3421 #(set-default-paper-size "a6" 'landscape)
3422 \book {
3423   \score { { c4 } }
3424   \paper { annotate-spacing = ##t }
3425 }
3426 @end lilypond
3427
3428
3429 @noindent
3430 All layout dimensions are displayed in staff-spaces, regardless
3431 of the units specified in the @code{\paper} or @code{\layout} block.
3432 In the above example, @code{paper-height} has a value of 59.75
3433 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3434 default value).  Note that:
3435
3436 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3437
3438 @item 1 point
3439 @tab = (25.4/72.27) mm
3440
3441 @item 1 staff-space
3442 @tab = (@code{staff-size})/4 pts
3443 @item
3444 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3445
3446 @end multitable
3447
3448 @noindent
3449 In this case, one @code{staff-space} is approximately equal to
3450 1.757mm.  Thus the @code{paper-height} measurement of 59.75
3451 @code{staff-spaces} is equivalent to 105 millimeters, the height
3452 of @code{a6} paper in landscape orientation.  The pairs
3453 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3454 edge and @var{b} the upper edge of the interval.
3455
3456 @seealso
3457 Notation Reference:
3458 @ref{Setting the staff size}.
3459
3460 Snippets:
3461 @rlsr{Spacing}.
3462
3463
3464 @node Changing spacing
3465 @subsection Changing spacing
3466
3467 The output of @code{annotate-spacing} reveals vertical dimensions
3468 in great detail.  For details about modifying margins and other
3469 layout variables, see @ref{Page layout}.
3470
3471 Other than margins, there are a few other options to save space:
3472
3473 @itemize
3474 @item
3475 Force systems to move as close together as possible (to fit as
3476 many systems as possible onto a page) while being spaced so that
3477 there is no blank space at the bottom of the page.
3478
3479 @example
3480 \paper @{
3481   system-system-spacing = #'((basic-distance . 0.1) (padding . 0))
3482   ragged-last-bottom = ##f
3483   ragged-bottom = ##f
3484 @}
3485 @end example
3486
3487 @item
3488 Force the number of systems.  This can help in two ways.  Just
3489 setting a value, even the same value as the number of systems
3490 being typeset by default, will sometimes cause more systems to
3491 be fitted onto each page, as an estimation step is then bypassed,
3492 giving a more accurate fit to each page.  Also, forcing an actual
3493 reduction in the number of systems may save a further page.  For
3494 example, if the default layout has 11 systems, the following
3495 assignment will force a layout with 10 systems.
3496
3497 @example
3498 \paper @{
3499   system-count = #10
3500 @}
3501 @end example
3502
3503 @item
3504 Force the number of pages.  For example, the following
3505 assignment will force a layout with 2 pages.
3506
3507 @example
3508 \paper @{
3509   page-count = #2
3510 @}
3511 @end example
3512
3513 @item
3514 Avoid (or reduce) objects that increase the vertical size of a
3515 system.  For example, volta repeats (or alternate repeats) require
3516 extra space.  If these repeats are spread over two systems, they
3517 will take up more space than one system with the volta repeats and
3518 another system without.  For example, dynamics that @q{stick out} of
3519 a system can be moved closer to the staff:
3520
3521 @lilypond[verbatim,quote,relative=1]
3522 e4 c g\f c
3523 e4 c g-\tweak #'X-offset #-2.7 -\tweak #'Y-offset #2.5 \f c
3524 @end lilypond
3525
3526 @item
3527 Alter the horizontal spacing via @code{SpacingSpanner}.  For more
3528 details, see @ref{Changing horizontal spacing}.  The following
3529 example illustrates the default spacing:
3530
3531 @lilypond[verbatim,quote]
3532 \score {
3533   \relative c'' {
3534     g4 e e2 |
3535     f4 d d2 |
3536     c4 d e f |
3537     g4 g g2 |
3538     g4 e e2 |
3539   }
3540 }
3541 @end lilypond
3542
3543 @noindent
3544 The next example modifies @code{common-shortest-duration} from a
3545 value of @code{1/4} to @code{1/2}.  The quarter note is the most
3546 common and shortest duration in this example, so by making this
3547 duration longer, a @q{squeezing} effect occurs:
3548
3549 @lilypond[verbatim,quote]
3550 \score {
3551   \relative c'' {
3552     g4 e e2 |
3553     f4 d d2 |
3554     c4 d e f |
3555     g4 g g2 |
3556     g4 e e2 |
3557   }
3558   \layout {
3559     \context {
3560       \Score
3561       \override SpacingSpanner
3562         #'common-shortest-duration = #(ly:make-moment 1 2)
3563     }
3564   }
3565 }
3566 @end lilypond
3567
3568 @noindent
3569 The @code{common-shortest-duration} property cannot be modified
3570 dynamically, so it must always be placed in a @code{\context}
3571 block so that it applies to the whole score.
3572
3573 @end itemize
3574
3575 @seealso
3576 Notation Reference:
3577 @ref{Page layout},
3578 @ref{Changing horizontal spacing}.
3579
3580 Snippets:
3581 @rlsr{Spacing}.