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