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 headers footers and titles}.
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 headers footers and titles},
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 paper size::
195 * Automatic scaling to paper size::
199 @node Setting paper size
200 @unnumberedsubsubsec Setting paper size
202 Two functions are available for changing the paper size:
203 @code{set-default-paper-size} and @code{set-paper-size}.
204 @code{set-default-paper-size} must be placed in the toplevel
205 scope, and @code{set-paper-size} must be placed in a @code{\paper}
209 #(set-default-paper-size "a4")
214 #(set-paper-size "a4")
219 In the toplevel scope, the @code{set-default-paper-size} function
220 can safely be called anywhere before the first @code{\paper}
221 block. Within a @code{\paper} block, the safest place to call
222 @code{set-paper-size} is at the top, above the list of variable
223 declarations. The reasons for this are discussed in
224 @ref{Automatic scaling to paper size}.
226 @code{set-default-paper-size} sets the size of all pages, whereas
227 @code{set-paper-size} only sets the size of the pages that the
228 @code{\paper} block applies to. For example, if the @code{\paper}
229 block is at the top of the file, then it will apply the paper size
230 to all pages. If the @code{\paper} block is inside a
231 @code{\book}, then the paper size will only apply to that book.
233 Common paper sizes are available, including @code{a4},
234 @code{letter}, @code{legal}, and @code{11x17} (also known as
235 tabloid). Many more paper sizes are supported by default. For
236 details, see @file{scm/paper.scm}, and search for the
237 definition of @code{paper-alist}.
239 @c TODO add a new appendix for paper sizes (auto-generated) -pm
241 @warning{The default paper size is @code{a4}.}
243 Extra sizes may be added by editing the definition of
244 @code{paper-alist} in the initialization file
245 @file{scm/paper.scm}, however they will be overridden on a
251 If the symbol @code{'landscape} is supplied as an argument to
252 @code{set-default-paper-size}, pages will be rotated by 90
253 degrees, and wider line widths will be set accordingly.
256 #(set-default-paper-size "a6" 'landscape)
261 @ref{Automatic scaling to paper size}.
264 @file{scm/paper.scm}.
267 @node Automatic scaling to paper size
268 @unnumberedsubsubsec Automatic scaling to paper size
270 If the paper size is changed with one of the scheme functions
271 (@code{set-default-paper-size} or @code{set-paper-size}), the
272 values of several @code{\paper} variables are automatically scaled
273 to the new size. To bypass the automatic scaling for a particular
274 variable, set the variable after setting the paper size. Note
275 that the automatic scaling is not triggered by setting the
276 @code{paper-height} or @code{paper-width} variables, even though
277 @code{paper-width} can influence other values (this is separate
278 from scaling and is discussed below). The
279 @code{set-default-paper-size} and @code{set-paper-size} functions
280 are described in @ref{Setting paper size}.
282 The vertical dimensions affected by automatic scaling are
283 @code{top-margin} and @code{bottom-margin} (see
284 @ref{Fixed vertical spacing \paper variables}. The horizontal
285 dimensions affected by automatic scaling are @code{left-margin},
286 @code{right-margin}, @code{inner-margin}, @code{outer-margin},
287 @code{binding-offset}, @code{indent}, and @code{short-indent} (see
288 @ref{Horizontal spacing \paper variables}.
290 The default values for these dimensions are set in
291 @file{ly/paper-defaults-init.ly}, using internal variables named
292 @code{top-margin-default}, @code{bottom-margin-default}, etc.
293 These are the values that result at the default paper size
294 @code{a4}. For reference, with @code{a4} paper the
295 @code{paper-height} is @code{297\mm} and the @code{paper-width} is
300 @ref{Fixed vertical spacing \paper variables},
301 @ref{Horizontal spacing \paper variables}.
304 @file{ly/paper-defaults-init.ly},
305 @file{scm/paper.scm}.
308 @node Fixed vertical spacing \paper variables
309 @subsection Fixed vertical spacing @code{\paper} variables
311 @warning{Some @code{@bs{}paper} dimensions are automatically
312 scaled to the paper size, which may lead to unexpected behavior.
313 See @ref{Automatic scaling to paper size}.}
315 Default values (before scaling) are defined in
316 @file{ly/paper-defaults-init.ly}.
320 @funindex paper-height
322 The height of the page, unset by default. Note that the automatic
323 scaling of some vertical dimensions is not affected by this.
328 The margin between the top of the page and the top of the
329 printable area. If the paper size is modified, this dimension's
330 default value is scaled accordingly.
333 @funindex bottom-margin
335 The margin between the bottom of the printable area and the bottom
336 of the page. If the paper size is modified, this dimension's
337 default value is scaled accordingly.
340 @funindex ragged-bottom
342 If set to true, systems will not spread vertically down the page.
343 This does not affect the last page. This should be set to true
344 for pieces that have only two or three systems per page, for
345 example orchestral scores.
347 @item ragged-last-bottom
348 @funindex ragged-last-bottom
350 If set to false, systems will spread vertically down the last
351 page. Pieces that amply fill two pages or more should have this
352 set to true. It also affects the last page of book parts, i.e.
353 parts of a book created with @code{\bookpart} blocks.
359 @ref{Automatic scaling to paper size}.
362 @file{ly/paper-defaults-init.ly}.
369 The titles (from the @code{\header} block) are treated as a
370 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
371 add space between the titles and the first system of the score.
374 @node Flexible vertical spacing \paper variables
375 @subsection Flexible vertical spacing @code{\paper} variables
377 In most cases, it is preferable for the vertical distances between
378 certain items (such as margins, titles, systems, and separate
379 scores) to be flexible, so that they stretch and compress nicely
380 according to each situation. A number of @code{\paper} variables
381 (listed below) are available to fine-tune the stretching behavior
384 Note that the @code{\paper} variables discussed in this section do
385 not control the spacing of staves within individual systems.
386 Within-system spacing is controlled by grob properties, with
387 settings typically entered inside a @code{\score} or
388 @code{\layout} block, and not inside a @code{\paper} block. See
389 @ref{Flexible vertical spacing within systems}.
392 * Structure of flexible vertical spacing alists::
393 * List of flexible vertical spacing \paper variables::
397 @node Structure of flexible vertical spacing alists
398 @unnumberedsubsubsec Structure of flexible vertical spacing alists
400 Each of the flexible vertical spacing @code{\paper} variables is
401 an alist (association list) containing four @emph{keys}:
406 @code{basic-distance} -- the vertical distance, measured in
407 staff-spaces, between the @emph{reference points} of the two
408 items, when no collisions would result, and no stretching or
409 compressing is in effect. The reference point of a (title or
410 top-level) markup is its highest point, and the reference point of
411 a system is the vertical center of the nearest @code{StaffSymbol}
412 -- even if a non-staff line (such as a @code{Lyrics} context) is
413 in the way. Values for @code{basic-distance} that are less than
414 either @code{padding} or @code{minimum-distance} are not
415 meaningful, since the resulting distance will never be less than
416 either @code{padding} or @code{minimum-distance}.
419 @code{minimum-distance} -- the smallest allowable vertical
420 distance, measured in staff-spaces, between the reference points
421 of the two items, when compressing is in effect. Values for
422 @code{minimum-distance} that are less than @code{padding} are not
423 meaningful, since the resulting distance will never be less than
426 @c TODO: explain skylines somewhere and xref to it from here.
429 @code{padding} -- the minimum required amount of unobstructed
430 vertical whitespace between the bounding boxes (or skylines) of
431 the two items, measured in staff-spaces.
434 @code{stretchability} -- a unitless measure of the dimension's
435 relative propensity to stretch. If zero, the distance will not
436 stretch (unless collisions would result). When positive, the
437 significance of a particular dimension's @code{stretchability}
438 value lies only in its relation to the @code{stretchability}
439 values of the other dimensions. For example, if one dimension has
440 twice the @code{stretchability} of another, it will stretch twice
441 as easily. Values should be non-negative and finite. The value
442 @code{+inf.0} triggers a @code{programming_error} and is ignored,
443 but @code{1.0e7} can be used for an almost infinitely stretchable
444 spring. If unset, the default value is set to
445 @code{basic-distance}. Note that the dimension's propensity to
446 @emph{compress} cannot be directly set by the user and is equal to
447 (@code{basic-distance}@tie{}@minus{}@tie{}@code{minimum-distance}).
451 If a page has a ragged bottom, the resulting distance is the
457 @code{basic-distance},
460 @code{minimum-distance}, and
463 @code{padding} plus the smallest distance necessary to eliminate
468 Specific methods for modifying alists are discussed in
469 @ref{Modifying alists}. The following example demonstrates the
470 two ways these alists can be modified. The first declaration
471 updates one key-value individually, and the second completely
472 redefines the variable:
476 system-system-spacing #'basic-distance = #8
477 score-system-spacing =
478 #'((basic-distance . 12)
479 (minimum-distance . 6)
481 (stretchability . 12))
486 @node List of flexible vertical spacing \paper variables
487 @unnumberedsubsubsec List of flexible vertical spacing @code{\paper} variables
489 The names of these variables follow the format
490 @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}}
491 and @code{@var{lower}} are the items to be spaced. Each distance
492 is measured between the reference points of the two items (see the
493 description of the alist structure above). Note that in these
494 variable names, the term @q{@code{markup}} refers to both
495 @emph{title markups} (@code{bookTitleMarkup} or
496 @code{scoreTitleMarkup}) and @emph{top-level markups} (see
497 @ref{File structure}). All distances are measured in
500 Default settings are defined in @file{ly/paper-defaults-init.ly}.
502 @c TODO: Where do headers/footers fit in? -mp
505 @item markup-system-spacing
506 @funindex markup-system-spacing
508 the distance between a (title or top-level) markup and the system
511 @item score-markup-spacing
512 @funindex score-markup-spacing
514 the distance between the last system of a score and the (title or
515 top-level) markup that follows it.
517 @item score-system-spacing
518 @funindex score-system-spacing
520 the distance between the last system of a score and the first
521 system of the score that follows it, when no (title or top-level)
522 markup exists between them.
524 @item system-system-spacing
525 @funindex system-system-spacing
527 the distance between two systems in the same score.
529 @item markup-markup-spacing
530 @funindex markup-markup-spacing
532 the distance between two (title or top-level) markups.
534 @item last-bottom-spacing
535 @funindex last-bottom-spacing
537 the distance from the last system or top-level markup on a page to
538 the bottom of the printable area (i.e. the top of the bottom
541 @item top-system-spacing
542 @funindex top-system-spacing
544 the distance from the top of the printable area (i.e. the bottom
545 of the top margin) to the first system on a page, when there is no
546 (title or top-level) markup between the two.
548 @item top-markup-spacing
549 @funindex top-markup-spacing
551 the distance from the top of the printable area (i.e. the bottom
552 of the top margin) to the first (title or top-level) markup on a
553 page, when there is no system between the two.
558 @ref{Flexible vertical spacing within systems}.
561 @file{ly/paper-defaults-init.ly}.
567 @node Horizontal spacing \paper variables
568 @subsection Horizontal spacing @code{\paper} variables
570 @warning{Some @code{@bs{}paper} dimensions are automatically
571 scaled to the paper size, which may lead to unexpected behavior.
572 See @ref{Automatic scaling to paper size}.}
575 * \paper variables for widths and margins::
576 * \paper variables for two-sided mode::
577 * \paper variables for shifts and indents::
581 @node \paper variables for widths and margins
582 @unnumberedsubsubsec @code{\paper} variables for widths and margins
584 Default values (before scaling) that are not listed here are
585 defined in @file{ly/paper-defaults-init.ly}.
590 @funindex paper-width
592 The width of the page, unset by default. While @code{paper-width}
593 has no effect on the automatic scaling of some horizontal
594 dimensions, it does influence the @code{line-width} variable. If
595 both @code{paper-width} and @code{line-width} are set, then
596 @code{left-margin} and @code{right-margin} will also be updated.
597 Also see @code{check-consistency}.
602 The horizontal extent of the staff lines in unindented, non-ragged
604 @code{(paper-width@tie{}@minus{}@tie{}left-margin@tie{}@minus{}@tie{}right-margin)}
605 when unset. If @code{line-width} is set, and both
606 @code{left-margin} and @code{right-margin} are unset, then the
607 margins will be updated to center the systems on the page
608 automatically. Also see @code{check-consistency}. This variable
609 can also be set in a @code{\layout} block.
612 @funindex left-margin
614 The margin between the left edge of the page and the start of the
615 staff lines in unindented systems. If the paper size is modified,
616 this dimension's default value is scaled accordingly. If
617 @code{left-margin} is unset, and both @code{line-width} and
618 @code{right-margin} are set, then @code{left-margin} is set to
619 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}right-margin)}.
620 If only @code{line-width} is set, then both margins are set to
621 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
622 and the systems are consequently centered on the page. Also see
623 @code{check-consistency}.
626 @funindex right-margin
628 The margin between the right edge of the page and the end of the
629 staff lines in non-ragged systems. If the paper size is modified,
630 this dimension's default value is scaled accordingly. If
631 @code{right-margin} is unset, and both @code{line-width} and
632 @code{left-margin} are set, then @code{right-margin} is set to
633 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}left-margin)}.
634 If only @code{line-width} is set, then both margins are set to
635 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
636 and the systems are consequently centered on the page. Also see
637 @code{check-consistency}.
639 @item check-consistency
640 @funindex check-consistency
642 If set to true, print a warning if @code{left-margin},
643 @code{line-width}, and @code{right-margin} do not exactly add up
644 to @code{paper-width}, and replace each of these (except
645 @code{paper-width}) with its default value (scaled to the paper
646 size if necessary). If set to false, ignore any inconsistencies
647 and allow systems to run off the edge of the page.
650 @funindex ragged-right
652 If set to true, systems will not fill the line width. Instead,
653 systems end at their natural horizontal length. Default:
654 @code{#t} for scores with only one system, and @code{#f} for
655 scores with two or more systems. This variable can also be set in
656 a @code{\layout} block.
659 @funindex ragged-last
661 If set to true, the last system in the score will not fill the
662 line width. Instead the last system ends at its natural
663 horizontal length. Default: @code{#f}. This variable can also be
664 set in a @code{\layout} block.
670 @ref{Automatic scaling to paper size}.
673 @file{ly/paper-defaults-init.ly}.
676 @node \paper variables for two-sided mode
677 @unnumberedsubsubsec @code{\paper} variables for two-sided mode
679 Default values (before scaling) are defined in
680 @file{ly/paper-defaults-init.ly}.
688 @cindex binding gutter
690 If set to true, use @code{inner-margin}, @code{outer-margin} and
691 @code{binding-offset} to determine margins depending on whether
692 the page number is odd or even. This overrides @code{left-margin}
693 and @code{right-margin}.
696 @funindex inner-margin
698 The margin all pages have at the inner side if they are part of a
699 book. If the paper size is modified, this dimension's default
700 value is scaled accordingly. Works only with @code{two-sided} set
704 @funindex outer-margin
706 The margin all pages have at the outer side if they are part of a
707 book. If the paper size is modified, this dimension's default
708 value is scaled accordingly. Works only with @code{two-sided} set
712 @funindex binding-offset
714 The amount @code{inner-margin} is increased to make sure nothing
715 will be hidden by the binding. If the paper size is modified,
716 this dimension's default value is scaled accordingly. Works only
717 with @code{two-sided} set to true.
723 @ref{Automatic scaling to paper size}.
726 @file{ly/paper-defaults-init.ly}.
729 @node \paper variables for shifts and indents
730 @unnumberedsubsubsec @code{\paper} variables for shifts and indents
732 Default values (before scaling) that are not listed here are
733 defined in @file{ly/paper-defaults-init.ly}.
737 @item horizontal-shift
738 @funindex horizontal-shift
740 @c This default value is buried in the middle of page.scm. -mp
742 The amount that all systems (including titles and system
743 separators) are shifted to the right. Default: @code{0.0\mm}.
748 The level of indentation for the first system in a score. If the
749 paper size is modified, this dimension's default value is scaled
750 accordingly. This variable can also be set in a @code{\layout}
754 @funindex short-indent
756 The level of indentation for all systems in a score besides the
757 first system. If the paper size is modified, this dimension's
758 default value is scaled accordingly. This variable can also be
759 set in a @code{\layout} block.
765 @ref{Automatic scaling to paper size}.
768 @file{ly/paper-defaults-init.ly}.
774 @node Other \paper variables
775 @subsection Other @code{\paper} variables
778 * \paper variables for line breaking::
779 * \paper variables for page breaking::
780 * \paper variables for page numbering::
781 * Miscellaneous \paper variables::
785 @node \paper variables for line breaking
786 @unnumberedsubsubsec @code{\paper} variables for line breaking
788 @c TODO: Mention that ly:optimal-breaking is on by default? -mp
792 @item max-systems-per-page
793 @funindex max-systems-per-page
795 The maximum number of systems that will be placed on a page. This
796 is currently supported only by the @code{ly:optimal-breaking} algorithm.
799 @item min-systems-per-page
800 @funindex min-systems-per-page
802 The minimum number of systems that will be placed on a page. This
803 may cause pages to be overfilled if it is made too large. This is
804 currently supported only by the @code{ly:optimal-breaking} algorithm.
807 @item systems-per-page
808 @funindex systems-per-page
810 The number of systems that should be placed on each page.
811 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
815 @funindex system-count
817 The number of systems to be used for a score. Default: unset.
818 This variable can also be set in a @code{\layout} block.
827 @node \paper variables for page breaking
828 @unnumberedsubsubsec @code{\paper} variables for page breaking
830 Default values not listed here are defined in
831 @file{ly/paper-defaults-init.ly}
835 @item blank-after-score-page-force
836 @funindex blank-after-score-page-force
838 The penalty for having a blank page after the end of one score and
839 before the next. By default, this is smaller than
840 @code{blank-page-force}, so that we prefer blank pages after
841 scores to blank pages within a score.
843 @item blank-last-page-force
844 @funindex blank-last-page-force
846 The penalty for ending the score on an odd-numbered page.
848 @item blank-page-force
849 @funindex blank-page-force
851 The penalty for having a blank page in the middle of a
852 score. This is not used by @code{ly:optimal-breaking} since it will
853 never consider blank pages in the middle of a score.
856 @funindex page-breaking
858 The page-breaking algorithm to use. Choices are
859 @code{ly:minimal-breaking}, @code{ly:page-turn-breaking}, and
860 @code{ly:optimal-breaking}.
862 @item page-breaking-system-system-spacing
863 @funindex page-breaking-system-system-spacing
865 Tricks the page breaker into thinking that
866 @code{system-system-spacing} is set to something different than
867 it really is. For example, if
868 @code{page-breaking-system-system-spacing #'padding} is set to something
869 substantially larger than @code{system-system-spacing #'padding}, then the
870 page-breaker will put fewer systems on each page. Default: unset.
875 The number of pages to be used for a score, unset by default.
882 @ref{Optimal page breaking},
883 @ref{Optimal page turning},
884 @ref{Minimal page breaking}.
887 @file{ly/paper-defaults-init.ly}.
890 @node \paper variables for page numbering
891 @unnumberedsubsubsec @code{\paper} variables for page numbering
893 Default values not listed here are defined in
894 @file{ly/paper-defaults-init.ly}
898 @item auto-first-page-number
899 @funindex auto-first-page-number
901 The page breaking algorithm is affected by the first page number
902 being odd or even. If set to true, the page breaking algorithm
903 will decide whether to start with an odd or even number. This
904 will result in the first page number remaining as is or being
905 increased by one. Default: @code{#f}.
907 @item first-page-number
908 @funindex first-page-number
910 The value of the page number on the first page.
912 @item print-first-page-number
913 @funindex print-first-page-number
915 If set to true, a page number is printed on the first page.
917 @item print-page-number
918 @funindex print-page-number
920 If set to false, page numbers are not printed.
926 @file{ly/paper-defaults-init.ly}.
929 Odd page numbers are always on the right. If you want the
930 music to start on page 1 there must be a blank page on the back
931 of the cover page so that page 1 is on the right hand side.
934 @node Miscellaneous \paper variables
935 @unnumberedsubsubsec Miscellaneous @code{\paper} variables
939 @item page-spacing-weight
940 @funindex page-spacing-weight
942 The relative importance of page (vertical) spacing and line
943 (horizontal) spacing. High values will make page spacing more
944 important. Default: @code{#10}.
946 @item print-all-headers
947 @funindex print-all-headers
949 If set to true, this will print all headers for each @code{\score}
950 in the output. Normally only the @code{piece} and @code{opus}
951 header variables are printed. Default: @code{#f}.
953 @item system-separator-markup
954 @funindex system-separator-markup
956 A markup object that is inserted between systems, often used for
957 orchestral scores. Default: unset. The @code{\slashSeparator}
958 markup, defined in @file{ly/titling-init.ly}, is provided as a
959 sensible default, for example:
961 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
962 #(set-default-paper-size "a8")
966 system-separator-markup = \slashSeparator
972 \relative c'' { c1 \break c1 \break c1 }
982 @file{ly/titling-init.ly}.
990 The default page header puts the page number and the @code{instrument}
991 field from the @code{\header} block on a line.
995 @section Score layout
997 This section discusses score layout options for the @code{\layout}
1001 * The \layout block::
1002 * Setting the staff size::
1006 @node The \layout block
1007 @subsection The @code{\layout} block
1011 While the @code{\paper} block contains settings that relate to the
1012 page formatting of the whole document, the @code{\layout} block
1013 contains settings for score-specific layout. To set score layout
1014 options globally, enter them in a toplevel @code{\layout} block.
1015 To set layout options for an individual score, enter them in a
1016 @code{\layout} block inside the @code{\score} block, after the
1017 music. Settings that can appear in a @code{\layout} block
1021 @item the @code{layout-set-staff-size} scheme function,
1022 @item context modifications in @code{\context} blocks, and
1023 @item @code{\paper} variables that affect score layout.
1026 The @code{layout-set-staff-size} function is discussed in the next
1027 section, @ref{Setting the staff size}. Context modifications are
1028 discussed in a separate chapter; see
1029 @ref{Modifying context plug-ins} and
1030 @ref{Changing context default settings}. The @code{\paper}
1031 variables that can appear in a @code{\layout} block are:
1036 @code{line-width}, @code{ragged-right} and @code{ragged-last}
1037 (see @ref{\paper variables for widths and margins})
1040 @code{indent} and @code{short-indent}
1041 (see @ref{\paper variables for shifts and indents})
1045 (see @ref{\paper variables for line breaking})
1049 Here is an example @code{\layout} block:
1056 \override StaffGrouper #'staff-staff-spacing #'basic-distance = #8
1060 \override TextScript #'padding = #1
1061 \override Glissando #'thickness = #3
1069 @ref{Changing context default settings}.
1075 @node Setting the staff size
1076 @subsection Setting the staff size
1078 @cindex font size, setting
1079 @cindex staff size, setting
1080 @funindex layout file
1082 The default @strong{staff size} is set to 20 points.
1083 This may be changed in two ways:
1085 To set the staff size globally for all scores in a file (or
1086 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
1089 #(set-global-staff-size 14)
1093 This sets the global default size to 14pt staff height and scales all
1096 To set the staff size individually for each score, use
1101 #(layout-set-staff-size 15)
1106 The Feta font provides musical symbols at eight different
1107 sizes. Each font is tuned for a different staff size: at a smaller size
1108 the font becomes heavier, to match the relatively heavier staff lines.
1109 The recommended font sizes are listed in the following table:
1112 @multitable @columnfractions .15 .2 .22 .2
1115 @tab @b{staff height (pt)}
1116 @tab @b{staff height (mm)}
1158 @c modern rental material?
1163 These fonts are available in any sizes. The context property
1164 @code{fontSize} and the layout property @code{staff-space} (in
1165 @rinternals{StaffSymbol}) can be used to tune the size for individual
1166 staves. The sizes of individual staves are relative to the global size.
1171 @ref{Selecting notation font size}.
1179 @code{layout-set-staff-size} does not change the distance between the
1189 * Optimal page breaking::
1190 * Optimal page turning::
1191 * Minimal page breaking::
1193 * Using an extra voice for breaks::
1198 @subsection Line breaking
1201 @cindex breaking lines
1203 Line breaks are normally determined automatically. They are chosen
1204 so that lines look neither cramped nor loose, and consecutive
1205 lines have similar density.
1207 To manually force a line break at a bar line, use the
1208 @code{\break} command:
1210 @lilypond[quote,ragged-right,relative=2,verbatim]
1215 By default, a @code{\break} in the middle of a measure is ignored,
1216 and a warning is printed. To force a line break in the middle of
1217 a measure, add an invisible bar line with @w{@samp{\bar ""}}:
1219 @lilypond[quote,ragged-right,relative=2,verbatim]
1226 A @code{\break} occurring at a bar line is also ignored if the
1227 previous measure ends in the middle of a note, such as when a
1228 tuplet begins and ends in different measures. To allow
1229 @code{\break} commands to work in these situations, remove the
1230 @code{Forbid_line_break_engraver} from the @code{Voice} context.
1231 Note that manually forced line breaks have to be added in parallel
1234 @lilypond[quote,ragged-right,verbatim]
1236 \remove Forbid_line_break_engraver
1239 { c2. \times 2/3 { c4 c c } c2. | }
1240 { s1 | \break s1 | }
1245 Similarly, line breaks are normally forbidden when beams cross bar
1246 lines. This behavior can be changed by setting
1247 @code{\override Beam #'breakable = ##t}:
1249 @lilypond[quote,ragged-right,relative=2,verbatim]
1250 \override Beam #'breakable = ##t
1255 The @code{\noBreak} command forbids a line break at the bar line
1256 where it is inserted.
1258 The most basic settings influencing line spacing are @code{indent}
1259 and @code{line-width}. They are set in the @code{\layout} block.
1260 They control the indentation of the first line of music, and the
1261 lengths of the lines.
1263 If @code{ragged-right} is set to true in the @code{\layout} block,
1264 then systems end at their natural horizontal length, instead of
1265 being spread horizontally to fill the whole line. This is useful
1266 for short fragments, and for checking how tight the natural
1269 @c TODO Check and add para on default for ragged-right
1271 The option @code{ragged-last} is similar to @code{ragged-right},
1272 but affects only the last line of the piece.
1284 @cindex regular line breaks
1285 @cindex four bar music.
1287 For line breaks at regular intervals use @code{\break} separated by
1288 skips and repeated with @code{\repeat}. For example, this would
1289 cause the following 28 measures (assuming 4/4 time) to be broken
1290 every 4 measures, and only there:
1295 s1 \noBreak s1 \noBreak
1296 s1 \noBreak s1 \break
1298 @{ @var{the actual music@dots{}} @}
1303 A linebreaking configuration can be saved as a @file{.ly} file
1304 automatically. This allows vertical alignments to be stretched to
1305 fit pages in a second formatting run. This is fairly new and
1306 complicated. More details are available in
1320 @ref{\paper variables for line breaking}.
1325 Internals Reference:
1326 @rinternals{LineBreakEvent}.
1330 @subsection Page breaking
1332 The default page breaking may be overridden by inserting
1333 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1334 analogous to @code{\break} and @code{\noBreak}. They should be
1335 inserted at a bar line. These commands force and forbid a page-break
1336 from happening. Of course, the @code{\pageBreak} command also forces
1339 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1340 inserted at top-level, between scores and top-level markups.
1342 There are also analogous settings to @code{ragged-right} and
1343 @code{ragged-last} which have the same effect on vertical spacing:
1344 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1345 @code{##t} the systems on all pages or just the last page
1346 respectively will not be justified vertically. See
1347 @ref{Fixed vertical spacing \paper variables}.
1349 Page breaks are computed by the @code{page-breaking} function. LilyPond
1350 provides three algorithms for computing page breaks,
1351 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1352 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1353 but the value can be changed in the @code{\paper} block:
1357 page-breaking = #ly:page-turn-breaking
1363 When a book has many scores and pages, the page breaking problem may be
1364 difficult to solve, requiring large processing time and memory. To ease
1365 the page breaking process, @code{\bookpart} blocks are used to divide
1366 the book into several parts: the page breaking occurs separately on each
1367 part. Different page breaking functions may also be used in different
1373 subtitle = "Preface"
1376 %% In a part consisting mostly of text,
1377 %% ly:minimal-breaking may be preferred
1378 page-breaking = #ly:minimal-breaking
1380 \markup @{ @dots{} @}
1384 %% In this part, consisting of music, the default optimal
1385 %% page breaking function is used.
1387 subtitle = "First movement"
1389 \score @{ @dots{} @}
1396 @funindex \pageBreak
1398 @funindex \noPageBreak
1399 @code{\noPageBreak}.
1405 @ref{\paper variables for page breaking}.
1411 @node Optimal page breaking
1412 @subsection Optimal page breaking
1414 @funindex ly:optimal-breaking
1416 The @code{ly:optimal-breaking} function is LilyPond's default method of
1417 determining page breaks. It attempts to find a page breaking that minimizes
1418 cramping and stretching, both horizontally and vertically. Unlike
1419 @code{ly:page-turn-breaking}, it has no concept of page turns.
1427 @node Optimal page turning
1428 @subsection Optimal page turning
1430 @funindex ly:page-turn-breaking
1432 Often it is necessary to find a page breaking configuration so that there is
1433 a rest at the end of every second page. This way, the musician can turn the
1434 page without having to miss notes. The @code{ly:page-turn-breaking} function
1435 attempts to find a page breaking minimizing cramping and stretching, but with
1436 the additional restriction that it is only allowed to introduce page turns
1437 in specified places.
1439 There are two steps to using this page breaking function. First, you
1440 must enable it in the @code{\paper} block, as explained in @ref{Page
1441 breaking}. Then you must tell the function where you would like to allow
1444 There are two ways to achieve the second step. First, you can specify each
1445 potential page turn manually, by inserting @code{\allowPageTurn} into your
1446 input file at the appropriate places.
1448 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1449 Voice context. The @code{Page_turn_engraver} will scan the context for
1450 sections without notes (note that it does not scan for rests; it scans for
1451 the absence of notes. This is so that single-staff polyphony with rests in one
1452 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1453 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1454 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1455 there is a @q{special} bar line (such as a double bar), in which case the
1456 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1459 @funindex minimumPageTurnLength
1460 The @code{Page_turn_engraver} reads the context property
1461 @code{minimumPageTurnLength} to determine how long a note-free section must
1462 be before a page turn is considered. The default value for
1463 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
1464 to disable page turns, you can set it to something very large.
1467 \new Staff \with @{ \consists "Page_turn_engraver" @}
1470 R1 | % a page turn will be allowed here
1472 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1473 R1 | % a page turn will not be allowed here
1475 R1*2 | % a page turn will be allowed here
1480 @funindex minimumRepeatLengthForPageTurn
1481 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1482 turn during the repeat if there is enough time at the beginning and end of the
1483 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1484 page turns if the repeat is very short. If you set the context property
1485 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1486 only allow turns in repeats whose duration is longer than this value.
1488 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1489 @code{\allowPageTurn}, may also be used at top-level, between scores and
1496 @funindex \noPageTurn
1498 @funindex \allowPageTurn
1499 @code{\allowPageTurn}.
1510 There should only be one @code{Page_turn_engraver} in a score. If there is more
1511 than one, they will interfere with each other.
1514 @node Minimal page breaking
1515 @subsection Minimal page breaking
1517 @funindex ly:minimal-breaking
1519 The @code{ly:minimal-breaking} function performs minimal computations to
1520 calculate the page breaking: it fills a page with as many systems as
1521 possible before moving to the next one. Thus, it may be preferred for
1522 scores with many pages, where the other page breaking functions could be
1523 too slow or memory demanding, or a lot of texts. It is enabled using:
1527 page-breaking = #ly:minimal-breaking
1537 @node Explicit breaks
1538 @subsection Explicit breaks
1540 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1541 commands. There are two commands to override this behavior:
1544 \override NonMusicalPaperColumn #'line-break-permission = ##f
1545 \override NonMusicalPaperColumn #'page-break-permission = ##f
1548 When @code{line-break-permission} is overridden to false, Lily will insert
1549 line breaks at explicit @code{\break} commands and nowhere else. When
1550 @code{page-break-permission} is overridden to false, Lily will insert
1551 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1553 @lilypond[quote,verbatim]
1560 music = \relative c'' { c8 c c c }
1564 \repeat unfold 2 { \music } \break
1565 \repeat unfold 4 { \music } \break
1566 \repeat unfold 6 { \music } \break
1567 \repeat unfold 8 { \music } \pageBreak
1568 \repeat unfold 8 { \music } \break
1569 \repeat unfold 6 { \music } \break
1570 \repeat unfold 4 { \music } \break
1571 \repeat unfold 2 { \music }
1576 \override NonMusicalPaperColumn #'line-break-permission = ##f
1577 \override NonMusicalPaperColumn #'page-break-permission = ##f
1589 @node Using an extra voice for breaks
1590 @subsection Using an extra voice for breaks
1592 Line- and page-breaking information usually appears within note entry directly.
1595 music = \relative c'' @{ c4 c c c @}
1599 \repeat unfold 2 @{ \music @} \break
1600 \repeat unfold 3 @{ \music @}
1605 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1606 music entry with information that specifies how music should lay out
1607 on the page. You can keep music entry and line- and page-breaking
1608 information in two separate places by introducing an extra voice to
1609 contain the breaks. This extra voice
1610 contains only skips together with @code{\break}, @code{pageBreak} and other
1611 breaking layout information.
1613 @lilypond[quote,verbatim]
1614 music = \relative c'' { c4 c c c }
1625 \repeat unfold 2 { \music }
1626 \repeat unfold 3 { \music }
1627 \repeat unfold 6 { \music }
1628 \repeat unfold 5 { \music }
1634 This pattern becomes especially helpful when overriding
1635 @code{line-break-system-details} and the other useful but long properties of
1636 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1638 @lilypond[quote,verbatim]
1639 music = \relative c'' { c4 c c c }
1644 \overrideProperty "Score.NonMusicalPaperColumn"
1645 #'line-break-system-details #'((Y-offset . 0))
1648 \overrideProperty "Score.NonMusicalPaperColumn"
1649 #'line-break-system-details #'((Y-offset . 35))
1652 \overrideProperty "Score.NonMusicalPaperColumn"
1653 #'line-break-system-details #'((Y-offset . 70))
1656 \overrideProperty "Score.NonMusicalPaperColumn"
1657 #'line-break-system-details #'((Y-offset . 105))
1661 \repeat unfold 2 { \music }
1662 \repeat unfold 3 { \music }
1663 \repeat unfold 6 { \music }
1664 \repeat unfold 5 { \music }
1673 @ref{Vertical spacing}.
1679 @node Vertical spacing
1680 @section Vertical spacing
1682 @cindex vertical spacing
1683 @cindex spacing, vertical
1685 Vertical spacing is controlled by three things: the amount of
1686 space available (i.e., paper size and margins), the amount of
1687 space between systems, and the amount of space between
1688 staves inside a system.
1691 * Flexible vertical spacing within systems::
1692 * Explicit staff and system positioning::
1693 * Vertical collision avoidance::
1697 @node Flexible vertical spacing within systems
1698 @subsection Flexible vertical spacing within systems
1700 @cindex distance between staves
1701 @cindex staff distance
1702 @cindex space between staves
1703 @cindex space inside systems
1705 Three separate mechanisms control the flexible vertical spacing
1706 within systems, one for each of the following categories:
1711 @emph{ungrouped staves},
1714 @emph{grouped staves} (staves within a staff-group such as
1715 @code{ChoirStaff}, etc.), and
1718 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1723 @c TODO: Clarify this. This almost implies that non-staff lines
1724 @c have NO effect on the spacing between staves. -mp
1726 The height of each system is determined in two steps. First, all
1727 of the staves are spaced according to the amount of space
1728 available. Then, the non-staff lines are distributed between the
1731 Note that the spacing mechanisms discussed in this section only
1732 control the vertical spacing of staves and non-staff lines within
1733 individual systems. The vertical spacing between separate
1734 systems, scores, markups, and margins is controlled by
1735 @code{\paper} variables, which are discussed in
1736 @ref{Flexible vertical spacing \paper variables}.
1739 * Within-system spacing properties::
1740 * Spacing of ungrouped staves::
1741 * Spacing of grouped staves::
1742 * Spacing of non-staff lines::
1746 @node Within-system spacing properties
1747 @unnumberedsubsubsec Within-system spacing properties
1749 The within-system vertical spacing mechanisms are controlled by
1750 two sets of grob properties. The first set is associated with the
1751 @code{VerticalAxisGroup} grob, which is created by all staves and
1752 non-staff lines. The second set is associated with the
1753 @code{StaffGrouper} grob, which can be created by staff-groups,
1754 but only if explicitly called. These properties are described
1755 individually at the end of this section.
1757 The names of these properties (except for @code{staff-affinity})
1758 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1759 @code{@var{item1}} and @code{@var{item2}} are the items to be
1760 spaced. Note that @code{@var{item2}} is not necessarily below
1761 @code{@var{item1}}; for example,
1762 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1763 non-staff line if @code{staff-affinity} is @code{#UP}.
1765 Each distance is measured between the @emph{reference points} of
1766 the two items. The reference point for a staff is the vertical
1767 center of its @code{StaffSymbol} (i.e. the middle line if
1768 @code{line-count} is odd; the middle space if @code{line-count} is
1769 even). The reference points for individual non-staff lines are
1770 given in the following table:
1772 @multitable {Non-staff line} {Reference point}
1773 @headitem Non-staff line @tab Reference point
1774 @item @code{ChordNames} @tab baseline
1775 @item @code{NoteNames} @tab baseline
1776 @item @code{Lyrics} @tab baseline
1777 @item @code{Dynamics} @tab vertical center
1778 @item @code{FiguredBass} @tab highest point
1779 @item @code{FretBoards} @tab top line
1782 In the following image, horizontal lines indicate the positions
1783 of these reference points:
1785 @lilypond[quote,noragged-right,line-width=110\mm]
1786 #(define zero-space '((padding . -inf.0) (basic-distance . 0)))
1788 alignToZero = \with {
1789 \override VerticalAxisGroup #'nonstaff-relatedstaff-spacing = #zero-space
1790 \override VerticalAxisGroup #'nonstaff-nonstaff-spacing = #zero-space
1792 lowerCaseChords = \with {
1793 chordNameLowercaseMinor = ##t
1795 staffAffinityDown = \with {
1796 \override VerticalAxisGroup #'staff-affinity = #DOWN
1799 #(define-music-function
1800 (parser location context)
1802 #{ s1*0^\markup { \typewriter $context } #})
1805 \context { \Dynamics \alignToZero }
1806 \context { \FiguredBass \alignToZero }
1807 \context { \Lyrics \alignToZero }
1808 \context { \NoteNames \alignToZero }
1809 \context { \ChordNames \alignToZero \lowerCaseChords }
1810 \context { \FretBoards \alignToZero \staffAffinityDown }
1812 \override BarLine #'stencil = ##f
1813 \override DynamicText #'self-alignment-X = #-1
1814 \override FretBoard #'X-offset = #1.75
1815 \override InstrumentName #'minimum-Y-extent = #'(-2 . 2)
1816 \override InstrumentName #'extra-offset = #'(0 . -0.5)
1817 \override TextScript #'minimum-Y-extent = #'(-2 . 3)
1818 \override TimeSignature #'stencil = ##f
1822 %% These contexts have reference points at the baseline:
1823 %% ChordNames, NoteNames, and Lyrics
1825 \new ChordNames { \chords { g1:m } }
1826 \new NoteNames { s1 | g1 | }
1827 \new RhythmicStaff {
1828 \set RhythmicStaff.instrumentName = #"baseline "
1830 \labelContext "ChordNames" s1 |
1831 \labelContext "NoteNames" s1 |
1832 \labelContext "Lyrics" s1 |
1834 \new Lyrics { \lyrics { \skip 1*2 | ghijk1 | } }
1837 %% The reference point for Dynamics is its vertical center
1839 \new RhythmicStaff {
1840 \set RhythmicStaff.instrumentName = #"vertical center "
1841 \labelContext "Dynamics" s1*3
1843 \new Dynamics { s2\mp s\fp }
1846 %% The reference point for FiguredBass is its highest point
1848 \new RhythmicStaff {
1849 \set RhythmicStaff.instrumentName = #"highest point "
1850 \labelContext "FiguredBass" s1
1852 \new FiguredBass { \figuremode { <6 5>1 } }
1855 %% The reference point for FretBoards is the top line
1856 \include "predefined-guitar-fretboards.ly"
1858 \new FretBoards { \chordmode { e1 } }
1859 \new RhythmicStaff {
1860 \set RhythmicStaff.instrumentName = #"top line "
1861 \labelContext "FretBoards " s1
1866 Each of the vertical spacing grob properties (except
1867 @code{staff-affinity}) is stored as an alist (association list),
1868 and each uses the same alist structure as the @code{\paper}
1869 spacing variables discussed in
1870 @ref{Flexible vertical spacing \paper variables}. Specific methods
1871 for modifying alists are discussed in @ref{Modifying alists}.
1872 Grob properties should be adjusted with an @code{\override} inside
1873 a @code{\score} or @code{\layout} block, and not inside a
1874 @code{\paper} block.
1876 The following example demonstrates the two ways these alists can
1877 be modified. The first declaration updates one key-value
1878 individually, and the second completely re-defines the property:
1882 \override VerticalAxisGroup #'default-staff-staff-spacing
1883 #'basic-distance = #10
1887 \override VerticalAxisGroup #'default-staff-staff-spacing =
1888 #'((basic-distance . 10)
1889 (minimum-distance . 9)
1891 (stretchability . 10))
1895 To change any spacing settings globally, put them in the
1896 @code{\layout} block:
1902 \override VerticalAxisGroup #'default-staff-staff-spacing
1903 #'basic-distance = #10
1908 Standard settings for the vertical spacing grob properties are
1909 listed in @rinternals{VerticalAxisGroup} and
1910 @rinternals{StaffGrouper}. Default overrides for specific types
1911 of non-staff lines are listed in the relevant context descriptions
1912 in @rinternals{Contexts}.
1915 @subsubheading Properties of the @code{VerticalAxisGroup} grob
1917 @code{VerticalAxisGroup} properties are typically adjusted with an
1918 @code{\override} at the @code{Staff} level (or equivalent).
1921 @item staff-staff-spacing
1922 The distance between the current staff and the staff just below it
1923 in the same system, even if one or more non-staff lines (such as
1924 @code{Lyrics}) are placed between the two staves. Does not apply
1925 to the bottom staff of a system. This replaces any settings
1926 inherited from the @code{StaffGrouper} grob of the containing
1927 staff-group, if there is one. If this is unset, and there are no
1928 @code{StaffGrouper} properties to inherit, the
1929 @code{default-staff-staff-spacing} property is used.
1931 @item default-staff-staff-spacing
1932 The settings to use for @code{staff-staff-spacing} when it is
1933 unset. This applies to ungrouped staves and to grouped staves
1934 that do not inherit settings from the @code{StaffGrouper} grob.
1936 @item staff-affinity
1937 The direction of the staff to use for spacing the current
1938 non-staff line. Choices are @code{UP}, @code{DOWN}, and
1939 @code{CENTER}. If @code{CENTER}, the non-staff line will be
1940 placed equidistant between the two nearest staves on either side,
1941 unless collisions or other spacing constraints prevent this.
1942 Adjacent non-staff lines should have non-increasing
1943 @code{staff-affinity} from top to bottom, e.g. a non-staff line
1944 set to @code{UP} should not immediately follow one that is set to
1945 @code{DOWN}. Non-staff lines at the top of a system should use
1946 @code{DOWN}; those at the bottom should use @code{UP}. Setting
1947 @code{staff-affinity} for a staff causes it to be treated as a
1948 non-staff line. Setting @code{staff-affinity} to @code{#f} causes
1949 a non-staff line to be treated as a staff.
1951 @c TODO: verify last clause below ("even if other...")
1953 @item nonstaff-relatedstaff-spacing
1954 The distance between the current non-staff line and the nearest
1955 staff in the direction of @code{staff-affinity}, if there are no
1956 non-staff lines between the two, and @code{staff-affinity} is
1957 either @code{UP} or @code{DOWN}. If @code{staff-affinity} is
1958 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
1959 for the nearest staves on @emph{both} sides, even if other
1960 non-staff lines appear between the current one and either of the
1963 @item nonstaff-nonstaff-spacing
1964 The distance between the current non-staff line and the next
1965 non-staff line in the direction of @code{staff-affinity}, if both
1966 are on the same side of the related staff, and
1967 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
1969 @item nonstaff-unrelatedstaff-spacing
1970 The distance between the current non-staff line and the staff in
1971 the opposite direction from @code{staff-affinity}, if there are no
1972 other non-staff lines between the two, and @code{staff-affinity}
1973 is either @code{UP} or @code{DOWN}. This can be used, for
1974 example, to require a minimum amount of padding between a
1975 @code{Lyrics} line and the staff to which it does not belong.
1979 @subsubheading Properties of the @code{StaffGrouper} grob
1981 @code{StaffGrouper} properties are typically adjusted with an
1982 @code{\override} at the @code{StaffGroup} level (or equivalent).
1985 @item staff-staff-spacing
1986 The distance between consecutive staves within the current
1987 staff-group. The @code{staff-staff-spacing} property of an
1988 individual staff's @code{VerticalAxisGroup} grob will be used
1989 instead for any staves in the staff-group that have it set. Also
1990 see @code{default-staff-staff-spacing}.
1992 @item staffgroup-staff-spacing
1993 The distance between the last staff of the current staff-group and
1994 the staff just below it in the same system, even if one or more
1995 non-staff lines (such as @code{Lyrics}) exist between the two
1996 staves. Does not apply to the bottom staff of a system. The
1997 @code{staff-staff-spacing} property of an individual staff's
1998 @code{VerticalAxisGroup} grob will be used instead for any staves
1999 in the staff-group that have it set. Also see
2000 @code{default-staff-staff-spacing}.
2005 @file{ly/engraver-init.ly},
2006 @file{scm/define-grobs.scm}.
2008 Internals Reference:
2009 @rinternals{Contexts},
2010 @rinternals{VerticalAxisGroup},
2011 @rinternals{StaffGrouper}.
2014 @node Spacing of ungrouped staves
2015 @unnumberedsubsubsec Spacing of ungrouped staves
2017 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
2018 @code{TabStaff}, etc.) are contexts that can contain one or more
2019 voice contexts, but cannot contain any other staves.
2021 The following properties affect the spacing of @emph{ungrouped}
2025 @item @code{VerticalAxisGroup} properties:
2027 @item @code{staff-staff-spacing}
2031 These grob properties are described individually above; see
2032 @ref{Within-system spacing properties}.
2034 Additional properties are involved for staves that are part of a
2035 staff-group; see @ref{Spacing of grouped staves}.
2037 The following example shows how the @code{staff-staff-spacing}
2038 property can affect the spacing of ungrouped staves:
2040 @lilypond[verbatim,quote,staffsize=16]
2044 \override VerticalAxisGroup #'staff-staff-spacing =
2045 #'((basic-distance . 8)
2046 (minimum-distance . 7)
2052 % The very low note here needs more room than 'basic-distance
2053 % can provide, so the distance between this staff and the next
2054 % is determined by 'padding.
2055 \new Staff { b,2 r | }
2057 % Here, 'basic-distance provides enough room, and there is no
2058 % need to compress the space (towards 'minimum-distance) to make
2059 % room for anything else on the page, so the distance between
2060 % this staff and the next is determined by 'basic-distance.
2061 \new Staff { \clef bass g2 r | }
2063 % By setting 'padding to a negative value, staves can be made to
2064 % collide. The lowest acceptable value for 'basic-distance is 0.
2066 \override VerticalAxisGroup #'staff-staff-spacing =
2067 #'((basic-distance . 3.5)
2069 } { \clef bass g2 r | }
2070 \new Staff { \clef bass g2 r | }
2076 @file{scm/define-grobs.scm}.
2081 Internals Reference:
2082 @rinternals{VerticalAxisGroup}.
2085 @node Spacing of grouped staves
2086 @unnumberedsubsubsec Spacing of grouped staves
2088 In orchestral and other large scores, it is common to place staves
2089 in groups. The space between groups is typically larger than the
2090 space between staves of the same group.
2092 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2093 etc.) are contexts that can contain one or more staves
2096 The following properties affect the spacing of staves inside
2100 @item @code{VerticalAxisGroup} properties:
2102 @item @code{staff-staff-spacing}
2103 @item @code{default-staff-staff-spacing}
2105 @item @code{StaffGrouper} properties:
2107 @item @code{staff-staff-spacing}
2108 @item @code{staffgroup-staff-spacing}
2112 These grob properties are described individually above; see
2113 @ref{Within-system spacing properties}.
2115 The following example shows how properties of the
2116 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2118 @lilypond[verbatim,quote,staffsize=16]
2122 \override StaffGrouper #'staff-staff-spacing #'padding = #0
2123 \override StaffGrouper #'staff-staff-spacing #'basic-distance = #1
2128 \new PianoStaff \with {
2129 \override StaffGrouper #'staffgroup-staff-spacing #'basic-distance = #20
2144 @file{scm/define-grobs.scm}.
2149 Internals Reference:
2150 @rinternals{VerticalAxisGroup},
2151 @rinternals{StaffGrouper}.
2154 @node Spacing of non-staff lines
2155 @unnumberedsubsubsec Spacing of non-staff lines
2157 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2158 etc.) are contexts whose layout objects are engraved like staves
2159 (i.e. in horizontal lines within systems). Specifically,
2160 non-staff lines are non-staff contexts that create the
2161 @code{VerticalAxisGroup} layout object.
2163 The following properties affect the spacing of non-staff lines:
2166 @item @code{VerticalAxisGroup} properties:
2168 @item @code{staff-affinity}
2169 @item @code{nonstaff-relatedstaff-spacing}
2170 @item @code{nonstaff-nonstaff-spacing}
2171 @item @code{nonstaff-unrelatedstaff-spacing}
2175 These grob properties are described individually above; see
2176 @ref{Within-system spacing properties}.
2178 The following example shows how the
2179 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2180 of consecutive non-staff lines. Here, by setting the
2181 @code{stretchability} key to a very high value, the lyrics are
2182 able to stretch much more than usual:
2184 @lilypond[verbatim,quote,staffsize=16]
2188 \override VerticalAxisGroup
2189 #'nonstaff-nonstaff-spacing #'stretchability = #1000
2196 \override VerticalAxisGroup #'staff-staff-spacing = #'((basic-distance . 30))
2199 \override VerticalAxisGroup #'staff-affinity = #UP
2202 \override VerticalAxisGroup #'staff-affinity = #CENTER
2203 } \lyricmode { center }
2205 \override VerticalAxisGroup #'staff-affinity = #DOWN
2206 } \lyricmode { down }
2214 @file{ly/engraver-init.ly},
2215 @file{scm/define-grobs.scm}.
2220 @c @lsr{spacing,page-spacing.ly},
2221 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2223 Internals Reference:
2224 @rinternals{Contexts},
2225 @rinternals{VerticalAxisGroup}.
2228 @node Explicit staff and system positioning
2229 @subsection Explicit staff and system positioning
2231 One way to understand the flexible vertical spacing mechanisms
2232 explained above is as a collection of settings that control the
2233 amount of vertical padding between staves and systems.
2235 It is possible to approach vertical spacing in a different way
2236 using @code{NonMusicalPaperColumn #'line-break-system-details}.
2237 While the flexible vertical spacing mechanisms specify vertical
2238 padding, @code{NonMusicalPaperColumn #'line-break-system-details}
2239 can specify exact vertical positions on the page.
2241 @code{NonMusicalPaperColumn #'line-break-system-details} accepts
2242 an associative list of three different settings:
2245 @item @code{X-offset}
2246 @item @code{Y-offset}
2247 @item @code{alignment-distances}
2250 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2251 below, can occur in any of three different places in an input file:
2254 @item in the middle of note entry directly
2255 @item in a @code{\context} block
2256 @item in the @code{\with} block
2259 When we override @code{NonMusicalPaperColumn}, we use the usual
2260 @code{\override} command in @code{\context} blocks and in the
2261 @code{\with} block. On the other hand, when we override
2262 @code{NonMusicalPaperColumn} in the middle of note entry,
2263 use the special @code{\overrideProperty} command. Here are some
2264 example @code{NonMusicalPaperColumn} overrides with the special
2265 @code{\overrideProperty} command:
2268 \overrideProperty NonMusicalPaperColumn
2269 #'line-break-system-details #'((X-offset . 20))
2271 \overrideProperty NonMusicalPaperColumn
2272 #'line-break-system-details #'((Y-offset . 40))
2274 \overrideProperty NonMusicalPaperColumn
2275 #'line-break-system-details #'((X-offset . 20)
2278 \overrideProperty NonMusicalPaperColumn
2279 #'line-break-system-details #'((alignment-distances . (15)))
2281 \overrideProperty NonMusicalPaperColumn
2282 #'line-break-system-details #'((X-offset . 20)
2284 (alignment-distances . (15)))
2287 To understand how each of these different settings work, we begin
2288 by looking at an example that includes no overrides at all.
2290 @c \book { } is required in these examples to ensure the spacing
2291 @c overrides can be seen between systems. -np
2293 @lilypond[verbatim,quote,staffsize=16]
2294 \header { tagline = ##f }
2295 \paper { left-margin = 0\mm }
2305 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2308 \repeat unfold 15 { d'4 d' d' d' }
2315 This score isolates line- and page-breaking information in a dedicated
2316 voice. This technique of creating a breaks voice will help keep layout
2317 separate from music entry as our example becomes more complicated.
2318 See @ref{Using an extra voice for breaks}.
2320 Explicit @code{\breaks} evenly divide the music into six measures per
2321 line. Vertical spacing results from LilyPond's defaults. To set
2322 the vertical startpoint of each system explicitly, we can set
2323 the @code{Y-offset} pair in the @code{line-break-system-details}
2324 attribute of the @code{NonMusicalPaperColumn} grob:
2326 @lilypond[verbatim,quote,staffsize=16]
2327 \header { tagline = ##f }
2328 \paper { left-margin = 0\mm }
2334 \overrideProperty #"Score.NonMusicalPaperColumn"
2335 #'line-break-system-details #'((Y-offset . 0))
2337 \overrideProperty #"Score.NonMusicalPaperColumn"
2338 #'line-break-system-details #'((Y-offset . 40))
2340 \overrideProperty #"Score.NonMusicalPaperColumn"
2341 #'line-break-system-details #'((Y-offset . 80))
2344 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2347 \repeat unfold 15 { d'4 d' d' d' }
2354 Note that @code{line-break-system-details} takes an associative list of
2355 potentially many values, but that we set only one value here. Note,
2356 too, that the @code{Y-offset} property here determines the exact vertical
2357 position on the page at which each new system will render.
2359 Now that we have set the vertical startpoint of each system
2360 explicitly, we can also set the vertical distances between staves
2361 within each system manually. We do this using the @code{alignment-distances}
2362 subproperty of @code{line-break-system-details}.
2364 @lilypond[verbatim,quote,staffsize=16]
2365 \header { tagline = ##f }
2366 \paper { left-margin = 0\mm }
2372 \overrideProperty #"Score.NonMusicalPaperColumn"
2373 #'line-break-system-details #'((Y-offset . 20)
2374 (alignment-distances . (15)))
2376 \overrideProperty #"Score.NonMusicalPaperColumn"
2377 #'line-break-system-details #'((Y-offset . 60)
2378 (alignment-distances . (15)))
2380 \overrideProperty #"Score.NonMusicalPaperColumn"
2381 #'line-break-system-details #'((Y-offset . 100)
2382 (alignment-distances . (15)))
2385 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2388 \repeat unfold 15 { d'4 d' d' d' }
2395 Note that here we assign two different values to the
2396 @code{line-break-system-details} attribute of the
2397 @code{NonMusicalPaperColumn} grob. Though the
2398 @code{line-break-system-details} attribute alist accepts many
2399 additional spacing parameters (including, for example, a corresponding
2400 @code{X-offset} pair), we need only set the @code{Y-offset} and
2401 @code{alignment-distances} pairs to control the vertical startpoint of
2402 every system and every staff. Finally, note that @code{alignment-distances}
2403 specifies the vertical positioning of staves but not of staff groups.
2405 @lilypond[verbatim,quote,staffsize=16]
2406 \header { tagline = ##f }
2407 \paper { left-margin = 0\mm }
2413 \overrideProperty #"Score.NonMusicalPaperColumn"
2414 #'line-break-system-details #'((Y-offset . 0)
2415 (alignment-distances . (30 10)))
2417 \overrideProperty #"Score.NonMusicalPaperColumn"
2418 #'line-break-system-details #'((Y-offset . 60)
2419 (alignment-distances . (10 10)))
2421 \overrideProperty #"Score.NonMusicalPaperColumn"
2422 #'line-break-system-details #'((Y-offset . 100)
2423 (alignment-distances . (10 30)))
2426 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2429 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2430 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2437 Some points to consider:
2440 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2441 do not count as a staff.
2443 @item The units of the numbers passed to @code{X-offset},
2444 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2445 of the distance between adjacent staff lines. Positive values move staves
2446 and lyrics up, negative values move staves and lyrics down.
2448 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
2449 settings given here allow the positioning of staves and systems anywhere
2450 on the page, it is possible to violate paper or margin boundaries or even
2451 to print staves or systems on top of one another. Reasonable values
2452 passed to these different settings will avoid this.
2461 @node Vertical collision avoidance
2462 @subsection Vertical collision avoidance
2464 @funindex outside-staff-priority
2465 @funindex outside-staff-padding
2466 @funindex outside-staff-horizontal-padding
2468 Intuitively, there are some objects in musical notation that belong
2469 to the staff and there are other objects that should be placed outside
2470 the staff. Objects belonging outside the staff include things such as
2471 rehearsal marks, text and dynamic markings (from now on, these will
2472 be called outside-staff objects). LilyPond's rule for the
2473 vertical placement of outside-staff objects is to place them as close
2474 to the staff as possible but not so close that they collide with
2477 LilyPond uses the @code{outside-staff-priority} property to determine
2478 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2479 is a number, the grob is an outside-staff object. In addition,
2480 @code{outside-staff-priority} tells LilyPond in which order the objects
2483 First, LilyPond places all the objects that do not belong outside
2484 the staff. Then it sorts the outside-staff objects according to their
2485 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
2486 takes the outside-staff objects and places them so that they do
2487 not collide with any objects that have already been placed. That
2488 is, if two outside-staff grobs are competing for the same space, the one
2489 with the lower @code{outside-staff-priority} will be placed closer to
2492 @lilypond[quote,ragged-right,relative=2,verbatim]
2495 \once \override TextScript #'outside-staff-priority = #1
2496 c4_"Text"\pp % this time the text will be closer to the staff
2498 % by setting outside-staff-priority to a non-number,
2499 % we disable the automatic collision avoidance
2500 \once \override TextScript #'outside-staff-priority = ##f
2501 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
2502 c4_"Text"\pp % now they will collide
2505 The vertical padding between an outside-staff object and the
2506 previously-positioned grobs can be controlled with
2507 @code{outside-staff-padding}.
2509 @lilypond[quote,ragged-right,relative=2,verbatim]
2510 \once \override TextScript #'outside-staff-padding = #0
2511 a'^"This text is placed very close to the note"
2512 \once \override TextScript #'outside-staff-padding = #3
2513 c^"This text is padded away from the previous text"
2514 c^"This text is placed close to the previous text"
2518 By default, outside-staff objects are placed only to avoid
2519 a horizontal collision with previously-positioned grobs. This
2520 can lead to situations in which objects are placed very close to each
2521 other horizontally. The vertical spacing between staves can
2522 also be set so that outside staff objects are interleaved.
2523 Setting @code{outside-staff-horizontal-padding}
2524 causes an object to be offset vertically so that such a situation
2527 @lilypond[quote,ragged-right,relative=2,verbatim]
2528 % the markup is too close to the following note
2532 % setting outside-staff-horizontal-padding fixes this
2534 \once \override TextScript #'outside-staff-horizontal-padding = #1
2546 @node Horizontal spacing
2547 @section Horizontal spacing
2549 @cindex horizontal spacing
2550 @cindex spacing, horizontal
2553 * Horizontal spacing overview::
2554 * New spacing area::
2555 * Changing horizontal spacing::
2557 * Proportional notation::
2561 @node Horizontal spacing overview
2562 @subsection Horizontal spacing overview
2564 The spacing engine translates differences in durations into stretchable
2565 distances (@q{springs}) of differing lengths. Longer durations get
2566 more space, shorter durations get less. The shortest durations get a
2567 fixed amount of space (which is controlled by
2568 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2569 object). The longer the duration, the more space it gets: doubling a
2570 duration adds a fixed amount (this amount is controlled by
2571 @code{spacing-increment}) of space to the note.
2573 For example, the following piece contains lots of half, quarter, and
2574 8th notes; the eighth note is followed by 1 note head width (NHW).
2575 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2577 @lilypond[quote,verbatim,relative=1]
2578 c2 c4. c8 c4. c8 c4. c8 c8
2582 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2583 approximately the width of a note head, and
2584 @code{shortest-duration-space} is set to 2.0, meaning that the
2585 shortest note gets 2.4 staff space (2.0 times the
2586 @code{spacing-increment}) of horizontal space. This space is counted
2587 from the left edge of the symbol, so the shortest notes are generally
2588 followed by one NHW of space.
2590 If one would follow the above procedure exactly, then adding a single
2591 32nd note to a score that uses 8th and 16th notes, would widen up the
2592 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2593 thus adding 1 NHW to every note. To prevent this, the shortest
2594 duration for spacing is not the shortest note in the score, but rather
2595 the one which occurs most frequently.
2598 The most common shortest duration is determined as follows: in every
2599 measure, the shortest duration is determined. The most common shortest
2600 duration is taken as the basis for the spacing, with the stipulation
2601 that this shortest duration should always be equal to or shorter than
2602 an 8th note. The shortest duration is printed when you run
2603 @code{lilypond} with the @code{--verbose} option.
2605 These durations may also be customized. If you set the
2606 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2607 this sets the base duration for spacing. The maximum duration for this
2608 base (normally an 8th), is set through @code{base-shortest-duration}.
2610 @funindex common-shortest-duration
2611 @funindex base-shortest-duration
2612 @funindex stem-spacing-correction
2615 Notes that are even shorter than the common shortest note are
2616 followed by a space that is proportional to their duration relative to
2617 the common shortest note. So if we were to add only a few 16th notes
2618 to the example above, they would be followed by half a NHW:
2620 @lilypond[quote,verbatim,relative=2]
2621 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2625 In the @emph{Essay on automated music engraving}, it was explained
2626 that stem directions influence spacing (see
2627 @ressay{Optical spacing}). This is controlled with the
2628 @code{stem-spacing-correction} property in the
2629 @rinternals{NoteSpacing}, object. These are generated for every
2630 @rinternals{Voice} context. The @code{StaffSpacing} object
2631 (generated in @rinternals{Staff} context) contains the same
2632 property for controlling the stem/bar line spacing. The following
2633 example shows these corrections, once with default settings, and
2634 once with exaggerated corrections:
2636 @lilypond[quote,ragged-right]
2640 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2641 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2647 Proportional notation is supported; see @ref{Proportional notation}.
2654 Internals Reference:
2655 @rinternals{SpacingSpanner},
2656 @rinternals{NoteSpacing},
2657 @rinternals{StaffSpacing},
2658 @rinternals{NonMusicalPaperColumn}.
2660 Essay on automated music engraving:
2661 @ressay{Optical spacing}.
2666 There is no convenient mechanism to manually override spacing. The
2667 following work-around may be used to insert extra space into a score,
2668 adjusting the padding value as necessary.
2670 \override Score.NonMusicalPaperColumn #'padding = #10
2673 No work-around exists for decreasing the amount of space.
2676 @node New spacing area
2677 @subsection New spacing area
2679 New sections with different spacing parameters can be started with
2680 @code{newSpacingSection}. This is useful when there are
2681 sections with a different notions of long and short notes.
2683 In the following example, the time signature change introduces a new
2684 section, and hence the 16ths notes are spaced wider.
2686 @lilypond[relative=1,verbatim,quote]
2689 c8 c c4 c16[ c c8] c4
2695 The @code{\newSpacingSection} command creates a new
2696 @code{SpacingSpanner} object, and hence new @code{\override}s
2697 may be used in that location.
2704 Internals Reference:
2705 @rinternals{SpacingSpanner}.
2708 @node Changing horizontal spacing
2709 @subsection Changing horizontal spacing
2711 Horizontal spacing may be altered with the
2712 @code{base-shortest-duration} property. Here
2713 we compare the same music; once without altering
2714 the property, and then altered. Larger values
2715 of @code{ly:make-moment} will produce smaller
2716 music. Note that @code{ly:make-moment} constructs
2717 a duration, so @code{1 4} is a longer duration
2720 @lilypond[verbatim,line-width=12\cm]
2723 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2724 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2725 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2726 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2731 @lilypond[verbatim,line-width=12\cm]
2734 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2735 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2736 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2737 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2742 \override SpacingSpanner
2743 #'base-shortest-duration = #(ly:make-moment 1 16)
2752 By default, spacing in tuplets depends on various non-duration
2753 factors (such as accidentals, clef changes, etc). To disregard
2754 such symbols and force uniform equal-duration spacing, use
2755 @code{Score.SpacingSpanner #'uniform-stretching}. This
2756 property can only be changed at the beginning of a score,
2758 @lilypond[quote,ragged-right,verbatim]
2777 \override SpacingSpanner #'uniform-stretching = ##t
2783 When @code{strict-note-spacing} is set, notes are spaced without
2784 regard for clefs, bar lines, and grace notes,
2786 @lilypond[quote,ragged-right,relative=2,verbatim]
2787 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2788 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2798 @subsection Line length
2801 @cindex breaking pages
2804 @funindex line-width
2805 @funindex ragged-right
2806 @funindex ragged-last
2808 @c Although line-width can be set in \layout, it should be set in paper
2809 @c block, to get page layout right.
2810 @c Setting indent in \paper block makes not much sense, but it works.
2812 @c Bit verbose and vague, use examples?
2813 The most basic settings influencing the spacing are @code{indent} and
2814 @code{line-width}. They are set in the @code{\layout} block. They
2815 control the indentation of the first line of music, and the lengths of
2818 If @code{ragged-right} is set to true in the @code{\layout} block, then
2819 systems ends at their natural horizontal length, instead of being spread
2820 horizontally to fill the whole line. This is useful for
2821 short fragments, and for checking how tight the natural spacing is.
2822 The normal default setting is false, but if the score has only one
2823 system the default value is true.
2826 @cindex vertical spacing
2828 The option @code{ragged-last} is similar to @code{ragged-right}, but
2829 only affects the last line of the piece. No restrictions are put on
2830 that line. The result is similar to formatting text paragraphs. In a
2831 paragraph, the last line simply takes its natural horizontal length.
2832 @c Note that for text there are several options for the last line.
2833 @c While Knuth TeX uses natural length, lead typesetters use the same
2834 @c stretch as the previous line. eTeX uses \lastlinefit to
2835 @c interpolate between both these solutions.
2851 @node Proportional notation
2852 @subsection Proportional notation
2854 LilyPond supports proportional notation, a type of horizontal spacing
2855 in which each note consumes an amount of horizontal space exactly
2856 equivalent to its rhythmic duration. This type of proportional spacing
2857 is comparable to horizontal spacing on top of graph paper. Some late
2858 20th- and early 21st-century scores use proportional notation to
2859 clarify complex rhythmic relationships or to facilitate the placement
2860 of timelines or other graphics directly in the score.
2862 LilyPond supports five different settings for proportional notation,
2863 which may be used together or alone:
2866 @item @code{proportionalNotationDuration}
2867 @item @code{uniform-stretching}
2868 @item @code{strict-note-spacing}
2869 @item @code{\remove Separating_line_group_engraver}
2870 @item @code{\override PaperColumn #'used = ##t}
2873 In the examples that follow, we explore these five different
2874 proportional notation settings and examine how these settings interact.
2876 We start with the following one-measure example, which uses classical
2877 spacing with ragged-right turned on.
2879 @lilypond[quote,verbatim,ragged-right]
2882 \new RhythmicStaff {
2886 c'16 c'16 c'16 c'16 c'16
2893 Notice that the half note which begins the measure takes up far less
2894 than half of the horizontal space of the measure. Likewise, the
2895 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
2896 which end the measure together take up far more than half the
2897 horizontal space of the measure.
2899 In classical engraving, this spacing may be exactly what we want
2900 because we can borrow horizontal space from the half note and conserve
2901 horizontal space across the measure as a whole.
2903 On the other hand, if we want to insert a measured timeline or other
2904 graphic above or below our score, we need proportional notation. We
2905 turn proportional notation on with the proportionalNotationDuration
2908 @lilypond[quote,verbatim,ragged-right]
2911 \new RhythmicStaff {
2915 c'16 c'16 c'16 c'16 c'16
2922 proportionalNotationDuration = #(ly:make-moment 1 20)
2928 The half note at the beginning of the measure and the faster notes in
2929 the second half of the measure now occupy equal amounts of horizontal
2930 space. We could place a measured timeline or graphic above or below
2933 The @code{proportionalNotationDuration} setting is a context setting
2934 that lives in @code{Score}. Remember that context settings can appear
2935 in one of three locations within our input file -- in a @code{\with}
2936 block, in a @code{\context} block, or directly in music entry preceded
2937 by the @code{\set} command. As with all context settings, users can
2938 pick which of the three different locations they would like to
2939 set @code{proportionalNotationDuration} in to.
2941 The @code{proportionalNotationDuration} setting takes a single argument,
2942 which is the reference duration against that all music will be spaced.
2943 The LilyPond Scheme function @code{make-moment} takes two arguments
2944 -- a numerator and denominator which together express some fraction of
2945 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces
2946 a reference duration of a twentieth note. Values such as
2947 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
2948 @code{#(ly:make-moment 3 97)} are all possible as well.
2950 How do we select the right reference duration to pass to
2951 @code{proportionalNotationDuration}? Usually by a process of trial
2952 and error, beginning with a duration close to the fastest (or smallest)
2953 duration in the piece. Smaller reference durations space music loosely;
2954 larger reference durations space music tightly.
2956 @lilypond[quote,verbatim,ragged-right]
2959 \new RhythmicStaff {
2963 c'16 c'16 c'16 c'16 c'16
2970 proportionalNotationDuration = #(ly:make-moment 1 8)
2977 \new RhythmicStaff {
2981 c'16 c'16 c'16 c'16 c'16
2988 proportionalNotationDuration = #(ly:make-moment 1 16)
2995 \new RhythmicStaff {
2999 c'16 c'16 c'16 c'16 c'16
3006 proportionalNotationDuration = #(ly:make-moment 1 32)
3012 Note that too large a reference duration -- such as the eighth note,
3013 above -- spaces music too tightly and can cause note head collisions.
3014 Also that proportional notation in general takes up more horizontal
3015 space than classical spacing. Proportional spacing provides rhythmic
3016 clarity at the expense of horizontal space.
3018 Next we examine how to optimally space overlapping tuplets.
3020 We start by examining what happens to our original example, with
3021 classical spacing, when we add a second staff with a different type of
3024 @lilypond[quote,verbatim,ragged-right]
3027 \new RhythmicStaff {
3031 c'16 c'16 c'16 c'16 c'16
3034 \new RhythmicStaff {
3036 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3043 The spacing is bad because the evenly spaced notes of the bottom staff
3044 do not stretch uniformly. Classical engravings include very few complex
3045 triplets and so classical engraving rules can generate this type of
3046 result. Setting @code{proportionalNotationDuration} fixes this.
3048 @lilypond[quote,verbatim,ragged-right]
3051 \new RhythmicStaff {
3055 c'16 c'16 c'16 c'16 c'16
3058 \new RhythmicStaff {
3060 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3067 proportionalNotationDuration = #(ly:make-moment 1 20)
3073 But if we look very carefully we can see that notes of the second half
3074 of the 9-tuplet space ever so slightly more widely than the notes
3075 of the first half of the 9-tuplet. To ensure uniform stretching, we
3076 turn on @code{uniform-stretching}, which is a property of
3077 @code{SpacingSpanner}.
3079 @lilypond[quote,verbatim,ragged-right]
3082 \new RhythmicStaff {
3086 c'16 c'16 c'16 c'16 c'16
3089 \new RhythmicStaff {
3091 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3098 proportionalNotationDuration = #(ly:make-moment 1 20)
3099 \override SpacingSpanner #'uniform-stretching = ##t
3105 Our two-staff example now spaces exactly, our rhythmic
3106 relationships are visually clear, and we can include a measured
3107 timeline or graphic if we want.
3109 Note that the LilyPond's proportional notation package expects
3110 that all proportional scores set the SpacingSpanner's
3111 'uniform-stretching attribute to ##t. Setting
3112 proportionalNotationDuration without also setting the
3113 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3114 example, cause Skips to consume an incorrect amount of horizontal
3117 The SpacingSpanner is an abstract grob that lives in the Score
3118 context. As with our settings of proportionalNotationDuration,
3119 overrides to the SpacingSpanner can occur in any of three
3120 different places in our input file – in the Score \with block, in
3121 a Score \context block, or in note entry directly.
3123 There is by default only one @code{SpacingSpanner} per @code{Score}. This
3124 means that, by default, @code{uniform-stretching} is either turned on for the
3125 entire score or turned off for the entire score. We can, however,
3126 override this behavior and turn on different spacing features at
3127 different places in the score. We do this with the command
3128 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
3130 Next we examine the effects of the @code{Separating_line_group_engraver} and
3131 see why proportional scores frequently remove this engraver. The following
3132 example shows that there is a small amount of @qq{prefatory} space
3133 just before the first note in each system.
3135 @lilypond[quote,verbatim,ragged-right]
3148 The amount of this prefatory space is the same whether after a time
3149 signature, a key signature or a clef. @code{Separating_line_group_engraver}
3150 is responsible for this space. Removing @code{Separating_line_group_engraver}
3151 reduces this space to zero.
3153 @lilypond[quote,verbatim,ragged-right]
3159 \remove Separating_line_group_engraver
3167 non-musical elements like time signatures, key signatures, clefs and
3168 accidentals are problematic in proportional notation. None of these
3169 elements has rhythmic duration. But all of these elements consume
3170 horizontal space. Different proportional scores approach these
3171 problems differently.
3173 It may be possible to avoid spacing problems with key signatures
3174 simply by not having any. This is a valid option since most
3175 proportional scores are contemporary music. The same may be true
3176 of time signatures, especially for those scores
3177 that include a measured timeline or other graphic. But these scores
3178 are exceptional and most proportional scores include at least some
3179 time signatures. Clefs and accidentals are even more essential.
3181 So what strategies exist for spacing non-musical elements in a
3182 proportional context? One good option is the @code{strict-note-spacing}
3183 property of @code{SpacingSpanner}. Compare the two scores below:
3185 @lilypond[quote,verbatim,ragged-right]
3187 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3197 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3198 \override Score.SpacingSpanner #'strict-note-spacing = ##t
3208 Both scores are proportional, but the spacing in the first score
3209 is too loose because of the clef change. The spacing of the second
3210 score remains strict, however, because strict-note-spacing is
3211 turned on. Turning on strict-note-spacing causes the width of
3212 time signatures, key signatures, clefs and accidentals to play no
3213 part in the spacing algorithm.
3215 In addition to the settings given here, there are other settings
3216 that frequently appear in proportional scores. These include:
3219 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
3220 @item @code{tupletFullLength = ##t}
3221 @item @code{\override Beam #'breakable = ##t}
3222 @item @code{\override Glissando #'breakable = ##t}
3223 @item @code{\override TextSpanner #'breakable = ##t}
3224 @item @code{\remove Forbid_line_break_engraver in the Voice context}
3227 These settings space grace notes strictly, extend tuplet brackets to
3228 mark both rhythmic start- and stop-points, and allow spanning elements
3229 to break across systems and pages. See the respective parts of the manual
3230 for these related settings.
3235 @ref{New spacing area}.
3241 @node Fitting music onto fewer pages
3242 @section Fitting music onto fewer pages
3244 Sometimes you can end up with one or two staves on a second
3245 (or third, or fourth...) page. This is annoying, especially
3246 if you look at previous pages and it looks like there is plenty
3247 of room left on those.
3249 When investigating layout issues, @code{annotate-spacing} is an
3250 invaluable tool. This command prints the values of various layout
3251 spacing variables; for more details see the following section,
3252 @ref{Displaying spacing}.
3255 * Displaying spacing::
3256 * Changing spacing::
3260 @node Displaying spacing
3261 @subsection Displaying spacing
3263 @funindex annotate-spacing
3264 @cindex spacing, display of layout
3266 To graphically display the dimensions of vertical layout variables
3267 that may be altered for page formatting, set
3268 @code{annotate-spacing} in the @code{\paper} block:
3270 @c need to have \book{} otherwise we get the separate systems. -hwn
3271 @lilypond[verbatim,quote]
3272 #(set-default-paper-size "a6" 'landscape)
3275 \paper { annotate-spacing = ##t }
3281 All layout dimensions are displayed in staff-spaces, regardless
3282 of the units specified in the @code{\paper} or @code{\layout} block.
3283 In the above example, @code{paper-height} has a value of 59.75
3284 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3285 default value). Note that:
3287 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3290 @tab = (25.4/72.27) mm
3293 @tab = (@code{staff-size})/4 pts
3295 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3300 In this case, one @code{staff-space} is approximately equal to
3301 1.757mm. Thus the @code{paper-height} measurement of 59.75
3302 @code{staff-spaces} is equivalent to 105 millimeters, the height
3303 of @code{a6} paper in landscape orientation. The pairs
3304 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3305 edge and @var{b} the upper edge of the interval.
3310 @ref{Setting the staff size}.
3316 @node Changing spacing
3317 @subsection Changing spacing
3319 The output of @code{annotate-spacing} reveals vertical dimensions
3320 in great detail. For details about modifying margins and other
3321 layout variables, see @ref{Page layout}.
3323 Other than margins, there are a few other options to save space:
3327 Force systems to move as close together as possible (to fit as
3328 many systems as possible onto a page) while being spaced so that
3329 there is no blank space at the bottom of the page.
3333 system-system-spacing = #'((basic-distance . 0.1) (padding . 0))
3334 ragged-last-bottom = ##f
3340 Force the number of systems. This can help in two ways. Just
3341 setting a value, even the same value as the number of systems
3342 being typeset by default, will sometimes cause more systems to
3343 be fitted onto each page, as an estimation step is then bypassed,
3344 giving a more accurate fit to each page. Also, forcing an actual
3345 reduction in the number of systems may save a further page. For
3346 example, if the default layout has 11 systems, the following
3347 assignment will force a layout with 10 systems.
3356 Avoid (or reduce) objects that increase the vertical size of a
3357 system. For example, volta repeats (or alternate repeats) require
3358 extra space. If these repeats are spread over two systems, they
3359 will take up more space than one system with the volta repeats and
3360 another system without. For example, dynamics that @q{stick out} of
3361 a system can be moved closer to the staff:
3363 @lilypond[verbatim,quote,relative=1]
3365 e4 c g-\tweak #'X-offset #-2.7 -\tweak #'Y-offset #2.5 \f c
3369 Alter the horizontal spacing via @code{SpacingSpanner}. For more
3370 details, see @ref{Changing horizontal spacing}. The following
3371 example illustrates the default spacing:
3373 @lilypond[verbatim,quote]
3386 The next example modifies @code{common-shortest-duration} from a
3387 value of @code{1/4} to @code{1/2}. The quarter note is the most
3388 common and shortest duration in this example, so by making this
3389 duration longer, a @q{squeezing} effect occurs:
3391 @lilypond[verbatim,quote]
3403 \override SpacingSpanner
3404 #'common-shortest-duration = #(ly:make-moment 1 2)
3411 The @code{common-shortest-duration} property cannot be modified
3412 dynamically, so it must always be placed in a @code{\context}
3413 block so that it applies to the whole score.
3421 @ref{Changing horizontal spacing}.