1 @c -*- coding: utf-8; mode: texinfo; -*-
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
6 When revising a translation, copy the HEAD committish of the
7 version that you are working on. For details, see the Contributors'
8 Guide, node Updating translation committishes..
16 Negative numbers are allowed:
17 > Are you sure? The following works well
19 > first-page-number = -2
21 > and prints page number -1 on the second page, for example.
24 In 5.2.1 the @refbugs (line 495 in spacing.itely on master) it
27 "@code{layout-set-staff-size} does not change the distance between
31 Could we add a sentence:
32 "Use instead the pair fontSize = #@var{N}
33 \override StaffSymbol.staff-space = #(magstep
35 inside the Staff context to change the size of the font and the
37 staff lines accordingly."
39 Actually I found, that the @internalsref{StaffSymbol} at line 481
40 sends to an incomplete
41 documentation. The property staff-space is not explained here. I
42 thought Y-extent might be of
43 help, but it is in turn explained by x-space which again is
44 missing from the list. Who has the
45 knowledge to fix this?
49 http://code.google.com/p/lilypond/issues/detail?id=68
55 @chapter Spacing issues
57 The global paper layout is determined by three factors: the page layout, the
58 line breaks, and the spacing. These all influence each other. The
59 choice of spacing determines how densely each system of music is set.
60 This influences where line breaks are chosen, and thus ultimately, how
61 many pages a piece of music takes.
63 Globally speaking, this procedure happens in four steps: first,
64 flexible distances (@q{springs}) are chosen, based on durations. All
65 possible line breaking combinations are tried, and a @q{badness} score
66 is calculated for each. Then the height of each possible system is
67 estimated. Finally, a page breaking and line breaking combination is chosen
68 so that neither the horizontal nor the vertical spacing is too cramped
71 Two types of blocks can contain layout settings:
72 @code{\paper @{@dots{}@}} and @code{\layout @{@dots{}@}}. The
73 @code{\paper} block contains page layout settings that are expected
74 to be the same for all scores in a book or bookpart, such as the
75 paper height, or whether to print page numbers, etc. See
76 @ref{Page layout}. The @code{\layout} block contains score layout
77 settings, such as the number of systems to use, or the space
78 between staff-groups, etc. See @ref{Score layout}.
85 * Horizontal spacing::
86 * Fitting music onto fewer pages::
93 This section discusses page layout options for the @code{\paper}
98 * Paper size and automatic scaling::
99 * Fixed vertical spacing \paper variables::
100 * Flexible vertical spacing \paper variables::
101 * Horizontal spacing \paper variables::
102 * Other \paper variables::
106 @node The \paper block
107 @subsection The @code{\paper} block
109 @code{\paper} blocks may be placed in three different places to form
110 a descending hierarchy of @code{\paper} blocks:
115 At the top of the input file, before all @code{\book},
116 @code{\bookpart}, and @code{\score} blocks.
119 Within a @code{\book} block but outside all the @code{\bookpart} and
120 @code{\score} blocks within that book.
123 Within a @code{\bookpart} block but outside all @code{\score} blocks
124 within that bookpart.
128 A @code{\paper} block cannot be placed within a @code{\score} block.
130 The values of the fields filter down this hierarchy, with the values
131 set higher in the hierarchy persisting unless they are over-ridden
132 by a value set lower in the hierarchy.
134 Several @code{\paper} blocks can appear at each of the levels, for
135 example as parts of several @code{\include}d files. If so, the
136 fields at each level are merged, with values encountered last taking
137 precedence if duplicated fields appear.
139 Settings that can appear in a @code{\paper} block include:
144 the @code{set-paper-size} scheme function,
147 @code{\paper} variables used for customizing page layout, and
150 markup definitions used for customizing the layout of headers,
155 The @code{set-paper-size} function is discussed in the next
156 section, @ref{Paper size and automatic scaling}. The
157 @code{\paper} variables that deal with page layout are discussed
158 in later sections. The markup definitions that deal with headers,
159 footers, and titles are discussed in
160 @ref{Custom titles headers and footers}.
162 Most @code{\paper} variables will only work in a @code{\paper}
163 block. The few that will also work in a @code{\layout} block are
164 listed in @ref{The \layout block}.
166 Except when specified otherwise, all @code{\paper} variables that
167 correspond to distances on the page are measured in millimeters,
168 unless a different unit is specified by the user. For example,
169 the following declaration sets @code{top-margin} to ten
178 To set it to @code{0.5} inches, use the @code{\in} unit suffix:
186 The available unit suffixes are @code{\mm}, @code{\cm},
187 @code{\in}, and @code{\pt}. These units are simple values for
188 converting from millimeters; they are defined in
189 @file{ly/paper-defaults-init.ly}. For the sake of clarity, when
190 using millimeters, the @code{\mm} is typically included in the
191 code, even though it is not technically necessary.
193 It is also possible to define @code{\paper} values using Scheme.
194 The Scheme equivalent of the above example is:
198 #(define top-margin (* 0.5 in))
204 @ref{Paper size and automatic scaling},
205 @ref{Custom titles headers and footers},
206 @ref{The \layout block}.
209 @file{ly/paper-defaults-init.ly}.
212 @node Paper size and automatic scaling
213 @subsection Paper size and automatic scaling
221 * Setting the paper size::
222 * Automatic scaling to paper size::
226 @node Setting the paper size
227 @unnumberedsubsubsec Setting the paper size
229 @q{A4} is the default value when no explicit paper size is set. However,
230 there are two functions that can be used to change it
231 @code{set-default-paper-size},
234 #(set-default-paper-size "quarto")
237 which must always be placed at the toplevel scope. and
238 @code{set-paper-size},
242 #(set-paper-size "tabloid")
246 which must always be placed in a @code{\paper} block.
248 If the @code{set-default-paper-size} function is used in the toplevel
249 scope, it must come before the any @code{\paper} block.
250 @code{set-default-paper-size} sets the paper size for all pages,
251 whereas @code{set-paper-size} only sets the paper size for the pages
252 that the @code{\paper} block applies to. For example, if the
253 @code{\paper} block is at the top of the file, then it will apply the
254 paper size to all pages. If the @code{\paper} block is inside a
255 @code{\book}, then the paper size will only apply to that book.
257 When the @code{set-paper-size} function is used, it must be
258 placed @emph{before} any other functions used within the same
259 @code{\paper} block. See @ref{Automatic scaling to paper size}.
261 Paper sizes are defined in @file{scm/paper.scm}, and while it is
262 possible to add custom sizes, they will be overwritten on subsequent
263 software updates. The available paper sizes are listed in
264 @ref{Predefined paper sizes}.
266 @c An appendix entry exists for paper sizes but is not auto-generated
268 The following command can be used in the file to add a custom paper size
269 which can then be used with @code{set-default-paper-size} or
270 @code{set-paper-size} as appropriate,
273 #(set! paper-alist (cons '("my size" . (cons (* 15 in) (* 3 in))) paper-alist))
276 #(set-paper-size "my size")
280 The units @code{in} (inches), @code{cm} (centimeters) and @code{mm}
281 (millimeters) can all be used.
283 @cindex paper size, orientation
284 @cindex page, orientation
285 @cindex paper size, landscape
287 If the symbol @code{'landscape} is added to the paper size function,
288 pages will be rotated by 90 degrees, and wider line widths will be set
292 #(set-default-paper-size "a6" 'landscape)
295 Swapping the paper dimensions @emph{without} having the print rotated
296 (like when printing to postcard size, or creating graphics for inclusion
297 rather than a standalone document) can be achieved by appending
298 @samp{landscape} to the name of the paper size itself:
301 #(set-default-paper-size "a6landscape")
304 When the paper size ends with an explicit @samp{landscape} or
305 @samp{portrait}, the presence of a @code{'landscape} symbol @emph{only}
306 affects print orientation, not the paper dimensions used for layout.
310 @ref{Automatic scaling to paper size},
311 @ref{Predefined paper sizes}.
314 @file{scm/paper.scm}.
317 @node Automatic scaling to paper size
318 @unnumberedsubsubsec Automatic scaling to paper size
320 If the paper size is changed with one of the scheme functions
321 (@code{set-default-paper-size} or @code{set-paper-size}), the
322 values of several @code{\paper} variables are automatically scaled
323 to the new size. To bypass the automatic scaling for a particular
324 variable, set the variable after setting the paper size. Note
325 that the automatic scaling is not triggered by setting the
326 @code{paper-height} or @code{paper-width} variables, even though
327 @code{paper-width} can influence other values (this is separate
328 from scaling and is discussed below). The
329 @code{set-default-paper-size} and @code{set-paper-size} functions
330 are described in @ref{Setting the paper size}.
332 The vertical dimensions affected by automatic scaling are
333 @code{top-margin} and @code{bottom-margin} (see
334 @ref{Fixed vertical spacing \paper variables}). The horizontal
335 dimensions affected by automatic scaling are @code{left-margin},
336 @code{right-margin}, @code{inner-margin}, @code{outer-margin},
337 @code{binding-offset}, @code{indent}, and @code{short-indent} (see
338 @ref{Horizontal spacing \paper variables}).
340 The default values for these dimensions are set in
341 @file{ly/paper-defaults-init.ly}, using internal variables named
342 @code{top-margin-default}, @code{bottom-margin-default}, etc.
343 These are the values that result at the default paper size
344 @code{a4}. For reference, with @code{a4} paper the
345 @code{paper-height} is @code{297\mm} and the @code{paper-width} is
350 @ref{Fixed vertical spacing \paper variables},
351 @ref{Horizontal spacing \paper variables}.
354 @file{ly/paper-defaults-init.ly},
355 @file{scm/paper.scm}.
358 @node Fixed vertical spacing \paper variables
359 @subsection Fixed vertical spacing @code{\paper} variables
361 @warning{Some @code{@bs{}paper} dimensions are automatically
362 scaled to the paper size, which may lead to unexpected behavior.
363 See @ref{Automatic scaling to paper size}.}
365 Default values (before scaling) are defined in
366 @file{ly/paper-defaults-init.ly}.
370 @funindex paper-height
372 The height of the page, unset by default. Note that the automatic
373 scaling of some vertical dimensions is not affected by this.
378 The margin between the top of the page and the top of the
379 printable area. If the paper size is modified, this dimension's
380 default value is scaled accordingly.
383 @funindex bottom-margin
385 The margin between the bottom of the printable area and the bottom
386 of the page. If the paper size is modified, this dimension's
387 default value is scaled accordingly.
390 @funindex ragged-bottom
392 If set to true, systems will not spread vertically down the page.
393 This does not affect the last page. This should be set to true
394 for pieces that have only two or three systems per page, for
395 example orchestral scores.
397 @item ragged-last-bottom
398 @funindex ragged-last-bottom
400 If set to false, systems will spread vertically down the last
401 page. Pieces that amply fill two pages or more should have this
402 set to false. It also affects the last page of book parts, i.e.
403 parts of a book created with @code{\bookpart} blocks.
409 @ref{Automatic scaling to paper size}.
412 @file{ly/paper-defaults-init.ly}.
418 The titles (from the @code{\header} block) are treated as a
419 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
420 add space between the titles and the first system of the score.
422 Explicitly defined paper-sizes will override any user-defined top or
423 bottom margin settings.
426 @node Flexible vertical spacing \paper variables
427 @subsection Flexible vertical spacing @code{\paper} variables
429 In most cases, it is preferable for the vertical distances between
430 certain items (such as margins, titles, systems, and separate
431 scores) to be flexible, so that they stretch and compress nicely
432 according to each situation. A number of @code{\paper} variables
433 (listed below) are available to fine-tune the stretching behavior
436 Note that the @code{\paper} variables discussed in this section do
437 not control the spacing of staves within individual systems.
438 Within-system spacing is controlled by grob properties, with
439 settings typically entered inside a @code{\score} or
440 @code{\layout} block, and not inside a @code{\paper} block. See
441 @ref{Flexible vertical spacing within systems}.
444 * Structure of flexible vertical spacing alists::
445 * List of flexible vertical spacing \paper variables::
449 @node Structure of flexible vertical spacing alists
450 @unnumberedsubsubsec Structure of flexible vertical spacing alists
452 Each of the flexible vertical spacing @code{\paper} variables is
453 an alist (association list) containing four @emph{keys}:
458 @code{basic-distance} -- the vertical distance, measured in
459 staff-spaces, between the @emph{reference points} of the two
460 items, when no collisions would result, and no stretching or
461 compressing is in effect. The reference point of a (title or
462 top-level) markup is its highest point, and the reference point of
463 a system is the vertical center of the nearest @code{StaffSymbol}
464 -- even if a non-staff line (such as a @code{Lyrics} context) is
465 in the way. Values for @code{basic-distance} that are less than
466 either @code{padding} or @code{minimum-distance} are not
467 meaningful, since the resulting distance will never be less than
468 either @code{padding} or @code{minimum-distance}.
471 @code{minimum-distance} -- the smallest allowable vertical
472 distance, measured in staff-spaces, between the reference points
473 of the two items, when compressing is in effect. Values for
474 @code{minimum-distance} that are less than @code{padding} are not
475 meaningful, since the resulting distance will never be less than
478 @c TODO: explain skylines somewhere and xref to it from here.
481 @code{padding} -- the minimum required amount of unobstructed
482 vertical whitespace between the bounding boxes (or skylines) of
483 the two items, measured in staff-spaces.
486 @code{stretchability} -- a unitless measure of the dimension's
487 relative propensity to stretch. If zero, the distance will not
488 stretch (unless collisions would result). When positive, the
489 significance of a particular dimension's @code{stretchability}
490 value lies only in its relation to the @code{stretchability}
491 values of the other dimensions. For example, if one dimension has
492 twice the @code{stretchability} of another, it will stretch twice
493 as easily. Values should be non-negative and finite. The value
494 @code{+inf.0} triggers a @code{programming_error} and is ignored,
495 but @code{1.0e7} can be used for an almost infinitely stretchable
496 spring. If unset, the default value is set to
497 @code{basic-distance}. Note that the dimension's propensity to
498 @emph{compress} cannot be directly set by the user and is equal to
499 (@code{basic-distance}@tie{}@minus{}@tie{}@code{minimum-distance}).
503 If a page has a ragged bottom, the resulting distance is the
509 @code{basic-distance},
512 @code{minimum-distance}, and
515 @code{padding} plus the smallest distance necessary to eliminate
520 For multi-page scores with a ragged bottom on the last page, the last
521 page uses the same spacing as the preceding page, provided there is
522 enough space for that.
524 Specific methods for modifying alists are discussed in
525 @ref{Modifying alists}. The following example demonstrates the
526 two ways these alists can be modified. The first declaration
527 updates one key-value individually, and the second completely
528 redefines the variable:
532 system-system-spacing #'basic-distance = #8
533 score-system-spacing =
534 #'((basic-distance . 12)
535 (minimum-distance . 6)
537 (stretchability . 12))
542 @node List of flexible vertical spacing \paper variables
543 @unnumberedsubsubsec List of flexible vertical spacing @code{\paper} variables
545 The names of these variables follow the format
546 @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}}
547 and @code{@var{lower}} are the items to be spaced. Each distance
548 is measured between the reference points of the two items (see the
549 description of the alist structure above). Note that in these
550 variable names, the term @q{@code{markup}} refers to both
551 @emph{title markups} (@code{bookTitleMarkup} or
552 @code{scoreTitleMarkup}) and @emph{top-level markups} (see
553 @ref{File structure}). All distances are measured in
556 Default settings are defined in @file{ly/paper-defaults-init.ly}.
558 @c TODO: Where do headers/footers fit in? -mp
561 @item markup-system-spacing
562 @funindex markup-system-spacing
564 the distance between a (title or top-level) markup and the system
567 @item score-markup-spacing
568 @funindex score-markup-spacing
570 the distance between the last system of a score and the (title or
571 top-level) markup that follows it.
573 @item score-system-spacing
574 @funindex score-system-spacing
576 the distance between the last system of a score and the first
577 system of the score that follows it, when no (title or top-level)
578 markup exists between them.
580 @item system-system-spacing
581 @funindex system-system-spacing
583 the distance between two systems in the same score.
585 @item markup-markup-spacing
586 @funindex markup-markup-spacing
588 the distance between two (title or top-level) markups.
590 @item last-bottom-spacing
591 @funindex last-bottom-spacing
593 the distance from the last system or top-level markup on a page to
594 the bottom of the printable area (i.e. the top of the bottom
597 @item top-system-spacing
598 @funindex top-system-spacing
600 the distance from the top of the printable area (i.e. the bottom
601 of the top margin) to the first system on a page, when there is no
602 (title or top-level) markup between the two.
604 @item top-markup-spacing
605 @funindex top-markup-spacing
607 the distance from the top of the printable area (i.e. the bottom
608 of the top margin) to the first (title or top-level) markup on a
609 page, when there is no system between the two.
614 @ref{Flexible vertical spacing within systems}.
617 @file{ly/paper-defaults-init.ly}.
623 @node Horizontal spacing \paper variables
624 @subsection Horizontal spacing @code{\paper} variables
626 @warning{Some @code{@bs{}paper} dimensions are automatically
627 scaled to the paper size, which may lead to unexpected behavior.
628 See @ref{Automatic scaling to paper size}.}
631 * \paper variables for widths and margins::
632 * \paper variables for two-sided mode::
633 * \paper variables for shifts and indents::
637 @node \paper variables for widths and margins
638 @unnumberedsubsubsec @code{\paper} variables for widths and margins
640 Default values (before scaling) that are not listed here are
641 defined in @file{ly/paper-defaults-init.ly}.
646 @funindex paper-width
648 The width of the page, unset by default. While @code{paper-width}
649 has no effect on the automatic scaling of some horizontal
650 dimensions, it does influence the @code{line-width} variable. If
651 both @code{paper-width} and @code{line-width} are set, then
652 @code{left-margin} and @code{right-margin} will also be updated.
653 Also see @code{check-consistency}.
658 The horizontal extent of the staff lines in unindented, non-ragged
660 @code{(paper-width@tie{}@minus{}@tie{}left-margin@tie{}@minus{}@tie{}right-margin)}
661 when unset. If @code{line-width} is set, and both
662 @code{left-margin} and @code{right-margin} are unset, then the
663 margins will be updated to center the systems on the page
664 automatically. Also see @code{check-consistency}. This variable
665 can also be set in a @code{\layout} block.
668 @funindex left-margin
670 The margin between the left edge of the page and the start of the
671 staff lines in unindented systems. If the paper size is modified,
672 this dimension's default value is scaled accordingly. If
673 @code{left-margin} is unset, and both @code{line-width} and
674 @code{right-margin} are set, then @code{left-margin} is set to
675 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}right-margin)}.
676 If only @code{line-width} is set, then both margins are set to
677 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
678 and the systems are consequently centered on the page. Also see
679 @code{check-consistency}.
682 @funindex right-margin
684 The margin between the right edge of the page and the end of the
685 staff lines in non-ragged systems. If the paper size is modified,
686 this dimension's default value is scaled accordingly. If
687 @code{right-margin} is unset, and both @code{line-width} and
688 @code{left-margin} are set, then @code{right-margin} is set to
689 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}left-margin)}.
690 If only @code{line-width} is set, then both margins are set to
691 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
692 and the systems are consequently centered on the page. Also see
693 @code{check-consistency}.
695 @item check-consistency
696 @funindex check-consistency
698 If set to true, print a warning if @code{left-margin},
699 @code{line-width}, and @code{right-margin} do not exactly add up
700 to @code{paper-width}, and replace each of these (except
701 @code{paper-width}) with its default value (scaled to the paper
702 size if necessary). If set to false, ignore any inconsistencies
703 and allow systems to run off the edge of the page.
706 @funindex ragged-right
708 If set to true, systems will not fill the line width. Instead,
709 systems end at their natural horizontal length. Default:
710 @code{#t} for scores with only one system, and @code{#f} for
711 scores with two or more systems. This variable can also be set in
712 a @code{\layout} block.
715 @funindex ragged-last
717 If set to true, the last system in the score will not fill the
718 line width. Instead the last system ends at its natural
719 horizontal length. Default: @code{#f}. This variable can also be
720 set in a @code{\layout} block.
726 @ref{Automatic scaling to paper size}.
729 @file{ly/paper-defaults-init.ly}.
732 Explicitly defined paper-sizes will override any user-defined left or
733 right margin settings.
736 @node \paper variables for two-sided mode
737 @unnumberedsubsubsec @code{\paper} variables for two-sided mode
739 Default values (before scaling) are defined in
740 @file{ly/paper-defaults-init.ly}.
748 @cindex binding gutter
750 If set to true, use @code{inner-margin}, @code{outer-margin} and
751 @code{binding-offset} to determine margins depending on whether
752 the page number is odd or even. This overrides @code{left-margin}
753 and @code{right-margin}.
756 @funindex inner-margin
758 The margin all pages have at the inner side if they are part of a
759 book. If the paper size is modified, this dimension's default
760 value is scaled accordingly. Works only with @code{two-sided} set
764 @funindex outer-margin
766 The margin all pages have at the outer side if they are part of a
767 book. If the paper size is modified, this dimension's default
768 value is scaled accordingly. Works only with @code{two-sided} set
772 @funindex binding-offset
774 The amount @code{inner-margin} is increased to make sure nothing
775 will be hidden by the binding. If the paper size is modified,
776 this dimension's default value is scaled accordingly. Works only
777 with @code{two-sided} set to true.
783 @ref{Automatic scaling to paper size}.
786 @file{ly/paper-defaults-init.ly}.
789 @node \paper variables for shifts and indents
790 @unnumberedsubsubsec @code{\paper} variables for shifts and indents
792 Default values (before scaling) that are not listed here are
793 defined in @file{ly/paper-defaults-init.ly}.
797 @item horizontal-shift
798 @funindex horizontal-shift
800 @c This default value is buried in the middle of page.scm. -mp
802 The amount that all systems (including titles and system
803 separators) are shifted to the right. Default: @code{0.0\mm}.
808 The level of indentation for the first system in a score. If the
809 paper size is modified, this dimension's default value is scaled
810 accordingly. This variable can also be set in a @code{\layout}
814 @funindex short-indent
816 The level of indentation for all systems in a score besides the
817 first system. If the paper size is modified, this dimension's
818 default value is scaled accordingly. This variable can also be
819 set in a @code{\layout} block.
825 @ref{Automatic scaling to paper size}.
828 @file{ly/paper-defaults-init.ly}.
834 @node Other \paper variables
835 @subsection Other @code{\paper} variables
838 * \paper variables for line breaking::
839 * \paper variables for page breaking::
840 * \paper variables for page numbering::
841 * Miscellaneous \paper variables::
845 @node \paper variables for line breaking
846 @unnumberedsubsubsec @code{\paper} variables for line breaking
850 @item max-systems-per-page
851 @funindex max-systems-per-page
853 The maximum number of systems that will be placed on a page. This
854 is currently supported only by the @code{ly:optimal-breaking} algorithm.
857 @item min-systems-per-page
858 @funindex min-systems-per-page
860 The minimum number of systems that will be placed on a page. This
861 may cause pages to be overfilled if it is made too large. This is
862 currently supported only by the @code{ly:optimal-breaking} algorithm.
865 @item systems-per-page
866 @funindex systems-per-page
868 The number of systems that should be placed on each page.
869 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
873 @funindex system-count
875 The number of systems to be used for a score. Default: unset.
876 This variable can also be set in a @code{\layout} block.
885 @node \paper variables for page breaking
886 @unnumberedsubsubsec @code{\paper} variables for page breaking
888 Default values not listed here are defined in
889 @file{ly/paper-defaults-init.ly}
894 @funindex page-breaking
896 The page-breaking algorithm to use. Choices are
897 @code{ly:minimal-breaking}, @code{ly:page-turn-breaking},
898 @code{ly:one-line-breaking} and @code{ly:optimal-breaking}
901 @item page-breaking-system-system-spacing
902 @funindex page-breaking-system-system-spacing
904 Tricks the page breaker into thinking that
905 @code{system-system-spacing} is set to something different than
906 it really is. For example, if
907 @code{page-breaking-system-system-spacing #'padding} is set to something
908 substantially larger than @code{system-system-spacing #'padding}, then the
909 page-breaker will put fewer systems on each page. Default: unset.
914 The number of pages to be used for a score, unset by default.
918 The following variables are effective only when @code{page-breaking}
919 is set to @code{ly:page-turn-breaking}. Page breaks are then chosen
920 to minimize the number of page turns. Since page turns are required
921 on moving from an odd-numbered page to an even-numbered one, a
922 layout in which the last page is odd-numbered will usually be
923 favoured. Places where page turns are preferred can be indicated
924 manually by inserting @code{\allowPageTurn} or automatically by
925 including the @code{Page_turn_engraver} (see @ref{Optimal page turning}).
927 If there are insufficient choices available for making suitable page
928 turns, LilyPond may insert a blank page either within a score, between
929 scores (if there are two or more scores), or by ending a score on an
930 even-numbered page. The values of the following three variables may
931 be increased to make these actions less likely.
933 The values are penalties, i.e. the higher the value the less likely
934 will be the associated action relative to other choices.
938 @item blank-page-penalty
939 @funindex blank-page-penalty
941 The penalty for having a blank page in the middle of a score. If
942 @code{blank-page-penalty} is large and @code{ly:page-turn-breaking} is
943 selected, then LilyPond will be less likely to insert a page in the
944 middle of a score. Instead, it will space out the music further to
945 fill the blank page and the following one. Default: 5.
947 @item blank-last-page-penalty
948 @funindex blank-last-page-penalty
950 The penalty for ending the score on an even-numbered page. If
951 @code{blank-last-page-penalty} is large and
952 @code{ly:page-turn-breaking} is selected, then LilyPond will be less
953 likely to produce a score in which the last page is even-numbered.
954 Instead, it will adjust the spacing in order to use one page more or
955 one page less. Default: 0.
957 @item blank-after-score-page-penalty
958 @funindex blank-after-score-page-penalty
960 The penalty for having a blank page after the end of one score and
961 before the next. By default, this is smaller than
962 @code{blank-page-penalty}, so that blank pages after scores are
963 inserted in preference to blank pages within a score. Default: 2.
971 @ref{Optimal page breaking},
972 @ref{Optimal page turning},
973 @ref{Minimal page breaking},
974 @ref{One-line page breaking}.
977 @file{ly/paper-defaults-init.ly}.
980 @node \paper variables for page numbering
981 @unnumberedsubsubsec @code{\paper} variables for page numbering
983 Default values not listed here are defined in
984 @file{ly/paper-defaults-init.ly}
988 @cindex page numbers, auto-numbering
989 @item auto-first-page-number
990 @funindex auto-first-page-number
992 The page breaking algorithm is affected by the first page number
993 being odd or even. If set to true, the page breaking algorithm
994 will decide whether to start with an odd or even number. This
995 will result in the first page number remaining as is or being
996 increased by one. Default: @code{#f}.
998 @cindex page numbers, specify the first
999 @item first-page-number
1000 @funindex first-page-number
1002 The value of the page number on the first page.
1004 @item print-first-page-number
1005 @funindex print-first-page-number
1007 If set to true, a page number is printed on the first page.
1009 @cindex page numbers, suppress
1010 @item print-page-number
1011 @funindex print-page-number
1013 If set to false, page numbers are not printed.
1019 @file{ly/paper-defaults-init.ly}.
1022 Odd page numbers are always on the right. If you want the
1023 music to start on page 1 there must be a blank page on the back
1024 of the cover page so that page 1 is on the right hand side.
1027 @node Miscellaneous \paper variables
1028 @unnumberedsubsubsec Miscellaneous @code{\paper} variables
1032 @item page-spacing-weight
1033 @funindex page-spacing-weight
1035 The relative importance of page (vertical) spacing and line
1036 (horizontal) spacing. High values will make page spacing more
1037 important. Default: @code{10}.
1039 @item print-all-headers
1040 @funindex print-all-headers
1042 If set to true, this will print all headers for each @code{\score}
1043 in the output. Normally only the @code{piece} and @code{opus}
1044 header variables are printed. Default: @code{#f}.
1046 @item system-separator-markup
1047 @funindex system-separator-markup
1049 A markup object that is inserted between systems, often used for
1050 orchestral scores. Default: unset. The @code{\slashSeparator}
1051 markup, defined in @file{ly/titling-init.ly}, is provided as a
1052 sensible default, for example:
1054 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
1055 #(set-default-paper-size "a8")
1059 system-separator-markup = \slashSeparator
1065 \relative c'' { c1 \break c1 \break c1 }
1074 @file{ly/titling-init.ly}.
1080 The default page header puts the page number and the @code{instrument}
1081 field from the @code{\header} block on a line.
1085 @section Score layout
1087 This section discusses score layout options for the @code{\layout}
1091 * The \layout block::
1092 * Setting the staff size::
1096 @node The \layout block
1097 @subsection The @code{\layout} block
1101 While the @code{\paper} block contains settings that relate to the
1102 page formatting of the whole document, the @code{\layout} block
1103 contains settings for score-specific layout. To set score layout
1104 options globally, enter them in a toplevel @code{\layout} block.
1105 To set layout options for an individual score, enter them in a
1106 @code{\layout} block inside the @code{\score} block, after the
1107 music. Settings that can appear in a @code{\layout} block
1111 @item the @code{layout-set-staff-size} scheme function,
1112 @item context modifications in @code{\context} blocks, and
1113 @item @code{\paper} variables that affect score layout.
1116 The @code{layout-set-staff-size} function is discussed in the next
1117 section, @ref{Setting the staff size}. Context modifications are
1118 discussed in a separate chapter; see
1119 @ref{Modifying context plug-ins} and
1120 @ref{Changing context default settings}. The @code{\paper}
1121 variables that can appear in a @code{\layout} block are:
1126 @code{line-width}, @code{ragged-right} and @code{ragged-last}
1127 (see @ref{\paper variables for widths and margins})
1130 @code{indent} and @code{short-indent}
1131 (see @ref{\paper variables for shifts and indents})
1135 (see @ref{\paper variables for line breaking})
1139 Here is an example @code{\layout} block:
1146 \override StaffGrouper.staff-staff-spacing.basic-distance = #8
1150 \override TextScript.padding = #1
1151 \override Glissando.thickness = #3
1156 Multiple @code{\layout} blocks can be entered as toplevel expressions.
1157 This can, for example, be useful if different settings are stored in
1158 separate files and included optionally. Internally, when
1159 a @code{\layout} block is evaluated, a copy of the current
1160 @code{\layout} configuration is made, then any changes defined within
1161 the block are applied and the result is saved as the new current
1162 configuration. From the user's perspective the @code{\layout} blocks
1163 are combined, but in conflicting situations (when the same property
1164 is changed in different blocks) the later definitions take precedence.
1166 For example, if this block:
1172 \override TextScript.color = #magenta
1173 \override Glissando.thickness = #1.5
1178 is placed after the one from the preceding example the @code{'padding}
1179 and @code{'color} overrides for @code{TextScript} are combined, but
1180 the later @code{'thickness} override for @code{Glissando} replaces
1181 (or hides) the earlier one.
1183 @code{\layout} blocks may be assigned to variables for reuse later,
1184 but the way this works is slightly but significantly different from
1185 writing them literally.
1187 If a variable is defined like this:
1190 layoutVariable = \layout @{
1193 \override NoteHead.font-size = #4
1198 it will hold the current @code{\layout} configuration with the
1199 @code{NoteHead.font-size} override added, but this combination
1200 is @emph{not} saved as the new current configuration. Be aware
1201 that the @q{current configuration} is read when the variable is
1202 defined and not when it is used, so the content of the variable
1203 is dependent on its position in the source.
1205 The variable can then be used inside another @code{\layout} block,
1213 \override NoteHead.color = #red
1218 A @code{\layout} block containing a variable, as in the example above,
1219 does @emph{not} copy the current configuration but instead uses the
1220 content of @code{\layoutVariable} as the base configuration for the
1221 further additions. This means that any changes defined between the
1222 definition and the use of the variable are lost.
1224 If @code{layoutVariable} is defined (or @code{\include}d) immediately
1225 before being used, its content is just the current configuration plus
1226 the overrides defined within it. So in the example above showing the
1227 use of @code{\layoutVariable} the final @code{\layout} block would
1231 TextScript.padding = #1
1232 TextScript.color = #magenta
1233 Glissando.thickness = #1.5
1234 NoteHead.font-size = #4
1235 NoteHead.color = #red
1238 plus the @code{indent} and the @code{StaffGrouper} overrides.
1240 But if the variable had already been defined before the first
1241 @code{\layout} block the current configuration would now contain
1245 NoteHead.font-size = #4 % (written in the variable definition)
1246 NoteHead.color = #red % (added after the use of the variable)
1249 If carefully planned, @code{\layout} variables can be a valuable tool
1250 to structure the layout design of sources, and also to reset the
1251 @code{\layout} configuration to a known state.
1255 @ref{Changing context default settings}.
1261 @node Setting the staff size
1262 @subsection Setting the staff size
1264 @cindex font size, setting
1265 @cindex staff size, setting
1266 @funindex layout file
1268 The default @strong{staff size} is set to 20 points.
1269 This may be changed in two ways:
1271 To set the staff size globally for all scores in a file (or
1272 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
1275 #(set-global-staff-size 14)
1279 This sets the global default size to 14pt staff height and scales all
1282 To set the staff size individually for each score, use
1287 #(layout-set-staff-size 15)
1292 The Feta font provides musical symbols at eight different
1293 sizes. Each font is tuned for a different staff size: at a smaller size
1294 the font becomes heavier, to match the relatively heavier staff lines.
1295 The recommended font sizes are listed in the following table:
1298 @multitable @columnfractions .15 .2 .22 .2
1301 @tab @b{staff height (pt)}
1302 @tab @b{staff height (mm)}
1344 @c modern rental material?
1349 These fonts are available in any sizes. The context property
1350 @code{fontSize} and the layout property @code{staff-space} (in
1351 @rinternals{StaffSymbol}) can be used to tune the size for individual
1352 staves. The sizes of individual staves are relative to the global size.
1356 @ref{Selecting notation font size}.
1362 @code{layout-set-staff-size} does not change the distance between the
1372 * Optimal page breaking::
1373 * Optimal page turning::
1374 * Minimal page breaking::
1375 * One-line page breaking::
1377 * Using an extra voice for breaks::
1382 @subsection Line breaking
1385 @cindex breaking lines
1387 Line breaks are normally determined automatically. They are chosen
1388 so that lines look neither cramped nor loose, and consecutive
1389 lines have similar density.
1391 To manually force a line break at a bar line, use the
1392 @code{\break} command:
1394 @lilypond[quote,ragged-right,relative=2,verbatim]
1399 By default, a @code{\break} in the middle of a measure is ignored,
1400 and a warning is printed. To force a line break in the middle of
1401 a measure, add an invisible bar line with @w{@samp{\bar ""}}:
1403 @lilypond[quote,ragged-right,relative=2,verbatim]
1410 A @code{\break} occurring at a bar line is also ignored if the
1411 previous measure ends in the middle of a note, such as when a
1412 tuplet begins and ends in different measures. To allow
1413 @code{\break} commands to work in these situations, remove the
1414 @code{Forbid_line_break_engraver} from the @code{Voice} context.
1415 Note that manually forced line breaks have to be added in parallel
1418 @lilypond[quote,ragged-right,verbatim]
1420 \remove "Forbid_line_break_engraver"
1423 { c2. \tuplet 3/2 { c4 c c } c2. | }
1424 { s1 | \break s1 | }
1429 Similarly, line breaks are normally forbidden when beams cross bar
1430 lines. This behavior can be changed by setting
1431 @code{\override Beam.breakable = ##t}:
1433 @lilypond[quote,ragged-right,relative=2,verbatim]
1434 \override Beam.breakable = ##t
1439 The @code{\noBreak} command forbids a line break at the bar line
1440 where it is inserted.
1442 The most basic settings influencing line spacing are @code{indent}
1443 and @code{line-width}. They are set in the @code{\layout} block.
1444 They control the indentation of the first line of music, and the
1445 lengths of the lines.
1447 If @code{ragged-right} is set to true in the @code{\layout} block,
1448 then systems end at their natural horizontal length, instead of
1449 being spread horizontally to fill the whole line. This is useful
1450 for short fragments, and for checking how tight the natural
1453 @c TODO Check and add para on default for ragged-right
1455 The option @code{ragged-last} is similar to @code{ragged-right},
1456 but affects only the last line of the piece.
1468 @cindex regular line breaks
1469 @cindex four bar music.
1471 For line breaks at regular intervals use @code{\break} separated by
1472 skips and repeated with @code{\repeat}. For example, this would
1473 cause the following 28 measures (assuming 4/4 time) to be broken
1474 every 4 measures, and only there:
1479 s1 \noBreak s1 \noBreak
1480 s1 \noBreak s1 \break
1482 @{ @var{the actual music@dots{}} @}
1496 @ref{\paper variables for line breaking}.
1501 Internals Reference:
1502 @rinternals{LineBreakEvent}.
1506 @subsection Page breaking
1508 The default page breaking may be overridden by inserting
1509 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1510 analogous to @code{\break} and @code{\noBreak}. They should be
1511 inserted at a bar line. These commands force and forbid a page-break
1512 from happening. Of course, the @code{\pageBreak} command also forces
1515 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1516 inserted at top-level, between scores and top-level markups.
1518 There are also analogous settings to @code{ragged-right} and
1519 @code{ragged-last} which have the same effect on vertical spacing:
1520 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1521 @code{#t} the systems on all pages or just the last page
1522 respectively will not be justified vertically. See
1523 @ref{Fixed vertical spacing \paper variables}.
1525 Page breaks are computed by the @code{page-breaking} function. LilyPond
1526 provides three algorithms for computing page breaks,
1527 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1528 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1529 but the value can be changed in the @code{\paper} block:
1533 page-breaking = #ly:page-turn-breaking
1539 When a book has many scores and pages, the page breaking problem may be
1540 difficult to solve, requiring large processing time and memory. To ease
1541 the page breaking process, @code{\bookpart} blocks are used to divide
1542 the book into several parts: the page breaking occurs separately on each
1543 part. Different page breaking functions may also be used in different
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 @subsection Optimal page breaking
1589 @funindex ly:optimal-breaking
1591 The @code{ly:optimal-breaking} function is LilyPond's default method of
1592 determining page breaks. It attempts to find a page breaking that minimizes
1593 cramping and stretching, both horizontally and vertically. Unlike
1594 @code{ly:page-turn-breaking}, it has no concept of page turns.
1601 @node Optimal page turning
1602 @subsection Optimal page turning
1604 @funindex ly:page-turn-breaking
1606 Often it is necessary to find a page breaking configuration so that there is
1607 a rest at the end of every second page. This way, the musician can turn the
1608 page without having to miss notes. The @code{ly:page-turn-breaking} function
1609 attempts to find a page breaking minimizing cramping and stretching, but with
1610 the additional restriction that it is only allowed to introduce page turns
1611 in specified places.
1613 There are two steps to using this page breaking function. First, you
1614 must enable it in the @code{\paper} block, as explained in @ref{Page
1615 breaking}. Then you must tell the function where you would like to allow
1618 There are two ways to achieve the second step. First, you can specify each
1619 potential page turn manually, by inserting @code{\allowPageTurn} into your
1620 input file at the appropriate places.
1622 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1623 Voice context. The @code{Page_turn_engraver} will scan the context for
1624 sections without notes (note that it does not scan for rests; it scans for
1625 the absence of notes. This is so that single-staff polyphony with rests in one
1626 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1627 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1628 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1629 there is a @q{special} bar line (such as a double bar), in which case the
1630 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1633 @funindex minimumPageTurnLength
1634 The @code{Page_turn_engraver} reads the context property
1635 @code{minimumPageTurnLength} to determine how long a note-free section must
1636 be before a page turn is considered. The default value for
1637 @code{minimumPageTurnLength} is @code{(ly:make-moment 1/1)}. If you want
1638 to disable page turns, you can set it to something very large.
1641 \new Staff \with @{ \consists "Page_turn_engraver" @}
1644 R1 | % a page turn will be allowed here
1646 \set Staff.minimumPageTurnLength = #(ly:make-moment 5/2)
1647 R1 | % a page turn will not be allowed here
1649 R1*2 | % a page turn will be allowed here
1654 @funindex minimumRepeatLengthForPageTurn
1655 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1656 turn during the repeat if there is enough time at the beginning and end of the
1657 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1658 page turns if the repeat is very short. If you set the context property
1659 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1660 only allow turns in repeats whose duration is longer than this value.
1662 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1663 @code{\allowPageTurn}, may also be used at top-level, between scores and
1669 @funindex \noPageTurn
1671 @funindex \allowPageTurn
1672 @code{\allowPageTurn}.
1677 @ref{\paper variables for line breaking}.
1683 There should only be one @code{Page_turn_engraver} in a score. If there is more
1684 than one, they will interfere with each other.
1687 @node Minimal page breaking
1688 @subsection Minimal page breaking
1690 @funindex ly:minimal-breaking
1692 The @code{ly:minimal-breaking} function performs minimal computations to
1693 calculate the page breaking: it fills a page with as many systems as
1694 possible before moving to the next one. Thus, it may be preferred for
1695 scores with many pages, where the other page breaking functions could be
1696 too slow or memory demanding, or a lot of texts. It is enabled using:
1700 page-breaking = #ly:minimal-breaking
1708 @node One-line page breaking
1709 @subsection One-line page breaking
1711 @funindex ly:one-line-breaking
1713 The @code{ly:one-line-breaking} function is a special-purpose
1714 page breaking algorithm that puts each score on its own page,
1715 and on a single line. This page breaking function does not
1716 typeset titles or margins; only the score will be displayed.
1718 The page width will be adjusted so that
1719 the longest score fits on one line. In particular,
1720 @code{paper-width}, @code{line-width} and @code{indent}
1721 variables in the @code{\paper} block will be ignored, although
1722 @code{left-margin} and @code{right-margin} will
1723 still be honored. The height of the page will
1726 @node Explicit breaks
1727 @subsection Explicit breaks
1729 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1730 commands. There are two commands to override this behavior:
1733 \override NonMusicalPaperColumn.line-break-permission = ##f
1734 \override NonMusicalPaperColumn.page-break-permission = ##f
1737 When @code{line-break-permission} is overridden to false, Lily will insert
1738 line breaks at explicit @code{\break} commands and nowhere else. When
1739 @code{page-break-permission} is overridden to false, Lily will insert
1740 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1742 @lilypond[quote,verbatim]
1749 music = \relative c'' { c8 c c c }
1753 \repeat unfold 2 { \music } \break
1754 \repeat unfold 4 { \music } \break
1755 \repeat unfold 6 { \music } \break
1756 \repeat unfold 8 { \music } \pageBreak
1757 \repeat unfold 8 { \music } \break
1758 \repeat unfold 6 { \music } \break
1759 \repeat unfold 4 { \music } \break
1760 \repeat unfold 2 { \music }
1765 \override NonMusicalPaperColumn.line-break-permission = ##f
1766 \override NonMusicalPaperColumn.page-break-permission = ##f
1777 @node Using an extra voice for breaks
1778 @subsection Using an extra voice for breaks
1780 Line- and page-breaking information usually appears within note entry directly.
1783 music = \relative c'' @{ c4 c c c @}
1787 \repeat unfold 2 @{ \music @} \break
1788 \repeat unfold 3 @{ \music @}
1793 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1794 music entry with information that specifies how music should lay out
1795 on the page. You can keep music entry and line- and page-breaking
1796 information in two separate places by introducing an extra voice to
1797 contain the breaks. This extra voice
1798 contains only skips together with @code{\break}, @code{pageBreak} and other
1799 breaking layout information.
1801 @lilypond[quote,verbatim]
1802 music = \relative c'' { c4 c c c }
1804 \header { tagline = ##f }
1805 \paper { left-margin = 0\mm }
1816 \repeat unfold 2 { \music }
1817 \repeat unfold 3 { \music }
1818 \repeat unfold 6 { \music }
1819 \repeat unfold 5 { \music }
1826 This pattern becomes especially helpful when overriding
1827 @code{line-break-system-details} and the other useful but long properties of
1828 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1830 @lilypond[quote,verbatim]
1831 music = \relative c'' { c4 c c c }
1833 \header { tagline = ##f }
1834 \paper { left-margin = 0\mm }
1839 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1843 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1847 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1851 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1856 \repeat unfold 2 { \music }
1857 \repeat unfold 3 { \music }
1858 \repeat unfold 6 { \music }
1859 \repeat unfold 5 { \music }
1868 @ref{Vertical spacing}.
1874 @node Vertical spacing
1875 @section Vertical spacing
1877 @cindex vertical spacing
1878 @cindex spacing, vertical
1880 Vertical spacing is controlled by three things: the amount of
1881 space available (i.e., paper size and margins), the amount of
1882 space between systems, and the amount of space between
1883 staves inside a system.
1886 * Flexible vertical spacing within systems::
1887 * Explicit staff and system positioning::
1888 * Vertical collision avoidance::
1892 @node Flexible vertical spacing within systems
1893 @subsection Flexible vertical spacing within systems
1895 @cindex distance between staves
1896 @cindex staff distance
1897 @cindex space between staves
1898 @cindex space inside systems
1900 Three separate mechanisms control the flexible vertical spacing
1901 within systems, one for each of the following categories:
1906 @emph{ungrouped staves},
1909 @emph{grouped staves} (staves within a staff-group such as
1910 @code{ChoirStaff}, etc.), and
1913 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1918 @c TODO: Clarify this. This almost implies that non-staff lines
1919 @c have NO effect on the spacing between staves. -mp
1921 The height of each system is determined in two steps. First, all
1922 of the staves are spaced according to the amount of space
1923 available. Then, the non-staff lines are distributed between the
1926 Note that the spacing mechanisms discussed in this section only
1927 control the vertical spacing of staves and non-staff lines within
1928 individual systems. The vertical spacing between separate
1929 systems, scores, markups, and margins is controlled by
1930 @code{\paper} variables, which are discussed in
1931 @ref{Flexible vertical spacing \paper variables}.
1934 * Within-system spacing properties::
1935 * Spacing of ungrouped staves::
1936 * Spacing of grouped staves::
1937 * Spacing of non-staff lines::
1941 @node Within-system spacing properties
1942 @unnumberedsubsubsec Within-system spacing properties
1944 @funindex staff-affinity
1945 @funindex staffgroup-staff-spacing
1946 @funindex staff-staff-spacing
1947 @funindex nonstaff-unrelatedstaff-spacing
1948 @funindex nonstaff-relatedstaff-spacing
1949 @funindex nonstaff-nonstaff-spacing
1950 @funindex default-staff-staff-spacing
1951 @funindex minimum-Y-extent
1952 @funindex extra-offset
1953 @funindex self-alignment-X
1955 @funindex VerticalAxisGroup
1957 The within-system vertical spacing mechanisms are controlled by
1958 two sets of grob properties. The first set is associated with the
1959 @code{VerticalAxisGroup} grob, which is created by all staves and
1960 non-staff lines. The second set is associated with the
1961 @code{StaffGrouper} grob, which can be created by staff-groups,
1962 but only if explicitly called. These properties are described
1963 individually at the end of this section.
1965 The names of these properties (except for @code{staff-affinity})
1966 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1967 @code{@var{item1}} and @code{@var{item2}} are the items to be
1968 spaced. Note that @code{@var{item2}} is not necessarily below
1969 @code{@var{item1}}; for example,
1970 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1971 non-staff line if @code{staff-affinity} is @code{UP}.
1973 Each distance is measured between the @emph{reference points} of
1974 the two items. The reference point for a staff is the vertical
1975 center of its @code{StaffSymbol} (i.e. the middle line if
1976 @code{line-count} is odd; the middle space if @code{line-count} is
1977 even). The reference points for individual non-staff lines are
1978 given in the following table:
1980 @multitable {Non-staff line} {Reference point}
1981 @headitem Non-staff line @tab Reference point
1982 @item @code{ChordNames} @tab baseline
1983 @item @code{NoteNames} @tab baseline
1984 @item @code{Lyrics} @tab baseline
1985 @item @code{Dynamics} @tab vertical center
1986 @item @code{FiguredBass} @tab highest point
1987 @item @code{FretBoards} @tab top line
1990 In the following image, horizontal lines indicate the positions
1991 of these reference points:
1993 @lilypond[quote,noragged-right,line-width=110\mm]
1994 #(define zero-space '((padding . -inf.0) (basic-distance . 0)))
1996 alignToZero = \with {
1997 \override VerticalAxisGroup.nonstaff-relatedstaff-spacing = #zero-space
1998 \override VerticalAxisGroup.nonstaff-nonstaff-spacing = #zero-space
2000 lowerCaseChords = \with {
2001 chordNameLowercaseMinor = ##t
2003 staffAffinityDown = \with {
2004 \override VerticalAxisGroup.staff-affinity = #DOWN
2007 #(define-music-function
2008 (parser location context)
2010 #{ s1*0^\markup { \typewriter #context } #})
2013 \context { \Dynamics \alignToZero }
2014 \context { \FiguredBass \alignToZero }
2015 \context { \Lyrics \alignToZero }
2016 \context { \NoteNames \alignToZero \staffAffinityDown }
2017 \context { \ChordNames \alignToZero
2020 \context { \FretBoards \alignToZero \staffAffinityDown }
2022 \override BarLine.stencil = ##f
2023 \override DynamicText.self-alignment-X = #-1
2024 \override FretBoard.X-offset = #1.75
2025 \override InstrumentName.minimum-Y-extent = #'(-2 . 2)
2026 \override InstrumentName.extra-offset = #'(0 . -0.5)
2027 \override TextScript.minimum-Y-extent = #'(-2 . 3)
2028 \override TimeSignature.stencil = ##f
2032 %% These contexts have reference points at the baseline:
2033 %% ChordNames, NoteNames, and Lyrics
2035 \new ChordNames { \chords { g1:m } }
2036 \new NoteNames { s1 | g1 | }
2037 \new RhythmicStaff {
2038 \set RhythmicStaff.instrumentName = #"baseline "
2040 \labelContext "ChordNames " s1 |
2041 \labelContext "NoteNames " s1 |
2042 \labelContext "Lyrics" s1 |
2044 \new Lyrics { \lyrics { \skip 1*2 | ghijk1 | } }
2047 %% The reference point for Dynamics is its vertical center
2049 \new RhythmicStaff {
2050 \set RhythmicStaff.instrumentName = #"vertical center "
2051 \labelContext "Dynamics" s1*3
2053 \new Dynamics { s1\mp s\fp }
2056 %% The reference point for FiguredBass is its highest point
2058 \new RhythmicStaff {
2059 \set RhythmicStaff.instrumentName = #"highest point "
2060 \labelContext "FiguredBass" s1
2062 \new FiguredBass { \figuremode { <6 5>1 } }
2065 %% The reference point for FretBoards is the top line
2066 \include "predefined-guitar-fretboards.ly"
2068 \new FretBoards { \chordmode { e1 } }
2069 \new RhythmicStaff {
2070 \set RhythmicStaff.instrumentName = #"top line "
2071 \labelContext "FretBoards " s1
2076 Each of the vertical spacing grob properties (except
2077 @code{staff-affinity}) uses the same alist structure as the
2078 @code{\paper} spacing variables discussed in
2079 @ref{Flexible vertical spacing \paper variables}. Specific methods
2080 for modifying alists are discussed in @ref{Modifying alists}.
2081 Grob properties should be adjusted with an @code{\override} inside
2082 a @code{\score} or @code{\layout} block, and not inside a
2083 @code{\paper} block.
2085 The following example demonstrates the two ways these alists can
2086 be modified. The first declaration updates one key-value
2087 individually, and the second completely re-defines the property:
2091 \override VerticalAxisGroup.default-staff-staff-spacing.basic-distance = #10
2095 \override VerticalAxisGroup.default-staff-staff-spacing =
2096 #'((basic-distance . 10)
2097 (minimum-distance . 9)
2099 (stretchability . 10))
2103 To change any spacing settings globally, put them in the
2104 @code{\layout} block:
2110 \override VerticalAxisGroup.default-staff-staff-spacing.basic-distance = #10
2115 Standard settings for the vertical spacing grob properties are
2116 listed in @rinternals{VerticalAxisGroup} and
2117 @rinternals{StaffGrouper}. Default overrides for specific types
2118 of non-staff lines are listed in the relevant context descriptions
2119 in @rinternals{Contexts}.
2122 @subsubheading Properties of the @code{VerticalAxisGroup} grob
2124 @code{VerticalAxisGroup} properties are typically adjusted with an
2125 @code{\override} at the @code{Staff} level (or equivalent).
2128 @item staff-staff-spacing
2130 Used to determine the distance between the current staff and the
2131 staff just below it in the same system, even if one or more
2132 non-staff lines (such as @code{Lyrics}) are placed between the two
2133 staves. Does not apply to the bottom staff of a system.
2135 Initially, the @code{staff-staff-spacing} of a
2136 @code{VerticalAxisGroup} is a Scheme function that applies the
2137 properties of the @code{StaffGrouper} if the staff is part of a
2138 group, or the @code{default-staff-staff-spacing} of the staff
2139 otherwise. This allows staves to be spaced differently when they
2140 are grouped. For uniform spacing regardless of grouping, this
2141 function may be replaced by a flexible-spacing alist, using the
2142 complete-redefinition form of override shown above.
2144 @item default-staff-staff-spacing
2145 A flexible-spacing alist defining the @code{staff-staff-spacing} used for
2146 ungrouped staves, unless @code{staff-staff-spacing} has been explicitly
2147 set with an @code{\override}.
2149 @item staff-affinity
2150 The direction of the staff to use for spacing the current
2151 non-staff line. Choices are @code{UP}, @code{DOWN}, and
2152 @code{CENTER}. If @code{CENTER}, the non-staff line will be
2153 placed equidistant between the two nearest staves on either side,
2154 unless collisions or other spacing constraints prevent this.
2155 Adjacent non-staff lines should have non-increasing
2156 @code{staff-affinity} from top to bottom, e.g. a non-staff line
2157 set to @code{UP} should not immediately follow one that is set to
2158 @code{DOWN}. Non-staff lines at the top of a system should use
2159 @code{DOWN}; those at the bottom should use @code{UP}. Setting
2160 @code{staff-affinity} for a staff causes it to be treated as a
2161 non-staff line. Setting @code{staff-affinity} to @code{#f} causes
2162 a non-staff line to be treated as a staff. Setting
2163 @code{staff-affinity} to @code{UP}, @code{CENTER}, or @code{DOWN}
2164 causes a staff to be spaced as a non-staff line.
2166 @item nonstaff-relatedstaff-spacing
2167 The distance between the current non-staff line and the nearest
2168 staff in the direction of @code{staff-affinity}, if there are no
2169 non-staff lines between the two, and @code{staff-affinity} is
2170 either @code{UP} or @code{DOWN}. If @code{staff-affinity} is
2171 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
2172 for the nearest staves on @emph{both} sides, even if other
2173 non-staff lines appear between the current one and either of the
2174 staves. This means that the placement of a non-staff line depends
2175 on both the surrounding staves and the surrounding non-staff lines.
2176 Setting the @code{stretchability} of one of these types of spacing to
2177 a small value will make that spacing dominate. Setting the
2178 @code{stretchability} to a large value will make that spacing have
2181 @item nonstaff-nonstaff-spacing
2182 The distance between the current non-staff line and the next
2183 non-staff line in the direction of @code{staff-affinity}, if both
2184 are on the same side of the related staff, and
2185 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
2187 @item nonstaff-unrelatedstaff-spacing
2188 The distance between the current non-staff line and the staff in
2189 the opposite direction from @code{staff-affinity}, if there are no
2190 other non-staff lines between the two, and @code{staff-affinity}
2191 is either @code{UP} or @code{DOWN}. This can be used, for
2192 example, to require a minimum amount of padding between a
2193 @code{Lyrics} line and the staff to which it does not belong.
2197 @subsubheading Properties of the @code{StaffGrouper} grob
2199 @code{StaffGrouper} properties are typically adjusted with an
2200 @code{\override} at the @code{StaffGroup} level (or equivalent).
2203 @item staff-staff-spacing
2204 The distance between consecutive staves within the current
2205 staff-group. The @code{staff-staff-spacing} property of an
2206 individual staff's @code{VerticalAxisGroup} grob can be
2207 overriden with different spacing settings for that staff.
2209 @item staffgroup-staff-spacing
2210 The distance between the last staff of the current staff-group and
2211 the staff just below it in the same system, even if one or more
2212 non-staff lines (such as @code{Lyrics}) exist between the two
2213 staves. Does not apply to the bottom staff of a system. The
2214 @code{staff-staff-spacing} property of an individual staff's
2215 @code{VerticalAxisGroup} grob can be overriden with different
2216 spacing settings for that staff.
2221 @ref{Flexible vertical spacing \paper variables},
2222 @ref{Modifying alists}.
2225 @file{ly/engraver-init.ly},
2226 @file{scm/define-grobs.scm}.
2228 Internals Reference:
2229 @rinternals{Contexts},
2230 @rinternals{VerticalAxisGroup},
2231 @rinternals{StaffGrouper}.
2234 @node Spacing of ungrouped staves
2235 @unnumberedsubsubsec Spacing of ungrouped staves
2237 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
2238 @code{TabStaff}, etc.) are contexts that can contain one or more
2239 voice contexts, but cannot contain any other staves.
2241 The following properties affect the spacing of @emph{ungrouped}
2245 @item @code{VerticalAxisGroup} properties:
2247 @item @code{default-staff-staff-spacing}
2248 @item @code{staff-staff-spacing}
2252 These grob properties are described individually above; see
2253 @ref{Within-system spacing properties}.
2255 Additional properties are involved for staves that are part of a
2256 staff-group; see @ref{Spacing of grouped staves}.
2258 The following example shows how the @code{default-staff-staff-spacing}
2259 property can affect the spacing of ungrouped staves.
2260 The same overrides applied to @code{staff-staff-spacing} would
2261 have the same effect, but would also apply in cases where the staves
2262 are combined in a group or groups.
2264 @lilypond[verbatim,quote,staffsize=16]
2268 \override VerticalAxisGroup.default-staff-staff-spacing =
2269 #'((basic-distance . 8)
2270 (minimum-distance . 7)
2276 % The very low note here needs more room than 'basic-distance
2277 % can provide, so the distance between this staff and the next
2278 % is determined by 'padding.
2279 \new Staff { b,2 r | }
2281 % Here, 'basic-distance provides enough room, and there is no
2282 % need to compress the space (towards 'minimum-distance) to make
2283 % room for anything else on the page, so the distance between
2284 % this staff and the next is determined by 'basic-distance.
2285 \new Staff { \clef bass g2 r | }
2287 % By setting 'padding to a negative value, staves can be made to
2288 % collide. The lowest acceptable value for 'basic-distance is 0.
2290 \override VerticalAxisGroup.default-staff-staff-spacing =
2291 #'((basic-distance . 3.5)
2293 } { \clef bass g2 r | }
2294 \new Staff { \clef bass g2 r | }
2300 @file{scm/define-grobs.scm}.
2305 Internals Reference:
2306 @rinternals{VerticalAxisGroup}.
2309 @node Spacing of grouped staves
2310 @unnumberedsubsubsec Spacing of grouped staves
2312 In orchestral and other large scores, it is common to place staves
2313 in groups. The space between groups is typically larger than the
2314 space between staves of the same group.
2316 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2317 etc.) are contexts that can contain one or more staves
2320 The following properties affect the spacing of staves inside
2324 @item @code{VerticalAxisGroup} properties:
2326 @item @code{staff-staff-spacing}
2328 @item @code{StaffGrouper} properties:
2330 @item @code{staff-staff-spacing}
2331 @item @code{staffgroup-staff-spacing}
2335 These grob properties are described individually above; see
2336 @ref{Within-system spacing properties}.
2338 The following example shows how properties of the
2339 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2341 @lilypond[verbatim,quote,staffsize=16]
2345 \override StaffGrouper.staff-staff-spacing.padding = #0
2346 \override StaffGrouper.staff-staff-spacing.basic-distance = #1
2351 \new PianoStaff \with {
2352 \override StaffGrouper.staffgroup-staff-spacing.basic-distance = #20
2367 @file{scm/define-grobs.scm}.
2372 Internals Reference:
2373 @rinternals{VerticalAxisGroup},
2374 @rinternals{StaffGrouper}.
2377 @node Spacing of non-staff lines
2378 @unnumberedsubsubsec Spacing of non-staff lines
2380 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2381 etc.) are contexts whose layout objects are engraved like staves
2382 (i.e. in horizontal lines within systems). Specifically,
2383 non-staff lines are non-staff contexts that create the
2384 @code{VerticalAxisGroup} layout object.
2386 The following properties affect the spacing of non-staff lines:
2389 @item @code{VerticalAxisGroup} properties:
2391 @item @code{staff-affinity}
2392 @item @code{nonstaff-relatedstaff-spacing}
2393 @item @code{nonstaff-nonstaff-spacing}
2394 @item @code{nonstaff-unrelatedstaff-spacing}
2398 These grob properties are described individually above; see
2399 @ref{Within-system spacing properties}.
2401 The following example shows how the
2402 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2403 of consecutive non-staff lines. Here, by setting the
2404 @code{stretchability} key to a very high value, the lyrics are
2405 able to stretch much more than usual:
2407 @lilypond[verbatim,quote,staffsize=16]
2411 \override VerticalAxisGroup.nonstaff-nonstaff-spacing.stretchability = #1000
2418 \override VerticalAxisGroup.staff-staff-spacing = #'((basic-distance . 30))
2421 \override VerticalAxisGroup.staff-affinity = #UP
2424 \override VerticalAxisGroup.staff-affinity = #CENTER
2425 } \lyricmode { center }
2427 \override VerticalAxisGroup.staff-affinity = #DOWN
2428 } \lyricmode { down }
2435 @file{ly/engraver-init.ly},
2436 @file{scm/define-grobs.scm}.
2441 @c @lsr{spacing,page-spacing.ly},
2442 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2444 Internals Reference:
2445 @rinternals{Contexts},
2446 @rinternals{VerticalAxisGroup}.
2449 @node Explicit staff and system positioning
2450 @subsection Explicit staff and system positioning
2452 One way to understand the flexible vertical spacing mechanisms
2453 explained above is as a collection of settings that control the
2454 amount of vertical padding between staves and systems.
2456 It is possible to approach vertical spacing in a different way
2457 using @code{NonMusicalPaperColumn.line-break-system-details}.
2458 While the flexible vertical spacing mechanisms specify vertical
2459 padding, @code{NonMusicalPaperColumn.line-break-system-details}
2460 can specify exact vertical positions on the page.
2462 @code{NonMusicalPaperColumn.line-break-system-details} accepts
2463 an associative list of three different settings:
2466 @item @code{X-offset}
2467 @item @code{Y-offset}
2468 @item @code{alignment-distances}
2471 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2472 below, can occur in any of three different places in an input file:
2475 @item in the middle of note entry directly
2476 @item in a @code{\context} block
2477 @item in the @code{\with} block
2480 When we override @code{NonMusicalPaperColumn}, we use the usual
2481 @code{\override} command in @code{\context} blocks and in the
2482 @code{\with} block. On the other hand, when we override
2483 @code{NonMusicalPaperColumn} in the middle of note entry,
2484 use the special @code{\overrideProperty} command. Here are some
2485 example @code{NonMusicalPaperColumn} overrides with the special
2486 @code{\overrideProperty} command:
2489 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2492 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2495 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2499 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2500 #'((alignment-distances . (15)))
2502 \overrideProperty NonMusicalPaperColumn.line-break-system-details
2505 (alignment-distances . (15)))
2508 To understand how each of these different settings work, we begin
2509 by looking at an example that includes no overrides at all.
2511 @c \book { } is required in these examples to ensure the spacing
2512 @c overrides can be seen between systems. -np
2514 @lilypond[verbatim,quote,staffsize=16]
2515 \header { tagline = ##f }
2516 \paper { left-margin = 0\mm }
2526 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2529 \repeat unfold 15 { d'4 d' d' d' }
2536 This score isolates line- and page-breaking information in a dedicated
2537 voice. This technique of creating a breaks voice will help keep layout
2538 separate from music entry as our example becomes more complicated.
2539 See @ref{Using an extra voice for breaks}.
2541 Explicit @code{\breaks} evenly divide the music into six measures per
2542 line. Vertical spacing results from LilyPond's defaults. To set
2543 the vertical startpoint of each system explicitly, we can set
2544 the @code{Y-offset} pair in the @code{line-break-system-details}
2545 attribute of the @code{NonMusicalPaperColumn} grob:
2547 @lilypond[verbatim,quote,staffsize=16]
2548 \header { tagline = ##f }
2549 \paper { left-margin = 0\mm }
2555 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2558 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2561 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2565 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2568 \repeat unfold 15 { d'4 d' d' d' }
2575 Note that @code{line-break-system-details} takes an associative list of
2576 potentially many values, but that we set only one value here. Note,
2577 too, that the @code{Y-offset} property here determines the exact vertical
2578 position on the page at which each new system will render.
2580 Now that we have set the vertical startpoint of each system
2581 explicitly, we can also set the vertical distances between staves
2582 within each system manually. We do this using the @code{alignment-distances}
2583 subproperty of @code{line-break-system-details}.
2585 @lilypond[verbatim,quote,staffsize=16]
2586 \header { tagline = ##f }
2587 \paper { left-margin = 0\mm }
2593 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2595 (alignment-distances . (10)))
2597 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2599 (alignment-distances . (15)))
2601 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2603 (alignment-distances . (20)))
2606 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2609 \repeat unfold 15 { d'4 d' d' d' }
2616 Note that here we assign two different values to the
2617 @code{line-break-system-details} attribute of the
2618 @code{NonMusicalPaperColumn} grob. Though the
2619 @code{line-break-system-details} attribute alist accepts many
2620 additional spacing parameters (including, for example, a corresponding
2621 @code{X-offset} pair), we need only set the @code{Y-offset} and
2622 @code{alignment-distances} pairs to control the vertical startpoint of
2623 every system and every staff. Finally, note that @code{alignment-distances}
2624 specifies the vertical positioning of staves but not of staff groups.
2626 @lilypond[verbatim,quote,staffsize=16]
2627 \header { tagline = ##f }
2628 \paper { left-margin = 0\mm }
2634 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2636 (alignment-distances . (30 10)))
2638 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2640 (alignment-distances . (10 10)))
2642 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
2644 (alignment-distances . (10 30)))
2647 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2650 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2651 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2658 Some points to consider:
2661 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2662 do not count as a staff.
2664 @item The units of the numbers passed to @code{X-offset},
2665 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2666 of the distance between adjacent staff lines. Positive values move staves
2667 and lyrics up, negative values move staves and lyrics down.
2669 @item Because the @code{NonMusicalPaperColumn.line-break-system-details}
2670 settings given here allow the positioning of staves and systems anywhere
2671 on the page, it is possible to violate paper or margin boundaries or even
2672 to print staves or systems on top of one another. Reasonable values
2673 passed to these different settings will avoid this.
2681 @node Vertical collision avoidance
2682 @subsection Vertical collision avoidance
2684 @funindex outside-staff-priority
2685 @funindex outside-staff-padding
2686 @funindex outside-staff-horizontal-padding
2688 Intuitively, there are some objects in musical notation that belong
2689 to the staff and there are other objects that should be placed outside
2690 the staff. Objects belonging outside the staff include things such as
2691 rehearsal marks, text and dynamic markings (from now on, these will
2692 be called outside-staff objects). LilyPond's rule for the
2693 vertical placement of outside-staff objects is to place them as close
2694 to the staff as possible but not so close that they collide with
2697 LilyPond uses the @code{outside-staff-priority} property to determine
2698 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2699 is a number, the grob is an outside-staff object. In addition,
2700 @code{outside-staff-priority} tells LilyPond in which order the objects
2703 First, LilyPond places all the objects that do not belong outside
2704 the staff. Then it sorts the outside-staff objects according to their
2705 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
2706 takes the outside-staff objects and places them so that they do
2707 not collide with any objects that have already been placed. That
2708 is, if two outside-staff grobs are competing for the same space, the one
2709 with the lower @code{outside-staff-priority} will be placed closer to
2712 @lilypond[quote,ragged-right,relative=2,verbatim]
2715 \once \override TextScript.outside-staff-priority = #1
2716 c4_"Text"\pp % this time the text will be closer to the staff
2718 % by setting outside-staff-priority to a non-number,
2719 % we disable the automatic collision avoidance
2720 \once \override TextScript.outside-staff-priority = ##f
2721 \once \override DynamicLineSpanner.outside-staff-priority = ##f
2722 c4_"Text"\pp % now they will collide
2725 The vertical padding between an outside-staff object and the
2726 previously-positioned grobs can be controlled with
2727 @code{outside-staff-padding}.
2729 @lilypond[quote,ragged-right,relative=2,verbatim,staffsize=18]
2730 \once \override TextScript.outside-staff-padding = #0
2731 a'^"This text is placed very close to the note"
2732 \once \override TextScript.outside-staff-padding = #3
2733 c^"This text is padded away from the previous text"
2734 c^"This text is placed close to the previous text"
2738 By default, outside-staff objects are placed so they avoid
2739 a horizontal collision with previously-positioned grobs. This
2740 can lead to situations in which objects are placed close to each
2742 As shown in the example below, setting @code{outside-staff-horizontal-padding}
2743 increases the horizontal spacing required, and in this case moves the text up
2744 to prevent it from getting too close to the ledger lines.
2746 @lilypond[quote,ragged-right,relative=2,verbatim]
2749 \once \override TextScript.outside-staff-horizontal-padding = #1
2758 @node Horizontal spacing
2759 @section Horizontal spacing
2761 @cindex horizontal spacing
2762 @cindex spacing, horizontal
2765 * Horizontal spacing overview::
2766 * New spacing area::
2767 * Changing horizontal spacing::
2769 * Proportional notation::
2773 @node Horizontal spacing overview
2774 @subsection Horizontal spacing overview
2776 The spacing engine translates differences in durations into stretchable
2777 distances (@q{springs}) of differing lengths. Longer durations get
2778 more space, shorter durations get less. The shortest durations get a
2779 fixed amount of space (which is controlled by
2780 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2781 object). The longer the duration, the more space it gets: doubling a
2782 duration adds a fixed amount (this amount is controlled by
2783 @code{spacing-increment}) of space to the note.
2785 For example, the following piece contains lots of half, quarter, and
2786 8th notes; the eighth note is followed by 1 note head width (NHW).
2787 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2789 @lilypond[quote,verbatim,relative=1]
2795 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2796 approximately the width of a note head, and
2797 @code{shortest-duration-space} is set to 2.0, meaning that the
2798 shortest note gets 2.4 staff space (2.0 times the
2799 @code{spacing-increment}) of horizontal space. This space is counted
2800 from the left edge of the symbol, so the shortest notes are generally
2801 followed by one NHW of space.
2803 If one would follow the above procedure exactly, then adding a single
2804 32nd note to a score that uses 8th and 16th notes, would widen up the
2805 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2806 thus adding 1 NHW to every note. To prevent this, the shortest
2807 duration for spacing is not the shortest note in the score, but rather
2808 the one which occurs most frequently.
2811 The most common shortest duration is determined as follows: in every
2812 measure, the shortest duration is determined. The most common shortest
2813 duration is taken as the basis for the spacing, with the stipulation
2814 that this shortest duration should always be equal to or shorter than
2815 an 8th note. The shortest duration is printed when you run
2816 @code{lilypond} with the @option{--verbose} option.
2818 These durations may also be customized. If you set the
2819 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2820 this sets the base duration for spacing. The maximum duration for this
2821 base (normally an 8th), is set through @code{base-shortest-duration}.
2823 @funindex common-shortest-duration
2824 @funindex base-shortest-duration
2825 @funindex stem-spacing-correction
2828 Notes that are even shorter than the common shortest note are
2829 followed by a space that is proportional to their duration relative to
2830 the common shortest note. So if we were to add only a few 16th notes
2831 to the example above, they would be followed by half a NHW:
2833 @lilypond[quote,verbatim,relative=2]
2834 c2 c4. c8 | c4. c16[ c] c4. c8 | c8 c c4 c c
2838 In the @emph{Essay on automated music engraving}, it was explained
2839 that stem directions influence spacing (see
2840 @ressay{Optical spacing}). This is controlled with the
2841 @code{stem-spacing-correction} property in the
2842 @rinternals{NoteSpacing}, object. These are generated for every
2843 @rinternals{Voice} context. The @code{StaffSpacing} object
2844 (generated in @rinternals{Staff} context) contains the same
2845 property for controlling the stem/bar line spacing. The following
2846 example shows these corrections, once with default settings, and
2847 once with exaggerated corrections:
2849 @lilypond[quote,ragged-right]
2853 \override Staff.NoteSpacing.stem-spacing-correction = #1.5
2854 \override Staff.StaffSpacing.stem-spacing-correction = #1.5
2860 Proportional notation is supported; see @ref{Proportional notation}.
2863 Essay on automated music engraving:
2864 @ressay{Optical spacing}.
2869 Internals Reference:
2870 @rinternals{SpacingSpanner},
2871 @rinternals{NoteSpacing},
2872 @rinternals{StaffSpacing},
2873 @rinternals{NonMusicalPaperColumn}.
2876 There is no convenient mechanism to manually override spacing. The
2877 following work-around may be used to insert extra space into a score,
2878 adjusting the padding value as necessary.
2881 \override Score.NonMusicalPaperColumn.padding = #10
2884 No work-around exists for decreasing the amount of space.
2887 @node New spacing area
2888 @subsection New spacing area
2890 @funindex \newSpacingSection
2891 @cindex new spacing area
2892 @cindex spacing area, new
2893 @cindex notes, spacing horizontally
2895 New sections with different spacing parameters can be started with
2896 @code{newSpacingSection}. This is useful when there are
2897 sections with a different notions of long and short notes.
2899 In the following example, the time signature change introduces a new
2900 section, and hence the 16ths notes are automatically spaced slightly
2903 @lilypond[relative=1,verbatim,quote]
2906 c8 c c4 c16[ c c8] c4
2912 The @code{\newSpacingSection} command creates a new
2913 @code{SpacingSpanner} object at that musical moment.
2914 If the automatic spacing adjustments do not give the required spacing,
2915 manual @code{\override}s may be applied to its properties. These must
2916 be applied at the same musical moment as the @code{\newSpacingSection}
2917 command itself. They will then affect the spacing of all the following
2918 music until the properties are changed in a new spacing section, for
2921 @lilypond[relative=1,verbatim,quote]
2925 \override Score.SpacingSpanner.spacing-increment = #2
2928 \revert Score.SpacingSpanner.spacing-increment
2937 Internals Reference:
2938 @rinternals{SpacingSpanner}.
2941 @node Changing horizontal spacing
2942 @subsection Changing horizontal spacing
2944 Horizontal spacing may be altered with the
2945 @code{base-shortest-duration} property. Here
2946 we compare the same music; once without altering
2947 the property, and then altered. Larger values
2948 of @code{ly:make-moment} will produce smaller
2949 music. Note that @code{ly:make-moment} constructs
2950 a duration, so @code{1 4} is a longer duration
2953 @lilypond[verbatim,line-width=12\cm]
2956 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2957 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2958 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2959 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2964 @lilypond[verbatim,line-width=12\cm]
2967 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2968 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2969 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2970 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2975 \override SpacingSpanner.base-shortest-duration = #(ly:make-moment 1/16)
2984 By default, spacing in tuplets depends on various non-duration
2985 factors (such as accidentals, clef changes, etc). To disregard
2986 such symbols and force uniform equal-duration spacing, use
2987 @code{Score.SpacingSpanner.uniform-stretching}. This
2988 property can only be changed at the beginning of a score,
2990 @lilypond[quote,ragged-right,verbatim]
2994 \tuplet 5/4 { c8 c c c c } c8 c c c
2997 c8 c c c \tuplet 5/4 { c8 c c c c }
3003 \override SpacingSpanner.uniform-stretching = ##t
3009 When @code{strict-note-spacing} is set, notes are spaced without
3010 regard for clefs, bar lines, and grace notes,
3012 @lilypond[quote,ragged-right,relative=2,verbatim]
3013 \override Score.SpacingSpanner.strict-note-spacing = ##t
3014 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c] }
3023 @subsection Line length
3026 @cindex breaking pages
3029 @funindex line-width
3030 @funindex ragged-right
3031 @funindex ragged-last
3033 @c Although line-width can be set in \layout, it should be set in paper
3034 @c block, to get page layout right.
3035 @c Setting indent in \paper block makes not much sense, but it works.
3037 @c Bit verbose and vague, use examples?
3038 The most basic settings influencing the spacing are @code{indent} and
3039 @code{line-width}. They are set in the @code{\layout} block. They
3040 control the indentation of the first line of music, and the lengths of
3043 If @code{ragged-right} is set to true in the @code{\layout} block, then
3044 systems ends at their natural horizontal length, instead of being spread
3045 horizontally to fill the whole line. This is useful for
3046 short fragments, and for checking how tight the natural spacing is.
3047 The normal default setting is false, but if the score has only one
3048 system the default value is true.
3051 @cindex vertical spacing
3053 The option @code{ragged-last} is similar to @code{ragged-right}, but
3054 only affects the last line of the piece. No restrictions are put on
3055 that line. The result is similar to formatting text paragraphs. In a
3056 paragraph, the last line simply takes its natural horizontal length.
3057 @c Note that for text there are several options for the last line.
3058 @c While Knuth TeX uses natural length, lead typesetters use the same
3059 @c stretch as the previous line. eTeX uses \lastlinefit to
3060 @c interpolate between both these solutions.
3075 @node Proportional notation
3076 @subsection Proportional notation
3078 LilyPond supports proportional notation, a type of horizontal spacing
3079 in which each note consumes an amount of horizontal space exactly
3080 equivalent to its rhythmic duration. This type of proportional spacing
3081 is comparable to horizontal spacing on top of graph paper. Some late
3082 20th- and early 21st-century scores use proportional notation to
3083 clarify complex rhythmic relationships or to facilitate the placement
3084 of timelines or other graphics directly in the score.
3086 LilyPond supports five different settings for proportional notation,
3087 which may be used together or alone:
3090 @item @code{proportionalNotationDuration}
3091 @item @code{uniform-stretching}
3092 @item @code{strict-note-spacing}
3093 @item @code{\remove "Separating_line_group_engraver"}
3094 @item @code{\override PaperColumn.used = ##t}
3097 In the examples that follow, we explore these five different
3098 proportional notation settings and examine how these settings interact.
3100 We start with the following one-measure example, which uses classical
3101 spacing with ragged-right turned on.
3103 @lilypond[quote,verbatim,ragged-right]
3106 \new RhythmicStaff {
3107 c'2 c'16 c' c' c' \tuplet 5/4 { c'16 c' c' c' c' }
3113 Notice that the half note which begins the measure takes up far less
3114 than half of the horizontal space of the measure. Likewise, the
3115 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
3116 which end the measure together take up far more than half the
3117 horizontal space of the measure.
3119 In classical engraving, this spacing may be exactly what we want
3120 because we can borrow horizontal space from the half note and conserve
3121 horizontal space across the measure as a whole.
3123 On the other hand, if we want to insert a measured timeline or other
3124 graphic above or below our score, we need proportional notation. We
3125 turn proportional notation on with the proportionalNotationDuration
3128 @lilypond[quote,verbatim,ragged-right]
3131 \new RhythmicStaff {
3132 c'2 c'16 c' c' c' \tuplet 5/4 { c'16 c' c' c' c' }
3138 proportionalNotationDuration = #(ly:make-moment 1/20)
3144 The half note at the beginning of the measure and the faster notes in
3145 the second half of the measure now occupy equal amounts of horizontal
3146 space. We could place a measured timeline or graphic above or below
3149 The @code{proportionalNotationDuration} setting is a context setting
3150 that lives in @code{Score}. Remember that context settings can appear
3151 in one of three locations within our input file -- in a @code{\with}
3152 block, in a @code{\context} block, or directly in music entry preceded
3153 by the @code{\set} command. As with all context settings, users can
3154 pick which of the three different locations they would like to
3155 set @code{proportionalNotationDuration} in to.
3157 The @code{proportionalNotationDuration} setting takes a single argument,
3158 which is the reference duration against that all music will be spaced.
3159 The LilyPond Scheme function @code{make-moment} takes two arguments
3160 -- a numerator and denominator which together express some fraction of
3161 a whole note. The call @code{(ly:make-moment 1/20)} therefore produces
3162 a reference duration of a twentieth note. Values such as
3163 @code{(ly:make-moment 1/16)}, @code{(ly:make-moment 1/8)}, and
3164 @code{(ly:make-moment 3/97)} are all possible as well.
3166 How do we select the right reference duration to pass to
3167 @code{proportionalNotationDuration}? Usually by a process of trial
3168 and error, beginning with a duration close to the fastest (or smallest)
3169 duration in the piece. Smaller reference durations space music loosely;
3170 larger reference durations space music tightly.
3172 @lilypond[quote,verbatim,ragged-right]
3175 \new RhythmicStaff {
3176 c'2 c'16 c' c' c' \tuplet 5/4 { c'16 c' c' c' c' }
3182 proportionalNotationDuration = #(ly:make-moment 1/8)
3189 \new RhythmicStaff {
3190 c'2 c'16 c' c' c' \tuplet 5/4 { c'16 c' c' c' c' }
3196 proportionalNotationDuration = #(ly:make-moment 1/16)
3203 \new RhythmicStaff {
3204 c'2 c'16 c' c' c' \tuplet 5/4 { c'16 c' c' c' c' }
3210 proportionalNotationDuration = #(ly:make-moment 1/32)
3216 Note that too large a reference duration -- such as the eighth note,
3217 above -- spaces music too tightly and can cause note head collisions.
3218 Also that proportional notation in general takes up more horizontal
3219 space than classical spacing. Proportional spacing provides rhythmic
3220 clarity at the expense of horizontal space.
3222 Next we examine how to optimally space overlapping tuplets.
3224 We start by examining what happens to our original example, with
3225 classical spacing, when we add a second staff with a different type of
3228 @lilypond[quote,verbatim,ragged-right]
3231 \new RhythmicStaff {
3232 c'2 c'16 c' c' c' \tuplet 5/4 { c'16 c' c' c' c' }
3234 \new RhythmicStaff {
3235 \tuplet 9/8 { c'8 c' c' c' c' c' c' c' c' }
3241 The spacing is bad because the evenly spaced notes of the bottom staff
3242 do not stretch uniformly. Classical engravings include very few complex
3243 triplets and so classical engraving rules can generate this type of
3244 result. Setting @code{proportionalNotationDuration} fixes this.
3246 @lilypond[quote,verbatim,ragged-right]
3249 \new RhythmicStaff {
3250 c'2 c'16 c' c' c' \tuplet 5/4 { c'16 c' c' c' c' }
3252 \new RhythmicStaff {
3253 \tuplet 9/8 { c'8 c' c' c' c' c' c' c' c' }
3259 proportionalNotationDuration = #(ly:make-moment 1/20)
3265 But if we look very carefully we can see that notes of the second half
3266 of the 9-tuplet space ever so slightly more widely than the notes
3267 of the first half of the 9-tuplet. To ensure uniform stretching, we
3268 turn on @code{uniform-stretching}, which is a property of
3269 @code{SpacingSpanner}.
3271 @lilypond[quote,verbatim,ragged-right]
3274 \new RhythmicStaff {
3275 c'2 c'16 c' c' c' \tuplet 5/4 { c'16 c' c' c' c' }
3277 \new RhythmicStaff {
3278 \tuplet 9/8 { c'8 c' c' c' c' c' c' c' c' }
3284 proportionalNotationDuration = #(ly:make-moment 1/20)
3285 \override SpacingSpanner.uniform-stretching = ##t
3291 Our two-staff example now spaces exactly, our rhythmic
3292 relationships are visually clear, and we can include a measured
3293 timeline or graphic if we want.
3295 Note that the LilyPond's proportional notation package expects
3296 that all proportional scores set the SpacingSpanner's
3297 'uniform-stretching attribute to ##t. Setting
3298 proportionalNotationDuration without also setting the
3299 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3300 example, cause Skips to consume an incorrect amount of horizontal
3303 The SpacingSpanner is an abstract grob that lives in the Score
3304 context. As with our settings of proportionalNotationDuration,
3305 overrides to the SpacingSpanner can occur in any of three
3306 different places in our input file – in the Score \with block, in
3307 a Score \context block, or in note entry directly.
3309 There is by default only one @code{SpacingSpanner} per @code{Score}. This
3310 means that, by default, @code{uniform-stretching} is either turned on for the
3311 entire score or turned off for the entire score. We can, however,
3312 override this behavior and turn on different spacing features at
3313 different places in the score. We do this with the command
3314 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
3316 Next we examine the effects of the @code{Separating_line_group_engraver} and
3317 see why proportional scores frequently remove this engraver. The following
3318 example shows that there is a small amount of @qq{prefatory} space
3319 just before the first note in each system.
3321 @lilypond[quote,verbatim,ragged-right]
3334 The amount of this prefatory space is the same whether after a time
3335 signature, a key signature or a clef. @code{Separating_line_group_engraver}
3336 is responsible for this space. Removing @code{Separating_line_group_engraver}
3337 reduces this space to zero.
3339 @lilypond[quote,verbatim,ragged-right]
3345 \remove "Separating_line_group_engraver"
3353 non-musical elements like time signatures, key signatures, clefs and
3354 accidentals are problematic in proportional notation. None of these
3355 elements has rhythmic duration. But all of these elements consume
3356 horizontal space. Different proportional scores approach these
3357 problems differently.
3359 It may be possible to avoid spacing problems with key signatures
3360 simply by not having any. This is a valid option since most
3361 proportional scores are contemporary music. The same may be true
3362 of time signatures, especially for those scores
3363 that include a measured timeline or other graphic. But these scores
3364 are exceptional and most proportional scores include at least some
3365 time signatures. Clefs and accidentals are even more essential.
3367 So what strategies exist for spacing non-musical elements in a
3368 proportional context? One good option is the @code{strict-note-spacing}
3369 property of @code{SpacingSpanner}. Compare the two scores below:
3371 @lilypond[quote,verbatim,ragged-right]
3373 \set Score.proportionalNotationDuration = #(ly:make-moment 1/16)
3374 c''8 c'' c'' \clef alto d' d'2
3378 \set Score.proportionalNotationDuration = #(ly:make-moment 1/16)
3379 \override Score.SpacingSpanner.strict-note-spacing = ##t
3380 c''8 c'' c'' \clef alto d' d'2
3384 Both scores are proportional, but the spacing in the first score
3385 is too loose because of the clef change. The spacing of the second
3386 score remains strict, however, because strict-note-spacing is
3387 turned on. Turning on strict-note-spacing causes the width of
3388 time signatures, key signatures, clefs and accidentals to play no
3389 part in the spacing algorithm.
3391 In addition to the settings given here, there are other settings
3392 that frequently appear in proportional scores. These include:
3395 @item @code{\override SpacingSpanner.strict-grace-spacing = ##t}
3396 @item @code{\set tupletFullLength = ##t}
3397 @item @code{\override Beam.breakable = ##t}
3398 @item @code{\override Glissando.breakable = ##t}
3399 @item @code{\override TextSpanner.breakable = ##t}
3400 @item @code{\remove "Forbid_line_break_engraver" in the Voice context}
3403 These settings space grace notes strictly, extend tuplet brackets to
3404 mark both rhythmic start- and stop-points, and allow spanning elements
3405 to break across systems and pages. See the respective parts of the manual
3406 for these related settings.
3410 @ref{New spacing area}.
3416 @node Fitting music onto fewer pages
3417 @section Fitting music onto fewer pages
3419 Sometimes you can end up with one or two staves on a second
3420 (or third, or fourth@dots{}) page. This is annoying, especially
3421 if you look at previous pages and it looks like there is plenty
3422 of room left on those.
3424 When investigating layout issues, @code{annotate-spacing} is an
3425 invaluable tool. This command prints the values of various layout
3426 spacing variables; for more details see the following section,
3427 @ref{Displaying spacing}.
3430 * Displaying spacing::
3431 * Changing spacing::
3435 @node Displaying spacing
3436 @subsection Displaying spacing
3438 @funindex annotate-spacing
3439 @cindex spacing, display of layout
3441 To graphically display the dimensions of vertical layout variables
3442 that may be altered for page formatting, set
3443 @code{annotate-spacing} in the @code{\paper} block:
3445 @lilypond[verbatim,quote,papersize=a6landscape]
3448 \paper { annotate-spacing = ##t }
3454 All layout dimensions are displayed in staff-spaces, regardless
3455 of the units specified in the @code{\paper} or @code{\layout} block.
3456 In the above example, @code{paper-height} has a value of 59.75
3457 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3458 default value). Note that:
3460 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3463 @tab = (25.4/72.27) mm
3466 @tab = (@code{staff-size})/4 pts
3468 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3473 In this case, one @code{staff-space} is approximately equal to
3474 1.757mm. Thus the @code{paper-height} measurement of 59.75
3475 @code{staff-spaces} is equivalent to 105 millimeters, the height
3476 of @code{a6} paper in landscape orientation. The pairs
3477 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3478 edge and @var{b} the upper edge of the interval.
3482 @ref{Setting the staff size}.
3488 @node Changing spacing
3489 @subsection Changing spacing
3491 The output of @code{annotate-spacing} reveals vertical dimensions
3492 in great detail. For details about modifying margins and other
3493 layout variables, see @ref{Page layout}.
3495 Other than margins, there are a few other options to save space:
3499 Force systems to move as close together as possible (to fit as
3500 many systems as possible onto a page) while being spaced so that
3501 there is no blank space at the bottom of the page.
3505 system-system-spacing = #'((basic-distance . 0.1) (padding . 0))
3506 ragged-last-bottom = ##f
3512 Force the number of systems. This can help in two ways. Just
3513 setting a value, even the same value as the number of systems
3514 being typeset by default, will sometimes cause more systems to
3515 be fitted onto each page, as an estimation step is then bypassed,
3516 giving a more accurate fit to each page. Also, forcing an actual
3517 reduction in the number of systems may save a further page. For
3518 example, if the default layout has 11 systems, the following
3519 assignment will force a layout with 10 systems.
3528 Force the number of pages. For example, the following
3529 assignment will force a layout with 2 pages.
3538 Avoid (or reduce) objects that increase the vertical size of a
3539 system. For example, volta repeats (or alternate repeats) require
3540 extra space. If these repeats are spread over two systems, they
3541 will take up more space than one system with the volta repeats and
3542 another system without. For example, dynamics that @q{stick out} of
3543 a system can be moved closer to the staff:
3545 @lilypond[verbatim,quote,relative=1]
3547 e4 c g-\tweak X-offset #-2.7 \f c
3551 Alter the horizontal spacing via @code{SpacingSpanner}. For more
3552 details, see @ref{Changing horizontal spacing}. The following
3553 example illustrates the default spacing:
3555 @lilypond[verbatim,quote]
3568 The next example modifies @code{common-shortest-duration} from a
3569 value of @code{1/4} to @code{1/2}. The quarter note is the most
3570 common and shortest duration in this example, so by making this
3571 duration longer, a @q{squeezing} effect occurs:
3573 @lilypond[verbatim,quote]
3585 \override SpacingSpanner.common-shortest-duration =
3586 #(ly:make-moment 1/2)
3593 The @code{common-shortest-duration} property cannot be modified
3594 dynamically, so it must always be placed in a @code{\context}
3595 block so that it applies to the whole score.
3602 @ref{Changing horizontal spacing}.