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