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