1 @c -*- coding: utf-8; mode: texinfo; -*-
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
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..
16 Negative numbers are allowed:
17 > Are you sure? The following works well
19 > first-page-number = -2
21 > and prints page number -1 on the second page, for example.
24 In 5.2.1 the @refbugs (line 495 in spacing.itely on master) it
27 "@code{layout-set-staff-size} does not change the distance between
31 Could we add a sentence:
32 "Use instead the pair fontSize = #@var{N}
33 \override StaffSymbol.staff-space = #(magstep
35 inside the Staff context to change the size of the font and the
37 staff lines accordingly."
39 Actually I found, that the @internalsref{StaffSymbol} at line 481
40 sends to an incomplete
41 documentation. The property staff-space is not explained here. I
42 thought Y-extent might be of
43 help, but it is in turn explained by x-space which again is
44 missing from the list. Who has the
45 knowledge to fix this?
49 http://code.google.com/p/lilypond/issues/detail?id=68
55 @chapter Spacing issues
57 The global paper layout is determined by three factors: the page layout, the
58 line breaks, and the spacing. These all influence each other. The
59 choice of spacing determines how densely each system of music is set.
60 This influences where line breaks are chosen, and thus ultimately, how
61 many pages a piece of music takes.
63 Globally speaking, this procedure happens in four steps: first,
64 flexible distances (@q{springs}) are chosen, based on durations. All
65 possible line breaking combinations are tried, and a @q{badness} score
66 is calculated for each. Then the height of each possible system is
67 estimated. Finally, a page breaking and line breaking combination is chosen
68 so that neither the horizontal nor the vertical spacing is too cramped
71 Two types of blocks can contain layout settings:
72 @code{\paper @{@dots{}@}} and @code{\layout @{@dots{}@}}. The
73 @code{\paper} block contains page layout settings that are expected
74 to be the same for all scores in a book or bookpart, such as the
75 paper height, or whether to print page numbers, etc. See
76 @ref{Page layout}. The @code{\layout} block contains score layout
77 settings, such as the number of systems to use, or the space
78 between staff-groups, etc. See @ref{Score layout}.
85 * Horizontal spacing::
86 * Fitting music onto fewer pages::
93 This section discusses page layout options for the @code{\paper}
98 * Paper size and automatic scaling::
99 * Fixed vertical spacing paper variables::
100 * Flexible vertical spacing paper variables::
101 * Horizontal spacing paper variables::
102 * Other paper variables::
106 @node The paper block
107 @subsection The @code{@bs{}paper} block
109 @code{\paper} blocks may be placed in three different places to form
110 a descending hierarchy of @code{\paper} blocks:
115 At the top of the input file, before all @code{\book},
116 @code{\bookpart}, and @code{\score} blocks.
119 Within a @code{\book} block but outside all the @code{\bookpart} and
120 @code{\score} blocks within that book.
123 Within a @code{\bookpart} block but outside all @code{\score} blocks
124 within that bookpart.
128 A @code{\paper} block cannot be placed within a @code{\score} block.
130 The values of the fields filter down this hierarchy, with the values
131 set higher in the hierarchy persisting unless they are over-ridden
132 by a value set lower in the hierarchy.
134 Several @code{\paper} blocks can appear at each of the levels, for
135 example as parts of several @code{\include}d files. If so, the
136 fields at each level are merged, with values encountered last taking
137 precedence if duplicated fields appear.
139 Settings that can appear in a @code{\paper} block include:
144 the @code{set-paper-size} scheme function,
147 @code{\paper} variables used for customizing page layout, and
150 markup definitions used for customizing the layout of headers,
155 The @code{set-paper-size} function is discussed in the next
156 section, @ref{Paper size and automatic scaling}. The
157 @code{\paper} variables that deal with page layout are discussed
158 in later sections. The markup definitions that deal with headers,
159 footers, and titles are discussed in
160 @ref{Custom titles headers and footers}.
162 Most @code{\paper} variables will only work in a @code{\paper}
163 block. The few that will also work in a @code{\layout} block are
164 listed in @ref{The layout block,,The @code{@bs{}layout} block}.
166 Except when specified otherwise, all @code{\paper} variables that
167 correspond to distances on the page are measured in millimeters,
168 unless a different unit is specified by the user. For example,
169 the following declaration sets @code{top-margin} to ten
178 To set it to @code{0.5} inches, use the @code{\in} unit suffix:
186 The available unit suffixes are @code{\mm}, @code{\cm},
187 @code{\in}, and @code{\pt}. These units are simple values for
188 converting from millimeters; they are defined in
189 @file{ly/paper-defaults-init.ly}. For the sake of clarity, when
190 using millimeters, the @code{\mm} is typically included in the
191 code, even though it is not technically necessary.
193 It is also possible to define @code{\paper} values using Scheme.
194 The Scheme equivalent of the above example is:
198 #(define top-margin (* 0.5 in))
204 @ref{Paper size and automatic scaling},
205 @ref{Custom titles headers and footers},
206 @ref{The layout block,,The @code{@bs{}layout} block}.
209 @file{ly/paper-defaults-init.ly}.
212 @node Paper size and automatic scaling
213 @subsection Paper size and automatic scaling
221 * Setting the paper size::
222 * Automatic scaling to paper size::
226 @node Setting the paper size
227 @unnumberedsubsubsec Setting the paper size
229 @q{A4} is the default value when no explicit paper size is set. However,
230 there are two functions that can be used to change it:
233 @item set-default-paper-size
236 #(set-default-paper-size "quarto")
239 which must always be placed at the toplevel scope, and
245 #(set-paper-size "tabloid")
249 which must always be placed in a @code{\paper} block.
252 If the @code{set-default-paper-size} function is used in the toplevel
253 scope, it must come before any @code{\paper} block.
254 @code{set-default-paper-size} sets the paper size for all pages,
255 whereas @code{set-paper-size} only sets the paper size for the pages
256 that the @code{\paper} block applies to. For example, if the
257 @code{\paper} block is at the top of the file, then it will apply the
258 paper size to all pages. If the @code{\paper} block is inside a
259 @code{\book}, then the paper size will only apply to that book.
261 When the @code{set-paper-size} function is used, it must be
262 placed @emph{before} any other functions used within the same
263 @code{\paper} block. See @ref{Automatic scaling to paper size}.
265 Paper sizes are defined in @file{scm/paper.scm}, and while it is
266 possible to add custom sizes, they will be overwritten on subsequent
267 software updates. The available paper sizes are listed in
268 @ref{Predefined paper sizes}.
270 @c An appendix entry exists for paper sizes but is not auto-generated
272 The following command can be used in the file to add a custom paper size
273 which can then be used with @code{set-default-paper-size} or
274 @code{set-paper-size} as appropriate,
277 #(set! paper-alist (cons '("my size" . (cons (* 15 in) (* 3 in))) paper-alist))
280 #(set-paper-size "my size")
284 The units @code{in} (inches), @code{cm} (centimeters) and @code{mm}
285 (millimeters) can all be used.
287 @cindex paper size, orientation
288 @cindex page, orientation
289 @cindex paper size, landscape
291 If the symbol @code{'landscape} is added to the paper size function,
292 pages will be rotated by 90 degrees, and wider line widths will be set
296 #(set-default-paper-size "a6" 'landscape)
299 Swapping the paper dimensions @emph{without} having the print rotated
300 (like when printing to postcard size, or creating graphics for inclusion
301 rather than a standalone document) can be achieved by appending
302 @samp{landscape} to the name of the paper size itself:
305 #(set-default-paper-size "a6landscape")
308 When the paper size ends with an explicit @samp{landscape} or
309 @samp{portrait}, the presence of a @code{'landscape} symbol @emph{only}
310 affects print orientation, not the paper dimensions used for layout.
314 @ref{Automatic scaling to paper size},
315 @ref{Predefined paper sizes}.
318 @file{scm/paper.scm}.
321 @node Automatic scaling to paper size
322 @unnumberedsubsubsec Automatic scaling to paper size
324 If the paper size is changed with one of the scheme functions
325 (@code{set-default-paper-size} or @code{set-paper-size}), the
326 values of several @code{\paper} variables are automatically scaled
327 to the new size. To bypass the automatic scaling for a particular
328 variable, set the variable after setting the paper size. Note
329 that the automatic scaling is not triggered by setting the
330 @code{paper-height} or @code{paper-width} variables, even though
331 @code{paper-width} can influence other values (this is separate
332 from scaling and is discussed below). The
333 @code{set-default-paper-size} and @code{set-paper-size} functions
334 are described in @ref{Setting the paper size}.
336 The vertical dimensions affected by automatic scaling are
337 @code{top-margin} and @code{bottom-margin} (see
338 @ref{Fixed vertical spacing paper variables,,Fixed vertical spacing @code{@bs{}paper} variables}).
340 dimensions affected by automatic scaling are @code{left-margin},
341 @code{right-margin}, @code{inner-margin}, @code{outer-margin},
342 @code{binding-offset}, @code{indent}, and @code{short-indent} (see
343 @ref{Horizontal spacing paper variables,,Horizontal spacing @code{@bs{}paper} variables}).
345 The default values for these dimensions are set in
346 @file{ly/paper-defaults-init.ly}, using internal variables named
347 @code{top-margin-default}, @code{bottom-margin-default}, etc.
348 These are the values that result at the default paper size
349 @code{a4}. For reference, with @code{a4} paper the
350 @code{paper-height} is @code{297\mm} and the @code{paper-width} is
355 @ref{Fixed vertical spacing paper variables,,Fixed vertical spacing @code{@bs{}paper} variables},
356 @ref{Horizontal spacing paper variables,,Horizontal spacing @code{@bs{}paper} variables}.
359 @file{ly/paper-defaults-init.ly},
360 @file{scm/paper.scm}.
363 @node Fixed vertical spacing paper variables
364 @subsection Fixed vertical spacing @code{@bs{}paper} variables
366 @warning{Some @code{@bs{}paper} dimensions are automatically
367 scaled to the paper size, which may lead to unexpected behavior.
368 See @ref{Automatic scaling to paper size}.}
370 Default values (before scaling) are defined in
371 @file{ly/paper-defaults-init.ly}.
375 @funindex paper-height
377 The height of the page, unset by default. Note that the automatic
378 scaling of some vertical dimensions is not affected by this.
383 The margin between the top of the page and the top of the
384 printable area. If the paper size is modified, this dimension's
385 default value is scaled accordingly.
388 @funindex bottom-margin
390 The margin between the bottom of the printable area and the bottom
391 of the page. If the paper size is modified, this dimension's
392 default value is scaled accordingly.
395 @funindex ragged-bottom
397 If this is set to true,
398 systems will be set at their natural spacing, neither compressed
399 nor stretched vertically to fit the page.
401 @item ragged-last-bottom
402 @funindex ragged-last-bottom
404 If this is set to false, then the last page,
405 and the last page in each section created with a @code{\bookpart} block,
406 will be vertically justified in the same way as the earlier pages.
412 @ref{Automatic scaling to paper size}.
415 @file{ly/paper-defaults-init.ly}.
421 The titles (from the @code{\header} block) are treated as a
422 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
423 add space between the titles and the first system of the score.
425 Explicitly defined paper-sizes will override any user-defined top or
426 bottom margin settings.
429 @node Flexible vertical spacing paper variables
430 @subsection Flexible vertical spacing @code{@bs{}paper} variables
432 In most cases, it is preferable for the vertical distances between
433 certain items (such as margins, titles, systems, and separate
434 scores) to be flexible, so that they stretch and compress nicely
435 according to each situation. A number of @code{\paper} variables
436 (listed below) are available to fine-tune the stretching behavior
439 Note that the @code{\paper} variables discussed in this section do
440 not control the spacing of staves within individual systems.
441 Within-system spacing is controlled by grob properties, with
442 settings typically entered inside a @code{\score} or
443 @code{\layout} block, and not inside a @code{\paper} block. See
444 @ref{Flexible vertical spacing within systems}.
447 * Structure of flexible vertical spacing alists::
448 * List of flexible vertical spacing paper variables::
452 @node Structure of flexible vertical spacing alists
453 @unnumberedsubsubsec Structure of flexible vertical spacing alists
455 Each of the flexible vertical spacing @code{\paper} variables is
456 an alist (association list) containing four @emph{keys}:
461 @code{basic-distance} -- the vertical distance, measured in
462 staff-spaces, between the @emph{reference points} of the two
463 items, when no collisions would result, and no stretching or
464 compressing is in effect. The reference point of a (title or
465 top-level) markup is its highest point, and the reference point of
466 a system is the vertical center of the nearest @code{StaffSymbol}
467 -- even if a non-staff line (such as a @code{Lyrics} context) is
468 in the way. Values for @code{basic-distance} that are less than
469 either @code{padding} or @code{minimum-distance} are not
470 meaningful, since the resulting distance will never be less than
471 either @code{padding} or @code{minimum-distance}.
474 @code{minimum-distance} -- the smallest allowable vertical
475 distance, measured in staff-spaces, between the reference points
476 of the two items, when compressing is in effect. Values for
477 @code{minimum-distance} that are less than @code{padding} are not
478 meaningful, since the resulting distance will never be less than
481 @c TODO: explain skylines somewhere and xref to it from here.
484 @code{padding} -- the minimum required amount of unobstructed
485 vertical whitespace between the bounding boxes (or skylines) of
486 the two items, measured in staff-spaces.
489 @code{stretchability} -- a unitless measure of the dimension's
490 relative propensity to stretch. If zero, the distance will not
491 stretch (unless collisions would result). When positive, the
492 significance of a particular dimension's @code{stretchability}
493 value lies only in its relation to the @code{stretchability}
494 values of the other dimensions. For example, if one dimension has
495 twice the @code{stretchability} of another, it will stretch twice
496 as easily. Values should be non-negative and finite. The value
497 @code{+inf.0} triggers a @code{programming_error} and is ignored,
498 but @code{1.0e7} can be used for an almost infinitely stretchable
499 spring. If unset, the default value is set to
500 @code{basic-distance}. Note that the dimension's propensity to
501 @emph{compress} cannot be directly set by the user and is equal to
502 (@code{basic-distance}@tie{}@minus{}@tie{}@code{minimum-distance}).
506 If a page has a ragged bottom, the resulting distance is the
512 @code{basic-distance},
515 @code{minimum-distance}, and
518 @code{padding} plus the smallest distance necessary to eliminate
523 For multi-page scores with a ragged bottom on the last page, the last
524 page uses the same spacing as the preceding page, provided there is
525 enough space for that.
527 Specific methods for modifying alists are discussed in
528 @ref{Modifying alists}. The following example demonstrates the
529 two ways these alists can be modified. The first declaration
530 updates one key-value individually, and the second completely
531 redefines the variable:
535 system-system-spacing #'basic-distance = #8
536 score-system-spacing =
537 #'((basic-distance . 12)
538 (minimum-distance . 6)
540 (stretchability . 12))
545 @node List of flexible vertical spacing paper variables
546 @unnumberedsubsubsec List of flexible vertical spacing @code{@bs{}paper} variables
548 The names of these variables follow the format
549 @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}}
550 and @code{@var{lower}} are the items to be spaced. Each distance
551 is measured between the reference points of the two items (see the
552 description of the alist structure above). Note that in these
553 variable names, the term @q{@code{markup}} refers to both
554 @emph{title markups} (@code{bookTitleMarkup} or
555 @code{scoreTitleMarkup}) and @emph{top-level markups} (see
556 @ref{File structure}). All distances are measured in
559 Default settings are defined in @file{ly/paper-defaults-init.ly}.
561 @c TODO: Where do headers/footers fit in? -mp
564 @item markup-system-spacing
565 @funindex markup-system-spacing
567 the distance between a (title or top-level) markup and the system
570 @item score-markup-spacing
571 @funindex score-markup-spacing
573 the distance between the last system of a score and the (title or
574 top-level) markup that follows it.
576 @item score-system-spacing
577 @funindex score-system-spacing
579 the distance between the last system of a score and the first
580 system of the score that follows it, when no (title or top-level)
581 markup exists between them.
583 @item system-system-spacing
584 @funindex system-system-spacing
586 the distance between two systems in the same score.
588 @item markup-markup-spacing
589 @funindex markup-markup-spacing
591 the distance between two (title or top-level) markups.
593 @item last-bottom-spacing
594 @funindex last-bottom-spacing
596 the distance from the last system or top-level markup on a page to
597 the bottom of the printable area (i.e. the top of the bottom
600 @item top-system-spacing
601 @funindex top-system-spacing
603 the distance from the top of the printable area (i.e. the bottom
604 of the top margin) to the first system on a page, when there is no
605 (title or top-level) markup between the two.
607 @item top-markup-spacing
608 @funindex top-markup-spacing
610 the distance from the top of the printable area (i.e. the bottom
611 of the top margin) to the first (title or top-level) markup on a
612 page, when there is no system between the two.
617 @ref{Flexible vertical spacing within systems}.
620 @file{ly/paper-defaults-init.ly}.
626 @node Horizontal spacing paper variables
627 @subsection Horizontal spacing @code{@bs{}paper} variables
629 @warning{Some @code{@bs{}paper} dimensions are automatically
630 scaled to the paper size, which may lead to unexpected behavior.
631 See @ref{Automatic scaling to paper size}.}
634 * paper variables for widths and margins::
635 * paper variables for two-sided mode::
636 * paper variables for shifts and indents::
640 @node paper variables for widths and margins
641 @unnumberedsubsubsec @code{@bs{}paper} variables for widths and margins
643 Default values (before scaling) that are not listed here are
644 defined in @file{ly/paper-defaults-init.ly}.
649 @funindex paper-width
651 The width of the page, unset by default. While @code{paper-width}
652 has no effect on the automatic scaling of some horizontal
653 dimensions, it does influence the @code{line-width} variable. If
654 both @code{paper-width} and @code{line-width} are set, then
655 @code{left-margin} and @code{right-margin} will also be updated.
656 Also see @code{check-consistency}.
661 The horizontal extent of the staff lines in unindented, non-ragged
663 @code{(paper-width@tie{}@minus{}@tie{}left-margin@tie{}@minus{}@tie{}right-margin)}
664 when unset. If @code{line-width} is set, and both
665 @code{left-margin} and @code{right-margin} are unset, then the
666 margins will be updated to center the systems on the page
667 automatically. Also see @code{check-consistency}. This variable
668 can also be set in a @code{\layout} block.
671 @funindex left-margin
673 The margin between the left edge of the page and the start of the
674 staff lines in unindented systems. If the paper size is modified,
675 this dimension's default value is scaled accordingly. If
676 @code{left-margin} is unset, and both @code{line-width} and
677 @code{right-margin} are set, then @code{left-margin} is set to
678 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}right-margin)}.
679 If only @code{line-width} is set, then both margins are set to
680 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
681 and the systems are consequently centered on the page. Also see
682 @code{check-consistency}.
685 @funindex right-margin
687 The margin between the right edge of the page and the end of the
688 staff lines in non-ragged systems. If the paper size is modified,
689 this dimension's default value is scaled accordingly. If
690 @code{right-margin} is unset, and both @code{line-width} and
691 @code{left-margin} are set, then @code{right-margin} is set to
692 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}left-margin)}.
693 If only @code{line-width} is set, then both margins are set to
694 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
695 and the systems are consequently centered on the page. Also see
696 @code{check-consistency}.
698 @item check-consistency
699 @funindex check-consistency
701 If set to true, print a warning if @code{left-margin},
702 @code{line-width}, and @code{right-margin} do not exactly add up
703 to @code{paper-width}, and replace each of these (except
704 @code{paper-width}) with its default value (scaled to the paper
705 size if necessary). If set to false, ignore any inconsistencies
706 and allow systems to run off the edge of the page.
709 @funindex ragged-right
711 If set to true, systems will not fill the line width. Instead,
712 systems end at their natural horizontal length. Default:
713 @code{#t} for scores with only one system, and @code{#f} for
714 scores with two or more systems. This variable can also be set in
715 a @code{\layout} block.
718 @funindex ragged-last
720 If set to true, the last system in the score will not fill the
721 line width. Instead the last system ends at its natural
722 horizontal length. Default: @code{#f}. This variable can also be
723 set in a @code{\layout} block.
729 @ref{Automatic scaling to paper size}.
732 @file{ly/paper-defaults-init.ly}.
735 Explicitly defined paper-sizes will override any user-defined left or
736 right margin settings.
739 @node paper variables for two-sided mode
740 @unnumberedsubsubsec @code{@bs{}paper} variables for two-sided mode
742 Default values (before scaling) are defined in
743 @file{ly/paper-defaults-init.ly}.
751 @cindex binding gutter
753 If set to true, use @code{inner-margin}, @code{outer-margin} and
754 @code{binding-offset} to determine margins depending on whether
755 the page number is odd or even. This overrides @code{left-margin}
756 and @code{right-margin}.
759 @funindex inner-margin
761 The margin all pages have at the inner side if they are part of a
762 book. If the paper size is modified, this dimension's default
763 value is scaled accordingly. Works only with @code{two-sided} set
767 @funindex outer-margin
769 The margin all pages have at the outer side if they are part of a
770 book. If the paper size is modified, this dimension's default
771 value is scaled accordingly. Works only with @code{two-sided} set
775 @funindex binding-offset
777 The amount @code{inner-margin} is increased to make sure nothing
778 will be hidden by the binding. If the paper size is modified,
779 this dimension's default value is scaled accordingly. Works only
780 with @code{two-sided} set to true.
786 @ref{Automatic scaling to paper size}.
789 @file{ly/paper-defaults-init.ly}.
792 @node paper variables for shifts and indents
793 @unnumberedsubsubsec @code{@bs{}paper} variables for shifts and indents
795 Default values (before scaling) that are not listed here are
796 defined in @file{ly/paper-defaults-init.ly}.
800 @item horizontal-shift
801 @funindex horizontal-shift
803 @c This default value is buried in the middle of page.scm. -mp
805 The amount that all systems (including titles and system
806 separators) are shifted to the right. Default: @code{0.0\mm}.
811 The level of indentation for the first system in a score. If the
812 paper size is modified, this dimension's default value is scaled
813 accordingly. This variable can also be set in a @code{\layout}
817 @funindex short-indent
819 The level of indentation for all systems in a score besides the
820 first system. If the paper size is modified, this dimension's
821 default value is scaled accordingly. This variable can also be
822 set in a @code{\layout} block.
828 @ref{Automatic scaling to paper size}.
831 @file{ly/paper-defaults-init.ly}.
837 @node Other paper variables
838 @subsection Other @code{@bs{}paper} variables
841 * paper variables for line breaking::
842 * paper variables for page breaking::
843 * paper variables for page numbering::
844 * Miscellaneous paper variables::
848 @node paper variables for line breaking
849 @unnumberedsubsubsec @code{@bs{}paper} variables for line breaking
853 @item max-systems-per-page
854 @funindex max-systems-per-page
856 The maximum number of systems that will be placed on a page. This
857 is currently supported only by the @code{ly:optimal-breaking} algorithm.
860 @item min-systems-per-page
861 @funindex min-systems-per-page
863 The minimum number of systems that will be placed on a page. This
864 may cause pages to be overfilled if it is made too large. This is
865 currently supported only by the @code{ly:optimal-breaking} algorithm.
868 @item systems-per-page
869 @funindex systems-per-page
871 The number of systems that should be placed on each page.
872 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
876 @funindex system-count
878 The number of systems to be used for a score. Default: unset.
879 This variable can also be set in a @code{\layout} block.
888 @node paper variables for page breaking
889 @unnumberedsubsubsec @code{@bs{}paper} variables for page breaking
891 Default values not listed here are defined in
892 @file{ly/paper-defaults-init.ly}
897 @funindex page-breaking
899 The page-breaking algorithm to use. Choices are
900 @code{ly:minimal-breaking}, @code{ly:page-turn-breaking},
901 @code{ly:one-line-breaking} and @code{ly:optimal-breaking}
904 @item page-breaking-system-system-spacing
905 @funindex page-breaking-system-system-spacing
907 Tricks the page breaker into thinking that
908 @code{system-system-spacing} is set to something different than
909 it really is. For example, if
910 @code{page-breaking-system-system-spacing #'padding} is set to something
911 substantially larger than @code{system-system-spacing #'padding}, then the
912 page-breaker will put fewer systems on each page. Default: unset.
917 The number of pages to be used for a score, unset by default.
921 The following variables are effective only when @code{page-breaking}
922 is set to @code{ly:page-turn-breaking}. Page breaks are then chosen
923 to minimize the number of page turns. Since page turns are required
924 on moving from an odd-numbered page to an even-numbered one, a
925 layout in which the last page is odd-numbered will usually be
926 favoured. Places where page turns are preferred can be indicated
927 manually by inserting @code{\allowPageTurn} or automatically by
928 including the @code{Page_turn_engraver} (see @ref{Optimal page turning}).
930 If there are insufficient choices available for making suitable page
931 turns, LilyPond may insert a blank page either within a score, between
932 scores (if there are two or more scores), or by ending a score on an
933 even-numbered page. The values of the following three variables may
934 be increased to make these actions less likely.
936 The values are penalties, i.e. the higher the value the less likely
937 will be the associated action relative to other choices.
941 @item blank-page-penalty
942 @funindex blank-page-penalty
944 The penalty for having a blank page in the middle of a score. If
945 @code{blank-page-penalty} is large and @code{ly:page-turn-breaking} is
946 selected, then LilyPond will be less likely to insert a page in the
947 middle of a score. Instead, it will space out the music further to
948 fill the blank page and the following one. Default: 5.
950 @item blank-last-page-penalty
951 @funindex blank-last-page-penalty
953 The penalty for ending the score on an even-numbered page. If
954 @code{blank-last-page-penalty} is large and
955 @code{ly:page-turn-breaking} is selected, then LilyPond will be less
956 likely to produce a score in which the last page is even-numbered.
957 Instead, it will adjust the spacing in order to use one page more or
958 one page less. Default: 0.
960 @item blank-after-score-page-penalty
961 @funindex blank-after-score-page-penalty
963 The penalty for having a blank page after the end of one score and
964 before the next. By default, this is smaller than
965 @code{blank-page-penalty}, so that blank pages after scores are
966 inserted in preference to blank pages within a score. Default: 2.
974 @ref{Optimal page breaking},
975 @ref{Optimal page turning},
976 @ref{Minimal page breaking},
977 @ref{One-line page breaking}.
980 @file{ly/paper-defaults-init.ly}.
983 @node paper variables for page numbering
984 @unnumberedsubsubsec @code{@bs{}paper} variables for page numbering
986 Default values not listed here are defined in
987 @file{ly/paper-defaults-init.ly}
991 @cindex page numbers, auto-numbering
992 @item auto-first-page-number
993 @funindex auto-first-page-number
995 The page breaking algorithm is affected by the first page number
996 being odd or even. If set to true, the page breaking algorithm
997 will decide whether to start with an odd or even number. This
998 will result in the first page number remaining as is or being
999 increased by one. Default: @code{#f}.
1001 @cindex page numbers, specify the first
1002 @item first-page-number
1003 @funindex first-page-number
1005 The value of the page number on the first page.
1007 @item print-first-page-number
1008 @funindex print-first-page-number
1010 If set to true, a page number is printed on the first page.
1012 @cindex page numbers, suppress
1013 @item print-page-number
1014 @funindex print-page-number
1016 If set to false, page numbers are not printed.
1022 @file{ly/paper-defaults-init.ly}.
1025 Odd page numbers are always on the right. If you want the
1026 music to start on page 1 there must be a blank page on the back
1027 of the cover page so that page 1 is on the right hand side.
1030 @node Miscellaneous paper variables
1031 @unnumberedsubsubsec Miscellaneous @code{@bs{}paper} variables
1035 @item page-spacing-weight
1036 @funindex page-spacing-weight
1038 The relative importance of page (vertical) spacing and line
1039 (horizontal) spacing. High values will make page spacing more
1040 important. Default: @code{10}.
1042 @item print-all-headers
1043 @funindex print-all-headers
1045 If set to true, this will print all headers for each @code{\score}
1046 in the output. Normally only the @code{piece} and @code{opus}
1047 header variables are printed. Default: @code{#f}.
1049 @item system-separator-markup
1050 @funindex system-separator-markup
1052 A markup object that is inserted between systems, often used for
1053 orchestral scores. Default: unset. The @code{\slashSeparator}
1054 markup, defined in @file{ly/titling-init.ly}, is provided as a
1055 sensible default, for example:
1057 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
1058 #(set-default-paper-size "a8")
1062 system-separator-markup = \slashSeparator
1068 \relative c'' { c1 \break c1 \break c1 }
1077 @file{ly/titling-init.ly}.
1083 The default page header puts the page number and the @code{instrument}
1084 field from the @code{\header} block on a line.
1088 @section Score layout
1090 This section discusses score layout options for the @code{\layout}
1094 * The layout block::
1095 * Setting the staff size::
1099 @node The layout block
1100 @subsection The @code{@bs{}layout} block
1104 While the @code{\paper} block contains settings that relate to the
1105 page formatting of the whole document, the @code{\layout} block
1106 contains settings for score-specific layout. To set score layout
1107 options globally, enter them in a toplevel @code{\layout} block.
1108 To set layout options for an individual score, enter them in a
1109 @code{\layout} block inside the @code{\score} block, after the
1110 music. Settings that can appear in a @code{\layout} block
1114 @item the @code{layout-set-staff-size} scheme function,
1115 @item context modifications in @code{\context} blocks, and
1116 @item @code{\paper} variables that affect score layout.
1119 The @code{layout-set-staff-size} function is discussed in the next
1120 section, @ref{Setting the staff size}. Context modifications are
1121 discussed in a separate chapter; see
1122 @ref{Modifying context plug-ins} and
1123 @ref{Changing context default settings}. The @code{\paper}
1124 variables that can appear in a @code{\layout} block are:
1129 @code{line-width}, @code{ragged-right} and @code{ragged-last}
1130 (see @ref{paper variables for widths and margins,,@code{@bs{}paper} variables for widths and margins})
1133 @code{indent} and @code{short-indent}
1134 (see @ref{paper variables for shifts and indents,,@code{@bs{}paper} variables for shifts and indents})
1138 (see @ref{paper variables for line breaking,,@code{@bs{}paper} variables for line breaking})
1142 Here is an example @code{\layout} block:
1149 \override StaffGrouper.staff-staff-spacing.basic-distance = #8
1153 \override TextScript.padding = #1
1154 \override Glissando.thickness = #3
1159 Multiple @code{\layout} blocks can be entered as toplevel expressions.
1160 This can, for example, be useful if different settings are stored in
1161 separate files and included optionally. Internally, when
1162 a @code{\layout} block is evaluated, a copy of the current
1163 @code{\layout} configuration is made, then any changes defined within
1164 the block are applied and the result is saved as the new current
1165 configuration. From the user's perspective the @code{\layout} blocks
1166 are combined, but in conflicting situations (when the same property
1167 is changed in different blocks) the later definitions take precedence.
1169 For example, if this block:
1175 \override TextScript.color = #magenta
1176 \override Glissando.thickness = #1.5
1181 is placed after the one from the preceding example the @code{'padding}
1182 and @code{'color} overrides for @code{TextScript} are combined, but
1183 the later @code{'thickness} override for @code{Glissando} replaces
1184 (or hides) the earlier one.
1186 @code{\layout} blocks may be assigned to variables for reuse later,
1187 but the way this works is slightly but significantly different from
1188 writing them literally.
1190 If a variable is defined like this:
1193 layoutVariable = \layout @{
1196 \override NoteHead.font-size = #4
1201 it will hold the current @code{\layout} configuration with the
1202 @code{NoteHead.font-size} override added, but this combination
1203 is @emph{not} saved as the new current configuration. Be aware
1204 that the @q{current configuration} is read when the variable is
1205 defined and not when it is used, so the content of the variable
1206 is dependent on its position in the source.
1208 The variable can then be used inside another @code{\layout} block,
1216 \override NoteHead.color = #red
1221 A @code{\layout} block containing a variable, as in the example above,
1222 does @emph{not} copy the current configuration but instead uses the
1223 content of @code{\layoutVariable} as the base configuration for the
1224 further additions. This means that any changes defined between the
1225 definition and the use of the variable are lost.
1227 If @code{layoutVariable} is defined (or @code{\include}d) immediately
1228 before being used, its content is just the current configuration plus
1229 the overrides defined within it. So in the example above showing the
1230 use of @code{\layoutVariable} the final @code{\layout} block would
1234 TextScript.padding = #1
1235 TextScript.color = #magenta
1236 Glissando.thickness = #1.5
1237 NoteHead.font-size = #4
1238 NoteHead.color = #red
1241 plus the @code{indent} and the @code{StaffGrouper} overrides.
1243 But if the variable had already been defined before the first
1244 @code{\layout} block the current configuration would now contain
1248 NoteHead.font-size = #4 % (written in the variable definition)
1249 NoteHead.color = #red % (added after the use of the variable)
1252 If carefully planned, @code{\layout} variables can be a valuable tool
1253 to structure the layout design of sources, and also to reset the
1254 @code{\layout} configuration to a known state.
1258 @ref{Changing context default settings}.
1264 @node Setting the staff size
1265 @subsection Setting the staff size
1267 @cindex font size, setting
1268 @cindex staff size, setting
1269 @funindex layout file
1271 The default @strong{staff size} is set to 20 points.
1272 This may be changed in two ways:
1274 To set the staff size globally for all scores in a file (or
1275 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
1278 #(set-global-staff-size 14)
1282 This sets the global default size to 14pt staff height and scales all
1285 To set the staff size individually for each score, use
1290 #(layout-set-staff-size 15)
1295 The Feta font provides musical symbols at eight different
1296 sizes. Each font is tuned for a different staff size: at a smaller size
1297 the font becomes heavier, to match the relatively heavier staff lines.
1298 The recommended font sizes are listed in the following table:
1301 @multitable @columnfractions .15 .2 .22 .2
1304 @tab @b{staff height (pt)}
1305 @tab @b{staff height (mm)}
1347 @c modern rental material?
1352 These fonts are available in any sizes. The context property
1353 @code{fontSize} and the layout property @code{staff-space} (in
1354 @rinternals{StaffSymbol}) can be used to tune the size for individual
1355 staves. The sizes of individual staves are relative to the global size.
1359 @ref{Selecting notation font size}.
1365 @code{layout-set-staff-size} does not change the distance between the
1375 * Optimal page breaking::
1376 * Optimal page turning::
1377 * Minimal page breaking::
1378 * One-line page breaking::
1380 * Using an extra voice for breaks::
1385 @subsection Line breaking
1388 @cindex breaking lines
1390 Line breaks are normally determined automatically. They are chosen
1391 so that lines look neither cramped nor loose, and consecutive
1392 lines have similar density.
1394 To manually force a line break at a bar line, use the
1395 @code{\break} command:
1397 @lilypond[quote,ragged-right,relative=2,verbatim]
1402 By default, a @code{\break} in the middle of a measure is ignored,
1403 and a warning is printed. To force a line break in the middle of
1404 a measure, add an invisible bar line with @w{@samp{\bar ""}}:
1406 @lilypond[quote,ragged-right,relative=2,verbatim]
1413 A @code{\break} occurring at a bar line is also ignored if the
1414 previous measure ends in the middle of a note, such as when a
1415 tuplet begins and ends in different measures. To allow
1416 @code{\break} commands to work in these situations, remove the
1417 @code{Forbid_line_break_engraver} from the @code{Voice} context.
1418 Note that manually forced line breaks have to be added in parallel
1421 @lilypond[quote,ragged-right,verbatim]
1423 \remove "Forbid_line_break_engraver"
1426 { c2. \tuplet 3/2 { c4 c c } c2. | }
1427 { s1 | \break s1 | }
1432 Similarly, line breaks are normally forbidden when beams cross bar
1433 lines. This behavior can be changed by setting
1434 @code{\override Beam.breakable = ##t}:
1436 @lilypond[quote,ragged-right,relative=2,verbatim]
1437 \override Beam.breakable = ##t
1442 The @code{\noBreak} command forbids a line break at the bar line
1443 where it is inserted.
1445 The most basic settings influencing line spacing are @code{indent}
1446 and @code{line-width}. They are set in the @code{\layout} block.
1447 They control the indentation of the first line of music, and the
1448 lengths of the lines.
1450 If @code{ragged-right} is set to true in the @code{\layout} block,
1451 then systems end at their natural horizontal length, instead of
1452 being spread horizontally to fill the whole line. This is useful
1453 for short fragments, and for checking how tight the natural
1456 @c TODO Check and add para on default for ragged-right
1458 The option @code{ragged-last} is similar to @code{ragged-right},
1459 but affects only the last line of the piece.
1471 @cindex regular line breaks
1472 @cindex four bar music.
1474 For line breaks at regular intervals use @code{\break} separated by
1475 skips and repeated with @code{\repeat}. For example, this would
1476 cause the following 28 measures (assuming 4/4 time) to be broken
1477 every 4 measures, and only there:
1482 s1 \noBreak s1 \noBreak
1483 s1 \noBreak s1 \break
1485 @{ @var{the actual music@dots{}} @}
1499 @ref{paper variables for line breaking,,@code{@bs{}paper} variables for line breaking}.
1504 Internals Reference:
1505 @rinternals{LineBreakEvent}.
1509 @subsection Page breaking
1511 The default page breaking may be overridden by inserting
1512 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1513 analogous to @code{\break} and @code{\noBreak}. They should be
1514 inserted at a bar line. These commands force and forbid a page-break
1515 from happening. Of course, the @code{\pageBreak} command also forces
1518 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1519 inserted at top-level, between scores and top-level markups.
1521 There are also analogous settings to @code{ragged-right} and
1522 @code{ragged-last} which have the same effect on vertical spacing.
1523 If @code{ragged-bottom} is set to @code{#t} the systems will not
1524 be justified vertically. When @code{ragged-last-bottom} is set
1525 to @code{#t}, as it is by default, empty space is allowed at the
1526 bottom of the final page (or the final page in each
1527 @code{\bookpart}). See
1528 @ref{Fixed vertical spacing paper variables,,Fixed vertical spacing @code{@bs{}paper} variables}.
1530 Page breaks are computed by the @code{page-breaking} function. LilyPond
1531 provides three algorithms for computing page breaks,
1532 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1533 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1534 but the value can be changed in the @code{\paper} block:
1538 page-breaking = #ly:page-turn-breaking
1544 When a book has many scores and pages, the page breaking problem may be
1545 difficult to solve, requiring large processing time and memory. To ease
1546 the page breaking process, @code{\bookpart} blocks are used to divide
1547 the book into several parts: the page breaking occurs separately on each
1548 part. Different page breaking functions may also be used in different
1554 subtitle = "Preface"
1557 %% In a part consisting mostly of text,
1558 %% ly:minimal-breaking may be preferred
1559 page-breaking = #ly:minimal-breaking
1561 \markup @{ @dots{} @}
1565 %% In this part, consisting of music, the default optimal
1566 %% page breaking function is used.
1568 subtitle = "First movement"
1570 \score @{ @dots{} @}
1577 @funindex \pageBreak
1579 @funindex \noPageBreak
1580 @code{\noPageBreak}.
1585 @ref{paper variables for page breaking,,@code{@bs{}paper} variables for page breaking}.
1591 @node Optimal page breaking
1592 @subsection Optimal page breaking
1594 @funindex ly:optimal-breaking
1596 The @code{ly:optimal-breaking} function is LilyPond's default method of
1597 determining page breaks. It attempts to find a page breaking that minimizes
1598 cramping and stretching, both horizontally and vertically. Unlike
1599 @code{ly:page-turn-breaking}, it has no concept of page turns.
1606 @node Optimal page turning
1607 @subsection Optimal page turning
1609 @funindex ly:page-turn-breaking
1611 Often it is necessary to find a page breaking configuration so that there is
1612 a rest at the end of every second page. This way, the musician can turn the
1613 page without having to miss notes. The @code{ly:page-turn-breaking} function
1614 attempts to find a page breaking minimizing cramping and stretching, but with
1615 the additional restriction that it is only allowed to introduce page turns
1616 in specified places.
1618 There are two steps to using this page breaking function. First, you
1619 must enable it in the @code{\paper} block, as explained in @ref{Page
1620 breaking}. Then you must tell the function where you would like to allow
1623 There are two ways to achieve the second step. First, you can specify each
1624 potential page turn manually, by inserting @code{\allowPageTurn} into your
1625 input file at the appropriate places.
1627 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1628 Voice context. The @code{Page_turn_engraver} will scan the context for
1629 sections without notes (note that it does not scan for rests; it scans for
1630 the absence of notes. This is so that single-staff polyphony with rests in one
1631 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1632 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1633 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1634 there is a @q{special} bar line (such as a double bar), in which case the
1635 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1638 @funindex minimumPageTurnLength
1639 The @code{Page_turn_engraver} reads the context property
1640 @code{minimumPageTurnLength} to determine how long a note-free section must
1641 be before a page turn is considered. The default value for
1642 @code{minimumPageTurnLength} is @code{(ly:make-moment 1/1)}. If you want
1643 to disable page turns, you can set it to something very large.
1646 \new Staff \with @{ \consists "Page_turn_engraver" @}
1649 R1 | % a page turn will be allowed here
1651 \set Staff.minimumPageTurnLength = #(ly:make-moment 5/2)
1652 R1 | % a page turn will not be allowed here
1654 R1*2 | % a page turn will be allowed here
1659 @funindex minimumRepeatLengthForPageTurn
1660 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1661 turn during the repeat if there is enough time at the beginning and end of the
1662 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1663 page turns if the repeat is very short. If you set the context property
1664 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1665 only allow turns in repeats whose duration is longer than this value.
1667 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1668 @code{\allowPageTurn}, may also be used at top-level, between scores and
1674 @funindex \noPageTurn
1676 @funindex \allowPageTurn
1677 @code{\allowPageTurn}.
1682 @ref{paper variables for line breaking,,@code{@bs{}paper} variables for line breaking}.
1688 There should only be one @code{Page_turn_engraver} in a score. If there is more
1689 than one, they will interfere with each other.
1692 @node Minimal page breaking
1693 @subsection Minimal page breaking
1695 @funindex ly:minimal-breaking
1697 The @code{ly:minimal-breaking} function performs minimal computations to
1698 calculate the page breaking: it fills a page with as many systems as
1699 possible before moving to the next one. Thus, it may be preferred for
1700 scores with many pages, where the other page breaking functions could be
1701 too slow or memory demanding, or a lot of texts. It is enabled using:
1705 page-breaking = #ly:minimal-breaking
1713 @node One-line page breaking
1714 @subsection One-line page breaking
1716 @funindex ly:one-line-breaking
1718 The @code{ly:one-line-breaking} function is a special-purpose
1719 page breaking algorithm that puts each score on its own page,
1720 and on a single line. This page breaking function does not
1721 typeset titles or margins; only the score will be displayed.
1723 The page width will be adjusted so that
1724 the longest score fits on one line. In particular,
1725 @code{paper-width}, @code{line-width} and @code{indent}
1726 variables in the @code{\paper} block will be ignored, although
1727 @code{left-margin} and @code{right-margin} will
1728 still be honored. The height of the page will
1731 @node Explicit breaks
1732 @subsection Explicit breaks
1734 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1735 commands. There are two commands to override this behavior:
1738 \override NonMusicalPaperColumn.line-break-permission = ##f
1739 \override NonMusicalPaperColumn.page-break-permission = ##f
1742 When @code{line-break-permission} is overridden to false, Lily will insert
1743 line breaks at explicit @code{\break} commands and nowhere else. When
1744 @code{page-break-permission} is overridden to false, Lily will insert
1745 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1747 @lilypond[quote,verbatim]
1754 music = \relative c'' { c8 c c c }
1758 \repeat unfold 2 { \music } \break
1759 \repeat unfold 4 { \music } \break
1760 \repeat unfold 6 { \music } \break
1761 \repeat unfold 8 { \music } \pageBreak
1762 \repeat unfold 8 { \music } \break
1763 \repeat unfold 6 { \music } \break
1764 \repeat unfold 4 { \music } \break
1765 \repeat unfold 2 { \music }
1770 \override NonMusicalPaperColumn.line-break-permission = ##f
1771 \override NonMusicalPaperColumn.page-break-permission = ##f
1782 @node Using an extra voice for breaks
1783 @subsection Using an extra voice for breaks
1785 Line- and page-breaking information usually appears within note entry directly.
1788 music = \relative c'' @{ c4 c c c @}
1792 \repeat unfold 2 @{ \music @} \break
1793 \repeat unfold 3 @{ \music @}
1798 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1799 music entry with information that specifies how music should lay out
1800 on the page. You can keep music entry and line- and page-breaking
1801 information in two separate places by introducing an extra voice to
1802 contain the breaks. This extra voice
1803 contains only skips together with @code{\break}, @code{pageBreak} and other
1804 breaking layout information.
1806 @lilypond[quote,verbatim]
1807 music = \relative c'' { c4 c c c }
1809 \header { tagline = ##f }
1810 \paper { left-margin = 0\mm }
1821 \repeat unfold 2 { \music }
1822 \repeat unfold 3 { \music }
1823 \repeat unfold 6 { \music }
1824 \repeat unfold 5 { \music }
1831 This pattern becomes especially helpful when overriding
1832 @code{line-break-system-details} and the other useful but long properties of
1833 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1835 @lilypond[quote,verbatim]
1836 music = \relative c'' { c4 c c c }
1838 \header { tagline = ##f }
1839 \paper { left-margin = 0\mm }
1844 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1848 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1852 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1856 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1861 \repeat unfold 2 { \music }
1862 \repeat unfold 3 { \music }
1863 \repeat unfold 6 { \music }
1864 \repeat unfold 5 { \music }
1873 @ref{Vertical spacing}.
1879 @node Vertical spacing
1880 @section Vertical spacing
1882 @cindex vertical spacing
1883 @cindex spacing, vertical
1885 Vertical spacing is controlled by three things: the amount of
1886 space available (i.e., paper size and margins), the amount of
1887 space between systems, and the amount of space between
1888 staves inside a system.
1891 * Flexible vertical spacing within systems::
1892 * Explicit staff and system positioning::
1893 * Vertical collision avoidance::
1897 @node Flexible vertical spacing within systems
1898 @subsection Flexible vertical spacing within systems
1900 @cindex distance between staves
1901 @cindex staff distance
1902 @cindex space between staves
1903 @cindex space inside systems
1905 Three separate mechanisms control the flexible vertical spacing
1906 within systems, one for each of the following categories:
1911 @emph{ungrouped staves},
1914 @emph{grouped staves} (staves within a staff-group such as
1915 @code{ChoirStaff}, etc.), and
1918 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1923 @c TODO: Clarify this. This almost implies that non-staff lines
1924 @c have NO effect on the spacing between staves. -mp
1926 The height of each system is determined in two steps. First, all
1927 of the staves are spaced according to the amount of space
1928 available. Then, the non-staff lines are distributed between the
1931 Note that the spacing mechanisms discussed in this section only
1932 control the vertical spacing of staves and non-staff lines within
1933 individual systems. The vertical spacing between separate
1934 systems, scores, markups, and margins is controlled by
1935 @code{\paper} variables, which are discussed in
1936 @ref{Flexible vertical spacing paper variables,,Flexible vertical spacing @code{@bs{}paper} variables}.
1939 * Within-system spacing properties::
1940 * Spacing of ungrouped staves::
1941 * Spacing of grouped staves::
1942 * Spacing of non-staff lines::
1946 @node Within-system spacing properties
1947 @unnumberedsubsubsec Within-system spacing properties
1949 @funindex staff-affinity
1950 @funindex staffgroup-staff-spacing
1951 @funindex staff-staff-spacing
1952 @funindex nonstaff-unrelatedstaff-spacing
1953 @funindex nonstaff-relatedstaff-spacing
1954 @funindex nonstaff-nonstaff-spacing
1955 @funindex default-staff-staff-spacing
1956 @funindex minimum-Y-extent
1957 @funindex extra-offset
1958 @funindex self-alignment-X
1960 @funindex VerticalAxisGroup
1962 The within-system vertical spacing mechanisms are controlled by
1963 two sets of grob properties. The first set is associated with the
1964 @code{VerticalAxisGroup} grob, which is created by all staves and
1965 non-staff lines. The second set is associated with the
1966 @code{StaffGrouper} grob, which can be created by staff-groups,
1967 but only if explicitly called. These properties are described
1968 individually at the end of this section.
1970 The names of these properties (except for @code{staff-affinity})
1971 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1972 @code{@var{item1}} and @code{@var{item2}} are the items to be
1973 spaced. Note that @code{@var{item2}} is not necessarily below
1974 @code{@var{item1}}; for example,
1975 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1976 non-staff line if @code{staff-affinity} is @code{UP}.
1978 Each distance is measured between the @emph{reference points} of
1979 the two items. The reference point for a staff is the vertical
1980 center of its @code{StaffSymbol} (i.e. the middle line if
1981 @code{line-count} is odd; the middle space if @code{line-count} is
1982 even). The reference points for individual non-staff lines are
1983 given in the following table:
1985 @multitable {Non-staff line} {Reference point}
1986 @headitem Non-staff line @tab Reference point
1987 @item @code{ChordNames} @tab baseline
1988 @item @code{NoteNames} @tab baseline
1989 @item @code{Lyrics} @tab baseline
1990 @item @code{Dynamics} @tab mid-height of @q{m}
1991 @item @code{FiguredBass} @tab highest point
1992 @item @code{FretBoards} @tab top line
1995 In the following image, horizontal lines indicate the positions
1996 of these reference points:
1998 @lilypond[quote,noragged-right,line-width=110\mm]
1999 #(define zero-space '((padding . -inf.0) (basic-distance . 0)))
2001 alignToZero = \with {
2002 \override VerticalAxisGroup.nonstaff-relatedstaff-spacing = #zero-space
2003 \override VerticalAxisGroup.nonstaff-nonstaff-spacing = #zero-space
2004 \override VerticalAxisGroup.staff-affinity = #DOWN
2005 \remove Text_engraver % avoid having two
2006 \consists Text_engraver
2008 lowerCaseChords = \with {
2009 chordNameLowercaseMinor = ##t
2012 #(define-music-function
2013 (parser location context)
2015 #{ s1*0^\markup { \upright {\typewriter #context } } #})
2018 \context { \Dynamics \alignToZero }
2019 \context { \FiguredBass \alignToZero }
2020 \context { \Lyrics \alignToZero }
2021 \context { \NoteNames \alignToZero }
2022 \context { \ChordNames \alignToZero \lowerCaseChords }
2023 \context { \FretBoards \alignToZero }
2026 \override DynamicText.self-alignment-X = #-1
2027 \override FretBoard.X-offset = #1.75
2028 \override InstrumentName.minimum-Y-extent = #'(-1 . 2)
2034 %% These contexts have reference points at the baseline:
2035 %% ChordNames, NoteNames, and Lyrics
2037 \new ChordNames { \chords { \labelContext "ChordNames" g1:m } }
2038 \new NoteNames { s1 |\labelContext "NoteNames" g1 | }
2039 \new Lyrics { \lyrics { \skip 1*2 | \labelContext "Lyrics" ghijk1 | } }
2040 \new RhythmicStaff \with { instrumentName = #"baseline " } s1*3
2043 %% The reference point for Dynamics is the midline of 'm' in the font
2045 \new Dynamics { \labelContext "Dynamics" s1\mp s\fp }
2046 \new RhythmicStaff \with { instrumentName = #"mid-height " } s1*3
2049 %% The reference point for FiguredBass is its highest point
2051 \new FiguredBass { \labelContext "FiguredBass" \figuremode { <6 5>1 } }
2052 \new RhythmicStaff \with { instrumentName = #"highest point " } s1
2055 %% The reference point for FretBoards is the top line
2056 \include "predefined-guitar-fretboards.ly"
2058 \new FretBoards { \labelContext "FretBoards" \chordmode { e1 } }
2059 \new RhythmicStaff \with { instrumentName = #"top line " } s1
2063 Each of the vertical spacing grob properties (except
2064 @code{staff-affinity}) uses the same alist structure as the
2065 @code{\paper} spacing variables discussed in
2066 @ref{Flexible vertical spacing paper variables,,Flexible vertical spacing @code{@bs{}paper} variables}.
2068 for modifying alists are discussed in @ref{Modifying alists}.
2069 Grob properties should be adjusted with an @code{\override} inside
2070 a @code{\score} or @code{\layout} block, and not inside a
2071 @code{\paper} block.
2073 The following example demonstrates the two ways these alists can
2074 be modified. The first declaration updates one key-value
2075 individually, and the second completely re-defines the property:
2079 \override VerticalAxisGroup.default-staff-staff-spacing.basic-distance = #10
2083 \override VerticalAxisGroup.default-staff-staff-spacing =
2084 #'((basic-distance . 10)
2085 (minimum-distance . 9)
2087 (stretchability . 10))
2091 To change any spacing settings globally, put them in the
2092 @code{\layout} block:
2098 \override VerticalAxisGroup.default-staff-staff-spacing.basic-distance = #10
2103 Standard settings for the vertical spacing grob properties are
2104 listed in @rinternals{VerticalAxisGroup} and
2105 @rinternals{StaffGrouper}. Default overrides for specific types
2106 of non-staff lines are listed in the relevant context descriptions
2107 in @rinternals{Contexts}.
2110 @subsubheading Properties of the @code{VerticalAxisGroup} grob
2112 @code{VerticalAxisGroup} properties are typically adjusted with an
2113 @code{\override} at the @code{Staff} level (or equivalent).
2116 @item staff-staff-spacing
2118 Used to determine the distance between the current staff and the
2119 staff just below it in the same system, even if one or more
2120 non-staff lines (such as @code{Lyrics}) are placed between the two
2121 staves. Does not apply to the bottom staff of a system.
2123 Initially, the @code{staff-staff-spacing} of a
2124 @code{VerticalAxisGroup} is a Scheme function that applies the
2125 properties of the @code{StaffGrouper} if the staff is part of a
2126 group, or the @code{default-staff-staff-spacing} of the staff
2127 otherwise. This allows staves to be spaced differently when they
2128 are grouped. For uniform spacing regardless of grouping, this
2129 function may be replaced by a flexible-spacing alist, using the
2130 complete-redefinition form of override shown above.
2132 @item default-staff-staff-spacing
2133 A flexible-spacing alist defining the @code{staff-staff-spacing} used for
2134 ungrouped staves, unless @code{staff-staff-spacing} has been explicitly
2135 set with an @code{\override}.
2137 @item staff-affinity
2138 The direction of the staff to use for spacing the current
2139 non-staff line. Choices are @code{UP}, @code{DOWN}, and
2140 @code{CENTER}. If @code{CENTER}, the non-staff line will be
2141 placed equidistant between the two nearest staves on either side,
2142 unless collisions or other spacing constraints prevent this.
2143 Adjacent non-staff lines should have non-increasing
2144 @code{staff-affinity} from top to bottom, e.g. a non-staff line
2145 set to @code{UP} should not immediately follow one that is set to
2146 @code{DOWN}. Non-staff lines at the top of a system should use
2147 @code{DOWN}; those at the bottom should use @code{UP}. Setting
2148 @code{staff-affinity} for a staff causes it to be treated as a
2149 non-staff line. Setting @code{staff-affinity} to @code{#f} causes
2150 a non-staff line to be treated as a staff. Setting
2151 @code{staff-affinity} to @code{UP}, @code{CENTER}, or @code{DOWN}
2152 causes a staff to be spaced as a non-staff line.
2154 @item nonstaff-relatedstaff-spacing
2155 The distance between the current non-staff line and the nearest
2156 staff in the direction of @code{staff-affinity}, if there are no
2157 non-staff lines between the two, and @code{staff-affinity} is
2158 either @code{UP} or @code{DOWN}. If @code{staff-affinity} is
2159 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
2160 for the nearest staves on @emph{both} sides, even if other
2161 non-staff lines appear between the current one and either of the
2162 staves. This means that the placement of a non-staff line depends
2163 on both the surrounding staves and the surrounding non-staff lines.
2164 Setting the @code{stretchability} of one of these types of spacing to
2165 a small value will make that spacing dominate. Setting the
2166 @code{stretchability} to a large value will make that spacing have
2169 @item nonstaff-nonstaff-spacing
2170 The distance between the current non-staff line and the next
2171 non-staff line in the direction of @code{staff-affinity}, if both
2172 are on the same side of the related staff, and
2173 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
2175 @item nonstaff-unrelatedstaff-spacing
2176 The distance between the current non-staff line and the staff in
2177 the opposite direction from @code{staff-affinity}, if there are no
2178 other non-staff lines between the two, and @code{staff-affinity}
2179 is either @code{UP} or @code{DOWN}. This can be used, for
2180 example, to require a minimum amount of padding between a
2181 @code{Lyrics} line and the staff to which it does not belong.
2185 @subsubheading Properties of the @code{StaffGrouper} grob
2187 @code{StaffGrouper} properties are typically adjusted with an
2188 @code{\override} at the @code{StaffGroup} level (or equivalent).
2191 @item staff-staff-spacing
2192 The distance between consecutive staves within the current
2193 staff-group. The @code{staff-staff-spacing} property of an
2194 individual staff's @code{VerticalAxisGroup} grob can be
2195 overriden with different spacing settings for that staff.
2197 @item staffgroup-staff-spacing
2198 The distance between the last staff of the current staff-group and
2199 the staff just below it in the same system, even if one or more
2200 non-staff lines (such as @code{Lyrics}) exist between the two
2201 staves. Does not apply to the bottom staff of a system. The
2202 @code{staff-staff-spacing} property of an individual staff's
2203 @code{VerticalAxisGroup} grob can be overriden with different
2204 spacing settings for that staff.
2209 @ref{Flexible vertical spacing paper variables,,Flexible vertical spacing @code{@bs{}paper} variables},
2210 @ref{Modifying alists}.
2213 @file{ly/engraver-init.ly},
2214 @file{scm/define-grobs.scm}.
2216 Internals Reference:
2217 @rinternals{Contexts},
2218 @rinternals{VerticalAxisGroup},
2219 @rinternals{StaffGrouper}.
2222 @node Spacing of ungrouped staves
2223 @unnumberedsubsubsec Spacing of ungrouped staves
2225 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
2226 @code{TabStaff}, etc.) are contexts that can contain one or more
2227 voice contexts, but cannot contain any other staves.
2229 The following properties affect the spacing of @emph{ungrouped}
2233 @item @code{VerticalAxisGroup} properties:
2235 @item @code{default-staff-staff-spacing}
2236 @item @code{staff-staff-spacing}
2240 These grob properties are described individually above; see
2241 @ref{Within-system spacing properties}.
2243 Additional properties are involved for staves that are part of a
2244 staff-group; see @ref{Spacing of grouped staves}.
2246 The following example shows how the @code{default-staff-staff-spacing}
2247 property can affect the spacing of ungrouped staves.
2248 The same overrides applied to @code{staff-staff-spacing} would
2249 have the same effect, but would also apply in cases where the staves
2250 are combined in a group or groups.
2252 @lilypond[verbatim,quote,staffsize=16]
2256 \override VerticalAxisGroup.default-staff-staff-spacing =
2257 #'((basic-distance . 8)
2258 (minimum-distance . 7)
2264 % The very low note here needs more room than 'basic-distance
2265 % can provide, so the distance between this staff and the next
2266 % is determined by 'padding.
2267 \new Staff { b,2 r | }
2269 % Here, 'basic-distance provides enough room, and there is no
2270 % need to compress the space (towards 'minimum-distance) to make
2271 % room for anything else on the page, so the distance between
2272 % this staff and the next is determined by 'basic-distance.
2273 \new Staff { \clef bass g2 r | }
2275 % By setting 'padding to a negative value, staves can be made to
2276 % collide. The lowest acceptable value for 'basic-distance is 0.
2278 \override VerticalAxisGroup.default-staff-staff-spacing =
2279 #'((basic-distance . 3.5)
2281 } { \clef bass g2 r | }
2282 \new Staff { \clef bass g2 r | }
2288 @file{scm/define-grobs.scm}.
2293 Internals Reference:
2294 @rinternals{VerticalAxisGroup}.
2297 @node Spacing of grouped staves
2298 @unnumberedsubsubsec Spacing of grouped staves
2300 In orchestral and other large scores, it is common to place staves
2301 in groups. The space between groups is typically larger than the
2302 space between staves of the same group.
2304 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2305 etc.) are contexts that can contain one or more staves
2308 The following properties affect the spacing of staves inside
2312 @item @code{VerticalAxisGroup} properties:
2314 @item @code{staff-staff-spacing}
2316 @item @code{StaffGrouper} properties:
2318 @item @code{staff-staff-spacing}
2319 @item @code{staffgroup-staff-spacing}
2323 These grob properties are described individually above; see
2324 @ref{Within-system spacing properties}.
2326 The following example shows how properties of the
2327 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2329 @lilypond[verbatim,quote,staffsize=16]
2333 \override StaffGrouper.staff-staff-spacing.padding = #0
2334 \override StaffGrouper.staff-staff-spacing.basic-distance = #1
2339 \new PianoStaff \with {
2340 \override StaffGrouper.staffgroup-staff-spacing.basic-distance = #20
2355 @file{scm/define-grobs.scm}.
2360 Internals Reference:
2361 @rinternals{VerticalAxisGroup},
2362 @rinternals{StaffGrouper}.
2365 @node Spacing of non-staff lines
2366 @unnumberedsubsubsec Spacing of non-staff lines
2368 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2369 etc.) are contexts whose layout objects are engraved like staves
2370 (i.e. in horizontal lines within systems). Specifically,
2371 non-staff lines are non-staff contexts that create the
2372 @code{VerticalAxisGroup} layout object.
2374 The following properties affect the spacing of non-staff lines:
2377 @item @code{VerticalAxisGroup} properties:
2379 @item @code{staff-affinity}
2380 @item @code{nonstaff-relatedstaff-spacing}
2381 @item @code{nonstaff-nonstaff-spacing}
2382 @item @code{nonstaff-unrelatedstaff-spacing}
2386 These grob properties are described individually above; see
2387 @ref{Within-system spacing properties}.
2389 The following example shows how the
2390 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2391 of consecutive non-staff lines. Here, by setting the
2392 @code{stretchability} key to a very high value, the lyrics are
2393 able to stretch much more than usual:
2395 @lilypond[verbatim,quote,staffsize=16]
2399 \override VerticalAxisGroup.nonstaff-nonstaff-spacing.stretchability = #1000
2406 \override VerticalAxisGroup.staff-staff-spacing = #'((basic-distance . 30))
2409 \override VerticalAxisGroup.staff-affinity = #UP
2412 \override VerticalAxisGroup.staff-affinity = #CENTER
2413 } \lyricmode { center }
2415 \override VerticalAxisGroup.staff-affinity = #DOWN
2416 } \lyricmode { down }
2423 @file{ly/engraver-init.ly},
2424 @file{scm/define-grobs.scm}.
2429 @c @lsr{spacing,page-spacing.ly},
2430 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2432 Internals Reference:
2433 @rinternals{Contexts},
2434 @rinternals{VerticalAxisGroup}.
2437 @node Explicit staff and system positioning
2438 @subsection Explicit staff and system positioning
2440 One way to understand the flexible vertical spacing mechanisms
2441 explained above is as a collection of settings that control the
2442 amount of vertical padding between staves and systems.
2444 It is possible to approach vertical spacing in a different way
2445 using @code{NonMusicalPaperColumn.line-break-system-details}.
2446 While the flexible vertical spacing mechanisms specify vertical
2447 padding, @code{NonMusicalPaperColumn.line-break-system-details}
2448 can specify exact vertical positions on the page.
2450 @code{NonMusicalPaperColumn.line-break-system-details} accepts
2451 an associative list of three different settings:
2454 @item @code{X-offset}
2455 @item @code{Y-offset}
2456 @item @code{alignment-distances}
2459 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2460 below, can occur in any of three different places in an input file:
2463 @item in the middle of note entry directly
2464 @item in a @code{\context} block
2465 @item in the @code{\with} block
2468 When we override @code{NonMusicalPaperColumn}, we use the usual
2469 @code{\override} command in @code{\context} blocks and in the
2470 @code{\with} block. On the other hand, when we override
2471 @code{NonMusicalPaperColumn} in the middle of note entry,
2472 use the special @code{\overrideProperty} command. Here are some
2473 example @code{NonMusicalPaperColumn} overrides with the special
2474 @code{\overrideProperty} command:
2477 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2480 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2483 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2487 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2488 #'((alignment-distances . (15)))
2490 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2493 (alignment-distances . (15)))
2496 To understand how each of these different settings work, we begin
2497 by looking at an example that includes no overrides at all.
2499 @c \book { } is required in these examples to ensure the spacing
2500 @c overrides can be seen between systems. -np
2502 @lilypond[verbatim,quote,staffsize=16]
2503 \header { tagline = ##f }
2504 \paper { left-margin = 0\mm }
2514 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2517 \repeat unfold 15 { d'4 d' d' d' }
2524 This score isolates line- and page-breaking information in a dedicated
2525 voice. This technique of creating a breaks voice will help keep layout
2526 separate from music entry as our example becomes more complicated.
2527 See @ref{Using an extra voice for breaks}.
2529 Explicit @code{\breaks} evenly divide the music into six measures per
2530 line. Vertical spacing results from LilyPond's defaults. To set
2531 the vertical startpoint of each system explicitly, we can set
2532 the @code{Y-offset} pair in the @code{line-break-system-details}
2533 attribute of the @code{NonMusicalPaperColumn} grob:
2535 @lilypond[verbatim,quote,staffsize=16]
2536 \header { tagline = ##f }
2537 \paper { left-margin = 0\mm }
2543 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2546 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2549 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2553 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2556 \repeat unfold 15 { d'4 d' d' d' }
2563 Note that @code{line-break-system-details} takes an associative list of
2564 potentially many values, but that we set only one value here. Note,
2565 too, that the @code{Y-offset} property here determines the exact vertical
2566 position on the page at which each new system will render.
2568 Now that we have set the vertical startpoint of each system
2569 explicitly, we can also set the vertical distances between staves
2570 within each system manually. We do this using the @code{alignment-distances}
2571 subproperty of @code{line-break-system-details}.
2573 @lilypond[verbatim,quote,staffsize=16]
2574 \header { tagline = ##f }
2575 \paper { left-margin = 0\mm }
2581 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2583 (alignment-distances . (10)))
2585 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2587 (alignment-distances . (15)))
2589 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2591 (alignment-distances . (20)))
2594 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2597 \repeat unfold 15 { d'4 d' d' d' }
2604 Note that here we assign two different values to the
2605 @code{line-break-system-details} attribute of the
2606 @code{NonMusicalPaperColumn} grob. Though the
2607 @code{line-break-system-details} attribute alist accepts many
2608 additional spacing parameters (including, for example, a corresponding
2609 @code{X-offset} pair), we need only set the @code{Y-offset} and
2610 @code{alignment-distances} pairs to control the vertical startpoint of
2611 every system and every staff. Finally, note that @code{alignment-distances}
2612 specifies the vertical positioning of staves but not of staff groups.
2614 @lilypond[verbatim,quote,staffsize=16]
2615 \header { tagline = ##f }
2616 \paper { left-margin = 0\mm }
2622 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2624 (alignment-distances . (30 10)))
2626 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2628 (alignment-distances . (10 10)))
2630 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2632 (alignment-distances . (10 30)))
2635 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2638 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2639 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2646 Some points to consider:
2649 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2650 do not count as a staff.
2652 @item The units of the numbers passed to @code{X-offset},
2653 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2654 of the distance between adjacent staff lines. Positive values move staves
2655 and lyrics up, negative values move staves and lyrics down.
2657 @item Because the @code{NonMusicalPaperColumn.line-break-system-details}
2658 settings given here allow the positioning of staves and systems anywhere
2659 on the page, it is possible to violate paper or margin boundaries or even
2660 to print staves or systems on top of one another. Reasonable values
2661 passed to these different settings will avoid this.
2669 @node Vertical collision avoidance
2670 @subsection Vertical collision avoidance
2672 @funindex outside-staff-priority
2673 @funindex outside-staff-padding
2674 @funindex outside-staff-horizontal-padding
2676 Intuitively, there are some objects in musical notation that belong
2677 to the staff and there are other objects that should be placed outside
2678 the staff. Objects belonging outside the staff include things such as
2679 rehearsal marks, text and dynamic markings (from now on, these will
2680 be called outside-staff objects). LilyPond's rule for the
2681 vertical placement of outside-staff objects is to place them as close
2682 to the staff as possible but not so close that they collide with
2685 LilyPond uses the @code{outside-staff-priority} property to determine
2686 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2687 is a number, the grob is an outside-staff object. In addition,
2688 @code{outside-staff-priority} tells LilyPond in which order the objects
2691 First, LilyPond places all the objects that do not belong outside
2692 the staff. Then it sorts the outside-staff objects according to their
2693 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
2694 takes the outside-staff objects and places them so that they do
2695 not collide with any objects that have already been placed. That
2696 is, if two outside-staff grobs are competing for the same space, the one
2697 with the lower @code{outside-staff-priority} will be placed closer to
2700 @lilypond[quote,ragged-right,relative=2,verbatim]
2703 \once \override TextScript.outside-staff-priority = #1
2704 c4_"Text"\pp % this time the text will be closer to the staff
2706 % by setting outside-staff-priority to a non-number,
2707 % we disable the automatic collision avoidance
2708 \once \override TextScript.outside-staff-priority = ##f
2709 \once \override DynamicLineSpanner.outside-staff-priority = ##f
2710 c4_"Text"\pp % now they will collide
2713 The vertical padding around outside-staff objects
2714 can be controlled with @code{outside-staff-padding}.
2716 @lilypond[quote,ragged-right,relative=2,verbatim,staffsize=18]
2717 \once \override TextScript.outside-staff-padding = #0
2718 a4-"outside-staff-padding = #0"
2719 \once \override TextScript.outside-staff-padding = #3
2720 d-"outside-staff-padding = #3"
2721 c-"default outside-staff-padding"
2722 b-"default outside-staff-padding"
2727 By default, outside-staff objects are placed so they avoid
2728 a horizontal collision with previously-positioned grobs. This
2729 can lead to situations in which objects are placed close to each
2731 As shown in the example below, setting @code{outside-staff-horizontal-padding}
2732 increases the horizontal spacing required, and in this case moves the text up
2733 to prevent it from getting too close to the ledger lines.
2735 @lilypond[quote,ragged-right,relative=2,verbatim]
2738 \once \override TextScript.outside-staff-horizontal-padding = #1
2747 @node Horizontal spacing
2748 @section Horizontal spacing
2750 @cindex horizontal spacing
2751 @cindex spacing, horizontal
2754 * Horizontal spacing overview::
2755 * New spacing area::
2756 * Changing horizontal spacing::
2758 * Proportional notation::
2762 @node Horizontal spacing overview
2763 @subsection Horizontal spacing overview
2765 The spacing engine translates differences in durations into stretchable
2766 distances (@q{springs}) of differing lengths. Longer durations get
2767 more space, shorter durations get less. The shortest durations get a
2768 fixed amount of space (which is controlled by
2769 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2770 object). The longer the duration, the more space it gets: doubling a
2771 duration adds a fixed amount (this amount is controlled by
2772 @code{spacing-increment}) of space to the note.
2774 For example, the following piece contains lots of half, quarter, and
2775 8th notes; the eighth note is followed by 1 note head width (NHW).
2776 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2778 @lilypond[quote,verbatim,relative=1]
2784 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2785 approximately the width of a note head, and
2786 @code{shortest-duration-space} is set to 2.0, meaning that the
2787 shortest note gets 2.4 staff space (2.0 times the
2788 @code{spacing-increment}) of horizontal space. This space is counted
2789 from the left edge of the symbol, so the shortest notes are generally
2790 followed by one NHW of space.
2792 If one would follow the above procedure exactly, then adding a single
2793 32nd note to a score that uses 8th and 16th notes, would widen up the
2794 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2795 thus adding 1 NHW to every note. To prevent this, the shortest
2796 duration for spacing is not the shortest note in the score, but rather
2797 the one which occurs most frequently.
2800 The most common shortest duration is determined as follows: in every
2801 measure, the shortest duration is determined. The most common shortest
2802 duration is taken as the basis for the spacing, with the stipulation
2803 that this shortest duration should always be equal to or shorter than
2804 an 8th note. The shortest duration is printed when you run
2805 @code{lilypond} with the @option{--verbose} option.
2807 These durations may also be customized. If you set the
2808 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2809 this sets the base duration for spacing. The maximum duration for this
2810 base (normally an 8th), is set through @code{base-shortest-duration}.
2812 @funindex common-shortest-duration
2813 @funindex base-shortest-duration
2814 @funindex stem-spacing-correction
2817 Notes that are even shorter than the common shortest note are
2818 followed by a space that is proportional to their duration relative to
2819 the common shortest note. So if we were to add only a few 16th notes
2820 to the example above, they would be followed by half a NHW:
2822 @lilypond[quote,verbatim,relative=2]
2823 c2 c4. c8 | c4. c16[ c] c4. c8 | c8 c c4 c c
2827 In the @emph{Essay on automated music engraving}, it was explained
2828 that stem directions influence spacing (see
2829 @ressay{Optical spacing}). This is controlled with the
2830 @code{stem-spacing-correction} property in the
2831 @rinternals{NoteSpacing}, object. These are generated for every
2832 @rinternals{Voice} context. The @code{StaffSpacing} object
2833 (generated in @rinternals{Staff} context) contains the same
2834 property for controlling the stem/bar line spacing. The following
2835 example shows these corrections, once with default settings, and
2836 once with exaggerated corrections:
2838 @lilypond[quote,ragged-right]
2842 \override Staff.NoteSpacing.stem-spacing-correction = #1.5
2843 \override Staff.StaffSpacing.stem-spacing-correction = #1.5
2849 Proportional notation is supported; see @ref{Proportional notation}.
2852 Essay on automated music engraving:
2853 @ressay{Optical spacing}.
2858 Internals Reference:
2859 @rinternals{SpacingSpanner},
2860 @rinternals{NoteSpacing},
2861 @rinternals{StaffSpacing},
2862 @rinternals{NonMusicalPaperColumn}.
2865 There is no convenient mechanism to manually override spacing. The
2866 following work-around may be used to insert extra space into a score,
2867 adjusting the padding value as necessary.
2870 \override Score.NonMusicalPaperColumn.padding = #10
2873 No work-around exists for decreasing the amount of space.
2876 @node New spacing area
2877 @subsection New spacing area
2879 @funindex \newSpacingSection
2880 @cindex new spacing area
2881 @cindex spacing area, new
2882 @cindex notes, spacing horizontally
2884 New sections with different spacing parameters can be started with
2885 @code{newSpacingSection}. This is useful when there are
2886 sections with a different notions of long and short notes.
2888 In the following example, the time signature change introduces a new
2889 section, and hence the 16ths notes are automatically spaced slightly
2892 @lilypond[relative=1,verbatim,quote]
2895 c8 c c4 c16[ c c8] c4
2901 The @code{\newSpacingSection} command creates a new
2902 @code{SpacingSpanner} object at that musical moment.
2903 If the automatic spacing adjustments do not give the required spacing,
2904 manual @code{\override}s may be applied to its properties. These must
2905 be applied at the same musical moment as the @code{\newSpacingSection}
2906 command itself. They will then affect the spacing of all the following
2907 music until the properties are changed in a new spacing section, for
2910 @lilypond[relative=1,verbatim,quote]
2914 \override Score.SpacingSpanner.spacing-increment = #2
2917 \revert Score.SpacingSpanner.spacing-increment
2926 Internals Reference:
2927 @rinternals{SpacingSpanner}.
2930 @node Changing horizontal spacing
2931 @subsection Changing horizontal spacing
2933 Horizontal spacing may be altered with the
2934 @code{base-shortest-duration} property. Here
2935 we compare the same music; once without altering
2936 the property, and then altered. Larger values
2937 of @code{ly:make-moment} will produce smaller
2938 music. Note that @code{ly:make-moment} constructs
2939 a duration, so @code{1 4} is a longer duration
2942 @lilypond[verbatim,line-width=12\cm]
2945 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2946 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2947 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2948 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2953 @lilypond[verbatim,line-width=12\cm]
2956 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2957 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2958 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2959 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2964 \override SpacingSpanner.base-shortest-duration = #(ly:make-moment 1/16)
2973 By default, spacing in tuplets depends on various non-duration
2974 factors (such as accidentals, clef changes, etc). To disregard
2975 such symbols and force uniform equal-duration spacing, use
2976 @code{Score.SpacingSpanner.uniform-stretching}. This
2977 property can only be changed at the beginning of a score,
2979 @lilypond[quote,ragged-right,verbatim]
2983 \tuplet 5/4 { c8 c c c c } c8 c c c
2986 c8 c c c \tuplet 5/4 { c8 c c c c }
2992 \override SpacingSpanner.uniform-stretching = ##t
2998 When @code{strict-note-spacing} is set, notes are spaced without
2999 regard for clefs, bar lines, and grace notes,
3001 @lilypond[quote,ragged-right,relative=2,verbatim]
3002 \override Score.SpacingSpanner.strict-note-spacing = ##t
3003 \new Staff { c8[ c \clef alto c \grace { c16 c } c8 c c] c32[ c] }
3012 @subsection Line length
3015 @cindex breaking pages
3018 @funindex line-width
3019 @funindex ragged-right
3020 @funindex ragged-last
3022 @c Although line-width can be set in \layout, it should be set in paper
3023 @c block, to get page layout right.
3024 @c Setting indent in \paper block makes not much sense, but it works.
3026 @c Bit verbose and vague, use examples?
3027 The most basic settings influencing the spacing are @code{indent} and
3028 @code{line-width}. They are set in the @code{\layout} block. They
3029 control the indentation of the first line of music, and the lengths of
3032 If @code{ragged-right} is set to true in the @code{\layout} block, then
3033 systems ends at their natural horizontal length, instead of being spread
3034 horizontally to fill the whole line. This is useful for
3035 short fragments, and for checking how tight the natural spacing is.
3036 The normal default setting is false, but if the score has only one
3037 system the default value is true.
3040 @cindex vertical spacing
3042 The option @code{ragged-last} is similar to @code{ragged-right}, but
3043 only affects the last line of the piece. No restrictions are put on
3044 that line. The result is similar to formatting text paragraphs. In a
3045 paragraph, the last line simply takes its natural horizontal length.
3046 @c Note that for text there are several options for the last line.
3047 @c While Knuth TeX uses natural length, lead typesetters use the same
3048 @c stretch as the previous line. eTeX uses \lastlinefit to
3049 @c interpolate between both these solutions.
3064 @node Proportional notation
3065 @subsection Proportional notation
3067 LilyPond supports proportional notation, a type of horizontal spacing
3068 in which each note consumes an amount of horizontal space exactly
3069 equivalent to its rhythmic duration. This type of proportional spacing
3070 is comparable to horizontal spacing on top of graph paper. Some late
3071 20th- and early 21st-century scores use proportional notation to
3072 clarify complex rhythmic relationships or to facilitate the placement
3073 of timelines or other graphics directly in the score.
3075 LilyPond supports five different settings for proportional notation,
3076 which may be used together or alone:
3079 @item @code{proportionalNotationDuration}
3080 @item @code{uniform-stretching}
3081 @item @code{strict-note-spacing}
3082 @item @code{\remove "Separating_line_group_engraver"}
3083 @item @code{\override PaperColumn.used = ##t}
3086 In the examples that follow, we explore these five different
3087 proportional notation settings and examine how these settings interact.
3089 We start with the following one-measure example, which uses classical
3090 spacing with ragged-right turned on.
3092 @c The initial pitch is not necessary as long as RhythmicStaff is
3093 @c not preceded by other material in the score, but we don't want
3095 @lilypond[quote,verbatim,ragged-right]
3098 \new RhythmicStaff {
3099 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3105 Notice that the half note which begins the measure takes up far less
3106 than half of the horizontal space of the measure. Likewise, the
3107 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
3108 which end the measure together take up far more than half the
3109 horizontal space of the measure.
3111 In classical engraving, this spacing may be exactly what we want
3112 because we can borrow horizontal space from the half note and conserve
3113 horizontal space across the measure as a whole.
3115 On the other hand, if we want to insert a measured timeline or other
3116 graphic above or below our score, we need proportional notation. We
3117 turn proportional notation on with the proportionalNotationDuration
3120 @lilypond[quote,verbatim,ragged-right]
3123 \new RhythmicStaff {
3124 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3130 proportionalNotationDuration = #(ly:make-moment 1/20)
3136 The half note at the beginning of the measure and the faster notes in
3137 the second half of the measure now occupy equal amounts of horizontal
3138 space. We could place a measured timeline or graphic above or below
3141 The @code{proportionalNotationDuration} setting is a context setting
3142 that lives in @code{Score}. Remember that context settings can appear
3143 in one of three locations within our input file -- in a @code{\with}
3144 block, in a @code{\context} block, or directly in music entry preceded
3145 by the @code{\set} command. As with all context settings, users can
3146 pick which of the three different locations they would like to
3147 set @code{proportionalNotationDuration} in to.
3149 The @code{proportionalNotationDuration} setting takes a single argument,
3150 which is the reference duration against that all music will be spaced.
3151 The LilyPond Scheme function @code{make-moment} takes two arguments
3152 -- a numerator and denominator which together express some fraction of
3153 a whole note. The call @code{(ly:make-moment 1/20)} therefore produces
3154 a reference duration of a twentieth note. Values such as
3155 @code{(ly:make-moment 1/16)}, @code{(ly:make-moment 1/8)}, and
3156 @code{(ly:make-moment 3/97)} are all possible as well.
3158 How do we select the right reference duration to pass to
3159 @code{proportionalNotationDuration}? Usually by a process of trial
3160 and error, beginning with a duration close to the fastest (or smallest)
3161 duration in the piece. Smaller reference durations space music loosely;
3162 larger reference durations space music tightly.
3164 @lilypond[quote,verbatim,ragged-right]
3167 \new RhythmicStaff {
3168 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3174 proportionalNotationDuration = #(ly:make-moment 1/8)
3181 \new RhythmicStaff {
3182 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3188 proportionalNotationDuration = #(ly:make-moment 1/16)
3195 \new RhythmicStaff {
3196 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3202 proportionalNotationDuration = #(ly:make-moment 1/32)
3208 Note that too large a reference duration -- such as the eighth note,
3209 above -- spaces music too tightly and can cause note head collisions.
3210 Also that proportional notation in general takes up more horizontal
3211 space than classical spacing. Proportional spacing provides rhythmic
3212 clarity at the expense of horizontal space.
3214 Next we examine how to optimally space overlapping tuplets.
3216 We start by examining what happens to our original example, with
3217 classical spacing, when we add a second staff with a different type of
3220 @lilypond[quote,verbatim,ragged-right]
3223 \new RhythmicStaff {
3224 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3226 \new RhythmicStaff {
3227 \tuplet 9/8 { c8 8 8 8 8 8 8 8 8 }
3233 The spacing is bad because the evenly spaced notes of the bottom staff
3234 do not stretch uniformly. Classical engravings include very few complex
3235 triplets and so classical engraving rules can generate this type of
3236 result. Setting @code{proportionalNotationDuration} fixes this.
3238 @lilypond[quote,verbatim,ragged-right]
3241 \new RhythmicStaff {
3242 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3244 \new RhythmicStaff {
3245 \tuplet 9/8 { c8 8 8 8 8 8 8 8 8 }
3251 proportionalNotationDuration = #(ly:make-moment 1/20)
3257 But if we look very carefully we can see that notes of the second half
3258 of the 9-tuplet space ever so slightly more widely than the notes
3259 of the first half of the 9-tuplet. To ensure uniform stretching, we
3260 turn on @code{uniform-stretching}, which is a property of
3261 @code{SpacingSpanner}.
3263 @lilypond[quote,verbatim,ragged-right]
3266 \new RhythmicStaff {
3267 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3269 \new RhythmicStaff {
3270 \tuplet 9/8 { c8 8 8 8 8 8 8 8 8 }
3276 proportionalNotationDuration = #(ly:make-moment 1/20)
3277 \override SpacingSpanner.uniform-stretching = ##t
3283 Our two-staff example now spaces exactly, our rhythmic
3284 relationships are visually clear, and we can include a measured
3285 timeline or graphic if we want.
3287 Note that the LilyPond's proportional notation package expects
3288 that all proportional scores set the SpacingSpanner's
3289 'uniform-stretching attribute to ##t. Setting
3290 proportionalNotationDuration without also setting the
3291 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3292 example, cause Skips to consume an incorrect amount of horizontal
3295 The SpacingSpanner is an abstract grob that lives in the Score
3296 context. As with our settings of proportionalNotationDuration,
3297 overrides to the SpacingSpanner can occur in any of three
3298 different places in our input file – in the Score \with block, in
3299 a Score \context block, or in note entry directly.
3301 There is by default only one @code{SpacingSpanner} per @code{Score}. This
3302 means that, by default, @code{uniform-stretching} is either turned on for the
3303 entire score or turned off for the entire score. We can, however,
3304 override this behavior and turn on different spacing features at
3305 different places in the score. We do this with the command
3306 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
3308 Next we examine the effects of the @code{Separating_line_group_engraver} and
3309 see why proportional scores frequently remove this engraver. The following
3310 example shows that there is a small amount of @qq{prefatory} space
3311 just before the first note in each system.
3313 @lilypond[quote,verbatim,ragged-right]
3326 The amount of this prefatory space is the same whether after a time
3327 signature, a key signature or a clef. @code{Separating_line_group_engraver}
3328 is responsible for this space. Removing @code{Separating_line_group_engraver}
3329 reduces this space to zero.
3331 @lilypond[quote,verbatim,ragged-right]
3337 \remove "Separating_line_group_engraver"
3345 non-musical elements like time signatures, key signatures, clefs and
3346 accidentals are problematic in proportional notation. None of these
3347 elements has rhythmic duration. But all of these elements consume
3348 horizontal space. Different proportional scores approach these
3349 problems differently.
3351 It may be possible to avoid spacing problems with key signatures
3352 simply by not having any. This is a valid option since most
3353 proportional scores are contemporary music. The same may be true
3354 of time signatures, especially for those scores
3355 that include a measured timeline or other graphic. But these scores
3356 are exceptional and most proportional scores include at least some
3357 time signatures. Clefs and accidentals are even more essential.
3359 So what strategies exist for spacing non-musical elements in a
3360 proportional context? One good option is the @code{strict-note-spacing}
3361 property of @code{SpacingSpanner}. Compare the two scores below:
3363 @lilypond[quote,verbatim,ragged-right]
3365 \set Score.proportionalNotationDuration = #(ly:make-moment 1/16)
3366 c''8 8 8 \clef alto d'2 2
3370 \set Score.proportionalNotationDuration = #(ly:make-moment 1/16)
3371 \override Score.SpacingSpanner.strict-note-spacing = ##t
3372 c''8 8 8 \clef alto d'2 2
3376 Both scores are proportional, but the spacing in the first score
3377 is too loose because of the clef change. The spacing of the second
3378 score remains strict, however, because strict-note-spacing is
3379 turned on. Turning on strict-note-spacing causes the width of
3380 time signatures, key signatures, clefs and accidentals to play no
3381 part in the spacing algorithm.
3383 In addition to the settings given here, there are other settings
3384 that frequently appear in proportional scores. These include:
3387 @item @code{\override SpacingSpanner.strict-grace-spacing = ##t}
3388 @item @code{\set tupletFullLength = ##t}
3389 @item @code{\override Beam.breakable = ##t}
3390 @item @code{\override Glissando.breakable = ##t}
3391 @item @code{\override TextSpanner.breakable = ##t}
3392 @item @code{\remove "Forbid_line_break_engraver" in the Voice context}
3395 These settings space grace notes strictly, extend tuplet brackets to
3396 mark both rhythmic start- and stop-points, and allow spanning elements
3397 to break across systems and pages. See the respective parts of the manual
3398 for these related settings.
3402 @ref{New spacing area}.
3408 @node Fitting music onto fewer pages
3409 @section Fitting music onto fewer pages
3411 Sometimes you can end up with one or two staves on a second
3412 (or third, or fourth@dots{}) page. This is annoying, especially
3413 if you look at previous pages and it looks like there is plenty
3414 of room left on those.
3416 When investigating layout issues, @code{annotate-spacing} is an
3417 invaluable tool. This command prints the values of various layout
3418 spacing variables; for more details see the following section,
3419 @ref{Displaying spacing}.
3422 * Displaying spacing::
3423 * Changing spacing::
3427 @node Displaying spacing
3428 @subsection Displaying spacing
3430 @funindex annotate-spacing
3431 @cindex spacing, display of layout
3433 To graphically display the dimensions of vertical layout variables
3434 that may be altered for page formatting, set
3435 @code{annotate-spacing} in the @code{\paper} block:
3437 @lilypond[verbatim,quote,papersize=a6landscape]
3440 \paper { annotate-spacing = ##t }
3446 All layout dimensions are displayed in staff-spaces, regardless
3447 of the units specified in the @code{\paper} or @code{\layout} block.
3448 In the above example, @code{paper-height} has a value of 59.75
3449 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3450 default value). Note that:
3452 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3455 @tab = (25.4/72.27) mm
3458 @tab = (@code{staff-size})/4 pts
3460 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3465 In this case, one @code{staff-space} is approximately equal to
3466 1.757mm. Thus the @code{paper-height} measurement of 59.75
3467 @code{staff-spaces} is equivalent to 105 millimeters, the height
3468 of @code{a6} paper in landscape orientation. The pairs
3469 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3470 edge and @var{b} the upper edge of the interval.
3474 @ref{Setting the staff size}.
3480 @node Changing spacing
3481 @subsection Changing spacing
3483 The output of @code{annotate-spacing} reveals vertical dimensions
3484 in great detail. For details about modifying margins and other
3485 layout variables, see @ref{Page layout}.
3487 Other than margins, there are a few other options to save space:
3491 Force systems to move as close together as possible (to fit as
3492 many systems as possible onto a page) while being spaced so that
3493 there is no blank space at the bottom of the page.
3497 system-system-spacing = #'((basic-distance . 0.1) (padding . 0))
3498 ragged-last-bottom = ##f
3504 Force the number of systems. This can help in two ways. Just
3505 setting a value, even the same value as the number of systems
3506 being typeset by default, will sometimes cause more systems to
3507 be fitted onto each page, as an estimation step is then bypassed,
3508 giving a more accurate fit to each page. Also, forcing an actual
3509 reduction in the number of systems may save a further page. For
3510 example, if the default layout has 11 systems, the following
3511 assignment will force a layout with 10 systems.
3520 Force the number of pages. For example, the following
3521 assignment will force a layout with 2 pages.
3530 Avoid (or reduce) objects that increase the vertical size of a
3531 system. For example, volta repeats (or alternate repeats) require
3532 extra space. If these repeats are spread over two systems, they
3533 will take up more space than one system with the volta repeats and
3534 another system without. For example, dynamics that @q{stick out} of
3535 a system can be moved closer to the staff:
3537 @lilypond[verbatim,quote,relative=1]
3539 e4 c g-\tweak X-offset #-2.7 \f c
3543 Alter the horizontal spacing via @code{SpacingSpanner}. For more
3544 details, see @ref{Changing horizontal spacing}. The following
3545 example illustrates the default spacing:
3547 @lilypond[verbatim,quote]
3560 The next example modifies @code{common-shortest-duration} from a
3561 value of @code{1/4} to @code{1/2}. The quarter note is the most
3562 common and shortest duration in this example, so by making this
3563 duration longer, a @q{squeezing} effect occurs:
3565 @lilypond[verbatim,quote]
3577 \override SpacingSpanner.common-shortest-duration =
3578 #(ly:make-moment 1/2)
3585 The @code{common-shortest-duration} property cannot be modified
3586 dynamically, so it must always be placed in a @code{\context}
3587 block so that it applies to the whole score.
3594 @ref{Changing horizontal spacing}.