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
74 expected to be the same for all scores in a book, such as the
75 paper height, or whether to print page numbers, etc. See
76 @ref{Page layout}. The @code{\layout} block contains score layout
77 settings, such as the number of systems to use, or the space
78 between staff-groups, etc. See @ref{Score layout}.
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 The @code{\paper} block can appear within a @code{\book} block,
110 but not within a @code{\score} block. Settings in a @code{\paper}
111 block apply to the entire book, which may include multiple scores.
112 Settings that can appear in a @code{\paper} block include:
117 the @code{set-paper-size} scheme function,
120 @code{\paper} variables used for customizing page layout, and
123 markup definitions used for customizing the layout of headers,
128 The @code{set-paper-size} function is discussed in the next
129 section, @ref{Paper size and automatic scaling}. The
130 @code{\paper} variables that deal with page layout are discussed
131 in later sections. The markup definitions that deal with headers,
132 footers, and titles are discussed in
133 @ref{Custom titles headers and footers}.
135 Most @code{\paper} variables will only work in a @code{\paper}
136 block. The few that will also work in a @code{\layout} block are
137 listed in @ref{The \layout block}.
139 Except when specified otherwise, all @code{\paper} variables that
140 correspond to distances on the page are measured in millimeters,
141 unless a different unit is specified by the user. For example,
142 the following declaration sets @code{top-margin} to ten
151 To set it to @code{0.5} inches, use the @code{\in} unit suffix:
159 The available unit suffixes are @code{\mm}, @code{\cm},
160 @code{\in}, and @code{\pt}. These units are simple values for
161 converting from millimeters; they are defined in
162 @file{ly/paper-defaults-init.ly}. For the sake of clarity, when
163 using millimeters, the @code{\mm} is typically included in the
164 code, even though it is not technically necessary.
166 It is also possible to define @code{\paper} values using Scheme.
167 The Scheme equivalent of the above example is:
171 #(define top-margin (* 0.5 in))
177 @ref{Paper size and automatic scaling},
178 @ref{Custom titles headers and footers},
179 @ref{The \layout block}.
182 @file{ly/paper-defaults-init.ly}.
185 @node Paper size and automatic scaling
186 @subsection Paper size and automatic scaling
194 * Setting the paper size::
195 * Automatic scaling to paper size::
199 @node Setting the paper size
200 @unnumberedsubsubsec Setting the paper size
202 @q{A4} is the default value when no explicit paper size is set. However,
203 there are two functions that can be used to change it
204 @code{set-default-paper-size},
207 #(set-default-paper-size "quarto")
210 which must always be placed at the toplevel scope. and
211 @code{set-paper-size},
215 #(set-paper-size "tabloid")
219 which must always be placed in a @code{\paper} block.
221 If the @code{set-default-paper-size} function is used in the toplevel
222 scope, it must come before the any @code{\paper} block.
223 @code{set-default-paper-size} sets the paper size for all pages,
224 whereas @code{set-paper-size} only sets the paper size for the pages
225 that the @code{\paper} block applies to. For example, if the
226 @code{\paper} block is at the top of the file, then it will apply the
227 paper size to all pages. If the @code{\paper} block is inside a
228 @code{\book}, then the paper size will only apply to that book.
230 When the @code{set-paper-size} function is used, it must be
231 placed @emph{before} any other functions used within the same
232 @code{\paper} block. See @ref{Automatic scaling to paper size}.
234 Paper sizes are defined in @file{scm/paper.scm}, and while it is
235 possible to add custom sizes, they will be overwritten on subsequent
236 software updates. The available paper sizes are listed in
237 @ref{Predefined paper sizes}.
239 @c An appendix entry exists for paper sizes but is not auto-generated
241 The following command can be used in the file to add a custom paper size
242 which can then be used with @code{set-default-paper-size} or
243 @code{set-paper-size} as appropriate,
246 #(set! paper-alist (cons '("my size" . (cons (* 15 in) (* 3 in))) paper-alist))
249 #(set-paper-size "my size")
253 The units @code{in} (inches), @code{cm} (centimeters) and @code{mm}
254 (millimeters) can all be used.
256 @cindex paper size, orientation
257 @cindex page, orientation
258 @cindex paper size, landscape
260 If the symbol @code{'landscape} is added to the paper size function,
261 pages will be rotated by 90 degrees, and wider line widths will be set
265 #(set-default-paper-size "a6" 'landscape)
268 Swapping the paper dimensions @emph{without} having the print rotated
269 (like when printing to postcard size, or creating graphics for inclusion
270 rather than a standalone document) can be achieved by appending
271 @samp{landscape} to the name of the paper size itself:
274 #(set-default-paper-size "a6landscape")
277 When the paper size ends with an explicit @samp{landscape} or
278 @samp{portrait}, the presence of a @code{'landscape} symbol @emph{only}
279 affects print orientation, not the paper dimensions used for layout.
283 @ref{Automatic scaling to paper size},
284 @ref{Predefined paper sizes}.
287 @file{scm/paper.scm}.
290 @node Automatic scaling to paper size
291 @unnumberedsubsubsec Automatic scaling to paper size
293 If the paper size is changed with one of the scheme functions
294 (@code{set-default-paper-size} or @code{set-paper-size}), the
295 values of several @code{\paper} variables are automatically scaled
296 to the new size. To bypass the automatic scaling for a particular
297 variable, set the variable after setting the paper size. Note
298 that the automatic scaling is not triggered by setting the
299 @code{paper-height} or @code{paper-width} variables, even though
300 @code{paper-width} can influence other values (this is separate
301 from scaling and is discussed below). The
302 @code{set-default-paper-size} and @code{set-paper-size} functions
303 are described in @ref{Setting the paper size}.
305 The vertical dimensions affected by automatic scaling are
306 @code{top-margin} and @code{bottom-margin} (see
307 @ref{Fixed vertical spacing \paper variables}). The horizontal
308 dimensions affected by automatic scaling are @code{left-margin},
309 @code{right-margin}, @code{inner-margin}, @code{outer-margin},
310 @code{binding-offset}, @code{indent}, and @code{short-indent} (see
311 @ref{Horizontal spacing \paper variables}).
313 The default values for these dimensions are set in
314 @file{ly/paper-defaults-init.ly}, using internal variables named
315 @code{top-margin-default}, @code{bottom-margin-default}, etc.
316 These are the values that result at the default paper size
317 @code{a4}. For reference, with @code{a4} paper the
318 @code{paper-height} is @code{297\mm} and the @code{paper-width} is
323 @ref{Fixed vertical spacing \paper variables},
324 @ref{Horizontal spacing \paper variables}.
327 @file{ly/paper-defaults-init.ly},
328 @file{scm/paper.scm}.
331 @node Fixed vertical spacing \paper variables
332 @subsection Fixed vertical spacing @code{\paper} variables
334 @warning{Some @code{@bs{}paper} dimensions are automatically
335 scaled to the paper size, which may lead to unexpected behavior.
336 See @ref{Automatic scaling to paper size}.}
338 Default values (before scaling) are defined in
339 @file{ly/paper-defaults-init.ly}.
343 @funindex paper-height
345 The height of the page, unset by default. Note that the automatic
346 scaling of some vertical dimensions is not affected by this.
351 The margin between the top of the page and the top of the
352 printable area. If the paper size is modified, this dimension's
353 default value is scaled accordingly.
356 @funindex bottom-margin
358 The margin between the bottom of the printable area and the bottom
359 of the page. If the paper size is modified, this dimension's
360 default value is scaled accordingly.
363 @funindex ragged-bottom
365 If set to true, systems will not spread vertically down the page.
366 This does not affect the last page. This should be set to true
367 for pieces that have only two or three systems per page, for
368 example orchestral scores.
370 @item ragged-last-bottom
371 @funindex ragged-last-bottom
373 If set to false, systems will spread vertically down the last
374 page. Pieces that amply fill two pages or more should have this
375 set to false. It also affects the last page of book parts, i.e.
376 parts of a book created with @code{\bookpart} blocks.
382 @ref{Automatic scaling to paper size}.
385 @file{ly/paper-defaults-init.ly}.
391 The titles (from the @code{\header} block) are treated as a
392 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
393 add space between the titles and the first system of the score.
395 Explicitly defined paper-sizes will override any user-defined top or
396 bottom margin settings.
399 @node Flexible vertical spacing \paper variables
400 @subsection Flexible vertical spacing @code{\paper} variables
402 In most cases, it is preferable for the vertical distances between
403 certain items (such as margins, titles, systems, and separate
404 scores) to be flexible, so that they stretch and compress nicely
405 according to each situation. A number of @code{\paper} variables
406 (listed below) are available to fine-tune the stretching behavior
409 Note that the @code{\paper} variables discussed in this section do
410 not control the spacing of staves within individual systems.
411 Within-system spacing is controlled by grob properties, with
412 settings typically entered inside a @code{\score} or
413 @code{\layout} block, and not inside a @code{\paper} block. See
414 @ref{Flexible vertical spacing within systems}.
417 * Structure of flexible vertical spacing alists::
418 * List of flexible vertical spacing \paper variables::
422 @node Structure of flexible vertical spacing alists
423 @unnumberedsubsubsec Structure of flexible vertical spacing alists
425 Each of the flexible vertical spacing @code{\paper} variables is
426 an alist (association list) containing four @emph{keys}:
431 @code{basic-distance} -- the vertical distance, measured in
432 staff-spaces, between the @emph{reference points} of the two
433 items, when no collisions would result, and no stretching or
434 compressing is in effect. The reference point of a (title or
435 top-level) markup is its highest point, and the reference point of
436 a system is the vertical center of the nearest @code{StaffSymbol}
437 -- even if a non-staff line (such as a @code{Lyrics} context) is
438 in the way. Values for @code{basic-distance} that are less than
439 either @code{padding} or @code{minimum-distance} are not
440 meaningful, since the resulting distance will never be less than
441 either @code{padding} or @code{minimum-distance}.
444 @code{minimum-distance} -- the smallest allowable vertical
445 distance, measured in staff-spaces, between the reference points
446 of the two items, when compressing is in effect. Values for
447 @code{minimum-distance} that are less than @code{padding} are not
448 meaningful, since the resulting distance will never be less than
451 @c TODO: explain skylines somewhere and xref to it from here.
454 @code{padding} -- the minimum required amount of unobstructed
455 vertical whitespace between the bounding boxes (or skylines) of
456 the two items, measured in staff-spaces.
459 @code{stretchability} -- a unitless measure of the dimension's
460 relative propensity to stretch. If zero, the distance will not
461 stretch (unless collisions would result). When positive, the
462 significance of a particular dimension's @code{stretchability}
463 value lies only in its relation to the @code{stretchability}
464 values of the other dimensions. For example, if one dimension has
465 twice the @code{stretchability} of another, it will stretch twice
466 as easily. Values should be non-negative and finite. The value
467 @code{+inf.0} triggers a @code{programming_error} and is ignored,
468 but @code{1.0e7} can be used for an almost infinitely stretchable
469 spring. If unset, the default value is set to
470 @code{basic-distance}. Note that the dimension's propensity to
471 @emph{compress} cannot be directly set by the user and is equal to
472 (@code{basic-distance}@tie{}@minus{}@tie{}@code{minimum-distance}).
476 If a page has a ragged bottom, the resulting distance is the
482 @code{basic-distance},
485 @code{minimum-distance}, and
488 @code{padding} plus the smallest distance necessary to eliminate
493 For multi-page scores with a ragged bottom on the last page, the last
494 page uses the same spacing as the preceding page, provided there is
495 enough space for that.
497 Specific methods for modifying alists are discussed in
498 @ref{Modifying alists}. The following example demonstrates the
499 two ways these alists can be modified. The first declaration
500 updates one key-value individually, and the second completely
501 redefines the variable:
505 system-system-spacing #'basic-distance = #8
506 score-system-spacing =
507 #'((basic-distance . 12)
508 (minimum-distance . 6)
510 (stretchability . 12))
515 @node List of flexible vertical spacing \paper variables
516 @unnumberedsubsubsec List of flexible vertical spacing @code{\paper} variables
518 The names of these variables follow the format
519 @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}}
520 and @code{@var{lower}} are the items to be spaced. Each distance
521 is measured between the reference points of the two items (see the
522 description of the alist structure above). Note that in these
523 variable names, the term @q{@code{markup}} refers to both
524 @emph{title markups} (@code{bookTitleMarkup} or
525 @code{scoreTitleMarkup}) and @emph{top-level markups} (see
526 @ref{File structure}). All distances are measured in
529 Default settings are defined in @file{ly/paper-defaults-init.ly}.
531 @c TODO: Where do headers/footers fit in? -mp
534 @item markup-system-spacing
535 @funindex markup-system-spacing
537 the distance between a (title or top-level) markup and the system
540 @item score-markup-spacing
541 @funindex score-markup-spacing
543 the distance between the last system of a score and the (title or
544 top-level) markup that follows it.
546 @item score-system-spacing
547 @funindex score-system-spacing
549 the distance between the last system of a score and the first
550 system of the score that follows it, when no (title or top-level)
551 markup exists between them.
553 @item system-system-spacing
554 @funindex system-system-spacing
556 the distance between two systems in the same score.
558 @item markup-markup-spacing
559 @funindex markup-markup-spacing
561 the distance between two (title or top-level) markups.
563 @item last-bottom-spacing
564 @funindex last-bottom-spacing
566 the distance from the last system or top-level markup on a page to
567 the bottom of the printable area (i.e. the top of the bottom
570 @item top-system-spacing
571 @funindex top-system-spacing
573 the distance from the top of the printable area (i.e. the bottom
574 of the top margin) to the first system on a page, when there is no
575 (title or top-level) markup between the two.
577 @item top-markup-spacing
578 @funindex top-markup-spacing
580 the distance from the top of the printable area (i.e. the bottom
581 of the top margin) to the first (title or top-level) markup on a
582 page, when there is no system between the two.
587 @ref{Flexible vertical spacing within systems}.
590 @file{ly/paper-defaults-init.ly}.
596 @node Horizontal spacing \paper variables
597 @subsection Horizontal spacing @code{\paper} variables
599 @warning{Some @code{@bs{}paper} dimensions are automatically
600 scaled to the paper size, which may lead to unexpected behavior.
601 See @ref{Automatic scaling to paper size}.}
604 * \paper variables for widths and margins::
605 * \paper variables for two-sided mode::
606 * \paper variables for shifts and indents::
610 @node \paper variables for widths and margins
611 @unnumberedsubsubsec @code{\paper} variables for widths and margins
613 Default values (before scaling) that are not listed here are
614 defined in @file{ly/paper-defaults-init.ly}.
619 @funindex paper-width
621 The width of the page, unset by default. While @code{paper-width}
622 has no effect on the automatic scaling of some horizontal
623 dimensions, it does influence the @code{line-width} variable. If
624 both @code{paper-width} and @code{line-width} are set, then
625 @code{left-margin} and @code{right-margin} will also be updated.
626 Also see @code{check-consistency}.
631 The horizontal extent of the staff lines in unindented, non-ragged
633 @code{(paper-width@tie{}@minus{}@tie{}left-margin@tie{}@minus{}@tie{}right-margin)}
634 when unset. If @code{line-width} is set, and both
635 @code{left-margin} and @code{right-margin} are unset, then the
636 margins will be updated to center the systems on the page
637 automatically. Also see @code{check-consistency}. This variable
638 can also be set in a @code{\layout} block.
641 @funindex left-margin
643 The margin between the left edge of the page and the start of the
644 staff lines in unindented systems. If the paper size is modified,
645 this dimension's default value is scaled accordingly. If
646 @code{left-margin} is unset, and both @code{line-width} and
647 @code{right-margin} are set, then @code{left-margin} is set to
648 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}right-margin)}.
649 If only @code{line-width} is set, then both margins are set to
650 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
651 and the systems are consequently centered on the page. Also see
652 @code{check-consistency}.
655 @funindex right-margin
657 The margin between the right edge of the page and the end of the
658 staff lines in non-ragged systems. If the paper size is modified,
659 this dimension's default value is scaled accordingly. If
660 @code{right-margin} is unset, and both @code{line-width} and
661 @code{left-margin} are set, then @code{right-margin} is set to
662 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}left-margin)}.
663 If only @code{line-width} is set, then both margins are set to
664 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
665 and the systems are consequently centered on the page. Also see
666 @code{check-consistency}.
668 @item check-consistency
669 @funindex check-consistency
671 If set to true, print a warning if @code{left-margin},
672 @code{line-width}, and @code{right-margin} do not exactly add up
673 to @code{paper-width}, and replace each of these (except
674 @code{paper-width}) with its default value (scaled to the paper
675 size if necessary). If set to false, ignore any inconsistencies
676 and allow systems to run off the edge of the page.
679 @funindex ragged-right
681 If set to true, systems will not fill the line width. Instead,
682 systems end at their natural horizontal length. Default:
683 @code{#t} for scores with only one system, and @code{#f} for
684 scores with two or more systems. This variable can also be set in
685 a @code{\layout} block.
688 @funindex ragged-last
690 If set to true, the last system in the score will not fill the
691 line width. Instead the last system ends at its natural
692 horizontal length. Default: @code{#f}. This variable can also be
693 set in a @code{\layout} block.
699 @ref{Automatic scaling to paper size}.
702 @file{ly/paper-defaults-init.ly}.
705 Explicitly defined paper-sizes will override any user-defined left or
706 right margin settings.
709 @node \paper variables for two-sided mode
710 @unnumberedsubsubsec @code{\paper} variables for two-sided mode
712 Default values (before scaling) are defined in
713 @file{ly/paper-defaults-init.ly}.
721 @cindex binding gutter
723 If set to true, use @code{inner-margin}, @code{outer-margin} and
724 @code{binding-offset} to determine margins depending on whether
725 the page number is odd or even. This overrides @code{left-margin}
726 and @code{right-margin}.
729 @funindex inner-margin
731 The margin all pages have at the inner side if they are part of a
732 book. If the paper size is modified, this dimension's default
733 value is scaled accordingly. Works only with @code{two-sided} set
737 @funindex outer-margin
739 The margin all pages have at the outer side if they are part of a
740 book. If the paper size is modified, this dimension's default
741 value is scaled accordingly. Works only with @code{two-sided} set
745 @funindex binding-offset
747 The amount @code{inner-margin} is increased to make sure nothing
748 will be hidden by the binding. If the paper size is modified,
749 this dimension's default value is scaled accordingly. Works only
750 with @code{two-sided} set to true.
756 @ref{Automatic scaling to paper size}.
759 @file{ly/paper-defaults-init.ly}.
762 @node \paper variables for shifts and indents
763 @unnumberedsubsubsec @code{\paper} variables for shifts and indents
765 Default values (before scaling) that are not listed here are
766 defined in @file{ly/paper-defaults-init.ly}.
770 @item horizontal-shift
771 @funindex horizontal-shift
773 @c This default value is buried in the middle of page.scm. -mp
775 The amount that all systems (including titles and system
776 separators) are shifted to the right. Default: @code{0.0\mm}.
781 The level of indentation for the first system in a score. If the
782 paper size is modified, this dimension's default value is scaled
783 accordingly. This variable can also be set in a @code{\layout}
787 @funindex short-indent
789 The level of indentation for all systems in a score besides the
790 first system. If the paper size is modified, this dimension's
791 default value is scaled accordingly. This variable can also be
792 set in a @code{\layout} block.
798 @ref{Automatic scaling to paper size}.
801 @file{ly/paper-defaults-init.ly}.
807 @node Other \paper variables
808 @subsection Other @code{\paper} variables
811 * \paper variables for line breaking::
812 * \paper variables for page breaking::
813 * \paper variables for page numbering::
814 * Miscellaneous \paper variables::
818 @node \paper variables for line breaking
819 @unnumberedsubsubsec @code{\paper} variables for line breaking
823 @item max-systems-per-page
824 @funindex max-systems-per-page
826 The maximum number of systems that will be placed on a page. This
827 is currently supported only by the @code{ly:optimal-breaking} algorithm.
830 @item min-systems-per-page
831 @funindex min-systems-per-page
833 The minimum number of systems that will be placed on a page. This
834 may cause pages to be overfilled if it is made too large. This is
835 currently supported only by the @code{ly:optimal-breaking} algorithm.
838 @item systems-per-page
839 @funindex systems-per-page
841 The number of systems that should be placed on each page.
842 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
846 @funindex system-count
848 The number of systems to be used for a score. Default: unset.
849 This variable can also be set in a @code{\layout} block.
858 @node \paper variables for page breaking
859 @unnumberedsubsubsec @code{\paper} variables for page breaking
861 Default values not listed here are defined in
862 @file{ly/paper-defaults-init.ly}
867 @funindex page-breaking
869 The page-breaking algorithm to use. Choices are
870 @code{ly:minimal-breaking}, @code{ly:page-turn-breaking},
871 @code{ly:one-line-breaking} and @code{ly:optimal-breaking}
874 @item page-breaking-system-system-spacing
875 @funindex page-breaking-system-system-spacing
877 Tricks the page breaker into thinking that
878 @code{system-system-spacing} is set to something different than
879 it really is. For example, if
880 @code{page-breaking-system-system-spacing #'padding} is set to something
881 substantially larger than @code{system-system-spacing #'padding}, then the
882 page-breaker will put fewer systems on each page. Default: unset.
887 The number of pages to be used for a score, unset by default.
891 The following variables are effective only when @code{page-breaking}
892 is set to @code{ly:page-turn-breaking}. Page breaks are then chosen
893 to minimize the number of page turns. Since page turns are required
894 on moving from an odd-numbered page to an even-numbered one, a
895 layout in which the last page is odd-numbered will usually be
896 favoured. Places where page turns are preferred can be indicated
897 manually by inserting @code{\allowPageTurn} or automatically by
898 including the @code{Page_turn_engraver} (see @ref{Optimal page turning}).
900 If there are insufficient choices available for making suitable page
901 turns, LilyPond may insert a blank page either within a score, between
902 scores (if there are two or more scores), or by ending a score on an
903 even-numbered page. The values of the following three variables may
904 be increased to make these actions less likely.
906 The values are penalties, i.e. the higher the value the less likely
907 will be the associated action relative to other choices.
911 @item blank-page-penalty
912 @funindex blank-page-penalty
914 The penalty for having a blank page in the middle of a score. If
915 @code{blank-page-penalty} is large and @code{ly:page-turn-breaking} is
916 selected, then LilyPond will be less likely to insert a page in the
917 middle of a score. Instead, it will space out the music further to
918 fill the blank page and the following one. Default: 5.
920 @item blank-last-page-penalty
921 @funindex blank-last-page-penalty
923 The penalty for ending the score on an even-numbered page. If
924 @code{blank-last-page-penalty} is large and
925 @code{ly:page-turn-breaking} is selected, then LilyPond will be less
926 likely to produce a score in which the last page is even-numbered.
927 Instead, it will adjust the spacing in order to use one page more or
928 one page less. Default: 0.
930 @item blank-after-score-page-penalty
931 @funindex blank-after-score-page-penalty
933 The penalty for having a blank page after the end of one score and
934 before the next. By default, this is smaller than
935 @code{blank-page-penalty}, so that blank pages after scores are
936 inserted in preference to blank pages within a score. Default: 2.
944 @ref{Optimal page breaking},
945 @ref{Optimal page turning},
946 @ref{Minimal page breaking},
947 @ref{One-line page breaking}.
950 @file{ly/paper-defaults-init.ly}.
953 @node \paper variables for page numbering
954 @unnumberedsubsubsec @code{\paper} variables for page numbering
956 Default values not listed here are defined in
957 @file{ly/paper-defaults-init.ly}
961 @cindex page numbers, auto-numbering
962 @item auto-first-page-number
963 @funindex auto-first-page-number
965 The page breaking algorithm is affected by the first page number
966 being odd or even. If set to true, the page breaking algorithm
967 will decide whether to start with an odd or even number. This
968 will result in the first page number remaining as is or being
969 increased by one. Default: @code{#f}.
971 @cindex page numbers, specify the first
972 @item first-page-number
973 @funindex first-page-number
975 The value of the page number on the first page.
977 @item print-first-page-number
978 @funindex print-first-page-number
980 If set to true, a page number is printed on the first page.
982 @cindex page numbers, suppress
983 @item print-page-number
984 @funindex print-page-number
986 If set to false, page numbers are not printed.
992 @file{ly/paper-defaults-init.ly}.
995 Odd page numbers are always on the right. If you want the
996 music to start on page 1 there must be a blank page on the back
997 of the cover page so that page 1 is on the right hand side.
1000 @node Miscellaneous \paper variables
1001 @unnumberedsubsubsec Miscellaneous @code{\paper} variables
1005 @item page-spacing-weight
1006 @funindex page-spacing-weight
1008 The relative importance of page (vertical) spacing and line
1009 (horizontal) spacing. High values will make page spacing more
1010 important. Default: @code{10}.
1012 @item print-all-headers
1013 @funindex print-all-headers
1015 If set to true, this will print all headers for each @code{\score}
1016 in the output. Normally only the @code{piece} and @code{opus}
1017 header variables are printed. Default: @code{#f}.
1019 @item system-separator-markup
1020 @funindex system-separator-markup
1022 A markup object that is inserted between systems, often used for
1023 orchestral scores. Default: unset. The @code{\slashSeparator}
1024 markup, defined in @file{ly/titling-init.ly}, is provided as a
1025 sensible default, for example:
1027 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
1028 #(set-default-paper-size "a8")
1032 system-separator-markup = \slashSeparator
1038 \relative c'' { c1 \break c1 \break c1 }
1047 @file{ly/titling-init.ly}.
1053 The default page header puts the page number and the @code{instrument}
1054 field from the @code{\header} block on a line.
1058 @section Score layout
1060 This section discusses score layout options for the @code{\layout}
1064 * The \layout block::
1065 * Setting the staff size::
1069 @node The \layout block
1070 @subsection The @code{\layout} block
1074 While the @code{\paper} block contains settings that relate to the
1075 page formatting of the whole document, the @code{\layout} block
1076 contains settings for score-specific layout. To set score layout
1077 options globally, enter them in a toplevel @code{\layout} block.
1078 To set layout options for an individual score, enter them in a
1079 @code{\layout} block inside the @code{\score} block, after the
1080 music. Settings that can appear in a @code{\layout} block
1084 @item the @code{layout-set-staff-size} scheme function,
1085 @item context modifications in @code{\context} blocks, and
1086 @item @code{\paper} variables that affect score layout.
1089 The @code{layout-set-staff-size} function is discussed in the next
1090 section, @ref{Setting the staff size}. Context modifications are
1091 discussed in a separate chapter; see
1092 @ref{Modifying context plug-ins} and
1093 @ref{Changing context default settings}. The @code{\paper}
1094 variables that can appear in a @code{\layout} block are:
1099 @code{line-width}, @code{ragged-right} and @code{ragged-last}
1100 (see @ref{\paper variables for widths and margins})
1103 @code{indent} and @code{short-indent}
1104 (see @ref{\paper variables for shifts and indents})
1108 (see @ref{\paper variables for line breaking})
1112 Here is an example @code{\layout} block:
1119 \override StaffGrouper.staff-staff-spacing.basic-distance = #8
1123 \override TextScript.padding = #1
1124 \override Glissando.thickness = #3
1129 Multiple @code{\layout} blocks can be entered as toplevel expressions.
1130 This can, for example, be useful if different settings are stored in
1131 separate files and included optionally. Internally, when
1132 a @code{\layout} block is evaluated, a copy of the current
1133 @code{\layout} configuration is made, then any changes defined within
1134 the block are applied and the result is saved as the new current
1135 configuration. From the user's perspective the @code{\layout} blocks
1136 are combined, but in conflicting situations (when the same property
1137 is changed in different blocks) the later definitions take precedence.
1139 For example, if this block:
1145 \override TextScript.color = #magenta
1146 \override Glissando.thickness = #1.5
1151 is placed after the one from the preceding example the @code{'padding}
1152 and @code{'color} overrides for @code{TextScript} are combined, but
1153 the later @code{'thickness} override for @code{Glissando} replaces
1154 (or hides) the earlier one.
1156 @code{\layout} blocks may be assigned to variables for reuse later,
1157 but the way this works is slightly but significantly different from
1158 writing them literally.
1160 If a variable is defined like this:
1163 layoutVariable = \layout @{
1166 \override NoteHead.font-size = #4
1171 it will hold the current @code{\layout} configuration with the
1172 @code{NoteHead.font-size} override added, but this combination
1173 is @emph{not} saved as the new current configuration. Be aware
1174 that the @q{current configuration} is read when the variable is
1175 defined and not when it is used, so the content of the variable
1176 is dependent on its position in the source.
1178 The variable can then be used inside another @code{\layout} block,
1186 \override NoteHead.color = #red
1191 A @code{\layout} block containing a variable, as in the example above,
1192 does @emph{not} copy the current configuration but instead uses the
1193 content of @code{\layoutVariable} as the base configuration for the
1194 further additions. This means that any changes defined between the
1195 definition and the use of the variable are lost.
1197 If @code{layoutVariable} is defined (or @code{\include}d) immediately
1198 before being used, its content is just the current configuration plus
1199 the overrides defined within it. So in the example above showing the
1200 use of @code{\layoutVariable} the final @code{\layout} block would
1204 TextScript.padding = #1
1205 TextScript.color = #magenta
1206 Glissando.thickness = #1.5
1207 NoteHead.font-size = #4
1208 NoteHead.color = #red
1211 plus the @code{indent} and the @code{StaffGrouper} overrides.
1213 But if the variable had already been defined before the first
1214 @code{\layout} block the current configuration would now contain
1218 NoteHead.font-size = #4 % (written in the variable definition)
1219 NoteHead.color = #red % (added after the use of the variable)
1222 If carefully planned, @code{\layout} variables can be a valuable tool
1223 to structure the layout design of sources, and also to reset the
1224 @code{\layout} configuration to a known state.
1228 @ref{Changing context default settings}.
1234 @node Setting the staff size
1235 @subsection Setting the staff size
1237 @cindex font size, setting
1238 @cindex staff size, setting
1239 @funindex layout file
1241 The default @strong{staff size} is set to 20 points.
1242 This may be changed in two ways:
1244 To set the staff size globally for all scores in a file (or
1245 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
1248 #(set-global-staff-size 14)
1252 This sets the global default size to 14pt staff height and scales all
1255 To set the staff size individually for each score, use
1260 #(layout-set-staff-size 15)
1265 The Feta font provides musical symbols at eight different
1266 sizes. Each font is tuned for a different staff size: at a smaller size
1267 the font becomes heavier, to match the relatively heavier staff lines.
1268 The recommended font sizes are listed in the following table:
1271 @multitable @columnfractions .15 .2 .22 .2
1274 @tab @b{staff height (pt)}
1275 @tab @b{staff height (mm)}
1317 @c modern rental material?
1322 These fonts are available in any sizes. The context property
1323 @code{fontSize} and the layout property @code{staff-space} (in
1324 @rinternals{StaffSymbol}) can be used to tune the size for individual
1325 staves. The sizes of individual staves are relative to the global size.
1329 @ref{Selecting notation font size}.
1335 @code{layout-set-staff-size} does not change the distance between the
1345 * Optimal page breaking::
1346 * Optimal page turning::
1347 * Minimal page breaking::
1348 * One-line page breaking::
1350 * Using an extra voice for breaks::
1355 @subsection Line breaking
1358 @cindex breaking lines
1360 Line breaks are normally determined automatically. They are chosen
1361 so that lines look neither cramped nor loose, and consecutive
1362 lines have similar density.
1364 To manually force a line break at a bar line, use the
1365 @code{\break} command:
1367 @lilypond[quote,ragged-right,relative=2,verbatim]
1372 By default, a @code{\break} in the middle of a measure is ignored,
1373 and a warning is printed. To force a line break in the middle of
1374 a measure, add an invisible bar line with @w{@samp{\bar ""}}:
1376 @lilypond[quote,ragged-right,relative=2,verbatim]
1383 A @code{\break} occurring at a bar line is also ignored if the
1384 previous measure ends in the middle of a note, such as when a
1385 tuplet begins and ends in different measures. To allow
1386 @code{\break} commands to work in these situations, remove the
1387 @code{Forbid_line_break_engraver} from the @code{Voice} context.
1388 Note that manually forced line breaks have to be added in parallel
1391 @lilypond[quote,ragged-right,verbatim]
1393 \remove "Forbid_line_break_engraver"
1396 { c2. \times 2/3 { c4 c c } c2. | }
1397 { s1 | \break s1 | }
1402 Similarly, line breaks are normally forbidden when beams cross bar
1403 lines. This behavior can be changed by setting
1404 @code{\override Beam.breakable = ##t}:
1406 @lilypond[quote,ragged-right,relative=2,verbatim]
1407 \override Beam.breakable = ##t
1412 The @code{\noBreak} command forbids a line break at the bar line
1413 where it is inserted.
1415 The most basic settings influencing line spacing are @code{indent}
1416 and @code{line-width}. They are set in the @code{\layout} block.
1417 They control the indentation of the first line of music, and the
1418 lengths of the lines.
1420 If @code{ragged-right} is set to true in the @code{\layout} block,
1421 then systems end at their natural horizontal length, instead of
1422 being spread horizontally to fill the whole line. This is useful
1423 for short fragments, and for checking how tight the natural
1426 @c TODO Check and add para on default for ragged-right
1428 The option @code{ragged-last} is similar to @code{ragged-right},
1429 but affects only the last line of the piece.
1441 @cindex regular line breaks
1442 @cindex four bar music.
1444 For line breaks at regular intervals use @code{\break} separated by
1445 skips and repeated with @code{\repeat}. For example, this would
1446 cause the following 28 measures (assuming 4/4 time) to be broken
1447 every 4 measures, and only there:
1452 s1 \noBreak s1 \noBreak
1453 s1 \noBreak s1 \break
1455 @{ @var{the actual music@dots{}} @}
1469 @ref{\paper variables for line breaking}.
1474 Internals Reference:
1475 @rinternals{LineBreakEvent}.
1479 @subsection Page breaking
1481 The default page breaking may be overridden by inserting
1482 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1483 analogous to @code{\break} and @code{\noBreak}. They should be
1484 inserted at a bar line. These commands force and forbid a page-break
1485 from happening. Of course, the @code{\pageBreak} command also forces
1488 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1489 inserted at top-level, between scores and top-level markups.
1491 There are also analogous settings to @code{ragged-right} and
1492 @code{ragged-last} which have the same effect on vertical spacing:
1493 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1494 @code{#t} the systems on all pages or just the last page
1495 respectively will not be justified vertically. See
1496 @ref{Fixed vertical spacing \paper variables}.
1498 Page breaks are computed by the @code{page-breaking} function. LilyPond
1499 provides three algorithms for computing page breaks,
1500 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1501 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1502 but the value can be changed in the @code{\paper} block:
1506 page-breaking = #ly:page-turn-breaking
1512 When a book has many scores and pages, the page breaking problem may be
1513 difficult to solve, requiring large processing time and memory. To ease
1514 the page breaking process, @code{\bookpart} blocks are used to divide
1515 the book into several parts: the page breaking occurs separately on each
1516 part. Different page breaking functions may also be used in different
1522 subtitle = "Preface"
1525 %% In a part consisting mostly of text,
1526 %% ly:minimal-breaking may be preferred
1527 page-breaking = #ly:minimal-breaking
1529 \markup @{ @dots{} @}
1533 %% In this part, consisting of music, the default optimal
1534 %% page breaking function is used.
1536 subtitle = "First movement"
1538 \score @{ @dots{} @}
1545 @funindex \pageBreak
1547 @funindex \noPageBreak
1548 @code{\noPageBreak}.
1553 @ref{\paper variables for page breaking}.
1559 @node Optimal page breaking
1560 @subsection Optimal page breaking
1562 @funindex ly:optimal-breaking
1564 The @code{ly:optimal-breaking} function is LilyPond's default method of
1565 determining page breaks. It attempts to find a page breaking that minimizes
1566 cramping and stretching, both horizontally and vertically. Unlike
1567 @code{ly:page-turn-breaking}, it has no concept of page turns.
1574 @node Optimal page turning
1575 @subsection Optimal page turning
1577 @funindex ly:page-turn-breaking
1579 Often it is necessary to find a page breaking configuration so that there is
1580 a rest at the end of every second page. This way, the musician can turn the
1581 page without having to miss notes. The @code{ly:page-turn-breaking} function
1582 attempts to find a page breaking minimizing cramping and stretching, but with
1583 the additional restriction that it is only allowed to introduce page turns
1584 in specified places.
1586 There are two steps to using this page breaking function. First, you
1587 must enable it in the @code{\paper} block, as explained in @ref{Page
1588 breaking}. Then you must tell the function where you would like to allow
1591 There are two ways to achieve the second step. First, you can specify each
1592 potential page turn manually, by inserting @code{\allowPageTurn} into your
1593 input file at the appropriate places.
1595 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1596 Voice context. The @code{Page_turn_engraver} will scan the context for
1597 sections without notes (note that it does not scan for rests; it scans for
1598 the absence of notes. This is so that single-staff polyphony with rests in one
1599 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1600 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1601 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1602 there is a @q{special} bar line (such as a double bar), in which case the
1603 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1606 @funindex minimumPageTurnLength
1607 The @code{Page_turn_engraver} reads the context property
1608 @code{minimumPageTurnLength} to determine how long a note-free section must
1609 be before a page turn is considered. The default value for
1610 @code{minimumPageTurnLength} is @code{(ly:make-moment 1 1)}. If you want
1611 to disable page turns, you can set it to something very large.
1614 \new Staff \with @{ \consists "Page_turn_engraver" @}
1617 R1 | % a page turn will be allowed here
1619 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1620 R1 | % a page turn will not be allowed here
1622 R1*2 | % a page turn will be allowed here
1627 @funindex minimumRepeatLengthForPageTurn
1628 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1629 turn during the repeat if there is enough time at the beginning and end of the
1630 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1631 page turns if the repeat is very short. If you set the context property
1632 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1633 only allow turns in repeats whose duration is longer than this value.
1635 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1636 @code{\allowPageTurn}, may also be used at top-level, between scores and
1642 @funindex \noPageTurn
1644 @funindex \allowPageTurn
1645 @code{\allowPageTurn}.
1650 @ref{\paper variables for line breaking}.
1656 There should only be one @code{Page_turn_engraver} in a score. If there is more
1657 than one, they will interfere with each other.
1660 @node Minimal page breaking
1661 @subsection Minimal page breaking
1663 @funindex ly:minimal-breaking
1665 The @code{ly:minimal-breaking} function performs minimal computations to
1666 calculate the page breaking: it fills a page with as many systems as
1667 possible before moving to the next one. Thus, it may be preferred for
1668 scores with many pages, where the other page breaking functions could be
1669 too slow or memory demanding, or a lot of texts. It is enabled using:
1673 page-breaking = #ly:minimal-breaking
1681 @node One-line page breaking
1682 @subsection One-line page breaking
1684 @funindex ly:one-line-breaking
1686 The @code{ly:one-line-breaking} function is a special-purpose
1687 page breaking algorithm that puts each score on its own page,
1688 and on a single line. This page breaking function does not
1689 typeset titles or margins; only the score will be displayed.
1691 The page width will be adjusted so that
1692 the longest score fits on one line. In particular,
1693 @code{paper-width}, @code{line-width} and @code{indent}
1694 variables in the @code{\paper} block will be ignored, although
1695 @code{left-margin} and @code{right-margin} will
1696 still be honored. The height of the page will
1699 @node Explicit breaks
1700 @subsection Explicit breaks
1702 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1703 commands. There are two commands to override this behavior:
1706 \override NonMusicalPaperColumn.line-break-permission = ##f
1707 \override NonMusicalPaperColumn.page-break-permission = ##f
1710 When @code{line-break-permission} is overridden to false, Lily will insert
1711 line breaks at explicit @code{\break} commands and nowhere else. When
1712 @code{page-break-permission} is overridden to false, Lily will insert
1713 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1715 @lilypond[quote,verbatim]
1722 music = \relative c'' { c8 c c c }
1726 \repeat unfold 2 { \music } \break
1727 \repeat unfold 4 { \music } \break
1728 \repeat unfold 6 { \music } \break
1729 \repeat unfold 8 { \music } \pageBreak
1730 \repeat unfold 8 { \music } \break
1731 \repeat unfold 6 { \music } \break
1732 \repeat unfold 4 { \music } \break
1733 \repeat unfold 2 { \music }
1738 \override NonMusicalPaperColumn.line-break-permission = ##f
1739 \override NonMusicalPaperColumn.page-break-permission = ##f
1750 @node Using an extra voice for breaks
1751 @subsection Using an extra voice for breaks
1753 Line- and page-breaking information usually appears within note entry directly.
1756 music = \relative c'' @{ c4 c c c @}
1760 \repeat unfold 2 @{ \music @} \break
1761 \repeat unfold 3 @{ \music @}
1766 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1767 music entry with information that specifies how music should lay out
1768 on the page. You can keep music entry and line- and page-breaking
1769 information in two separate places by introducing an extra voice to
1770 contain the breaks. This extra voice
1771 contains only skips together with @code{\break}, @code{pageBreak} and other
1772 breaking layout information.
1774 @lilypond[quote,verbatim]
1775 music = \relative c'' { c4 c c c }
1786 \repeat unfold 2 { \music }
1787 \repeat unfold 3 { \music }
1788 \repeat unfold 6 { \music }
1789 \repeat unfold 5 { \music }
1795 This pattern becomes especially helpful when overriding
1796 @code{line-break-system-details} and the other useful but long properties of
1797 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1799 @lilypond[quote,verbatim]
1800 music = \relative c'' { c4 c c c }
1805 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 0))
1808 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 35))
1811 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 70))
1814 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 105))
1818 \repeat unfold 2 { \music }
1819 \repeat unfold 3 { \music }
1820 \repeat unfold 6 { \music }
1821 \repeat unfold 5 { \music }
1829 @ref{Vertical spacing}.
1835 @node Vertical spacing
1836 @section Vertical spacing
1838 @cindex vertical spacing
1839 @cindex spacing, vertical
1841 Vertical spacing is controlled by three things: the amount of
1842 space available (i.e., paper size and margins), the amount of
1843 space between systems, and the amount of space between
1844 staves inside a system.
1847 * Flexible vertical spacing within systems::
1848 * Explicit staff and system positioning::
1849 * Vertical collision avoidance::
1853 @node Flexible vertical spacing within systems
1854 @subsection Flexible vertical spacing within systems
1856 @cindex distance between staves
1857 @cindex staff distance
1858 @cindex space between staves
1859 @cindex space inside systems
1861 Three separate mechanisms control the flexible vertical spacing
1862 within systems, one for each of the following categories:
1867 @emph{ungrouped staves},
1870 @emph{grouped staves} (staves within a staff-group such as
1871 @code{ChoirStaff}, etc.), and
1874 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1879 @c TODO: Clarify this. This almost implies that non-staff lines
1880 @c have NO effect on the spacing between staves. -mp
1882 The height of each system is determined in two steps. First, all
1883 of the staves are spaced according to the amount of space
1884 available. Then, the non-staff lines are distributed between the
1887 Note that the spacing mechanisms discussed in this section only
1888 control the vertical spacing of staves and non-staff lines within
1889 individual systems. The vertical spacing between separate
1890 systems, scores, markups, and margins is controlled by
1891 @code{\paper} variables, which are discussed in
1892 @ref{Flexible vertical spacing \paper variables}.
1895 * Within-system spacing properties::
1896 * Spacing of ungrouped staves::
1897 * Spacing of grouped staves::
1898 * Spacing of non-staff lines::
1902 @node Within-system spacing properties
1903 @unnumberedsubsubsec Within-system spacing properties
1905 @funindex staff-affinity
1906 @funindex staffgroup-staff-spacing
1907 @funindex staff-staff-spacing
1908 @funindex nonstaff-unrelatedstaff-spacing
1909 @funindex nonstaff-relatedstaff-spacing
1910 @funindex nonstaff-nonstaff-spacing
1911 @funindex default-staff-staff-spacing
1912 @funindex minimum-Y-extent
1913 @funindex extra-offset
1914 @funindex self-alignment-X
1916 @funindex VerticalAxisGroup
1918 The within-system vertical spacing mechanisms are controlled by
1919 two sets of grob properties. The first set is associated with the
1920 @code{VerticalAxisGroup} grob, which is created by all staves and
1921 non-staff lines. The second set is associated with the
1922 @code{StaffGrouper} grob, which can be created by staff-groups,
1923 but only if explicitly called. These properties are described
1924 individually at the end of this section.
1926 The names of these properties (except for @code{staff-affinity})
1927 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1928 @code{@var{item1}} and @code{@var{item2}} are the items to be
1929 spaced. Note that @code{@var{item2}} is not necessarily below
1930 @code{@var{item1}}; for example,
1931 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1932 non-staff line if @code{staff-affinity} is @code{UP}.
1934 Each distance is measured between the @emph{reference points} of
1935 the two items. The reference point for a staff is the vertical
1936 center of its @code{StaffSymbol} (i.e. the middle line if
1937 @code{line-count} is odd; the middle space if @code{line-count} is
1938 even). The reference points for individual non-staff lines are
1939 given in the following table:
1941 @multitable {Non-staff line} {Reference point}
1942 @headitem Non-staff line @tab Reference point
1943 @item @code{ChordNames} @tab baseline
1944 @item @code{NoteNames} @tab baseline
1945 @item @code{Lyrics} @tab baseline
1946 @item @code{Dynamics} @tab vertical center
1947 @item @code{FiguredBass} @tab highest point
1948 @item @code{FretBoards} @tab top line
1951 In the following image, horizontal lines indicate the positions
1952 of these reference points:
1954 @lilypond[quote,noragged-right,line-width=110\mm]
1955 #(define zero-space '((padding . -inf.0) (basic-distance . 0)))
1957 alignToZero = \with {
1958 \override VerticalAxisGroup.nonstaff-relatedstaff-spacing = #zero-space
1959 \override VerticalAxisGroup.nonstaff-nonstaff-spacing = #zero-space
1961 lowerCaseChords = \with {
1962 chordNameLowercaseMinor = ##t
1964 staffAffinityDown = \with {
1965 \override VerticalAxisGroup.staff-affinity = #DOWN
1968 #(define-music-function
1969 (parser location context)
1971 #{ s1*0^\markup { \typewriter #context } #})
1974 \context { \Dynamics \alignToZero }
1975 \context { \FiguredBass \alignToZero }
1976 \context { \Lyrics \alignToZero }
1977 \context { \NoteNames \alignToZero \staffAffinityDown }
1978 \context { \ChordNames \alignToZero
1981 \context { \FretBoards \alignToZero \staffAffinityDown }
1983 \override BarLine.stencil = ##f
1984 \override DynamicText.self-alignment-X = #-1
1985 \override FretBoard.X-offset = #1.75
1986 \override InstrumentName.minimum-Y-extent = #'(-2 . 2)
1987 \override InstrumentName.extra-offset = #'(0 . -0.5)
1988 \override TextScript.minimum-Y-extent = #'(-2 . 3)
1989 \override TimeSignature.stencil = ##f
1993 %% These contexts have reference points at the baseline:
1994 %% ChordNames, NoteNames, and Lyrics
1996 \new ChordNames { \chords { g1:m } }
1997 \new NoteNames { s1 | g1 | }
1998 \new RhythmicStaff {
1999 \set RhythmicStaff.instrumentName = #"baseline "
2001 \labelContext "ChordNames " s1 |
2002 \labelContext "NoteNames " s1 |
2003 \labelContext "Lyrics" s1 |
2005 \new Lyrics { \lyrics { \skip 1*2 | ghijk1 | } }
2008 %% The reference point for Dynamics is its vertical center
2010 \new RhythmicStaff {
2011 \set RhythmicStaff.instrumentName = #"vertical center "
2012 \labelContext "Dynamics" s1*3
2014 \new Dynamics { s1\mp s\fp }
2017 %% The reference point for FiguredBass is its highest point
2019 \new RhythmicStaff {
2020 \set RhythmicStaff.instrumentName = #"highest point "
2021 \labelContext "FiguredBass" s1
2023 \new FiguredBass { \figuremode { <6 5>1 } }
2026 %% The reference point for FretBoards is the top line
2027 \include "predefined-guitar-fretboards.ly"
2029 \new FretBoards { \chordmode { e1 } }
2030 \new RhythmicStaff {
2031 \set RhythmicStaff.instrumentName = #"top line "
2032 \labelContext "FretBoards " s1
2037 Each of the vertical spacing grob properties (except
2038 @code{staff-affinity}) uses the same alist structure as the
2039 @code{\paper} spacing variables discussed in
2040 @ref{Flexible vertical spacing \paper variables}. Specific methods
2041 for modifying alists are discussed in @ref{Modifying alists}.
2042 Grob properties should be adjusted with an @code{\override} inside
2043 a @code{\score} or @code{\layout} block, and not inside a
2044 @code{\paper} block.
2046 The following example demonstrates the two ways these alists can
2047 be modified. The first declaration updates one key-value
2048 individually, and the second completely re-defines the property:
2052 \override VerticalAxisGroup.default-staff-staff-spacing.basic-distance = #10
2056 \override VerticalAxisGroup.default-staff-staff-spacing =
2057 #'((basic-distance . 10)
2058 (minimum-distance . 9)
2060 (stretchability . 10))
2064 To change any spacing settings globally, put them in the
2065 @code{\layout} block:
2071 \override VerticalAxisGroup.default-staff-staff-spacing.basic-distance = #10
2076 Standard settings for the vertical spacing grob properties are
2077 listed in @rinternals{VerticalAxisGroup} and
2078 @rinternals{StaffGrouper}. Default overrides for specific types
2079 of non-staff lines are listed in the relevant context descriptions
2080 in @rinternals{Contexts}.
2083 @subsubheading Properties of the @code{VerticalAxisGroup} grob
2085 @code{VerticalAxisGroup} properties are typically adjusted with an
2086 @code{\override} at the @code{Staff} level (or equivalent).
2089 @item staff-staff-spacing
2091 Used to determine the distance between the current staff and the
2092 staff just below it in the same system, even if one or more
2093 non-staff lines (such as @code{Lyrics}) are placed between the two
2094 staves. Does not apply to the bottom staff of a system.
2096 Initially, the @code{staff-staff-spacing} of a
2097 @code{VerticalAxisGroup} is a Scheme function that applies the
2098 properties of the @code{StaffGrouper} if the staff is part of a
2099 group, or the @code{default-staff-staff-spacing} of the staff
2100 otherwise. This allows staves to be spaced differently when they
2101 are grouped. For uniform spacing regardless of grouping, this
2102 function may be replaced by a flexible-spacing alist, using the
2103 complete-redefinition form of override shown above.
2105 @item default-staff-staff-spacing
2106 A flexible-spacing alist defining the @code{staff-staff-spacing} used for
2107 ungrouped staves, unless @code{staff-staff-spacing} has been explicitly
2108 set with an @code{\override}.
2110 @item staff-affinity
2111 The direction of the staff to use for spacing the current
2112 non-staff line. Choices are @code{UP}, @code{DOWN}, and
2113 @code{CENTER}. If @code{CENTER}, the non-staff line will be
2114 placed equidistant between the two nearest staves on either side,
2115 unless collisions or other spacing constraints prevent this.
2116 Adjacent non-staff lines should have non-increasing
2117 @code{staff-affinity} from top to bottom, e.g. a non-staff line
2118 set to @code{UP} should not immediately follow one that is set to
2119 @code{DOWN}. Non-staff lines at the top of a system should use
2120 @code{DOWN}; those at the bottom should use @code{UP}. Setting
2121 @code{staff-affinity} for a staff causes it to be treated as a
2122 non-staff line. Setting @code{staff-affinity} to @code{#f} causes
2123 a non-staff line to be treated as a staff. Setting
2124 @code{staff-affinity} to @code{UP}, @code{CENTER}, or @code{DOWN}
2125 causes a staff to be spaced as a non-staff line.
2127 @item nonstaff-relatedstaff-spacing
2128 The distance between the current non-staff line and the nearest
2129 staff in the direction of @code{staff-affinity}, if there are no
2130 non-staff lines between the two, and @code{staff-affinity} is
2131 either @code{UP} or @code{DOWN}. If @code{staff-affinity} is
2132 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
2133 for the nearest staves on @emph{both} sides, even if other
2134 non-staff lines appear between the current one and either of the
2135 staves. This means that the placement of a non-staff line depends
2136 on both the surrounding staves and the surrounding non-staff lines.
2137 Setting the @code{stretchability} of one of these types of spacing to
2138 a small value will make that spacing dominate. Setting the
2139 @code{stretchability} to a large value will make that spacing have
2142 @item nonstaff-nonstaff-spacing
2143 The distance between the current non-staff line and the next
2144 non-staff line in the direction of @code{staff-affinity}, if both
2145 are on the same side of the related staff, and
2146 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
2148 @item nonstaff-unrelatedstaff-spacing
2149 The distance between the current non-staff line and the staff in
2150 the opposite direction from @code{staff-affinity}, if there are no
2151 other non-staff lines between the two, and @code{staff-affinity}
2152 is either @code{UP} or @code{DOWN}. This can be used, for
2153 example, to require a minimum amount of padding between a
2154 @code{Lyrics} line and the staff to which it does not belong.
2158 @subsubheading Properties of the @code{StaffGrouper} grob
2160 @code{StaffGrouper} properties are typically adjusted with an
2161 @code{\override} at the @code{StaffGroup} level (or equivalent).
2164 @item staff-staff-spacing
2165 The distance between consecutive staves within the current
2166 staff-group. The @code{staff-staff-spacing} property of an
2167 individual staff's @code{VerticalAxisGroup} grob can be
2168 overriden with different spacing settings for that staff.
2170 @item staffgroup-staff-spacing
2171 The distance between the last staff of the current staff-group and
2172 the staff just below it in the same system, even if one or more
2173 non-staff lines (such as @code{Lyrics}) exist between the two
2174 staves. Does not apply to the bottom staff of a system. The
2175 @code{staff-staff-spacing} property of an individual staff's
2176 @code{VerticalAxisGroup} grob can be overriden with different
2177 spacing settings for that staff.
2182 @ref{Flexible vertical spacing \paper variables},
2183 @ref{Modifying alists}.
2186 @file{ly/engraver-init.ly},
2187 @file{scm/define-grobs.scm}.
2189 Internals Reference:
2190 @rinternals{Contexts},
2191 @rinternals{VerticalAxisGroup},
2192 @rinternals{StaffGrouper}.
2195 @node Spacing of ungrouped staves
2196 @unnumberedsubsubsec Spacing of ungrouped staves
2198 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
2199 @code{TabStaff}, etc.) are contexts that can contain one or more
2200 voice contexts, but cannot contain any other staves.
2202 The following properties affect the spacing of @emph{ungrouped}
2206 @item @code{VerticalAxisGroup} properties:
2208 @item @code{default-staff-staff-spacing}
2209 @item @code{staff-staff-spacing}
2213 These grob properties are described individually above; see
2214 @ref{Within-system spacing properties}.
2216 Additional properties are involved for staves that are part of a
2217 staff-group; see @ref{Spacing of grouped staves}.
2219 The following example shows how the @code{default-staff-staff-spacing}
2220 property can affect the spacing of ungrouped staves.
2221 The same overrides applied to @code{staff-staff-spacing} would
2222 have the same effect, but would also apply in cases where the staves
2223 are combined in a group or groups.
2225 @lilypond[verbatim,quote,staffsize=16]
2229 \override VerticalAxisGroup.default-staff-staff-spacing =
2230 #'((basic-distance . 8)
2231 (minimum-distance . 7)
2237 % The very low note here needs more room than 'basic-distance
2238 % can provide, so the distance between this staff and the next
2239 % is determined by 'padding.
2240 \new Staff { b,2 r | }
2242 % Here, 'basic-distance provides enough room, and there is no
2243 % need to compress the space (towards 'minimum-distance) to make
2244 % room for anything else on the page, so the distance between
2245 % this staff and the next is determined by 'basic-distance.
2246 \new Staff { \clef bass g2 r | }
2248 % By setting 'padding to a negative value, staves can be made to
2249 % collide. The lowest acceptable value for 'basic-distance is 0.
2251 \override VerticalAxisGroup.default-staff-staff-spacing =
2252 #'((basic-distance . 3.5)
2254 } { \clef bass g2 r | }
2255 \new Staff { \clef bass g2 r | }
2261 @file{scm/define-grobs.scm}.
2266 Internals Reference:
2267 @rinternals{VerticalAxisGroup}.
2270 @node Spacing of grouped staves
2271 @unnumberedsubsubsec Spacing of grouped staves
2273 In orchestral and other large scores, it is common to place staves
2274 in groups. The space between groups is typically larger than the
2275 space between staves of the same group.
2277 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2278 etc.) are contexts that can contain one or more staves
2281 The following properties affect the spacing of staves inside
2285 @item @code{VerticalAxisGroup} properties:
2287 @item @code{staff-staff-spacing}
2289 @item @code{StaffGrouper} properties:
2291 @item @code{staff-staff-spacing}
2292 @item @code{staffgroup-staff-spacing}
2296 These grob properties are described individually above; see
2297 @ref{Within-system spacing properties}.
2299 The following example shows how properties of the
2300 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2302 @lilypond[verbatim,quote,staffsize=16]
2306 \override StaffGrouper.staff-staff-spacing.padding = #0
2307 \override StaffGrouper.staff-staff-spacing.basic-distance = #1
2312 \new PianoStaff \with {
2313 \override StaffGrouper.staffgroup-staff-spacing.basic-distance = #20
2328 @file{scm/define-grobs.scm}.
2333 Internals Reference:
2334 @rinternals{VerticalAxisGroup},
2335 @rinternals{StaffGrouper}.
2338 @node Spacing of non-staff lines
2339 @unnumberedsubsubsec Spacing of non-staff lines
2341 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2342 etc.) are contexts whose layout objects are engraved like staves
2343 (i.e. in horizontal lines within systems). Specifically,
2344 non-staff lines are non-staff contexts that create the
2345 @code{VerticalAxisGroup} layout object.
2347 The following properties affect the spacing of non-staff lines:
2350 @item @code{VerticalAxisGroup} properties:
2352 @item @code{staff-affinity}
2353 @item @code{nonstaff-relatedstaff-spacing}
2354 @item @code{nonstaff-nonstaff-spacing}
2355 @item @code{nonstaff-unrelatedstaff-spacing}
2359 These grob properties are described individually above; see
2360 @ref{Within-system spacing properties}.
2362 The following example shows how the
2363 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2364 of consecutive non-staff lines. Here, by setting the
2365 @code{stretchability} key to a very high value, the lyrics are
2366 able to stretch much more than usual:
2368 @lilypond[verbatim,quote,staffsize=16]
2372 \override VerticalAxisGroup.nonstaff-nonstaff-spacing.stretchability = #1000
2379 \override VerticalAxisGroup.staff-staff-spacing = #'((basic-distance . 30))
2382 \override VerticalAxisGroup.staff-affinity = #UP
2385 \override VerticalAxisGroup.staff-affinity = #CENTER
2386 } \lyricmode { center }
2388 \override VerticalAxisGroup.staff-affinity = #DOWN
2389 } \lyricmode { down }
2396 @file{ly/engraver-init.ly},
2397 @file{scm/define-grobs.scm}.
2402 @c @lsr{spacing,page-spacing.ly},
2403 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2405 Internals Reference:
2406 @rinternals{Contexts},
2407 @rinternals{VerticalAxisGroup}.
2410 @node Explicit staff and system positioning
2411 @subsection Explicit staff and system positioning
2413 One way to understand the flexible vertical spacing mechanisms
2414 explained above is as a collection of settings that control the
2415 amount of vertical padding between staves and systems.
2417 It is possible to approach vertical spacing in a different way
2418 using @code{NonMusicalPaperColumn.line-break-system-details}.
2419 While the flexible vertical spacing mechanisms specify vertical
2420 padding, @code{NonMusicalPaperColumn.line-break-system-details}
2421 can specify exact vertical positions on the page.
2423 @code{NonMusicalPaperColumn.line-break-system-details} accepts
2424 an associative list of three different settings:
2427 @item @code{X-offset}
2428 @item @code{Y-offset}
2429 @item @code{alignment-distances}
2432 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2433 below, can occur in any of three different places in an input file:
2436 @item in the middle of note entry directly
2437 @item in a @code{\context} block
2438 @item in the @code{\with} block
2441 When we override @code{NonMusicalPaperColumn}, we use the usual
2442 @code{\override} command in @code{\context} blocks and in the
2443 @code{\with} block. On the other hand, when we override
2444 @code{NonMusicalPaperColumn} in the middle of note entry,
2445 use the special @code{\overrideProperty} command. Here are some
2446 example @code{NonMusicalPaperColumn} overrides with the special
2447 @code{\overrideProperty} command:
2450 \overrideProperty NonMusicalPaperColumn.line-break-system-details #'((X-offset . 20))
2452 \overrideProperty NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 40))
2454 \overrideProperty NonMusicalPaperColumn.line-break-system-details #'((X-offset . 20)
2457 \overrideProperty NonMusicalPaperColumn.line-break-system-details #'((alignment-distances . (15)))
2459 \overrideProperty NonMusicalPaperColumn.line-break-system-details #'((X-offset . 20)
2461 (alignment-distances . (15)))
2464 To understand how each of these different settings work, we begin
2465 by looking at an example that includes no overrides at all.
2467 @c \book { } is required in these examples to ensure the spacing
2468 @c overrides can be seen between systems. -np
2470 @lilypond[verbatim,quote,staffsize=16]
2471 \header { tagline = ##f }
2472 \paper { left-margin = 0\mm }
2482 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2485 \repeat unfold 15 { d'4 d' d' d' }
2492 This score isolates line- and page-breaking information in a dedicated
2493 voice. This technique of creating a breaks voice will help keep layout
2494 separate from music entry as our example becomes more complicated.
2495 See @ref{Using an extra voice for breaks}.
2497 Explicit @code{\breaks} evenly divide the music into six measures per
2498 line. Vertical spacing results from LilyPond's defaults. To set
2499 the vertical startpoint of each system explicitly, we can set
2500 the @code{Y-offset} pair in the @code{line-break-system-details}
2501 attribute of the @code{NonMusicalPaperColumn} grob:
2503 @lilypond[verbatim,quote,staffsize=16]
2504 \header { tagline = ##f }
2505 \paper { left-margin = 0\mm }
2511 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 0))
2513 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 40))
2515 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 80))
2518 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2521 \repeat unfold 15 { d'4 d' d' d' }
2528 Note that @code{line-break-system-details} takes an associative list of
2529 potentially many values, but that we set only one value here. Note,
2530 too, that the @code{Y-offset} property here determines the exact vertical
2531 position on the page at which each new system will render.
2533 Now that we have set the vertical startpoint of each system
2534 explicitly, we can also set the vertical distances between staves
2535 within each system manually. We do this using the @code{alignment-distances}
2536 subproperty of @code{line-break-system-details}.
2538 @lilypond[verbatim,quote,staffsize=16]
2539 \header { tagline = ##f }
2540 \paper { left-margin = 0\mm }
2546 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 20)
2547 (alignment-distances . (15)))
2549 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 60)
2550 (alignment-distances . (15)))
2552 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 100)
2553 (alignment-distances . (15)))
2556 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2559 \repeat unfold 15 { d'4 d' d' d' }
2566 Note that here we assign two different values to the
2567 @code{line-break-system-details} attribute of the
2568 @code{NonMusicalPaperColumn} grob. Though the
2569 @code{line-break-system-details} attribute alist accepts many
2570 additional spacing parameters (including, for example, a corresponding
2571 @code{X-offset} pair), we need only set the @code{Y-offset} and
2572 @code{alignment-distances} pairs to control the vertical startpoint of
2573 every system and every staff. Finally, note that @code{alignment-distances}
2574 specifies the vertical positioning of staves but not of staff groups.
2576 @lilypond[verbatim,quote,staffsize=16]
2577 \header { tagline = ##f }
2578 \paper { left-margin = 0\mm }
2584 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 0)
2585 (alignment-distances . (30 10)))
2587 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 60)
2588 (alignment-distances . (10 10)))
2590 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details #'((Y-offset . 100)
2591 (alignment-distances . (10 30)))
2594 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2597 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2598 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2605 Some points to consider:
2608 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2609 do not count as a staff.
2611 @item The units of the numbers passed to @code{X-offset},
2612 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2613 of the distance between adjacent staff lines. Positive values move staves
2614 and lyrics up, negative values move staves and lyrics down.
2616 @item Because the @code{NonMusicalPaperColumn.line-break-system-details}
2617 settings given here allow the positioning of staves and systems anywhere
2618 on the page, it is possible to violate paper or margin boundaries or even
2619 to print staves or systems on top of one another. Reasonable values
2620 passed to these different settings will avoid this.
2628 @node Vertical collision avoidance
2629 @subsection Vertical collision avoidance
2631 @funindex outside-staff-priority
2632 @funindex outside-staff-padding
2633 @funindex outside-staff-horizontal-padding
2635 Intuitively, there are some objects in musical notation that belong
2636 to the staff and there are other objects that should be placed outside
2637 the staff. Objects belonging outside the staff include things such as
2638 rehearsal marks, text and dynamic markings (from now on, these will
2639 be called outside-staff objects). LilyPond's rule for the
2640 vertical placement of outside-staff objects is to place them as close
2641 to the staff as possible but not so close that they collide with
2644 LilyPond uses the @code{outside-staff-priority} property to determine
2645 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2646 is a number, the grob is an outside-staff object. In addition,
2647 @code{outside-staff-priority} tells LilyPond in which order the objects
2650 First, LilyPond places all the objects that do not belong outside
2651 the staff. Then it sorts the outside-staff objects according to their
2652 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
2653 takes the outside-staff objects and places them so that they do
2654 not collide with any objects that have already been placed. That
2655 is, if two outside-staff grobs are competing for the same space, the one
2656 with the lower @code{outside-staff-priority} will be placed closer to
2659 @lilypond[quote,ragged-right,relative=2,verbatim]
2662 \once \override TextScript.outside-staff-priority = #1
2663 c4_"Text"\pp % this time the text will be closer to the staff
2665 % by setting outside-staff-priority to a non-number,
2666 % we disable the automatic collision avoidance
2667 \once \override TextScript.outside-staff-priority = ##f
2668 \once \override DynamicLineSpanner.outside-staff-priority = ##f
2669 c4_"Text"\pp % now they will collide
2672 The vertical padding between an outside-staff object and the
2673 previously-positioned grobs can be controlled with
2674 @code{outside-staff-padding}.
2676 @lilypond[quote,ragged-right,relative=2,verbatim,staffsize=18]
2677 \once \override TextScript.outside-staff-padding = #0
2678 a'^"This text is placed very close to the note"
2679 \once \override TextScript.outside-staff-padding = #3
2680 c^"This text is padded away from the previous text"
2681 c^"This text is placed close to the previous text"
2685 By default, outside-staff objects are placed only to avoid
2686 a horizontal collision with previously-positioned grobs. This
2687 can lead to situations in which objects are placed very close to each
2688 other horizontally. The vertical spacing between staves can
2689 also be set so that outside staff objects are interleaved.
2690 Setting @code{outside-staff-horizontal-padding}
2691 causes an object to be offset vertically so that such a situation
2694 @lilypond[quote,ragged-right,relative=2,verbatim]
2695 % the markup is too close to the following note
2699 % setting outside-staff-horizontal-padding fixes this
2701 \once \override TextScript.outside-staff-horizontal-padding = #1
2712 @node Horizontal spacing
2713 @section Horizontal spacing
2715 @cindex horizontal spacing
2716 @cindex spacing, horizontal
2719 * Horizontal spacing overview::
2720 * New spacing area::
2721 * Changing horizontal spacing::
2723 * Proportional notation::
2727 @node Horizontal spacing overview
2728 @subsection Horizontal spacing overview
2730 The spacing engine translates differences in durations into stretchable
2731 distances (@q{springs}) of differing lengths. Longer durations get
2732 more space, shorter durations get less. The shortest durations get a
2733 fixed amount of space (which is controlled by
2734 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2735 object). The longer the duration, the more space it gets: doubling a
2736 duration adds a fixed amount (this amount is controlled by
2737 @code{spacing-increment}) of space to the note.
2739 For example, the following piece contains lots of half, quarter, and
2740 8th notes; the eighth note is followed by 1 note head width (NHW).
2741 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2743 @lilypond[quote,verbatim,relative=1]
2744 c2 c4. c8 c4. c8 c4. c8 c8
2748 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2749 approximately the width of a note head, and
2750 @code{shortest-duration-space} is set to 2.0, meaning that the
2751 shortest note gets 2.4 staff space (2.0 times the
2752 @code{spacing-increment}) of horizontal space. This space is counted
2753 from the left edge of the symbol, so the shortest notes are generally
2754 followed by one NHW of space.
2756 If one would follow the above procedure exactly, then adding a single
2757 32nd note to a score that uses 8th and 16th notes, would widen up the
2758 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2759 thus adding 1 NHW to every note. To prevent this, the shortest
2760 duration for spacing is not the shortest note in the score, but rather
2761 the one which occurs most frequently.
2764 The most common shortest duration is determined as follows: in every
2765 measure, the shortest duration is determined. The most common shortest
2766 duration is taken as the basis for the spacing, with the stipulation
2767 that this shortest duration should always be equal to or shorter than
2768 an 8th note. The shortest duration is printed when you run
2769 @code{lilypond} with the @option{--verbose} option.
2771 These durations may also be customized. If you set the
2772 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2773 this sets the base duration for spacing. The maximum duration for this
2774 base (normally an 8th), is set through @code{base-shortest-duration}.
2776 @funindex common-shortest-duration
2777 @funindex base-shortest-duration
2778 @funindex stem-spacing-correction
2781 Notes that are even shorter than the common shortest note are
2782 followed by a space that is proportional to their duration relative to
2783 the common shortest note. So if we were to add only a few 16th notes
2784 to the example above, they would be followed by half a NHW:
2786 @lilypond[quote,verbatim,relative=2]
2787 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2791 In the @emph{Essay on automated music engraving}, it was explained
2792 that stem directions influence spacing (see
2793 @ressay{Optical spacing}). This is controlled with the
2794 @code{stem-spacing-correction} property in the
2795 @rinternals{NoteSpacing}, object. These are generated for every
2796 @rinternals{Voice} context. The @code{StaffSpacing} object
2797 (generated in @rinternals{Staff} context) contains the same
2798 property for controlling the stem/bar line spacing. The following
2799 example shows these corrections, once with default settings, and
2800 once with exaggerated corrections:
2802 @lilypond[quote,ragged-right]
2806 \override Staff.NoteSpacing.stem-spacing-correction = #1.5
2807 \override Staff.StaffSpacing.stem-spacing-correction = #1.5
2813 Proportional notation is supported; see @ref{Proportional notation}.
2816 Essay on automated music engraving:
2817 @ressay{Optical spacing}.
2822 Internals Reference:
2823 @rinternals{SpacingSpanner},
2824 @rinternals{NoteSpacing},
2825 @rinternals{StaffSpacing},
2826 @rinternals{NonMusicalPaperColumn}.
2829 There is no convenient mechanism to manually override spacing. The
2830 following work-around may be used to insert extra space into a score,
2831 adjusting the padding value as necessary.
2834 \override Score.NonMusicalPaperColumn.padding = #10
2837 No work-around exists for decreasing the amount of space.
2840 @node New spacing area
2841 @subsection New spacing area
2843 New sections with different spacing parameters can be started with
2844 @code{newSpacingSection}. This is useful when there are
2845 sections with a different notions of long and short notes.
2847 In the following example, the time signature change introduces a new
2848 section, and hence the 16ths notes are spaced wider.
2850 @lilypond[relative=1,verbatim,quote]
2853 c8 c c4 c16[ c c8] c4
2859 The @code{\newSpacingSection} command creates a new
2860 @code{SpacingSpanner} object, and hence new @code{\override}s
2861 may be used in that location.
2867 Internals Reference:
2868 @rinternals{SpacingSpanner}.
2871 @node Changing horizontal spacing
2872 @subsection Changing horizontal spacing
2874 Horizontal spacing may be altered with the
2875 @code{base-shortest-duration} property. Here
2876 we compare the same music; once without altering
2877 the property, and then altered. Larger values
2878 of @code{ly:make-moment} will produce smaller
2879 music. Note that @code{ly:make-moment} constructs
2880 a duration, so @code{1 4} is a longer duration
2883 @lilypond[verbatim,line-width=12\cm]
2886 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2887 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2888 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2889 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2894 @lilypond[verbatim,line-width=12\cm]
2897 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2898 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2899 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2900 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2905 \override SpacingSpanner.base-shortest-duration = #(ly:make-moment 1 16)
2914 By default, spacing in tuplets depends on various non-duration
2915 factors (such as accidentals, clef changes, etc). To disregard
2916 such symbols and force uniform equal-duration spacing, use
2917 @code{Score.SpacingSpanner.uniform-stretching}. This
2918 property can only be changed at the beginning of a score,
2920 @lilypond[quote,ragged-right,verbatim]
2939 \override SpacingSpanner.uniform-stretching = ##t
2945 When @code{strict-note-spacing} is set, notes are spaced without
2946 regard for clefs, bar lines, and grace notes,
2948 @lilypond[quote,ragged-right,relative=2,verbatim]
2949 \override Score.SpacingSpanner.strict-note-spacing = ##t
2950 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2959 @subsection Line length
2962 @cindex breaking pages
2965 @funindex line-width
2966 @funindex ragged-right
2967 @funindex ragged-last
2969 @c Although line-width can be set in \layout, it should be set in paper
2970 @c block, to get page layout right.
2971 @c Setting indent in \paper block makes not much sense, but it works.
2973 @c Bit verbose and vague, use examples?
2974 The most basic settings influencing the spacing are @code{indent} and
2975 @code{line-width}. They are set in the @code{\layout} block. They
2976 control the indentation of the first line of music, and the lengths of
2979 If @code{ragged-right} is set to true in the @code{\layout} block, then
2980 systems ends at their natural horizontal length, instead of being spread
2981 horizontally to fill the whole line. This is useful for
2982 short fragments, and for checking how tight the natural spacing is.
2983 The normal default setting is false, but if the score has only one
2984 system the default value is true.
2987 @cindex vertical spacing
2989 The option @code{ragged-last} is similar to @code{ragged-right}, but
2990 only affects the last line of the piece. No restrictions are put on
2991 that line. The result is similar to formatting text paragraphs. In a
2992 paragraph, the last line simply takes its natural horizontal length.
2993 @c Note that for text there are several options for the last line.
2994 @c While Knuth TeX uses natural length, lead typesetters use the same
2995 @c stretch as the previous line. eTeX uses \lastlinefit to
2996 @c interpolate between both these solutions.
3011 @node Proportional notation
3012 @subsection Proportional notation
3014 LilyPond supports proportional notation, a type of horizontal spacing
3015 in which each note consumes an amount of horizontal space exactly
3016 equivalent to its rhythmic duration. This type of proportional spacing
3017 is comparable to horizontal spacing on top of graph paper. Some late
3018 20th- and early 21st-century scores use proportional notation to
3019 clarify complex rhythmic relationships or to facilitate the placement
3020 of timelines or other graphics directly in the score.
3022 LilyPond supports five different settings for proportional notation,
3023 which may be used together or alone:
3026 @item @code{proportionalNotationDuration}
3027 @item @code{uniform-stretching}
3028 @item @code{strict-note-spacing}
3029 @item @code{\remove "Separating_line_group_engraver"}
3030 @item @code{\override PaperColumn.used = ##t}
3033 In the examples that follow, we explore these five different
3034 proportional notation settings and examine how these settings interact.
3036 We start with the following one-measure example, which uses classical
3037 spacing with ragged-right turned on.
3039 @lilypond[quote,verbatim,ragged-right]
3042 \new RhythmicStaff {
3046 c'16 c'16 c'16 c'16 c'16
3053 Notice that the half note which begins the measure takes up far less
3054 than half of the horizontal space of the measure. Likewise, the
3055 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
3056 which end the measure together take up far more than half the
3057 horizontal space of the measure.
3059 In classical engraving, this spacing may be exactly what we want
3060 because we can borrow horizontal space from the half note and conserve
3061 horizontal space across the measure as a whole.
3063 On the other hand, if we want to insert a measured timeline or other
3064 graphic above or below our score, we need proportional notation. We
3065 turn proportional notation on with the proportionalNotationDuration
3068 @lilypond[quote,verbatim,ragged-right]
3071 \new RhythmicStaff {
3075 c'16 c'16 c'16 c'16 c'16
3082 proportionalNotationDuration = #(ly:make-moment 1 20)
3088 The half note at the beginning of the measure and the faster notes in
3089 the second half of the measure now occupy equal amounts of horizontal
3090 space. We could place a measured timeline or graphic above or below
3093 The @code{proportionalNotationDuration} setting is a context setting
3094 that lives in @code{Score}. Remember that context settings can appear
3095 in one of three locations within our input file -- in a @code{\with}
3096 block, in a @code{\context} block, or directly in music entry preceded
3097 by the @code{\set} command. As with all context settings, users can
3098 pick which of the three different locations they would like to
3099 set @code{proportionalNotationDuration} in to.
3101 The @code{proportionalNotationDuration} setting takes a single argument,
3102 which is the reference duration against that all music will be spaced.
3103 The LilyPond Scheme function @code{make-moment} takes two arguments
3104 -- a numerator and denominator which together express some fraction of
3105 a whole note. The call @code{(ly:make-moment 1 20)} therefore produces
3106 a reference duration of a twentieth note. Values such as
3107 @code{(ly:make-moment 1 16)}, @code{(ly:make-moment 1 8)}, and
3108 @code{(ly:make-moment 3 97)} are all possible as well.
3110 How do we select the right reference duration to pass to
3111 @code{proportionalNotationDuration}? Usually by a process of trial
3112 and error, beginning with a duration close to the fastest (or smallest)
3113 duration in the piece. Smaller reference durations space music loosely;
3114 larger reference durations space music tightly.
3116 @lilypond[quote,verbatim,ragged-right]
3119 \new RhythmicStaff {
3123 c'16 c'16 c'16 c'16 c'16
3130 proportionalNotationDuration = #(ly:make-moment 1 8)
3137 \new RhythmicStaff {
3141 c'16 c'16 c'16 c'16 c'16
3148 proportionalNotationDuration = #(ly:make-moment 1 16)
3155 \new RhythmicStaff {
3159 c'16 c'16 c'16 c'16 c'16
3166 proportionalNotationDuration = #(ly:make-moment 1 32)
3172 Note that too large a reference duration -- such as the eighth note,
3173 above -- spaces music too tightly and can cause note head collisions.
3174 Also that proportional notation in general takes up more horizontal
3175 space than classical spacing. Proportional spacing provides rhythmic
3176 clarity at the expense of horizontal space.
3178 Next we examine how to optimally space overlapping tuplets.
3180 We start by examining what happens to our original example, with
3181 classical spacing, when we add a second staff with a different type of
3184 @lilypond[quote,verbatim,ragged-right]
3187 \new RhythmicStaff {
3191 c'16 c'16 c'16 c'16 c'16
3194 \new RhythmicStaff {
3196 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3203 The spacing is bad because the evenly spaced notes of the bottom staff
3204 do not stretch uniformly. Classical engravings include very few complex
3205 triplets and so classical engraving rules can generate this type of
3206 result. Setting @code{proportionalNotationDuration} fixes this.
3208 @lilypond[quote,verbatim,ragged-right]
3211 \new RhythmicStaff {
3215 c'16 c'16 c'16 c'16 c'16
3218 \new RhythmicStaff {
3220 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3227 proportionalNotationDuration = #(ly:make-moment 1 20)
3233 But if we look very carefully we can see that notes of the second half
3234 of the 9-tuplet space ever so slightly more widely than the notes
3235 of the first half of the 9-tuplet. To ensure uniform stretching, we
3236 turn on @code{uniform-stretching}, which is a property of
3237 @code{SpacingSpanner}.
3239 @lilypond[quote,verbatim,ragged-right]
3242 \new RhythmicStaff {
3246 c'16 c'16 c'16 c'16 c'16
3249 \new RhythmicStaff {
3251 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3258 proportionalNotationDuration = #(ly:make-moment 1 20)
3259 \override SpacingSpanner.uniform-stretching = ##t
3265 Our two-staff example now spaces exactly, our rhythmic
3266 relationships are visually clear, and we can include a measured
3267 timeline or graphic if we want.
3269 Note that the LilyPond's proportional notation package expects
3270 that all proportional scores set the SpacingSpanner's
3271 'uniform-stretching attribute to ##t. Setting
3272 proportionalNotationDuration without also setting the
3273 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3274 example, cause Skips to consume an incorrect amount of horizontal
3277 The SpacingSpanner is an abstract grob that lives in the Score
3278 context. As with our settings of proportionalNotationDuration,
3279 overrides to the SpacingSpanner can occur in any of three
3280 different places in our input file – in the Score \with block, in
3281 a Score \context block, or in note entry directly.
3283 There is by default only one @code{SpacingSpanner} per @code{Score}. This
3284 means that, by default, @code{uniform-stretching} is either turned on for the
3285 entire score or turned off for the entire score. We can, however,
3286 override this behavior and turn on different spacing features at
3287 different places in the score. We do this with the command
3288 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
3290 Next we examine the effects of the @code{Separating_line_group_engraver} and
3291 see why proportional scores frequently remove this engraver. The following
3292 example shows that there is a small amount of @qq{prefatory} space
3293 just before the first note in each system.
3295 @lilypond[quote,verbatim,ragged-right]
3308 The amount of this prefatory space is the same whether after a time
3309 signature, a key signature or a clef. @code{Separating_line_group_engraver}
3310 is responsible for this space. Removing @code{Separating_line_group_engraver}
3311 reduces this space to zero.
3313 @lilypond[quote,verbatim,ragged-right]
3319 \remove "Separating_line_group_engraver"
3327 non-musical elements like time signatures, key signatures, clefs and
3328 accidentals are problematic in proportional notation. None of these
3329 elements has rhythmic duration. But all of these elements consume
3330 horizontal space. Different proportional scores approach these
3331 problems differently.
3333 It may be possible to avoid spacing problems with key signatures
3334 simply by not having any. This is a valid option since most
3335 proportional scores are contemporary music. The same may be true
3336 of time signatures, especially for those scores
3337 that include a measured timeline or other graphic. But these scores
3338 are exceptional and most proportional scores include at least some
3339 time signatures. Clefs and accidentals are even more essential.
3341 So what strategies exist for spacing non-musical elements in a
3342 proportional context? One good option is the @code{strict-note-spacing}
3343 property of @code{SpacingSpanner}. Compare the two scores below:
3345 @lilypond[quote,verbatim,ragged-right]
3347 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3357 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3358 \override Score.SpacingSpanner.strict-note-spacing = ##t
3368 Both scores are proportional, but the spacing in the first score
3369 is too loose because of the clef change. The spacing of the second
3370 score remains strict, however, because strict-note-spacing is
3371 turned on. Turning on strict-note-spacing causes the width of
3372 time signatures, key signatures, clefs and accidentals to play no
3373 part in the spacing algorithm.
3375 In addition to the settings given here, there are other settings
3376 that frequently appear in proportional scores. These include:
3379 @item @code{\override SpacingSpanner.strict-grace-spacing = ##t}
3380 @item @code{tupletFullLength = ##t}
3381 @item @code{\override Beam.breakable = ##t}
3382 @item @code{\override Glissando.breakable = ##t}
3383 @item @code{\override TextSpanner.breakable = ##t}
3384 @item @code{\remove "Forbid_line_break_engraver" in the Voice context}
3387 These settings space grace notes strictly, extend tuplet brackets to
3388 mark both rhythmic start- and stop-points, and allow spanning elements
3389 to break across systems and pages. See the respective parts of the manual
3390 for these related settings.
3394 @ref{New spacing area}.
3400 @node Fitting music onto fewer pages
3401 @section Fitting music onto fewer pages
3403 Sometimes you can end up with one or two staves on a second
3404 (or third, or fourth@dots{}) page. This is annoying, especially
3405 if you look at previous pages and it looks like there is plenty
3406 of room left on those.
3408 When investigating layout issues, @code{annotate-spacing} is an
3409 invaluable tool. This command prints the values of various layout
3410 spacing variables; for more details see the following section,
3411 @ref{Displaying spacing}.
3414 * Displaying spacing::
3415 * Changing spacing::
3419 @node Displaying spacing
3420 @subsection Displaying spacing
3422 @funindex annotate-spacing
3423 @cindex spacing, display of layout
3425 To graphically display the dimensions of vertical layout variables
3426 that may be altered for page formatting, set
3427 @code{annotate-spacing} in the @code{\paper} block:
3429 @c need to have \book{} otherwise we get the separate systems. -hwn
3430 @lilypond[verbatim,quote]
3431 #(set-default-paper-size "a6" 'landscape)
3434 \paper { annotate-spacing = ##t }
3440 All layout dimensions are displayed in staff-spaces, regardless
3441 of the units specified in the @code{\paper} or @code{\layout} block.
3442 In the above example, @code{paper-height} has a value of 59.75
3443 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3444 default value). Note that:
3446 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3449 @tab = (25.4/72.27) mm
3452 @tab = (@code{staff-size})/4 pts
3454 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3459 In this case, one @code{staff-space} is approximately equal to
3460 1.757mm. Thus the @code{paper-height} measurement of 59.75
3461 @code{staff-spaces} is equivalent to 105 millimeters, the height
3462 of @code{a6} paper in landscape orientation. The pairs
3463 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3464 edge and @var{b} the upper edge of the interval.
3468 @ref{Setting the staff size}.
3474 @node Changing spacing
3475 @subsection Changing spacing
3477 The output of @code{annotate-spacing} reveals vertical dimensions
3478 in great detail. For details about modifying margins and other
3479 layout variables, see @ref{Page layout}.
3481 Other than margins, there are a few other options to save space:
3485 Force systems to move as close together as possible (to fit as
3486 many systems as possible onto a page) while being spaced so that
3487 there is no blank space at the bottom of the page.
3491 system-system-spacing = #'((basic-distance . 0.1) (padding . 0))
3492 ragged-last-bottom = ##f
3498 Force the number of systems. This can help in two ways. Just
3499 setting a value, even the same value as the number of systems
3500 being typeset by default, will sometimes cause more systems to
3501 be fitted onto each page, as an estimation step is then bypassed,
3502 giving a more accurate fit to each page. Also, forcing an actual
3503 reduction in the number of systems may save a further page. For
3504 example, if the default layout has 11 systems, the following
3505 assignment will force a layout with 10 systems.
3514 Force the number of pages. For example, the following
3515 assignment will force a layout with 2 pages.
3524 Avoid (or reduce) objects that increase the vertical size of a
3525 system. For example, volta repeats (or alternate repeats) require
3526 extra space. If these repeats are spread over two systems, they
3527 will take up more space than one system with the volta repeats and
3528 another system without. For example, dynamics that @q{stick out} of
3529 a system can be moved closer to the staff:
3531 @lilypond[verbatim,quote,relative=1]
3533 e4 c g-\tweak X-offset #-2.7 -\tweak Y-offset #2.5 \f c
3537 Alter the horizontal spacing via @code{SpacingSpanner}. For more
3538 details, see @ref{Changing horizontal spacing}. The following
3539 example illustrates the default spacing:
3541 @lilypond[verbatim,quote]
3554 The next example modifies @code{common-shortest-duration} from a
3555 value of @code{1/4} to @code{1/2}. The quarter note is the most
3556 common and shortest duration in this example, so by making this
3557 duration longer, a @q{squeezing} effect occurs:
3559 @lilypond[verbatim,quote]
3571 \override SpacingSpanner.common-shortest-duration = #(ly:make-moment 1 2)
3578 The @code{common-shortest-duration} property cannot be modified
3579 dynamically, so it must always be placed in a @code{\context}
3580 block so that it applies to the whole score.
3587 @ref{Changing horizontal spacing}.