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.
25 http://code.google.com/p/lilypond/issues/detail?id=68
31 @chapter Spacing issues
33 The global paper layout is determined by three factors: the page layout, the
34 line breaks, and the spacing. These all influence each other. The
35 choice of spacing determines how densely each system of music is set.
36 This influences where line breaks are chosen, and thus ultimately, how
37 many pages a piece of music takes.
39 Globally speaking, this procedure happens in four steps: first,
40 flexible distances (@q{springs}) are chosen, based on durations. All
41 possible line breaking combinations are tried, and a @q{badness} score
42 is calculated for each. Then the height of each possible system is
43 estimated. Finally, a page breaking and line breaking combination is chosen
44 so that neither the horizontal nor the vertical spacing is too cramped
47 Two types of blocks can contain layout settings:
48 @code{\paper @{@dots{}@}} and @code{\layout @{@dots{}@}}. The
49 @code{\paper} block contains page layout settings that are expected
50 to be the same for all scores in a book or bookpart, such as the
51 paper height, or whether to print page numbers, etc. See
52 @ref{Page layout}. The @code{\layout} block contains score layout
53 settings, such as the number of systems to use, or the space
54 between staff-groups, etc. See @ref{Score layout}.
61 * Horizontal spacing::
62 * Fitting music onto fewer pages::
69 This section discusses page layout options for the @code{\paper}
74 * Paper size and automatic scaling::
75 * Fixed vertical spacing paper variables::
76 * Flexible vertical spacing paper variables::
77 * Horizontal spacing paper variables::
78 * Other paper variables::
83 @subsection The @code{@bs{}paper} block
85 @code{\paper} blocks may be placed in three different places to form
86 a descending hierarchy of @code{\paper} blocks:
91 At the top of the input file, before all @code{\book},
92 @code{\bookpart}, and @code{\score} blocks.
95 Within a @code{\book} block but outside all the @code{\bookpart} and
96 @code{\score} blocks within that book.
99 Within a @code{\bookpart} block but outside all @code{\score} blocks
100 within that bookpart.
104 A @code{\paper} block cannot be placed within a @code{\score} block.
106 The values of the fields filter down this hierarchy, with the values
107 set higher in the hierarchy persisting unless they are over-ridden
108 by a value set lower in the hierarchy.
110 Several @code{\paper} blocks can appear at each of the levels, for
111 example as parts of several @code{\include}d files. If so, the
112 fields at each level are merged, with values encountered last taking
113 precedence if duplicated fields appear.
115 Settings that can appear in a @code{\paper} block include:
120 the @code{set-paper-size} scheme function,
123 @code{\paper} variables used for customizing page layout, and
126 markup definitions used for customizing the layout of headers,
131 The @code{set-paper-size} function is discussed in the next
132 section, @ref{Paper size and automatic scaling}. The
133 @code{\paper} variables that deal with page layout are discussed
134 in later sections. The markup definitions that deal with headers,
135 footers, and titles are discussed in
136 @ref{Custom titles headers and footers}.
138 Most @code{\paper} variables will only work in a @code{\paper}
139 block. The few that will also work in a @code{\layout} block are
140 listed in @ref{The layout block,,The @code{@bs{}layout} block}.
142 Except when specified otherwise, all @code{\paper} variables that
143 correspond to distances on the page are measured in millimeters,
144 unless a different unit is specified by the user. For example,
145 the following declaration sets @code{top-margin} to ten
154 To set it to @code{0.5} inches, use the @code{\in} unit suffix:
162 The available unit suffixes are @code{\mm}, @code{\cm},
163 @code{\in}, and @code{\pt}. These units are simple values for
164 converting from millimeters; they are defined in
165 @file{ly/paper-defaults-init.ly}. For the sake of clarity, when
166 using millimeters, the @code{\mm} is typically included in the
167 code, even though it is not technically necessary.
169 It is also possible to define @code{\paper} values using Scheme.
170 The Scheme equivalent of the above example is:
174 #(define top-margin (* 0.5 in))
180 @ref{Paper size and automatic scaling},
181 @ref{Custom titles headers and footers},
182 @ref{The layout block,,The @code{@bs{}layout} block}.
185 @file{ly/paper-defaults-init.ly}.
188 @node Paper size and automatic scaling
189 @subsection Paper size and automatic scaling
197 * Setting the paper size::
198 * Automatic scaling to paper size::
202 @node Setting the paper size
203 @unnumberedsubsubsec Setting the paper size
205 @q{A4} is the default value when no explicit paper size is set. However,
206 there are two functions that can be used to change it:
209 @item set-default-paper-size
212 #(set-default-paper-size "quarto")
215 which must always be placed at the toplevel scope, and
221 #(set-paper-size "tabloid")
225 which must always be placed in a @code{\paper} block.
228 If the @code{set-default-paper-size} function is used in the toplevel
229 scope, it must come before any @code{\paper} block.
230 @code{set-default-paper-size} sets the paper size for all pages,
231 whereas @code{set-paper-size} only sets the paper size for the pages
232 that the @code{\paper} block applies to. For example, if the
233 @code{\paper} block is at the top of the file, then it will apply the
234 paper size to all pages. If the @code{\paper} block is inside a
235 @code{\book}, then the paper size will only apply to that book.
237 When the @code{set-paper-size} function is used, it must be
238 placed @emph{before} any other functions used within the same
239 @code{\paper} block. See @ref{Automatic scaling to paper size}.
241 Paper sizes are defined in @file{scm/paper.scm}, and while it is
242 possible to add custom sizes, they will be overwritten on subsequent
243 software updates. The available paper sizes are listed in
244 @ref{Predefined paper sizes}.
246 @c An appendix entry exists for paper sizes but is not auto-generated
248 The following command can be used in the file to add a custom paper size
249 which can then be used with @code{set-default-paper-size} or
250 @code{set-paper-size} as appropriate,
253 #(set! paper-alist (cons '("my size" . (cons (* 15 in) (* 3 in))) paper-alist))
256 #(set-paper-size "my size")
260 The units @code{in} (inches), @code{cm} (centimeters) and @code{mm}
261 (millimeters) can all be used.
263 @cindex paper size, orientation
264 @cindex page, orientation
265 @cindex paper size, landscape
267 If the symbol @code{'landscape} is added to the paper size function,
268 pages will be rotated by 90 degrees, and wider line widths will be set
272 #(set-default-paper-size "a6" 'landscape)
275 Swapping the paper dimensions @emph{without} having the print rotated
276 (like when printing to postcard size, or creating graphics for inclusion
277 rather than a standalone document) can be achieved by appending
278 @samp{landscape} to the name of the paper size itself:
281 #(set-default-paper-size "a6landscape")
284 When the paper size ends with an explicit @samp{landscape} or
285 @samp{portrait}, the presence of a @code{'landscape} symbol @emph{only}
286 affects print orientation, not the paper dimensions used for layout.
290 @ref{Automatic scaling to paper size},
291 @ref{Predefined paper sizes}.
294 @file{scm/paper.scm}.
297 @node Automatic scaling to paper size
298 @unnumberedsubsubsec Automatic scaling to paper size
300 If the paper size is changed with one of the scheme functions
301 (@code{set-default-paper-size} or @code{set-paper-size}), the
302 values of several @code{\paper} variables are automatically scaled
303 to the new size. To bypass the automatic scaling for a particular
304 variable, set the variable after setting the paper size. Note
305 that the automatic scaling is not triggered by setting the
306 @code{paper-height} or @code{paper-width} variables, even though
307 @code{paper-width} can influence other values (this is separate
308 from scaling and is discussed below). The
309 @code{set-default-paper-size} and @code{set-paper-size} functions
310 are described in @ref{Setting the paper size}.
312 The vertical dimensions affected by automatic scaling are
313 @code{top-margin} and @code{bottom-margin} (see
314 @ref{Fixed vertical spacing paper variables,,Fixed vertical spacing @code{@bs{}paper} variables}).
316 dimensions affected by automatic scaling are @code{left-margin},
317 @code{right-margin}, @code{inner-margin}, @code{outer-margin},
318 @code{binding-offset}, @code{indent}, and @code{short-indent} (see
319 @ref{Horizontal spacing paper variables,,Horizontal spacing @code{@bs{}paper} variables}).
321 The default values for these dimensions are set in
322 @file{ly/paper-defaults-init.ly}, using internal variables named
323 @code{top-margin-default}, @code{bottom-margin-default}, etc.
324 These are the values that result at the default paper size
325 @code{a4}. For reference, with @code{a4} paper the
326 @code{paper-height} is @code{297\mm} and the @code{paper-width} is
331 @ref{Fixed vertical spacing paper variables,,Fixed vertical spacing @code{@bs{}paper} variables},
332 @ref{Horizontal spacing paper variables,,Horizontal spacing @code{@bs{}paper} variables}.
335 @file{ly/paper-defaults-init.ly},
336 @file{scm/paper.scm}.
339 @node Fixed vertical spacing paper variables
340 @subsection Fixed vertical spacing @code{@bs{}paper} variables
342 @warning{Some @code{@bs{}paper} dimensions are automatically
343 scaled to the paper size, which may lead to unexpected behavior.
344 See @ref{Automatic scaling to paper size}.}
346 Default values (before scaling) are defined in
347 @file{ly/paper-defaults-init.ly}.
351 @funindex paper-height
353 The height of the page, unset by default. Note that the automatic
354 scaling of some vertical dimensions is not affected by this.
359 The margin between the top of the page and the top of the
360 printable area. If the paper size is modified, this dimension's
361 default value is scaled accordingly.
364 @funindex bottom-margin
366 The margin between the bottom of the printable area and the bottom
367 of the page. If the paper size is modified, this dimension's
368 default value is scaled accordingly.
371 @funindex ragged-bottom
373 If this is set to true,
374 systems will be set at their natural spacing, neither compressed
375 nor stretched vertically to fit the page.
377 @item ragged-last-bottom
378 @funindex ragged-last-bottom
380 If this is set to false, then the last page,
381 and the last page in each section created with a @code{\bookpart} block,
382 will be vertically justified in the same way as the earlier pages.
388 @ref{Automatic scaling to paper size}.
391 @file{ly/paper-defaults-init.ly}.
397 The titles (from the @code{\header} block) are treated as a
398 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
399 add space between the titles and the first system of the score.
401 Explicitly defined paper-sizes will override any user-defined top or
402 bottom margin settings.
405 @node Flexible vertical spacing paper variables
406 @subsection Flexible vertical spacing @code{@bs{}paper} variables
408 In most cases, it is preferable for the vertical distances between
409 certain items (such as margins, titles, systems, and separate
410 scores) to be flexible, so that they stretch and compress nicely
411 according to each situation. A number of @code{\paper} variables
412 (listed below) are available to fine-tune the stretching behavior
415 Note that the @code{\paper} variables discussed in this section do
416 not control the spacing of staves within individual systems.
417 Within-system spacing is controlled by grob properties, with
418 settings typically entered inside a @code{\score} or
419 @code{\layout} block, and not inside a @code{\paper} block. See
420 @ref{Flexible vertical spacing within systems}.
423 * Structure of flexible vertical spacing alists::
424 * List of flexible vertical spacing paper variables::
428 @node Structure of flexible vertical spacing alists
429 @unnumberedsubsubsec Structure of flexible vertical spacing alists
431 Each of the flexible vertical spacing @code{\paper} variables is
432 an alist (association list) containing four @emph{keys}:
437 @code{basic-distance} -- the vertical distance, measured in
438 staff-spaces, between the @emph{reference points} of the two
439 items, when no collisions would result, and no stretching or
440 compressing is in effect. The reference point of a (title or
441 top-level) markup is its highest point, and the reference point of
442 a system is the vertical center of the nearest @code{StaffSymbol}
443 -- even if a non-staff line (such as a @code{Lyrics} context) is
444 in the way. Values for @code{basic-distance} that are less than
445 either @code{padding} or @code{minimum-distance} are not
446 meaningful, since the resulting distance will never be less than
447 either @code{padding} or @code{minimum-distance}.
450 @code{minimum-distance} -- the smallest allowable vertical
451 distance, measured in staff-spaces, between the reference points
452 of the two items, when compressing is in effect. Values for
453 @code{minimum-distance} that are less than @code{padding} are not
454 meaningful, since the resulting distance will never be less than
457 @c TODO: explain skylines somewhere and xref to it from here.
460 @code{padding} -- the minimum required amount of unobstructed
461 vertical whitespace between the bounding boxes (or skylines) of
462 the two items, measured in staff-spaces.
465 @code{stretchability} -- a unitless measure of the dimension's
466 relative propensity to stretch. If zero, the distance will not
467 stretch (unless collisions would result). When positive, the
468 significance of a particular dimension's @code{stretchability}
469 value lies only in its relation to the @code{stretchability}
470 values of the other dimensions. For example, if one dimension has
471 twice the @code{stretchability} of another, it will stretch twice
472 as easily. Values should be non-negative and finite. The value
473 @code{+inf.0} triggers a @code{programming_error} and is ignored,
474 but @code{1.0e7} can be used for an almost infinitely stretchable
475 spring. If unset, the default value is set to
476 @code{basic-distance}. Note that the dimension's propensity to
477 @emph{compress} cannot be directly set by the user and is equal to
478 (@code{basic-distance}@tie{}@minus{}@tie{}@code{minimum-distance}).
482 If a page has a ragged bottom, the resulting distance is the
488 @code{basic-distance},
491 @code{minimum-distance}, and
494 @code{padding} plus the smallest distance necessary to eliminate
499 For multi-page scores with a ragged bottom on the last page, the last
500 page uses the same spacing as the preceding page, provided there is
501 enough space for that.
503 Specific methods for modifying alists are discussed in
504 @ref{Modifying alists}. The following example demonstrates the
505 two ways these alists can be modified. The first declaration
506 updates one key-value individually, and the second completely
507 redefines the variable:
511 system-system-spacing #'basic-distance = #8
512 score-system-spacing =
513 #'((basic-distance . 12)
514 (minimum-distance . 6)
516 (stretchability . 12))
521 @node List of flexible vertical spacing paper variables
522 @unnumberedsubsubsec List of flexible vertical spacing @code{@bs{}paper} variables
524 The names of these variables follow the format
525 @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}}
526 and @code{@var{lower}} are the items to be spaced. Each distance
527 is measured between the reference points of the two items (see the
528 description of the alist structure above). Note that in these
529 variable names, the term @q{@code{markup}} refers to both
530 @emph{title markups} (@code{bookTitleMarkup} or
531 @code{scoreTitleMarkup}) and @emph{top-level markups} (see
532 @ref{File structure}). All distances are measured in
535 Default settings are defined in @file{ly/paper-defaults-init.ly}.
537 @c TODO: Where do headers/footers fit in? -mp
540 @item markup-system-spacing
541 @funindex markup-system-spacing
543 the distance between a (title or top-level) markup and the system
546 @item score-markup-spacing
547 @funindex score-markup-spacing
549 the distance between the last system of a score and the (title or
550 top-level) markup that follows it.
552 @item score-system-spacing
553 @funindex score-system-spacing
555 the distance between the last system of a score and the first
556 system of the score that follows it, when no (title or top-level)
557 markup exists between them.
559 @item system-system-spacing
560 @funindex system-system-spacing
562 the distance between two systems in the same score.
564 @item markup-markup-spacing
565 @funindex markup-markup-spacing
567 the distance between two (title or top-level) markups.
569 @item last-bottom-spacing
570 @funindex last-bottom-spacing
572 the distance from the last system or top-level markup on a page to
573 the bottom of the printable area (i.e. the top of the bottom
576 @item top-system-spacing
577 @funindex top-system-spacing
579 the distance from the top of the printable area (i.e. the bottom
580 of the top margin) to the first system on a page, when there is no
581 (title or top-level) markup between the two.
583 @item top-markup-spacing
584 @funindex top-markup-spacing
586 the distance from the top of the printable area (i.e. the bottom
587 of the top margin) to the first (title or top-level) markup on a
588 page, when there is no system between the two.
593 @ref{Flexible vertical spacing within systems}.
596 @file{ly/paper-defaults-init.ly}.
602 @node Horizontal spacing paper variables
603 @subsection Horizontal spacing @code{@bs{}paper} variables
605 @warning{Some @code{@bs{}paper} dimensions are automatically
606 scaled to the paper size, which may lead to unexpected behavior.
607 See @ref{Automatic scaling to paper size}.}
610 * paper variables for widths and margins::
611 * paper variables for two-sided mode::
612 * paper variables for shifts and indents::
616 @node paper variables for widths and margins
617 @unnumberedsubsubsec @code{@bs{}paper} variables for widths and margins
619 Default values (before scaling) that are not listed here are
620 defined in @file{ly/paper-defaults-init.ly}.
625 @funindex paper-width
627 The width of the page, unset by default. While @code{paper-width}
628 has no effect on the automatic scaling of some horizontal
629 dimensions, it does influence the @code{line-width} variable. If
630 both @code{paper-width} and @code{line-width} are set, then
631 @code{left-margin} and @code{right-margin} will also be updated.
632 Also see @code{check-consistency}.
637 The horizontal extent of the staff lines in unindented, non-ragged
639 @code{(paper-width@tie{}@minus{}@tie{}left-margin@tie{}@minus{}@tie{}right-margin)}
640 when unset. If @code{line-width} is set, and both
641 @code{left-margin} and @code{right-margin} are unset, then the
642 margins will be updated to center the systems on the page
643 automatically. Also see @code{check-consistency}. This variable
644 can also be set in a @code{\layout} block.
647 @funindex left-margin
649 The margin between the left edge of the page and the start of the
650 staff lines in unindented systems. If the paper size is modified,
651 this dimension's default value is scaled accordingly. If
652 @code{left-margin} is unset, and both @code{line-width} and
653 @code{right-margin} are set, then @code{left-margin} is set to
654 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}right-margin)}.
655 If only @code{line-width} is set, then both margins are set to
656 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
657 and the systems are consequently centered on the page. Also see
658 @code{check-consistency}.
661 @funindex right-margin
663 The margin between the right edge of the page and the end of the
664 staff lines in non-ragged systems. If the paper size is modified,
665 this dimension's default value is scaled accordingly. If
666 @code{right-margin} is unset, and both @code{line-width} and
667 @code{left-margin} are set, then @code{right-margin} is set to
668 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}left-margin)}.
669 If only @code{line-width} is set, then both margins are set to
670 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
671 and the systems are consequently centered on the page. Also see
672 @code{check-consistency}.
674 @item check-consistency
675 @funindex check-consistency
677 If set to true, print a warning if @code{left-margin},
678 @code{line-width}, and @code{right-margin} do not exactly add up
679 to @code{paper-width}, and replace each of these (except
680 @code{paper-width}) with its default value (scaled to the paper
681 size if necessary). If set to false, ignore any inconsistencies
682 and allow systems to run off the edge of the page.
685 @funindex ragged-right
687 If set to true, systems will not fill the line width. Instead,
688 systems end at their natural horizontal length. Default:
689 @code{#t} for scores with only one system, and @code{#f} for
690 scores with two or more systems. This variable can also be set in
691 a @code{\layout} block.
694 @funindex ragged-last
696 If set to true, the last system in the score will not fill the
697 line width. Instead the last system ends at its natural
698 horizontal length. Default: @code{#f}. This variable can also be
699 set in a @code{\layout} block.
705 @ref{Automatic scaling to paper size}.
708 @file{ly/paper-defaults-init.ly}.
711 Explicitly defined paper-sizes will override any user-defined left or
712 right margin settings.
715 @node paper variables for two-sided mode
716 @unnumberedsubsubsec @code{@bs{}paper} variables for two-sided mode
718 Default values (before scaling) are defined in
719 @file{ly/paper-defaults-init.ly}.
727 @cindex binding gutter
729 If set to true, use @code{inner-margin}, @code{outer-margin} and
730 @code{binding-offset} to determine margins depending on whether
731 the page number is odd or even. This overrides @code{left-margin}
732 and @code{right-margin}.
735 @funindex inner-margin
737 The margin all pages have at the inner side if they are part of a
738 book. If the paper size is modified, this dimension's default
739 value is scaled accordingly. Works only with @code{two-sided} set
743 @funindex outer-margin
745 The margin all pages have at the outer side if they are part of a
746 book. If the paper size is modified, this dimension's default
747 value is scaled accordingly. Works only with @code{two-sided} set
751 @funindex binding-offset
753 The amount @code{inner-margin} is increased to make sure nothing
754 will be hidden by the binding. If the paper size is modified,
755 this dimension's default value is scaled accordingly. Works only
756 with @code{two-sided} set to true.
762 @ref{Automatic scaling to paper size}.
765 @file{ly/paper-defaults-init.ly}.
768 @node paper variables for shifts and indents
769 @unnumberedsubsubsec @code{@bs{}paper} variables for shifts and indents
771 Default values (before scaling) that are not listed here are
772 defined in @file{ly/paper-defaults-init.ly}.
776 @item horizontal-shift
777 @funindex horizontal-shift
779 @c This default value is buried in the middle of page.scm. -mp
781 The amount that all systems (including titles and system
782 separators) are shifted to the right. Default: @code{0.0\mm}.
787 The level of indentation for the first system in a score. If the
788 paper size is modified, this dimension's default value is scaled
789 accordingly. This variable can also be set in a @code{\layout}
793 @funindex short-indent
795 The level of indentation for all systems in a score besides the
796 first system. If the paper size is modified, this dimension's
797 default value is scaled accordingly. This variable can also be
798 set in a @code{\layout} block.
804 @ref{Automatic scaling to paper size}.
807 @file{ly/paper-defaults-init.ly}.
813 @node Other paper variables
814 @subsection Other @code{@bs{}paper} variables
817 * paper variables for line breaking::
818 * paper variables for page breaking::
819 * paper variables for page numbering::
820 * Miscellaneous paper variables::
824 @node paper variables for line breaking
825 @unnumberedsubsubsec @code{@bs{}paper} variables for line breaking
829 @item max-systems-per-page
830 @funindex max-systems-per-page
832 The maximum number of systems that will be placed on a page. This
833 is currently supported only by the @code{ly:optimal-breaking} algorithm.
836 @item min-systems-per-page
837 @funindex min-systems-per-page
839 The minimum number of systems that will be placed on a page. This
840 may cause pages to be overfilled if it is made too large. This is
841 currently supported only by the @code{ly:optimal-breaking} algorithm.
844 @item systems-per-page
845 @funindex systems-per-page
847 The number of systems that should be placed on each page.
848 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
852 @funindex system-count
854 The number of systems to be used for a score. Default: unset.
855 This variable can also be set in a @code{\layout} block.
864 @node paper variables for page breaking
865 @unnumberedsubsubsec @code{@bs{}paper} variables for page breaking
867 Default values not listed here are defined in
868 @file{ly/paper-defaults-init.ly}
873 @funindex page-breaking
875 The page-breaking algorithm to use. Choices are
876 @code{ly:minimal-breaking}, @code{ly:page-turn-breaking},
877 @code{ly:one-line-breaking} and @code{ly:optimal-breaking}
880 @item page-breaking-system-system-spacing
881 @funindex page-breaking-system-system-spacing
883 Tricks the page breaker into thinking that
884 @code{system-system-spacing} is set to something different than
885 it really is. For example, if
886 @code{page-breaking-system-system-spacing #'padding} is set to something
887 substantially larger than @code{system-system-spacing #'padding}, then the
888 page-breaker will put fewer systems on each page. Default: unset.
893 The number of pages to be used for a score, unset by default.
897 The following variables are effective only when @code{page-breaking}
898 is set to @code{ly:page-turn-breaking}. Page breaks are then chosen
899 to minimize the number of page turns. Since page turns are required
900 on moving from an odd-numbered page to an even-numbered one, a
901 layout in which the last page is odd-numbered will usually be
902 favoured. Places where page turns are preferred can be indicated
903 manually by inserting @code{\allowPageTurn} or automatically by
904 including the @code{Page_turn_engraver} (see @ref{Optimal page turning}).
906 If there are insufficient choices available for making suitable page
907 turns, LilyPond may insert a blank page either within a score, between
908 scores (if there are two or more scores), or by ending a score on an
909 even-numbered page. The values of the following three variables may
910 be increased to make these actions less likely.
912 The values are penalties, i.e. the higher the value the less likely
913 will be the associated action relative to other choices.
917 @item blank-page-penalty
918 @funindex blank-page-penalty
920 The penalty for having a blank page in the middle of a score. If
921 @code{blank-page-penalty} is large and @code{ly:page-turn-breaking} is
922 selected, then LilyPond will be less likely to insert a page in the
923 middle of a score. Instead, it will space out the music further to
924 fill the blank page and the following one. Default: 5.
926 @item blank-last-page-penalty
927 @funindex blank-last-page-penalty
929 The penalty for ending the score on an even-numbered page. If
930 @code{blank-last-page-penalty} is large and
931 @code{ly:page-turn-breaking} is selected, then LilyPond will be less
932 likely to produce a score in which the last page is even-numbered.
933 Instead, it will adjust the spacing in order to use one page more or
934 one page less. Default: 0.
936 @item blank-after-score-page-penalty
937 @funindex blank-after-score-page-penalty
939 The penalty for having a blank page after the end of one score and
940 before the next. By default, this is smaller than
941 @code{blank-page-penalty}, so that blank pages after scores are
942 inserted in preference to blank pages within a score. Default: 2.
950 @ref{Optimal page breaking},
951 @ref{Optimal page turning},
952 @ref{Minimal page breaking},
953 @ref{One-line page breaking}.
956 @file{ly/paper-defaults-init.ly}.
959 @node paper variables for page numbering
960 @unnumberedsubsubsec @code{@bs{}paper} variables for page numbering
962 Default values not listed here are defined in
963 @file{ly/paper-defaults-init.ly}
967 @cindex page numbers, auto-numbering
968 @item auto-first-page-number
969 @funindex auto-first-page-number
971 The page breaking algorithm is affected by the first page number
972 being odd or even. If set to true, the page breaking algorithm
973 will decide whether to start with an odd or even number. This
974 will result in the first page number remaining as is or being
975 increased by one. Default: @code{#f}.
977 @cindex page numbers, specify the first
978 @item first-page-number
979 @funindex first-page-number
981 The value of the page number on the first page.
983 @item print-first-page-number
984 @funindex print-first-page-number
986 If set to true, a page number is printed on the first page.
988 @cindex page numbers, suppress
989 @item print-page-number
990 @funindex print-page-number
992 If set to false, page numbers are not printed.
998 @file{ly/paper-defaults-init.ly}.
1001 Odd page numbers are always on the right. If you want the
1002 music to start on page 1 there must be a blank page on the back
1003 of the cover page so that page 1 is on the right hand side.
1006 @node Miscellaneous paper variables
1007 @unnumberedsubsubsec Miscellaneous @code{@bs{}paper} variables
1011 @item page-spacing-weight
1012 @funindex page-spacing-weight
1014 The relative importance of page (vertical) spacing and line
1015 (horizontal) spacing. High values will make page spacing more
1016 important. Default: @code{10}.
1018 @item print-all-headers
1019 @funindex print-all-headers
1021 If set to true, this will print all headers for each @code{\score}
1022 in the output. Normally only the @code{piece} and @code{opus}
1023 header variables are printed. Default: @code{#f}.
1025 @item system-separator-markup
1026 @funindex system-separator-markup
1028 A markup object that is inserted between systems, often used for
1029 orchestral scores. Default: unset. The @code{\slashSeparator}
1030 markup, defined in @file{ly/titling-init.ly}, is provided as a
1031 sensible default, for example:
1033 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
1034 #(set-default-paper-size "a8")
1038 system-separator-markup = \slashSeparator
1044 \relative c'' { c1 \break c1 \break c1 }
1053 @file{ly/titling-init.ly}.
1059 The default page header puts the page number and the @code{instrument}
1060 field from the @code{\header} block on a line.
1064 @section Score layout
1066 This section discusses score layout options for the @code{\layout}
1070 * The layout block::
1071 * Setting the staff size::
1075 @node The layout block
1076 @subsection The @code{@bs{}layout} block
1080 While the @code{\paper} block contains settings that relate to the
1081 page formatting of the whole document, the @code{\layout} block
1082 contains settings for score-specific layout. To set score layout
1083 options globally, enter them in a toplevel @code{\layout} block.
1084 To set layout options for an individual score, enter them in a
1085 @code{\layout} block inside the @code{\score} block, after the
1086 music. Settings that can appear in a @code{\layout} block
1090 @item the @code{layout-set-staff-size} scheme function,
1091 @item context modifications in @code{\context} blocks, and
1092 @item @code{\paper} variables that affect score layout.
1095 The @code{layout-set-staff-size} function is discussed in the next
1096 section, @ref{Setting the staff size}. Context modifications are
1097 discussed in a separate chapter; see
1098 @ref{Modifying context plug-ins} and
1099 @ref{Changing context default settings}. The @code{\paper}
1100 variables that can appear in a @code{\layout} block are:
1105 @code{line-width}, @code{ragged-right} and @code{ragged-last}
1106 (see @ref{paper variables for widths and margins,,@code{@bs{}paper} variables for widths and margins})
1109 @code{indent} and @code{short-indent}
1110 (see @ref{paper variables for shifts and indents,,@code{@bs{}paper} variables for shifts and indents})
1114 (see @ref{paper variables for line breaking,,@code{@bs{}paper} variables for line breaking})
1118 Here is an example @code{\layout} block:
1125 \override StaffGrouper.staff-staff-spacing.basic-distance = #8
1129 \override TextScript.padding = #1
1130 \override Glissando.thickness = #3
1135 Multiple @code{\layout} blocks can be entered as toplevel expressions.
1136 This can, for example, be useful if different settings are stored in
1137 separate files and included optionally. Internally, when
1138 a @code{\layout} block is evaluated, a copy of the current
1139 @code{\layout} configuration is made, then any changes defined within
1140 the block are applied and the result is saved as the new current
1141 configuration. From the user's perspective the @code{\layout} blocks
1142 are combined, but in conflicting situations (when the same property
1143 is changed in different blocks) the later definitions take precedence.
1145 For example, if this block:
1151 \override TextScript.color = #magenta
1152 \override Glissando.thickness = #1.5
1157 is placed after the one from the preceding example the @code{'padding}
1158 and @code{'color} overrides for @code{TextScript} are combined, but
1159 the later @code{'thickness} override for @code{Glissando} replaces
1160 (or hides) the earlier one.
1162 @code{\layout} blocks may be assigned to variables for reuse later,
1163 but the way this works is slightly but significantly different from
1164 writing them literally.
1166 If a variable is defined like this:
1169 layoutVariable = \layout @{
1172 \override NoteHead.font-size = #4
1177 it will hold the current @code{\layout} configuration with the
1178 @code{NoteHead.font-size} override added, but this combination
1179 is @emph{not} saved as the new current configuration. Be aware
1180 that the @q{current configuration} is read when the variable is
1181 defined and not when it is used, so the content of the variable
1182 is dependent on its position in the source.
1184 The variable can then be used inside another @code{\layout} block,
1192 \override NoteHead.color = #red
1197 A @code{\layout} block containing a variable, as in the example above,
1198 does @emph{not} copy the current configuration but instead uses the
1199 content of @code{\layoutVariable} as the base configuration for the
1200 further additions. This means that any changes defined between the
1201 definition and the use of the variable are lost.
1203 If @code{layoutVariable} is defined (or @code{\include}d) immediately
1204 before being used, its content is just the current configuration plus
1205 the overrides defined within it. So in the example above showing the
1206 use of @code{\layoutVariable} the final @code{\layout} block would
1210 TextScript.padding = #1
1211 TextScript.color = #magenta
1212 Glissando.thickness = #1.5
1213 NoteHead.font-size = #4
1214 NoteHead.color = #red
1217 plus the @code{indent} and the @code{StaffGrouper} overrides.
1219 But if the variable had already been defined before the first
1220 @code{\layout} block the current configuration would now contain
1224 NoteHead.font-size = #4 % (written in the variable definition)
1225 NoteHead.color = #red % (added after the use of the variable)
1228 If carefully planned, @code{\layout} variables can be a valuable tool
1229 to structure the layout design of sources, and also to reset the
1230 @code{\layout} configuration to a known state.
1234 @ref{Changing context default settings}.
1240 @node Setting the staff size
1241 @subsection Setting the staff size
1243 @cindex font size, setting
1244 @cindex staff size, setting
1245 @funindex layout file
1246 @funindex magnification->font-size
1248 @funindex set-global-staff-size
1249 @funindex layout-set-staff-size
1251 The default @strong{staff size} is 20 points, which corresponds to
1252 a staff height of 7.03mm (one point is equal to 100/7227 of an
1253 inch, or 2540/7227 mm). The staff size may be changed in three
1259 To set the staff size globally for all scores in a file (or in a
1260 @code{\book} block, to be precise), use
1261 @code{set-global-staff-size}:
1264 #(set-global-staff-size 14)
1268 The above example sets the global default staff size to 14pt
1269 (4.92mm) and scales all fonts accordingly.
1272 To set the staff size for a single score within a book, use
1273 @code{layout-set-staff-size} inside that score's @code{\layout}
1280 #(layout-set-staff-size 14)
1286 To set the staff size for a single staff within a system, use the
1287 @code{\magnifyStaff} command. For example, traditionally engraved
1288 chamber music scores with piano often used 7mm piano staves while
1289 the other staves were typically between 3/5 and 5/7 as large
1290 (between 60% and 71%). To achieve the 5/7 proportion, use:
1298 \new PianoStaff @{ @dots{} @}
1303 If you happen to know which @code{fontSize} you wish to use, you
1304 could use the following form:
1310 \magnifyStaff #(magstep -3)
1312 \new PianoStaff @{ @dots{} @}
1317 To emulate the look of traditional engraving, it is best to avoid
1318 reducing the thickness of the staff lines.
1323 @subheading Automatic font weight at different sizes
1325 The Feta font provides musical symbols at eight different
1326 sizes. Each font is tuned for a different staff size: at a smaller size
1327 the font becomes heavier, to match the relatively heavier staff lines.
1328 The recommended font sizes are listed in the following table:
1330 @multitable @columnfractions .15 .2 .22 .2
1331 @item @b{font name} @tab @b{staff height (pt)} @tab @b{staff height (mm)} @tab @b{use}
1332 @item feta11 @tab 11.22 @tab 3.9 @tab pocket scores
1333 @item feta13 @tab 12.60 @tab 4.4 @tab
1334 @item feta14 @tab 14.14 @tab 5.0 @tab
1335 @item feta16 @tab 15.87 @tab 5.6 @tab
1336 @item feta18 @tab 17.82 @tab 6.3 @tab song books
1337 @item feta20 @tab 20 @tab 7.0 @tab standard parts
1338 @item feta23 @tab 22.45 @tab 7.9 @tab
1339 @item feta26 @tab 25.2 @tab 8.9 @tab @c modern rental material?
1344 @ref{Selecting notation font size}.
1350 @code{layout-set-staff-size} does not change the distance between the
1365 @subsection Line breaking
1368 @cindex breaking lines
1370 Line breaks are normally determined automatically. They are
1371 chosen so that lines look neither cramped nor loose, and
1372 consecutive lines have similar density.
1374 To manually force a line break at a bar line, use the
1375 @code{\break} command:
1377 @lilypond[quote,ragged-right,relative=2,verbatim]
1382 By default, a @code{\break} in the middle of a measure is ignored,
1383 and a warning is printed. To force a line break in the middle of
1384 a measure, add an invisible bar line with @w{@samp{\bar ""}}:
1386 @lilypond[quote,ragged-right,relative=2,verbatim]
1393 A @code{\break} occurring at a bar line is also ignored if the
1394 previous measure ends in the middle of a note, such as when a
1395 tuplet begins and ends in different measures. To allow
1396 @code{\break} commands to work in these situations, remove the
1397 @code{Forbid_line_break_engraver} from the @code{Voice} context.
1398 Note that manually forced line breaks have to be added in parallel
1401 @lilypond[quote,ragged-right,verbatim]
1403 \remove "Forbid_line_break_engraver"
1406 { c2. \tuplet 3/2 { c4 c c } c2. | }
1407 { s1 | \break s1 | }
1412 Similarly, line breaks are normally forbidden when beams cross bar
1413 lines. This behavior can be changed by setting
1414 @code{\override Beam.breakable = ##t}:
1416 @lilypond[quote,ragged-right,relative=2,verbatim]
1417 \override Beam.breakable = ##t
1422 The @code{\noBreak} command forbids a line break at the bar line
1423 where it is inserted.
1425 The most basic settings influencing line spacing are @code{indent}
1426 and @code{line-width}. They are set in the @code{\layout} block.
1427 They control the indentation of the first line of music, and the
1428 lengths of the lines.
1430 If @code{ragged-right} is set to true in the @code{\layout} block,
1431 then systems end at their natural horizontal length, instead of
1432 being spread horizontally to fill the whole line. This is useful
1433 for short fragments, and for checking how tight the natural
1436 @c TODO Check and add para on default for ragged-right
1438 The option @code{ragged-last} is similar to @code{ragged-right},
1439 but affects only the last line of the piece.
1449 @cindex regular line breaks
1450 @cindex four bar music.
1452 For line breaks at regular intervals use @code{\break} separated
1453 by skips and repeated with @code{\repeat}. For example, this
1454 would cause the following 28 measures (assuming 4/4 time) to be
1455 broken every 4 measures, and only there:
1460 s1 \noBreak s1 \noBreak
1461 s1 \noBreak s1 \break
1463 @{ @var{the actual music@dots{}} @}
1477 @ref{paper variables for line breaking}
1478 @ref{The layout block}.
1483 Internals Reference:
1484 @rinternals{LineBreakEvent}.
1488 @subsection Page breaking
1490 This section describes the different page breaking methods, and
1494 * Manual page breaking::
1495 * Optimal page breaking::
1496 * Minimal page breaking::
1497 * One-line page breaking::
1498 * Optimal page turning::
1502 @node Manual page breaking
1503 @unnumberedsubsubsec Manual page breaking
1505 The default page breaking may be overridden by inserting
1506 @code{\pageBreak} or @code{\noPageBreak} commands. These commands
1507 are analogous to @code{\break} and @code{\noBreak}. They should
1508 be inserted at a bar line. These commands force and forbid a
1509 page-break from happening. Of course, the @code{\pageBreak}
1510 command also forces a line break.
1512 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1513 inserted at top-level, between scores and top-level markups.
1515 There are also analogous settings to @code{ragged-right} and
1516 @code{ragged-last} which have the same effect on vertical spacing.
1517 If @code{ragged-bottom} is set to @code{#t} the systems will not
1518 be justified vertically. When @code{ragged-last-bottom} is set
1519 to @code{#t}, as it is by default, empty space is allowed at the
1520 bottom of the final page (or the final page in each
1521 @code{\bookpart}). See
1522 @ref{Fixed vertical spacing paper variables,,Fixed vertical spacing @code{@bs{}paper} variables}.
1524 Page breaks are computed by the @code{page-breaking} function.
1525 LilyPond provides three algorithms for computing page breaks,
1526 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1527 @code{ly:minimal-breaking}. The default is
1528 @code{ly:optimal-breaking}, but the value can be changed in the
1529 @code{\paper} block:
1533 page-breaking = #ly:page-turn-breaking
1539 When a book has many scores and pages, the page breaking problem
1540 may be difficult to solve, requiring large processing time and
1541 memory. To ease the page breaking process, @code{\bookpart}
1542 blocks are used to divide the book into several parts: the page
1543 breaking occurs separately on each part. Different page breaking
1544 functions may also be used in different book parts.
1549 subtitle = "Preface"
1552 %% In a part consisting mostly of text,
1553 %% ly:minimal-breaking may be preferred
1554 page-breaking = #ly:minimal-breaking
1556 \markup @{ @dots{} @}
1560 %% In this part, consisting of music, the default optimal
1561 %% page breaking function is used.
1563 subtitle = "First movement"
1565 \score @{ @dots{} @}
1572 @funindex \pageBreak
1574 @funindex \noPageBreak
1575 @code{\noPageBreak}.
1580 @ref{paper variables for page breaking}.
1586 @node Optimal page breaking
1587 @unnumberedsubsubsec Optimal page breaking
1589 @funindex ly:optimal-breaking
1591 The @code{ly:optimal-breaking} function is LilyPond's default
1592 method of determining page breaks. It attempts to find a page
1593 breaking that minimizes cramping and stretching, both horizontally
1594 and vertically. Unlike @code{ly:page-turn-breaking}, it has no
1595 concept of page turns.
1602 @node Minimal page breaking
1603 @unnumberedsubsubsec Minimal page breaking
1605 @funindex ly:minimal-breaking
1607 The @code{ly:minimal-breaking} function performs minimal
1608 computations to calculate the page breaking: it fills a page with
1609 as many systems as possible before moving to the next one. Thus,
1610 it may be preferred for scores with many pages, where the other
1611 page breaking functions could be too slow or memory demanding, or
1612 a lot of texts. It is enabled using:
1616 page-breaking = #ly:minimal-breaking
1625 @node One-line page breaking
1626 @unnumberedsubsubsec One-line page breaking
1628 @funindex ly:one-line-breaking
1630 The @code{ly:one-line-breaking} function is a special-purpose
1631 page breaking algorithm that puts each score on its own page, and
1632 on a single line. This page breaking function does not typeset
1633 titles or margins; only the score will be displayed.
1635 The page width will be adjusted so that the longest score fits on
1636 one line. In particular, @code{paper-width}, @code{line-width}
1637 and @code{indent} variables in the @code{\paper} block will be
1638 ignored, although @code{left-margin} and @code{right-margin} will
1639 still be honored. The height of the page will be left unmodified.
1642 @node Optimal page turning
1643 @unnumberedsubsubsec Optimal page turning
1645 @funindex ly:page-turn-breaking
1647 Often it is necessary to find a page breaking configuration so
1648 that there is a rest at the end of every second page. This way,
1649 the musician can turn the page without having to miss notes. The
1650 @code{ly:page-turn-breaking} function attempts to find a page
1651 breaking minimizing cramping and stretching, but with the
1652 additional restriction that it is only allowed to introduce page
1653 turns in specified places.
1655 There are two steps to using this page breaking function. First,
1656 you must enable it in the @code{\paper} block, as explained in
1657 @ref{Page breaking}. Then you must tell the function where you
1658 would like to allow page breaks.
1660 There are two ways to achieve the second step. First, you can
1661 specify each potential page turn manually, by inserting
1662 @code{\allowPageTurn} into your input file at the appropriate
1665 If this is too tedious, you can add a @code{Page_turn_engraver} to
1666 a Staff or Voice context. The @code{Page_turn_engraver} will scan
1667 the context for sections without notes (note that it does not scan
1668 for rests; it scans for the absence of notes. This is so that
1669 single-staff polyphony with rests in one of the parts does not
1670 throw off the @code{Page_turn_engraver}). When it finds a
1671 sufficiently long section without notes, the
1672 @code{Page_turn_engraver} will insert an @code{\allowPageTurn} at
1673 the final bar line in that section, unless there is a @q{special}
1674 bar line (such as a double bar), in which case the
1675 @code{\allowPageTurn} will be inserted at the final @q{special}
1676 bar line in the section.
1678 @funindex minimumPageTurnLength
1679 The @code{Page_turn_engraver} reads the context property
1680 @code{minimumPageTurnLength} to determine how long a note-free
1681 section must be before a page turn is considered. The default
1682 value for @code{minimumPageTurnLength} is
1683 @code{(ly:make-moment 1/1)}. If you want to disable page turns,
1684 set it to something @q{very large}.
1687 \new Staff \with @{ \consists "Page_turn_engraver" @}
1690 R1 | % a page turn will be allowed here
1692 \set Staff.minimumPageTurnLength = #(ly:make-moment 5/2)
1693 R1 | % a page turn will not be allowed here
1695 R1*2 | % a page turn will be allowed here
1700 @funindex minimumRepeatLengthForPageTurn
1701 With volta repeats, the @code{Page_turn_engraver} will only
1702 allow a page turn during the repeat if there is enough time at the
1703 beginning and end of the repeat to turn the page back. If the
1704 repeat is very short, the @code{Page_turn_engraver} can also be
1705 used to disable page turns by setting a value for the context
1706 property @code{minimumRepeatLengthForPageTurn} where as
1707 @code{Page_turn_engraver} only allows turns in repeats whose
1708 duration is longer than this value.
1710 The page turning commands, @code{\pageTurn}, @code{\noPageTurn}
1711 and @code{\allowPageTurn}, may also be used at top-level, in
1712 top-level markups and between scores.
1717 @funindex \noPageTurn
1719 @funindex \allowPageTurn
1720 @code{\allowPageTurn}.
1725 @ref{paper variables for line breaking}.
1731 Use only one @code{Page_turn_engraver} per score. If there are
1732 more, they will interfere with each other.
1735 @node Explicit breaks
1736 @subsection Explicit breaks
1738 There are cases when manual @code{\break} or @code{\pageBreak}
1739 commands are ignored by LilyPond. There are two commands to
1740 override this behavior:
1743 \override NonMusicalPaperColumn.line-break-permission = ##f
1744 \override NonMusicalPaperColumn.page-break-permission = ##f
1747 If @code{line-break-permission} is set to @code{##f}, all line
1748 breaks must be explicitly inserted with a @code{\break} command.
1749 Likewise, if @code{page-break-permission} is set to @code{##f},
1750 all page breaks must be explicitly inserted with a
1751 @code{\pageBreak} command.
1753 @lilypond[quote,verbatim]
1760 music = \relative c'' { c8 c c c }
1764 \repeat unfold 2 { \music } \break
1765 \repeat unfold 4 { \music } \break
1766 \repeat unfold 6 { \music } \break
1767 \repeat unfold 8 { \music } \pageBreak
1768 \repeat unfold 8 { \music } \break
1769 \repeat unfold 6 { \music } \break
1770 \repeat unfold 4 { \music } \break
1771 \repeat unfold 2 { \music }
1776 \override NonMusicalPaperColumn.line-break-permission = ##f
1777 \override NonMusicalPaperColumn.page-break-permission = ##f
1785 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
1786 {using-an-extra-voice-for-breaks.ly}
1790 @ref{Vertical spacing}.
1796 @node Vertical spacing
1797 @section Vertical spacing
1799 @cindex vertical spacing
1800 @cindex spacing, vertical
1802 Vertical spacing is controlled by three things: the amount of
1803 space available (i.e., paper size and margins), the amount of
1804 space between systems, and the amount of space between staves
1808 * Flexible vertical spacing within systems::
1809 * Explicit staff and system positioning::
1810 * Vertical collision avoidance::
1814 @node Flexible vertical spacing within systems
1815 @subsection Flexible vertical spacing within systems
1817 @cindex distance between staves
1818 @cindex staff distance
1819 @cindex space between staves
1820 @cindex space inside systems
1822 Three separate mechanisms control the flexible vertical spacing
1823 within systems, one for each of the following categories:
1828 @emph{ungrouped staves},
1831 @emph{grouped staves} (staves within a staff-group such as
1832 @code{ChoirStaff}, etc.), and
1835 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1840 @c TODO: Clarify this. This almost implies that non-staff lines
1841 @c have NO effect on the spacing between staves. -mp
1843 The height of each system is determined in two steps. First, all
1844 of the staves are spaced according to the amount of space
1845 available. Then, the non-staff lines are distributed between the
1848 Note that the spacing mechanisms discussed in this section only
1849 control the vertical spacing of staves and non-staff lines within
1850 individual systems. The vertical spacing between separate
1851 systems, scores, markups, and margins is controlled by
1852 @code{\paper} variables, which are discussed in
1853 @ref{Flexible vertical spacing paper variables,,Flexible vertical spacing @code{@bs{}paper} variables}.
1856 * Within-system spacing properties::
1857 * Spacing of ungrouped staves::
1858 * Spacing of grouped staves::
1859 * Spacing of non-staff lines::
1863 @node Within-system spacing properties
1864 @unnumberedsubsubsec Within-system spacing properties
1866 @funindex staff-affinity
1867 @funindex staffgroup-staff-spacing
1868 @funindex staff-staff-spacing
1869 @funindex nonstaff-unrelatedstaff-spacing
1870 @funindex nonstaff-relatedstaff-spacing
1871 @funindex nonstaff-nonstaff-spacing
1872 @funindex default-staff-staff-spacing
1873 @funindex minimum-Y-extent
1874 @funindex extra-offset
1875 @funindex self-alignment-X
1877 @funindex VerticalAxisGroup
1879 The within-system vertical spacing mechanisms are controlled by
1880 two sets of grob properties. The first set is associated with the
1881 @code{VerticalAxisGroup} grob, which is created by all staves and
1882 non-staff lines. The second set is associated with the
1883 @code{StaffGrouper} grob, which can be created by staff-groups,
1884 but only if explicitly called. These properties are described
1885 individually at the end of this section.
1887 The names of these properties (except for @code{staff-affinity})
1888 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1889 @code{@var{item1}} and @code{@var{item2}} are the items to be
1890 spaced. Note that @code{@var{item2}} is not necessarily below
1891 @code{@var{item1}}; for example,
1892 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1893 non-staff line if @code{staff-affinity} is @code{UP}.
1895 Each distance is measured between the @emph{reference points} of
1896 the two items. The reference point for a staff is the vertical
1897 center of its @code{StaffSymbol} (i.e. the middle line if
1898 @code{line-count} is odd; the middle space if @code{line-count} is
1899 even). The reference points for individual non-staff lines are
1900 given in the following table:
1902 @multitable {Non-staff line} {Reference point}
1903 @headitem Non-staff line @tab Reference point
1904 @item @code{ChordNames} @tab baseline
1905 @item @code{NoteNames} @tab baseline
1906 @item @code{Lyrics} @tab baseline
1907 @item @code{Dynamics} @tab mid-height of @q{m}
1908 @item @code{FiguredBass} @tab highest point
1909 @item @code{FretBoards} @tab top line
1912 In the following image, horizontal lines indicate the positions
1913 of these reference points:
1915 @lilypond[quote,noragged-right,line-width=110\mm]
1916 #(define zero-space '((padding . -inf.0) (basic-distance . 0)))
1918 alignToZero = \with {
1919 \override VerticalAxisGroup.nonstaff-relatedstaff-spacing = #zero-space
1920 \override VerticalAxisGroup.nonstaff-nonstaff-spacing = #zero-space
1921 \override VerticalAxisGroup.staff-affinity = #DOWN
1922 \remove Text_engraver % avoid having two
1923 \consists Text_engraver
1925 lowerCaseChords = \with {
1926 chordNameLowercaseMinor = ##t
1929 #(define-music-function
1930 (parser location context)
1932 #{ s1*0^\markup { \upright {\typewriter #context } } #})
1935 \context { \Dynamics \alignToZero }
1936 \context { \FiguredBass \alignToZero }
1937 \context { \Lyrics \alignToZero }
1938 \context { \NoteNames \alignToZero }
1939 \context { \ChordNames \alignToZero \lowerCaseChords }
1940 \context { \FretBoards \alignToZero }
1943 \override DynamicText.self-alignment-X = #-1
1944 \override FretBoard.X-offset = #1.75
1945 \override InstrumentName.minimum-Y-extent = #'(-1 . 2)
1951 %% These contexts have reference points at the baseline:
1952 %% ChordNames, NoteNames, and Lyrics
1954 \new ChordNames { \chords { \labelContext "ChordNames" g1:m } }
1955 \new NoteNames { s1 |\labelContext "NoteNames" g1 | }
1956 \new Lyrics { \lyrics { \skip 1*2 | \labelContext "Lyrics" ghijk1 | } }
1957 \new RhythmicStaff \with { instrumentName = #"baseline " } s1*3
1960 %% The reference point for Dynamics is the midline of 'm' in the font
1962 \new Dynamics { \labelContext "Dynamics" s1\mp s\fp }
1963 \new RhythmicStaff \with { instrumentName = #"mid-height " } s1*3
1966 %% The reference point for FiguredBass is its highest point
1968 \new FiguredBass { \labelContext "FiguredBass" \figuremode { <6 5>1 } }
1969 \new RhythmicStaff \with { instrumentName = #"highest point " } s1
1972 %% The reference point for FretBoards is the top line
1973 \include "predefined-guitar-fretboards.ly"
1975 \new FretBoards { \labelContext "FretBoards" \chordmode { e1 } }
1976 \new RhythmicStaff \with { instrumentName = #"top line " } s1
1980 Each of the vertical spacing grob properties (except
1981 @code{staff-affinity}) uses the same alist structure as the
1982 @code{\paper} spacing variables discussed in
1983 @ref{Flexible vertical spacing paper variables,,Flexible vertical spacing @code{@bs{}paper} variables}.
1985 for modifying alists are discussed in @ref{Modifying alists}.
1986 Grob properties should be adjusted with an @code{\override} inside
1987 a @code{\score} or @code{\layout} block, and not inside a
1988 @code{\paper} block.
1990 The following example demonstrates the two ways these alists can
1991 be modified. The first declaration updates one key-value
1992 individually, and the second completely re-defines the property:
1996 \override VerticalAxisGroup.default-staff-staff-spacing.basic-distance = #10
2000 \override VerticalAxisGroup.default-staff-staff-spacing =
2001 #'((basic-distance . 10)
2002 (minimum-distance . 9)
2004 (stretchability . 10))
2008 To change any spacing settings globally, put them in the
2009 @code{\layout} block:
2015 \override VerticalAxisGroup.default-staff-staff-spacing.basic-distance = #10
2020 Standard settings for the vertical spacing grob properties are
2021 listed in @rinternals{VerticalAxisGroup} and
2022 @rinternals{StaffGrouper}. Default overrides for specific types
2023 of non-staff lines are listed in the relevant context descriptions
2024 in @rinternals{Contexts}.
2027 @subsubheading Properties of the @code{VerticalAxisGroup} grob
2029 @code{VerticalAxisGroup} properties are typically adjusted with an
2030 @code{\override} at the @code{Staff} level (or equivalent).
2033 @item staff-staff-spacing
2035 Used to determine the distance between the current staff and the
2036 staff just below it in the same system, even if one or more
2037 non-staff lines (such as @code{Lyrics}) are placed between the two
2038 staves. Does not apply to the bottom staff of a system.
2040 Initially, the @code{staff-staff-spacing} of a
2041 @code{VerticalAxisGroup} is a Scheme function that applies the
2042 properties of the @code{StaffGrouper} if the staff is part of a
2043 group, or the @code{default-staff-staff-spacing} of the staff
2044 otherwise. This allows staves to be spaced differently when they
2045 are grouped. For uniform spacing regardless of grouping, this
2046 function may be replaced by a flexible-spacing alist, using the
2047 complete-redefinition form of override shown above.
2049 @item default-staff-staff-spacing
2050 A flexible-spacing alist defining the @code{staff-staff-spacing} used for
2051 ungrouped staves, unless @code{staff-staff-spacing} has been explicitly
2052 set with an @code{\override}.
2054 @item staff-affinity
2055 The direction of the staff to use for spacing the current
2056 non-staff line. Choices are @code{UP}, @code{DOWN}, and
2057 @code{CENTER}. If @code{CENTER}, the non-staff line will be
2058 placed equidistant between the two nearest staves on either side,
2059 unless collisions or other spacing constraints prevent this.
2060 Adjacent non-staff lines should have non-increasing
2061 @code{staff-affinity} from top to bottom, e.g. a non-staff line
2062 set to @code{UP} should not immediately follow one that is set to
2063 @code{DOWN}. Non-staff lines at the top of a system should use
2064 @code{DOWN}; those at the bottom should use @code{UP}. Setting
2065 @code{staff-affinity} for a staff causes it to be treated as a
2066 non-staff line. Setting @code{staff-affinity} to @code{#f} causes
2067 a non-staff line to be treated as a staff. Setting
2068 @code{staff-affinity} to @code{UP}, @code{CENTER}, or @code{DOWN}
2069 causes a staff to be spaced as a non-staff line.
2071 @item nonstaff-relatedstaff-spacing
2072 The distance between the current non-staff line and the nearest
2073 staff in the direction of @code{staff-affinity}, if there are no
2074 non-staff lines between the two, and @code{staff-affinity} is
2075 either @code{UP} or @code{DOWN}. If @code{staff-affinity} is
2076 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
2077 for the nearest staves on @emph{both} sides, even if other
2078 non-staff lines appear between the current one and either of the
2079 staves. This means that the placement of a non-staff line depends
2080 on both the surrounding staves and the surrounding non-staff lines.
2081 Setting the @code{stretchability} of one of these types of spacing to
2082 a small value will make that spacing dominate. Setting the
2083 @code{stretchability} to a large value will make that spacing have
2086 @item nonstaff-nonstaff-spacing
2087 The distance between the current non-staff line and the next
2088 non-staff line in the direction of @code{staff-affinity}, if both
2089 are on the same side of the related staff, and
2090 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
2092 @item nonstaff-unrelatedstaff-spacing
2093 The distance between the current non-staff line and the staff in
2094 the opposite direction from @code{staff-affinity}, if there are no
2095 other non-staff lines between the two, and @code{staff-affinity}
2096 is either @code{UP} or @code{DOWN}. This can be used, for
2097 example, to require a minimum amount of padding between a
2098 @code{Lyrics} line and the staff to which it does not belong.
2102 @subsubheading Properties of the @code{StaffGrouper} grob
2104 @code{StaffGrouper} properties are typically adjusted with an
2105 @code{\override} at the @code{StaffGroup} level (or equivalent).
2108 @item staff-staff-spacing
2109 The distance between consecutive staves within the current
2110 staff-group. The @code{staff-staff-spacing} property of an
2111 individual staff's @code{VerticalAxisGroup} grob can be
2112 overriden with different spacing settings for that staff.
2114 @item staffgroup-staff-spacing
2115 The distance between the last staff of the current staff-group and
2116 the staff just below it in the same system, even if one or more
2117 non-staff lines (such as @code{Lyrics}) exist between the two
2118 staves. Does not apply to the bottom staff of a system. The
2119 @code{staff-staff-spacing} property of an individual staff's
2120 @code{VerticalAxisGroup} grob can be overriden with different
2121 spacing settings for that staff.
2126 @ref{Flexible vertical spacing paper variables,,Flexible vertical spacing @code{@bs{}paper} variables},
2127 @ref{Modifying alists}.
2130 @file{ly/engraver-init.ly},
2131 @file{scm/define-grobs.scm}.
2133 Internals Reference:
2134 @rinternals{Contexts},
2135 @rinternals{VerticalAxisGroup},
2136 @rinternals{StaffGrouper}.
2139 @node Spacing of ungrouped staves
2140 @unnumberedsubsubsec Spacing of ungrouped staves
2142 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
2143 @code{TabStaff}, etc.) are contexts that can contain one or more
2144 voice contexts, but cannot contain any other staves.
2146 The following properties affect the spacing of @emph{ungrouped}
2150 @item @code{VerticalAxisGroup} properties:
2152 @item @code{default-staff-staff-spacing}
2153 @item @code{staff-staff-spacing}
2157 These grob properties are described individually above; see
2158 @ref{Within-system spacing properties}.
2160 Additional properties are involved for staves that are part of a
2161 staff-group; see @ref{Spacing of grouped staves}.
2163 The following example shows how the @code{default-staff-staff-spacing}
2164 property can affect the spacing of ungrouped staves.
2165 The same overrides applied to @code{staff-staff-spacing} would
2166 have the same effect, but would also apply in cases where the staves
2167 are combined in a group or groups.
2169 @lilypond[verbatim,quote,staffsize=16]
2173 \override VerticalAxisGroup.default-staff-staff-spacing =
2174 #'((basic-distance . 8)
2175 (minimum-distance . 7)
2181 % The very low note here needs more room than 'basic-distance
2182 % can provide, so the distance between this staff and the next
2183 % is determined by 'padding.
2184 \new Staff { b,2 r | }
2186 % Here, 'basic-distance provides enough room, and there is no
2187 % need to compress the space (towards 'minimum-distance) to make
2188 % room for anything else on the page, so the distance between
2189 % this staff and the next is determined by 'basic-distance.
2190 \new Staff { \clef bass g2 r | }
2192 % By setting 'padding to a negative value, staves can be made to
2193 % collide. The lowest acceptable value for 'basic-distance is 0.
2195 \override VerticalAxisGroup.default-staff-staff-spacing =
2196 #'((basic-distance . 3.5)
2198 } { \clef bass g2 r | }
2199 \new Staff { \clef bass g2 r | }
2205 @file{scm/define-grobs.scm}.
2210 Internals Reference:
2211 @rinternals{VerticalAxisGroup}.
2214 @node Spacing of grouped staves
2215 @unnumberedsubsubsec Spacing of grouped staves
2217 In orchestral and other large scores, it is common to place staves
2218 in groups. The space between groups is typically larger than the
2219 space between staves of the same group.
2221 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2222 etc.) are contexts that can contain one or more staves
2225 The following properties affect the spacing of staves inside
2229 @item @code{VerticalAxisGroup} properties:
2231 @item @code{staff-staff-spacing}
2233 @item @code{StaffGrouper} properties:
2235 @item @code{staff-staff-spacing}
2236 @item @code{staffgroup-staff-spacing}
2240 These grob properties are described individually above; see
2241 @ref{Within-system spacing properties}.
2243 The following example shows how properties of the
2244 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2246 @lilypond[verbatim,quote,staffsize=16]
2250 \override StaffGrouper.staff-staff-spacing.padding = #0
2251 \override StaffGrouper.staff-staff-spacing.basic-distance = #1
2256 \new PianoStaff \with {
2257 \override StaffGrouper.staffgroup-staff-spacing.basic-distance = #20
2272 @file{scm/define-grobs.scm}.
2277 Internals Reference:
2278 @rinternals{VerticalAxisGroup},
2279 @rinternals{StaffGrouper}.
2282 @node Spacing of non-staff lines
2283 @unnumberedsubsubsec Spacing of non-staff lines
2285 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2286 etc.) are contexts whose layout objects are engraved like staves
2287 (i.e. in horizontal lines within systems). Specifically,
2288 non-staff lines are non-staff contexts that contain the
2289 @rinternals{Axis_group_engraver}.
2291 The following properties affect the spacing of non-staff lines:
2294 @item @code{VerticalAxisGroup} properties:
2296 @item @code{staff-affinity}
2297 @item @code{nonstaff-relatedstaff-spacing}
2298 @item @code{nonstaff-nonstaff-spacing}
2299 @item @code{nonstaff-unrelatedstaff-spacing}
2303 These grob properties are described individually above; see
2304 @ref{Within-system spacing properties}.
2306 The following example shows how the
2307 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2308 of consecutive non-staff lines. Here, by setting the
2309 @code{stretchability} key to a very high value, the lyrics are
2310 able to stretch much more than usual:
2312 @lilypond[verbatim,quote,staffsize=16]
2316 \override VerticalAxisGroup.nonstaff-nonstaff-spacing.stretchability = #1000
2323 \override VerticalAxisGroup.staff-staff-spacing = #'((basic-distance . 30))
2326 \override VerticalAxisGroup.staff-affinity = #UP
2329 \override VerticalAxisGroup.staff-affinity = #CENTER
2330 } \lyricmode { center }
2332 \override VerticalAxisGroup.staff-affinity = #DOWN
2333 } \lyricmode { down }
2340 @file{ly/engraver-init.ly},
2341 @file{scm/define-grobs.scm}.
2346 @c @lsr{spacing,page-spacing.ly},
2347 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2349 Internals Reference:
2350 @rinternals{Contexts},
2351 @rinternals{VerticalAxisGroup}.
2354 @node Explicit staff and system positioning
2355 @subsection Explicit staff and system positioning
2357 One way to understand the flexible vertical spacing mechanisms
2358 explained above is as a collection of settings that control the
2359 amount of vertical padding between staves and systems.
2361 It is possible to approach vertical spacing in a different way
2362 using @code{NonMusicalPaperColumn.line-break-system-details}.
2363 While the flexible vertical spacing mechanisms specify vertical
2364 padding, @code{NonMusicalPaperColumn.line-break-system-details}
2365 can specify exact vertical positions on the page.
2367 @code{NonMusicalPaperColumn.line-break-system-details} accepts
2368 an associative list of three different settings:
2371 @item @code{X-offset}
2372 @item @code{Y-offset}
2373 @item @code{alignment-distances}
2376 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2377 below, can occur in any of three different places in an input file:
2380 @item in the middle of note entry directly
2381 @item in a @code{\context} block
2382 @item in the @code{\with} block
2385 When we override @code{NonMusicalPaperColumn}, we use the usual
2386 @code{\override} command in @code{\context} blocks and in the
2387 @code{\with} block. On the other hand, when we override
2388 @code{NonMusicalPaperColumn} in the middle of note entry,
2389 use the special @code{\overrideProperty} command. Here are some
2390 example @code{NonMusicalPaperColumn} overrides with the special
2391 @code{\overrideProperty} command:
2394 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2397 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2400 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2404 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2405 #'((alignment-distances . (15)))
2407 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2410 (alignment-distances . (15)))
2413 To understand how each of these different settings work, we begin
2414 by looking at an example that includes no overrides at all.
2416 @c \book { } is required in these examples to ensure the spacing
2417 @c overrides can be seen between systems. -np
2419 @lilypond[verbatim,quote,staffsize=16]
2420 \header { tagline = ##f }
2421 \paper { left-margin = 0\mm }
2431 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2434 \repeat unfold 15 { d'4 d' d' d' }
2441 This score isolates line- and page-breaking information in a dedicated
2442 voice. This technique of creating a breaks voice will help keep layout
2443 separate from music entry as our example becomes more complicated.
2444 See @ref{Explicit breaks}.
2446 Explicit @code{\breaks} evenly divide the music into six measures per
2447 line. Vertical spacing results from LilyPond's defaults. To set
2448 the vertical startpoint of each system explicitly, we can set
2449 the @code{Y-offset} pair in the @code{line-break-system-details}
2450 attribute of the @code{NonMusicalPaperColumn} grob:
2452 @lilypond[verbatim,quote,staffsize=16]
2453 \header { tagline = ##f }
2454 \paper { left-margin = 0\mm }
2460 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2463 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2466 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2470 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2473 \repeat unfold 15 { d'4 d' d' d' }
2480 Note that @code{line-break-system-details} takes an associative list of
2481 potentially many values, but that we set only one value here. Note,
2482 too, that the @code{Y-offset} property here determines the exact vertical
2483 position on the page at which each new system will render.
2485 Now that we have set the vertical startpoint of each system
2486 explicitly, we can also set the vertical distances between staves
2487 within each system manually. We do this using the @code{alignment-distances}
2488 subproperty of @code{line-break-system-details}.
2490 @lilypond[verbatim,quote,staffsize=16]
2491 \header { tagline = ##f }
2492 \paper { left-margin = 0\mm }
2498 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2500 (alignment-distances . (10)))
2502 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2504 (alignment-distances . (15)))
2506 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2508 (alignment-distances . (20)))
2511 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2514 \repeat unfold 15 { d'4 d' d' d' }
2521 Note that here we assign two different values to the
2522 @code{line-break-system-details} attribute of the
2523 @code{NonMusicalPaperColumn} grob. Though the
2524 @code{line-break-system-details} attribute alist accepts many
2525 additional spacing parameters (including, for example, a corresponding
2526 @code{X-offset} pair), we need only set the @code{Y-offset} and
2527 @code{alignment-distances} pairs to control the vertical startpoint of
2528 every system and every staff. Finally, note that @code{alignment-distances}
2529 specifies the vertical positioning of staves but not of staff groups.
2531 @lilypond[verbatim,quote,staffsize=16]
2532 \header { tagline = ##f }
2533 \paper { left-margin = 0\mm }
2539 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2541 (alignment-distances . (30 10)))
2543 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2545 (alignment-distances . (10 10)))
2547 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2549 (alignment-distances . (10 30)))
2552 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2555 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2556 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2563 Some points to consider:
2566 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2567 do not count as a staff.
2569 @item The units of the numbers passed to @code{X-offset},
2570 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2571 of the distance between adjacent staff lines. Positive values move staves
2572 and lyrics up, negative values move staves and lyrics down.
2574 @item Because the @code{NonMusicalPaperColumn.line-break-system-details}
2575 settings given here allow the positioning of staves and systems anywhere
2576 on the page, it is possible to violate paper or margin boundaries or even
2577 to print staves or systems on top of one another. Reasonable values
2578 passed to these different settings will avoid this.
2586 @node Vertical collision avoidance
2587 @subsection Vertical collision avoidance
2589 @funindex outside-staff-priority
2590 @funindex outside-staff-padding
2591 @funindex outside-staff-horizontal-padding
2593 Intuitively, there are some objects in musical notation that belong
2594 to the staff and there are other objects that should be placed outside
2595 the staff. Objects belonging outside the staff include things such as
2596 rehearsal marks, text and dynamic markings (from now on, these will
2597 be called outside-staff objects). LilyPond's rule for the
2598 vertical placement of outside-staff objects is to place them as close
2599 to the staff as possible but not so close that they collide with
2602 LilyPond uses the @code{outside-staff-priority} property to determine
2603 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2604 is a number, the grob is an outside-staff object. In addition,
2605 @code{outside-staff-priority} tells LilyPond in which order the objects
2608 First, LilyPond places all the objects that do not belong outside
2609 the staff. Then it sorts the outside-staff objects according to their
2610 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
2611 takes the outside-staff objects and places them so that they do
2612 not collide with any objects that have already been placed. That
2613 is, if two outside-staff grobs are competing for the same space, the one
2614 with the lower @code{outside-staff-priority} will be placed closer to
2617 @lilypond[quote,ragged-right,relative=2,verbatim]
2620 \once \override TextScript.outside-staff-priority = #1
2621 c4_"Text"\pp % this time the text will be closer to the staff
2623 % by setting outside-staff-priority to a non-number,
2624 % we disable the automatic collision avoidance
2625 \once \override TextScript.outside-staff-priority = ##f
2626 \once \override DynamicLineSpanner.outside-staff-priority = ##f
2627 c4_"Text"\pp % now they will collide
2630 The vertical padding around outside-staff objects
2631 can be controlled with @code{outside-staff-padding}.
2633 @lilypond[quote,ragged-right,relative=2,verbatim,staffsize=18]
2634 \once \override TextScript.outside-staff-padding = #0
2635 a4-"outside-staff-padding = #0"
2636 \once \override TextScript.outside-staff-padding = #3
2637 d-"outside-staff-padding = #3"
2638 c-"default outside-staff-padding"
2639 b-"default outside-staff-padding"
2644 By default, outside-staff objects are placed so they avoid
2645 a horizontal collision with previously-positioned grobs. This
2646 can lead to situations in which objects are placed close to each
2648 As shown in the example below, setting @code{outside-staff-horizontal-padding}
2649 increases the horizontal spacing required, and in this case moves the text up
2650 to prevent it from getting too close to the ledger lines.
2652 @lilypond[quote,ragged-right,relative=2,verbatim]
2655 \once \override TextScript.outside-staff-horizontal-padding = #1
2664 @node Horizontal spacing
2665 @section Horizontal spacing
2667 @cindex horizontal spacing
2668 @cindex spacing, horizontal
2671 * Horizontal spacing overview::
2672 * New spacing area::
2673 * Changing horizontal spacing::
2675 * Proportional notation::
2679 @node Horizontal spacing overview
2680 @subsection Horizontal spacing overview
2682 The spacing engine translates differences in durations into stretchable
2683 distances (@q{springs}) of differing lengths. Longer durations get
2684 more space, shorter durations get less. The shortest durations get a
2685 fixed amount of space (which is controlled by
2686 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2687 object). The longer the duration, the more space it gets: doubling a
2688 duration adds @code{spacing-increment} of space to the note.
2690 For example, the following piece contains lots of half, quarter, and
2691 8th notes; the eighth note is followed by 1 note head width (NHW).
2692 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2694 @lilypond[quote,verbatim,relative=1]
2700 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2701 approximately the width of a note head, and
2702 @code{shortest-duration-space} is set to 2.0, meaning that the
2703 shortest note gets 2.4 staff space (2.0 times the
2704 @code{spacing-increment}) of horizontal space. This space is counted
2705 from the left edge of the symbol, so the shortest notes are generally
2706 followed by one NHW of space.
2708 If one would follow the above procedure exactly, then adding a single
2709 32nd note to a score that uses 8th and 16th notes, would widen up the
2710 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2711 thus adding 1 NHW to every note. To prevent this, the shortest
2712 duration for spacing is not the shortest note in the score, but rather
2713 the one which occurs most frequently.
2716 The most common shortest duration is determined as follows: in every
2717 measure, the shortest duration is determined. The most common shortest
2718 duration is taken as the basis for the spacing, with the stipulation
2719 that this shortest duration should always be equal to or shorter than
2720 an 8th note. The shortest duration is printed when you run
2721 @code{lilypond} with the @option{--verbose} option.
2723 These durations may also be customized. If you set the
2724 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2725 this sets the base duration for spacing. The maximum duration for this
2726 base (normally an 8th), is set through @code{base-shortest-duration}.
2728 @funindex common-shortest-duration
2729 @funindex base-shortest-duration
2730 @funindex stem-spacing-correction
2733 Notes that are even shorter than the common shortest note are
2734 followed by a space that is proportional to their duration relative to
2735 the common shortest note. So if we were to add only a few 16th notes
2736 to the example above, they would be followed by half a NHW:
2738 @lilypond[quote,verbatim,relative=2]
2739 c2 c4. c8 | c4. c16[ c] c4. c8 | c8 c c4 c c
2743 In the @emph{Essay on automated music engraving}, it was explained
2744 that stem directions influence spacing (see
2745 @ressay{Optical spacing}). This is controlled with the
2746 @code{stem-spacing-correction} property in the
2747 @rinternals{NoteSpacing}, object. These are generated for every
2748 @rinternals{Voice} context. The @code{StaffSpacing} object
2749 (generated in @rinternals{Staff} context) contains the same
2750 property for controlling the stem/bar line spacing. The following
2751 example shows these corrections, once with default settings, and
2752 once with exaggerated corrections:
2754 @lilypond[quote,ragged-right]
2758 \override Staff.NoteSpacing.stem-spacing-correction = #1.5
2759 \override Staff.StaffSpacing.stem-spacing-correction = #1.5
2765 Proportional notation is supported; see @ref{Proportional notation}.
2768 Essay on automated music engraving:
2769 @ressay{Optical spacing}.
2774 Internals Reference:
2775 @rinternals{SpacingSpanner},
2776 @rinternals{NoteSpacing},
2777 @rinternals{StaffSpacing},
2778 @rinternals{NonMusicalPaperColumn}.
2781 There is no convenient mechanism to manually override spacing. The
2782 following work-around may be used to insert extra space into a score,
2783 adjusting the padding value as necessary.
2786 \override Score.NonMusicalPaperColumn.padding = #10
2789 No work-around exists for decreasing the amount of space.
2792 @node New spacing area
2793 @subsection New spacing area
2795 @funindex \newSpacingSection
2796 @cindex new spacing area
2797 @cindex spacing area, new
2798 @cindex notes, spacing horizontally
2800 New sections with different spacing parameters can be started with
2801 @code{newSpacingSection}. This is useful when there are
2802 sections with a different notions of long and short notes.
2804 In the following example, the time signature change introduces a new
2805 section, and hence the 16ths notes are automatically spaced slightly
2808 @lilypond[relative=1,verbatim,quote]
2811 c8 c c4 c16[ c c8] c4
2817 The @code{\newSpacingSection} command creates a new
2818 @code{SpacingSpanner} object at that musical moment.
2819 If the automatic spacing adjustments do not give the required spacing,
2820 manual @code{\override}s may be applied to its properties. These must
2821 be applied at the same musical moment as the @code{\newSpacingSection}
2822 command itself. They will then affect the spacing of all the following
2823 music until the properties are changed in a new spacing section, for
2826 @lilypond[relative=1,verbatim,quote]
2830 \override Score.SpacingSpanner.spacing-increment = #2
2833 \revert Score.SpacingSpanner.spacing-increment
2842 Internals Reference:
2843 @rinternals{SpacingSpanner}.
2846 @node Changing horizontal spacing
2847 @subsection Changing horizontal spacing
2849 Horizontal spacing may be altered with the
2850 @code{base-shortest-duration} property. Here
2851 we compare the same music; once without altering
2852 the property, and then altered. Larger values
2853 of @code{ly:make-moment} will produce smaller
2854 music. Note that @code{ly:make-moment} constructs
2855 a duration, so @code{1 4} is a longer duration
2858 @lilypond[verbatim,line-width=12\cm]
2861 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2862 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2863 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2864 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2869 @lilypond[verbatim,line-width=12\cm]
2872 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2873 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2874 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2875 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2880 \override SpacingSpanner.base-shortest-duration = #(ly:make-moment 1/16)
2889 By default, spacing in tuplets depends on various non-duration
2890 factors (such as accidentals, clef changes, etc). To disregard
2891 such symbols and force uniform equal-duration spacing, use
2892 @code{Score.SpacingSpanner.uniform-stretching}. This
2893 property can only be changed at the beginning of a score,
2895 @lilypond[quote,ragged-right,verbatim]
2899 \tuplet 5/4 { c8 c c c c } c8 c c c
2902 c8 c c c \tuplet 5/4 { c8 c c c c }
2908 \override SpacingSpanner.uniform-stretching = ##t
2914 When @code{strict-note-spacing} is set, notes are spaced without
2915 regard for clefs, bar lines, and grace notes,
2917 @lilypond[quote,ragged-right,relative=2,verbatim]
2918 \override Score.SpacingSpanner.strict-note-spacing = ##t
2919 \new Staff { c8[ c \clef alto c \grace { c16 c } c8 c c] c32[ c] }
2928 @subsection Line width
2931 @cindex breaking pages
2934 @funindex line-width
2935 @funindex ragged-right
2936 @funindex ragged-last
2938 @c Although line-width can be set in \layout, it should be set in paper
2939 @c block, to get page layout right.
2940 @c Setting indent in \paper block makes not much sense, but it works.
2942 @c Bit verbose and vague, use examples?
2943 The most basic settings influencing the spacing are @code{indent} and
2944 @code{line-width}. They are set in the @code{\layout} block. They
2945 control the indentation of the first line of music, and the lengths of
2948 If @code{ragged-right} is set to true in the @code{\layout} block, then
2949 systems ends at their natural horizontal length, instead of being spread
2950 horizontally to fill the whole line. This is useful for
2951 short fragments, and for checking how tight the natural spacing is.
2952 The normal default setting is false, but if the score has only one
2953 system the default value is true.
2956 @cindex vertical spacing
2958 The option @code{ragged-last} is similar to @code{ragged-right}, but
2959 only affects the last line of the piece. No restrictions are put on
2960 that line. The result is similar to formatting text paragraphs. In a
2961 paragraph, the last line simply takes its natural horizontal length.
2962 @c Note that for text there are several options for the last line.
2963 @c While Knuth TeX uses natural length, lead typesetters use the same
2964 @c stretch as the previous line. eTeX uses \lastlinefit to
2965 @c interpolate between both these solutions.
2980 @node Proportional notation
2981 @subsection Proportional notation
2983 LilyPond supports proportional notation, a type of horizontal spacing
2984 in which each note consumes an amount of horizontal space exactly
2985 equivalent to its rhythmic duration. This type of proportional spacing
2986 is comparable to horizontal spacing on top of graph paper. Some late
2987 20th- and early 21st-century scores use proportional notation to
2988 clarify complex rhythmic relationships or to facilitate the placement
2989 of timelines or other graphics directly in the score.
2991 LilyPond supports five different settings for proportional notation,
2992 which may be used together or alone:
2995 @item @code{proportionalNotationDuration}
2996 @item @code{uniform-stretching}
2997 @item @code{strict-note-spacing}
2998 @item @code{\remove "Separating_line_group_engraver"}
2999 @item @code{\override PaperColumn.used = ##t}
3002 In the examples that follow, we explore these five different
3003 proportional notation settings and examine how these settings interact.
3005 We start with the following one-measure example, which uses classical
3006 spacing with ragged-right turned on.
3008 @c The initial pitch is not necessary as long as RhythmicStaff is
3009 @c not preceded by other material in the score, but we don't want
3011 @lilypond[quote,verbatim,ragged-right]
3014 \new RhythmicStaff {
3015 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3021 Notice that the half note which begins the measure takes up far less
3022 than half of the horizontal space of the measure. Likewise, the
3023 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
3024 which end the measure together take up far more than half the
3025 horizontal space of the measure.
3027 In classical engraving, this spacing may be exactly what we want
3028 because we can borrow horizontal space from the half note and conserve
3029 horizontal space across the measure as a whole.
3031 On the other hand, if we want to insert a measured timeline or other
3032 graphic above or below our score, we need proportional notation. We
3033 turn proportional notation on with the proportionalNotationDuration
3036 @lilypond[quote,verbatim,ragged-right]
3039 \new RhythmicStaff {
3040 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3046 proportionalNotationDuration = #(ly:make-moment 1/20)
3052 The half note at the beginning of the measure and the faster notes in
3053 the second half of the measure now occupy equal amounts of horizontal
3054 space. We could place a measured timeline or graphic above or below
3057 The @code{proportionalNotationDuration} setting is a context setting
3058 that lives in @code{Score}. Remember that context settings can appear
3059 in one of three locations within our input file -- in a @code{\with}
3060 block, in a @code{\context} block, or directly in music entry preceded
3061 by the @code{\set} command. As with all context settings, users can
3062 pick which of the three different locations they would like to
3063 set @code{proportionalNotationDuration} in to.
3065 The @code{proportionalNotationDuration} setting takes a single argument,
3066 which is the reference duration against that all music will be spaced.
3067 The LilyPond Scheme function @code{make-moment} takes two arguments
3068 -- a numerator and denominator which together express some fraction of
3069 a whole note. The call @code{(ly:make-moment 1/20)} therefore produces
3070 a reference duration of a twentieth note. Values such as
3071 @code{(ly:make-moment 1/16)}, @code{(ly:make-moment 1/8)}, and
3072 @code{(ly:make-moment 3/97)} are all possible as well.
3074 How do we select the right reference duration to pass to
3075 @code{proportionalNotationDuration}? Usually by a process of trial
3076 and error, beginning with a duration close to the fastest (or smallest)
3077 duration in the piece. Smaller reference durations space music loosely;
3078 larger reference durations space music tightly.
3080 @lilypond[quote,verbatim,ragged-right]
3083 \new RhythmicStaff {
3084 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3090 proportionalNotationDuration = #(ly:make-moment 1/8)
3097 \new RhythmicStaff {
3098 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3104 proportionalNotationDuration = #(ly:make-moment 1/16)
3111 \new RhythmicStaff {
3112 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3118 proportionalNotationDuration = #(ly:make-moment 1/32)
3124 Note that too large a reference duration -- such as the eighth note,
3125 above -- spaces music too tightly and can cause note head collisions.
3126 Also that proportional notation in general takes up more horizontal
3127 space than classical spacing. Proportional spacing provides rhythmic
3128 clarity at the expense of horizontal space.
3130 Next we examine how to optimally space overlapping tuplets.
3132 We start by examining what happens to our original example, with
3133 classical spacing, when we add a second staff with a different type of
3136 @lilypond[quote,verbatim,ragged-right]
3139 \new RhythmicStaff {
3140 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3142 \new RhythmicStaff {
3143 \tuplet 9/8 { c8 8 8 8 8 8 8 8 8 }
3149 The spacing is bad because the evenly spaced notes of the bottom staff
3150 do not stretch uniformly. Classical engravings include very few complex
3151 triplets and so classical engraving rules can generate this type of
3152 result. Setting @code{proportionalNotationDuration} fixes this.
3154 @lilypond[quote,verbatim,ragged-right]
3157 \new RhythmicStaff {
3158 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3160 \new RhythmicStaff {
3161 \tuplet 9/8 { c8 8 8 8 8 8 8 8 8 }
3167 proportionalNotationDuration = #(ly:make-moment 1/20)
3173 But if we look very carefully we can see that notes of the second half
3174 of the 9-tuplet space ever so slightly more widely than the notes
3175 of the first half of the 9-tuplet. To ensure uniform stretching, we
3176 turn on @code{uniform-stretching}, which is a property of
3177 @code{SpacingSpanner}.
3179 @lilypond[quote,verbatim,ragged-right]
3182 \new RhythmicStaff {
3183 c2 16 16 16 16 \tuplet 5/4 { 16 16 16 16 16 }
3185 \new RhythmicStaff {
3186 \tuplet 9/8 { c8 8 8 8 8 8 8 8 8 }
3192 proportionalNotationDuration = #(ly:make-moment 1/20)
3193 \override SpacingSpanner.uniform-stretching = ##t
3199 Our two-staff example now spaces exactly, our rhythmic
3200 relationships are visually clear, and we can include a measured
3201 timeline or graphic if we want.
3203 Note that the LilyPond's proportional notation package expects
3204 that all proportional scores set the SpacingSpanner's
3205 'uniform-stretching attribute to ##t. Setting
3206 proportionalNotationDuration without also setting the
3207 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3208 example, cause Skips to consume an incorrect amount of horizontal
3211 The SpacingSpanner is an abstract grob that lives in the Score
3212 context. As with our settings of proportionalNotationDuration,
3213 overrides to the SpacingSpanner can occur in any of three
3214 different places in our input file – in the Score \with block, in
3215 a Score \context block, or in note entry directly.
3217 There is by default only one @code{SpacingSpanner} per @code{Score}. This
3218 means that, by default, @code{uniform-stretching} is either turned on for the
3219 entire score or turned off for the entire score. We can, however,
3220 override this behavior and turn on different spacing features at
3221 different places in the score. We do this with the command
3222 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
3224 Next we examine the effects of the @code{Separating_line_group_engraver} and
3225 see why proportional scores frequently remove this engraver. The following
3226 example shows that there is a small amount of @qq{prefatory} space
3227 just before the first note in each system.
3229 @lilypond[quote,verbatim,ragged-right]
3242 The amount of this prefatory space is the same whether after a time
3243 signature, a key signature or a clef. @code{Separating_line_group_engraver}
3244 is responsible for this space. Removing @code{Separating_line_group_engraver}
3245 reduces this space to zero.
3247 @lilypond[quote,verbatim,ragged-right]
3253 \remove "Separating_line_group_engraver"
3261 non-musical elements like time signatures, key signatures, clefs and
3262 accidentals are problematic in proportional notation. None of these
3263 elements has rhythmic duration. But all of these elements consume
3264 horizontal space. Different proportional scores approach these
3265 problems differently.
3267 It may be possible to avoid spacing problems with key signatures
3268 simply by not having any. This is a valid option since most
3269 proportional scores are contemporary music. The same may be true
3270 of time signatures, especially for those scores
3271 that include a measured timeline or other graphic. But these scores
3272 are exceptional and most proportional scores include at least some
3273 time signatures. Clefs and accidentals are even more essential.
3275 So what strategies exist for spacing non-musical elements in a
3276 proportional context? One good option is the @code{strict-note-spacing}
3277 property of @code{SpacingSpanner}. Compare the two scores below:
3279 @lilypond[quote,verbatim,ragged-right]
3281 \set Score.proportionalNotationDuration = #(ly:make-moment 1/16)
3282 c''8 8 8 \clef alto d'2 2
3286 \set Score.proportionalNotationDuration = #(ly:make-moment 1/16)
3287 \override Score.SpacingSpanner.strict-note-spacing = ##t
3288 c''8 8 8 \clef alto d'2 2
3292 Both scores are proportional, but the spacing in the first score
3293 is too loose because of the clef change. The spacing of the second
3294 score remains strict, however, because strict-note-spacing is
3295 turned on. Turning on strict-note-spacing causes the width of
3296 time signatures, key signatures, clefs and accidentals to play no
3297 part in the spacing algorithm.
3299 In addition to the settings given here, there are other settings
3300 that frequently appear in proportional scores. These include:
3303 @item @code{\override SpacingSpanner.strict-grace-spacing = ##t}
3304 @item @code{\set tupletFullLength = ##t}
3305 @item @code{\override Beam.breakable = ##t}
3306 @item @code{\override Glissando.breakable = ##t}
3307 @item @code{\override TextSpanner.breakable = ##t}
3308 @item @code{\remove "Forbid_line_break_engraver" in the Voice context}
3311 These settings space grace notes strictly, extend tuplet brackets to
3312 mark both rhythmic start- and stop-points, and allow spanning elements
3313 to break across systems and pages. See the respective parts of the manual
3314 for these related settings.
3318 @ref{New spacing area}.
3324 @node Fitting music onto fewer pages
3325 @section Fitting music onto fewer pages
3327 Sometimes you can end up with one or two staves on a second
3328 (or third, or fourth@dots{}) page. This is annoying, especially
3329 if you look at previous pages and it looks like there is plenty
3330 of room left on those.
3332 When investigating layout issues, @code{annotate-spacing} is an
3333 invaluable tool. This command prints the values of various layout
3334 spacing variables; for more details see the following section,
3335 @ref{Displaying spacing}.
3338 * Displaying spacing::
3339 * Changing spacing::
3343 @node Displaying spacing
3344 @subsection Displaying spacing
3346 @funindex annotate-spacing
3347 @cindex spacing, display of layout
3349 To graphically display the dimensions of vertical layout variables
3350 that may be altered for page formatting, set
3351 @code{annotate-spacing} in the @code{\paper} block:
3353 @lilypond[verbatim,quote,papersize=a6landscape]
3356 \paper { annotate-spacing = ##t }
3362 All layout dimensions are displayed in staff-spaces, regardless
3363 of the units specified in the @code{\paper} or @code{\layout} block.
3364 In the above example, @code{paper-height} has a value of 59.75
3365 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3366 default value). Note that:
3368 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3371 @tab = (25.4/72.27) mm
3374 @tab = (@code{staff-size})/4 pts
3376 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3381 In this case, one @code{staff-space} is approximately equal to
3382 1.757mm. Thus the @code{paper-height} measurement of 59.75
3383 @code{staff-spaces} is equivalent to 105 millimeters, the height
3384 of @code{a6} paper in landscape orientation. The pairs
3385 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3386 edge and @var{b} the upper edge of the interval.
3390 @ref{Setting the staff size}.
3396 @node Changing spacing
3397 @subsection Changing spacing
3399 The output of @code{annotate-spacing} reveals vertical dimensions
3400 in great detail. For details about modifying margins and other
3401 layout variables, see @ref{Page layout}.
3403 Other than margins, there are a few other options to save space:
3407 Force systems to move as close together as possible (to fit as
3408 many systems as possible onto a page) while being spaced so that
3409 there is no blank space at the bottom of the page.
3413 system-system-spacing = #'((basic-distance . 0.1) (padding . 0))
3414 ragged-last-bottom = ##f
3420 Force the number of systems. This can help in two ways. Just
3421 setting a value, even the same value as the number of systems
3422 being typeset by default, will sometimes cause more systems to
3423 be fitted onto each page, as an estimation step is then bypassed,
3424 giving a more accurate fit to each page. Also, forcing an actual
3425 reduction in the number of systems may save a further page. For
3426 example, if the default layout has 11 systems, the following
3427 assignment will force a layout with 10 systems.
3436 Force the number of pages. For example, the following
3437 assignment will force a layout with 2 pages.
3446 Avoid (or reduce) objects that increase the vertical size of a
3447 system. For example, volta repeats (or alternate repeats) require
3448 extra space. If these repeats are spread over two systems, they
3449 will take up more space than one system with the volta repeats and
3450 another system without. For example, dynamics that @q{stick out} of
3451 a system can be moved closer to the staff:
3453 @lilypond[verbatim,quote,relative=1]
3455 e4 c g-\tweak X-offset #-2.7 \f c
3459 Alter the horizontal spacing via @code{SpacingSpanner}. For more
3460 details, see @ref{Changing horizontal spacing}. The following
3461 example illustrates the default spacing:
3463 @lilypond[verbatim,quote]
3476 The next example modifies @code{common-shortest-duration} from a
3477 value of @code{1/4} to @code{1/2}. The quarter note is the most
3478 common and shortest duration in this example, so by making this
3479 duration longer, a @q{squeezing} effect occurs:
3481 @lilypond[verbatim,quote]
3493 \override SpacingSpanner.common-shortest-duration =
3494 #(ly:make-moment 1/2)
3501 The @code{common-shortest-duration} property cannot be modified
3502 dynamically, so it must always be placed in a @code{\context}
3503 block so that it applies to the whole score.
3510 @ref{Changing horizontal spacing}.