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{padding} -- the minimum required amount of unobstructed
407 vertical whitespace between two items, measured in staff-spaces.
408 This can be thought of as the minimum height of an unobstructed
409 (invisible) rectangle that extends from the leftmost to the
410 rightmost point of the combined items.
413 @code{space} -- the vertical distance, measured in staff-spaces,
414 between the @emph{reference points} of the two items, when no
415 collisions would result, and no stretching or compressing is in
416 effect. The reference point of a (title or top-level) markup is
417 its highest point, and the reference point of a system is the
418 vertical center of the nearest @code{StaffSymbol} -- even if a
419 non-staff line (such as a @code{Lyrics} context) is in the way.
420 Values for @code{space} that are less than either @code{padding}
421 or @code{minimum-distance} are not meaningful, since the resulting
422 distance will never be less than either @code{padding} or
423 @code{minimum-distance}.
426 @code{minimum-distance} -- the smallest allowable vertical
427 distance, measured in staff-spaces, between the reference points
428 of the two items, when compressing is in effect. Values for
429 @code{minimum-distance} that are less than @code{padding} are not
430 meaningful, since the resulting distance will never be less than
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 @code{space}. Note
445 that the dimension's propensity to @emph{compress} cannot be
446 directly set by the user and is equal to
447 (@code{space}@tie{}@minus{}@tie{}@code{minimum-distance}).
451 If a page has a ragged bottom, the resulting distance is the
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 #'space = #8
477 score-system-spacing =
480 (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 @node Miscellaneous \paper variables
930 @unnumberedsubsubsec Miscellaneous @code{\paper} variables
934 @item page-spacing-weight
935 @funindex page-spacing-weight
937 The relative importance of page (vertical) spacing and line
938 (horizontal) spacing. High values will make page spacing more
939 important. Default: @code{#10}.
941 @item print-all-headers
942 @funindex print-all-headers
944 If set to true, this will print all headers for each @code{\score}
945 in the output. Normally only the @code{piece} and @code{opus}
946 header variables are printed. Default: @code{#f}.
948 @item system-separator-markup
949 @funindex system-separator-markup
951 A markup object that is inserted between systems, often used for
952 orchestral scores. Default: unset. The @code{\slashSeparator}
953 markup, defined in @file{ly/titling-init.ly}, is provided as a
954 sensible default, for example:
956 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
957 #(set-default-paper-size "a8")
961 system-separator-markup = \slashSeparator
967 \relative c'' { c1 \break c1 \break c1 }
977 @file{ly/titling-init.ly}.
985 The default page header puts the page number and the @code{instrument}
986 field from the @code{\header} block on a line.
990 @section Score layout
992 This section discusses score layout options for the @code{\layout}
996 * The \layout block::
997 * Setting the staff size::
1001 @node The \layout block
1002 @subsection The @code{\layout} block
1006 While the @code{\paper} block contains settings that relate to the
1007 page formatting of the whole document, the @code{\layout} block
1008 contains settings for score-specific layout. To set score layout
1009 options globally, enter them in a toplevel @code{\layout} block.
1010 To set layout options for an individual score, enter them in a
1011 @code{\layout} block inside the @code{\score} block, after the
1012 music. Settings that can appear in a @code{\layout} block
1016 @item the @code{layout-set-staff-size} scheme function,
1017 @item context modifications in @code{\context} blocks, and
1018 @item @code{\paper} variables that affect score layout.
1021 The @code{layout-set-staff-size} function is discussed in the next
1022 section, @ref{Setting the staff size}. Context modifications are
1023 discussed in a separate chapter; see
1024 @ref{Modifying context plug-ins} and
1025 @ref{Changing context default settings}. The @code{\paper}
1026 variables that can appear in a @code{\layout} block are:
1031 @code{line-width}, @code{ragged-right} and @code{ragged-last}
1032 (see @ref{\paper variables for widths and margins})
1035 @code{indent} and @code{short-indent}
1036 (see @ref{\paper variables for shifts and indents})
1040 (see @ref{\paper variables for line breaking})
1044 Here is an example @code{\layout} block:
1051 \override StaffGrouper #'staff-staff-spacing #space = #8
1055 \override TextScript #'padding = #1
1056 \override Glissando #'thickness = #3
1064 @ref{Changing context default settings}.
1070 @node Setting the staff size
1071 @subsection Setting the staff size
1073 @cindex font size, setting
1074 @cindex staff size, setting
1075 @funindex layout file
1077 The default @strong{staff size} is set to 20 points.
1078 This may be changed in two ways:
1080 To set the staff size globally for all scores in a file (or
1081 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
1084 #(set-global-staff-size 14)
1088 This sets the global default size to 14pt staff height and scales all
1091 To set the staff size individually for each score, use
1096 #(layout-set-staff-size 15)
1101 The Feta font provides musical symbols at eight different
1102 sizes. Each font is tuned for a different staff size: at a smaller size
1103 the font becomes heavier, to match the relatively heavier staff lines.
1104 The recommended font sizes are listed in the following table:
1107 @multitable @columnfractions .15 .2 .22 .2
1110 @tab @b{staff height (pt)}
1111 @tab @b{staff height (mm)}
1153 @c modern rental material?
1158 These fonts are available in any sizes. The context property
1159 @code{fontSize} and the layout property @code{staff-space} (in
1160 @rinternals{StaffSymbol}) can be used to tune the size for individual
1161 staves. The sizes of individual staves are relative to the global size.
1166 @ref{Selecting notation font size}.
1174 @code{layout-set-staff-size} does not change the distance between the
1184 * Optimal page breaking::
1185 * Optimal page turning::
1186 * Minimal page breaking::
1188 * Using an extra voice for breaks::
1193 @subsection Line breaking
1196 @cindex breaking lines
1198 Line breaks are normally determined automatically. They are chosen
1199 so that lines look neither cramped nor loose, and consecutive
1200 lines have similar density.
1202 To manually force a line break at a bar line, use the
1203 @code{\break} command:
1205 @lilypond[quote,ragged-right,relative=2,verbatim]
1210 By default, a @code{\break} in the middle of a measure is ignored,
1211 and a warning is printed. To force a line break in the middle of
1212 a measure, add an invisible bar line with @w{@samp{\bar ""}}:
1214 @lilypond[quote,ragged-right,relative=2,verbatim]
1221 A @code{\break} occuring at a bar line is also ignored if the
1222 previous measure ends in the middle of a note, such as when a
1223 tuplet begins and ends in different measures. To allow
1224 @code{\break} commands to work in these situations, remove the
1225 @code{Forbid_line_break_engraver} from the @code{Voice} context.
1226 Note that manually forced line breaks have to be added in parallel
1229 @lilypond[quote,ragged-right,verbatim]
1231 \remove Forbid_line_break_engraver
1234 { c2. \times 2/3 { c4 c c } c2. | }
1235 { s1 | \break s1 | }
1240 Similarly, line breaks are normally forbidden when beams cross bar
1241 lines. This behavior can be changed by setting
1242 @code{\override Beam #'breakable = ##t}:
1244 @lilypond[quote,ragged-right,relative=2,verbatim]
1245 \override Beam #'breakable = ##t
1250 The @code{\noBreak} command forbids a line break at the bar line
1251 where it is inserted.
1253 The most basic settings influencing line spacing are @code{indent}
1254 and @code{line-width}. They are set in the @code{\layout} block.
1255 They control the indentation of the first line of music, and the
1256 lengths of the lines.
1258 If @code{ragged-right} is set to true in the @code{\layout} block,
1259 then systems end at their natural horizontal length, instead of
1260 being spread horizontally to fill the whole line. This is useful
1261 for short fragments, and for checking how tight the natural
1264 @c TODO Check and add para on default for ragged-right
1266 The option @code{ragged-last} is similar to @code{ragged-right},
1267 but affects only the last line of the piece.
1279 @cindex regular line breaks
1280 @cindex four bar music.
1282 For line breaks at regular intervals use @code{\break} separated by
1283 skips and repeated with @code{\repeat}. For example, this would
1284 cause the following 28 measures (assuming 4/4 time) to be broken
1285 every 4 measures, and only there:
1290 s1 \noBreak s1 \noBreak
1291 s1 \noBreak s1 \break
1293 @{ @var{the actual music@dots{}} @}
1298 A linebreaking configuration can be saved as a @file{.ly} file
1299 automatically. This allows vertical alignments to be stretched to
1300 fit pages in a second formatting run. This is fairly new and
1301 complicated. More details are available in
1315 @ref{\paper variables for line breaking}.
1320 Internals Reference:
1321 @rinternals{LineBreakEvent}.
1325 @subsection Page breaking
1327 The default page breaking may be overridden by inserting
1328 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1329 analogous to @code{\break} and @code{\noBreak}. They should be
1330 inserted at a bar line. These commands force and forbid a page-break
1331 from happening. Of course, the @code{\pageBreak} command also forces
1334 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1335 inserted at top-level, between scores and top-level markups.
1337 There are also analogous settings to @code{ragged-right} and
1338 @code{ragged-last} which have the same effect on vertical spacing:
1339 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1340 @code{##t} the systems on all pages or just the last page
1341 respectively will not be justified vertically. See
1342 @ref{Fixed vertical spacing \paper variables}.
1344 Page breaks are computed by the @code{page-breaking} function. LilyPond
1345 provides three algorithms for computing page breaks,
1346 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1347 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1348 but the value can be changed in the @code{\paper} block:
1352 page-breaking = #ly:page-turn-breaking
1358 When a book has many scores and pages, the page breaking problem may be
1359 difficult to solve, requiring large processing time and memory. To ease
1360 the page breaking process, @code{\bookpart} blocks are used to divide
1361 the book into several parts: the page breaking occurs separately on each
1362 part. Different page breaking functions may also be used in different
1368 subtitle = "Preface"
1371 %% In a part consisting mostly of text,
1372 %% ly:minimal-breaking may be preferred
1373 page-breaking = #ly:minimal-breaking
1375 \markup @{ @dots{} @}
1379 %% In this part, consisting of music, the default optimal
1380 %% page breaking function is used.
1382 subtitle = "First movement"
1384 \score @{ @dots{} @}
1391 @funindex \pageBreak
1393 @funindex \noPageBreak
1394 @code{\noPageBreak}.
1400 @ref{\paper variables for page breaking}.
1406 @node Optimal page breaking
1407 @subsection Optimal page breaking
1409 @funindex ly:optimal-breaking
1411 The @code{ly:optimal-breaking} function is LilyPond's default method of
1412 determining page breaks. It attempts to find a page breaking that minimizes
1413 cramping and stretching, both horizontally and vertically. Unlike
1414 @code{ly:page-turn-breaking}, it has no concept of page turns.
1422 @node Optimal page turning
1423 @subsection Optimal page turning
1425 @funindex ly:page-turn-breaking
1427 Often it is necessary to find a page breaking configuration so that there is
1428 a rest at the end of every second page. This way, the musician can turn the
1429 page without having to miss notes. The @code{ly:page-turn-breaking} function
1430 attempts to find a page breaking minimizing cramping and stretching, but with
1431 the additional restriction that it is only allowed to introduce page turns
1432 in specified places.
1434 There are two steps to using this page breaking function. First, you
1435 must enable it in the @code{\paper} block, as explained in @ref{Page
1436 breaking}. Then you must tell the function where you would like to allow
1439 There are two ways to achieve the second step. First, you can specify each
1440 potential page turn manually, by inserting @code{\allowPageTurn} into your
1441 input file at the appropriate places.
1443 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1444 Voice context. The @code{Page_turn_engraver} will scan the context for
1445 sections without notes (note that it does not scan for rests; it scans for
1446 the absence of notes. This is so that single-staff polyphony with rests in one
1447 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1448 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1449 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1450 there is a @q{special} bar line (such as a double bar), in which case the
1451 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1454 @funindex minimumPageTurnLength
1455 The @code{Page_turn_engraver} reads the context property
1456 @code{minimumPageTurnLength} to determine how long a note-free section must
1457 be before a page turn is considered. The default value for
1458 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
1459 to disable page turns, you can set it to something very large.
1462 \new Staff \with @{ \consists "Page_turn_engraver" @}
1465 R1 | % a page turn will be allowed here
1467 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1468 R1 | % a page turn will not be allowed here
1470 R1*2 | % a page turn will be allowed here
1475 @funindex minimumRepeatLengthForPageTurn
1476 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1477 turn during the repeat if there is enough time at the beginning and end of the
1478 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1479 page turns if the repeat is very short. If you set the context property
1480 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1481 only allow turns in repeats whose duration is longer than this value.
1483 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1484 @code{\allowPageTurn}, may also be used at top-level, between scores and
1491 @funindex \noPageTurn
1493 @funindex \allowPageTurn
1494 @code{\allowPageTurn}.
1505 There should only be one @code{Page_turn_engraver} in a score. If there is more
1506 than one, they will interfere with each other.
1509 @node Minimal page breaking
1510 @subsection Minimal page breaking
1512 @funindex ly:minimal-breaking
1514 The @code{ly:minimal-breaking} function performs minimal computations to
1515 calculate the page breaking: it fills a page with as many systems as
1516 possible before moving to the next one. Thus, it may be preferred for
1517 scores with many pages, where the other page breaking functions could be
1518 too slow or memory demanding, or a lot of texts. It is enabled using:
1522 page-breaking = #ly:minimal-breaking
1532 @node Explicit breaks
1533 @subsection Explicit breaks
1535 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1536 commands. There are two commands to override this behavior:
1539 \override NonMusicalPaperColumn #'line-break-permission = ##f
1540 \override NonMusicalPaperColumn #'page-break-permission = ##f
1543 When @code{line-break-permission} is overridden to false, Lily will insert
1544 line breaks at explicit @code{\break} commands and nowhere else. When
1545 @code{page-break-permission} is overridden to false, Lily will insert
1546 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1548 @lilypond[quote,verbatim]
1555 music = \relative c'' { c8 c c c }
1559 \repeat unfold 2 { \music } \break
1560 \repeat unfold 4 { \music } \break
1561 \repeat unfold 6 { \music } \break
1562 \repeat unfold 8 { \music } \pageBreak
1563 \repeat unfold 8 { \music } \break
1564 \repeat unfold 6 { \music } \break
1565 \repeat unfold 4 { \music } \break
1566 \repeat unfold 2 { \music }
1571 \override NonMusicalPaperColumn #'line-break-permission = ##f
1572 \override NonMusicalPaperColumn #'page-break-permission = ##f
1584 @node Using an extra voice for breaks
1585 @subsection Using an extra voice for breaks
1587 Line- and page-breaking information usually appears within note entry directly.
1590 music = \relative c'' @{ c4 c c c @}
1594 \repeat unfold 2 @{ \music @} \break
1595 \repeat unfold 3 @{ \music @}
1600 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1601 music entry with information that specifies how music should lay out
1602 on the page. You can keep music entry and line- and page-breaking
1603 information in two separate places by introducing an extra voice to
1604 contain the breaks. This extra voice
1605 contains only skips together with @code{\break}, @code{pageBreak} and other
1606 breaking layout information.
1608 @lilypond[quote,verbatim]
1609 music = \relative c'' { c4 c c c }
1620 \repeat unfold 2 { \music }
1621 \repeat unfold 3 { \music }
1622 \repeat unfold 6 { \music }
1623 \repeat unfold 5 { \music }
1629 This pattern becomes especially helpful when overriding
1630 @code{line-break-system-details} and the other useful but long properties of
1631 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1633 @lilypond[quote,verbatim]
1634 music = \relative c'' { c4 c c c }
1639 \overrideProperty "Score.NonMusicalPaperColumn"
1640 #'line-break-system-details #'((Y-offset . 0))
1643 \overrideProperty "Score.NonMusicalPaperColumn"
1644 #'line-break-system-details #'((Y-offset . 35))
1647 \overrideProperty "Score.NonMusicalPaperColumn"
1648 #'line-break-system-details #'((Y-offset . 70))
1651 \overrideProperty "Score.NonMusicalPaperColumn"
1652 #'line-break-system-details #'((Y-offset . 105))
1656 \repeat unfold 2 { \music }
1657 \repeat unfold 3 { \music }
1658 \repeat unfold 6 { \music }
1659 \repeat unfold 5 { \music }
1668 @ref{Vertical spacing}.
1674 @node Vertical spacing
1675 @section Vertical spacing
1677 @cindex vertical spacing
1678 @cindex spacing, vertical
1680 Vertical spacing is controlled by three things: the amount of
1681 space available (i.e., paper size and margins), the amount of
1682 space between systems, and the amount of space between
1683 staves inside a system.
1686 * Flexible vertical spacing within systems::
1687 * Explicit staff and system positioning::
1688 * Vertical collision avoidance::
1692 @node Flexible vertical spacing within systems
1693 @subsection Flexible vertical spacing within systems
1695 @cindex distance between staves
1696 @cindex staff distance
1697 @cindex space between staves
1698 @cindex space inside systems
1700 Three separate mechanisms control the flexible vertical spacing
1701 within systems, one for each of the following categories:
1706 @emph{ungrouped staves},
1709 @emph{grouped staves} (staves within a staff-group such as
1710 @code{ChoirStaff}, etc.), and
1713 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1718 @c TODO: Clarify this. This almost implies that non-staff lines
1719 @c have NO effect on the spacing between staves. -mp
1721 The height of each system is determined in two steps. First, all
1722 of the staves are spaced according to the amount of space
1723 available. Then, the non-staff lines are distributed between the
1726 Note that the spacing mechanisms discussed in this section only
1727 control the vertical spacing of staves and non-staff lines within
1728 individual systems. The vertical spacing between separate
1729 systems, scores, markups, and margins is controlled by
1730 @code{\paper} variables, which are discussed in
1731 @ref{Flexible vertical spacing \paper variables}.
1734 * Within-system spacing properties::
1735 * Spacing of ungrouped staves::
1736 * Spacing of grouped staves::
1737 * Spacing of non-staff lines::
1741 @node Within-system spacing properties
1742 @unnumberedsubsubsec Within-system spacing properties
1744 The within-system vertical spacing mechanisms are controlled by
1745 two sets of grob properties. The first set is associated with the
1746 @code{VerticalAxisGroup} grob, which is created by all staves and
1747 non-staff lines. The second set is associated with the
1748 @code{StaffGrouper} grob, which can be created by staff-groups,
1749 but only if explicitly called. These properties are described
1750 individually at the end of this section.
1752 The names of these properties (except for @code{staff-affinity})
1753 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1754 @code{@var{item1}} and @code{@var{item2}} are the items to be
1755 spaced. Note that @code{@var{item2}} is not necessarily below
1756 @code{@var{item1}}; for example,
1757 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1758 non-staff line if @code{staff-affinity} is @code{#UP}.
1760 Each distance is measured between the @emph{reference points} of
1761 the two items. The reference point for a staff is the vertical
1762 center of its @code{StaffSymbol} (i.e. the middle line if
1763 @code{line-count} is odd; the middle space if @code{line-count} is
1764 even). The reference points for individual non-staff lines are
1765 given in the following table:
1767 @multitable {Non-staff line} {Reference point}
1768 @headitem Non-staff line @tab Reference point
1769 @item @code{ChordNames} @tab baseline
1770 @item @code{NoteNames} @tab baseline
1771 @item @code{Lyrics} @tab baseline
1772 @item @code{Dynamics} @tab vertical center
1773 @item @code{FiguredBass} @tab highest point
1774 @item @code{FretBoards} @tab top line
1777 In the following image, horizontal lines indicate the positions
1778 of these reference points:
1780 @lilypond[quote,noragged-right,line-width=110\mm]
1781 #(define zero-space '((padding . -inf.0) (space . 0)))
1783 alignToZero = \with {
1784 \override VerticalAxisGroup #'nonstaff-relatedstaff-spacing = #zero-space
1785 \override VerticalAxisGroup #'nonstaff-nonstaff-spacing = #zero-space
1787 lowerCaseChords = \with {
1788 chordNameLowercaseMinor = ##t
1790 staffAffinityDown = \with {
1791 \override VerticalAxisGroup #'staff-affinity = #DOWN
1794 #(define-music-function
1795 (parser location context)
1797 #{ s1*0^\markup { \typewriter $context } #})
1800 \context { \Dynamics \alignToZero }
1801 \context { \FiguredBass \alignToZero }
1802 \context { \Lyrics \alignToZero }
1803 \context { \NoteNames \alignToZero }
1804 \context { \ChordNames \alignToZero \lowerCaseChords }
1805 \context { \FretBoards \alignToZero \staffAffinityDown }
1807 \override BarLine #'stencil = ##f
1808 \override DynamicText #'self-alignment-X = #-1
1809 \override FretBoard #'X-offset = #1.75
1810 \override InstrumentName #'minimum-Y-extent = #'(-2 . 2)
1811 \override InstrumentName #'extra-offset = #'(0 . -0.5)
1812 \override TextScript #'minimum-Y-extent = #'(-2 . 3)
1813 \override TimeSignature #'stencil = ##f
1817 %% These contexts have reference points at the baseline:
1818 %% ChordNames, NoteNames, and Lyrics
1820 \new ChordNames { \chords { g1:m } }
1821 \new NoteNames { s1 | g1 | }
1822 \new RhythmicStaff {
1823 \set RhythmicStaff.instrumentName = #"baseline "
1825 \labelContext "ChordNames" s1 |
1826 \labelContext "NoteNames" s1 |
1827 \labelContext "Lyrics" s1 |
1829 \new Lyrics { \lyrics { \skip 1*2 | ghijk1 | } }
1832 %% The reference point for Dynamics is its vertical center
1834 \new RhythmicStaff {
1835 \set RhythmicStaff.instrumentName = #"vertical center "
1836 \labelContext "Dynamics" s1*3
1838 \new Dynamics { s2\mp s\fp }
1841 %% The reference point for FiguredBass is its highest point
1843 \new RhythmicStaff {
1844 \set RhythmicStaff.instrumentName = #"highest point "
1845 \labelContext "FiguredBass" s1
1847 \new FiguredBass { \figuremode { <6 5>1 } }
1850 %% The reference point for FretBoards is the top line
1851 \include "predefined-guitar-fretboards.ly"
1853 \new FretBoards { \chordmode { e1 } }
1854 \new RhythmicStaff {
1855 \set RhythmicStaff.instrumentName = #"top line "
1856 \labelContext "FretBoards " s1
1861 Each of the vertical spacing grob properties (except
1862 @code{staff-affinity}) is stored as an alist (association list),
1863 and each uses the same alist structure as the @code{\paper}
1864 spacing variables discussed in
1865 @ref{Flexible vertical spacing \paper variables}. Specific methods
1866 for modifying alists are discussed in @ref{Modifying alists}.
1867 Grob properties should be adjusted with an @code{\override} inside
1868 a @code{\score} or @code{\layout} block, and not inside a
1869 @code{\paper} block.
1871 The following example demonstrates the two ways these alists can
1872 be modified. The first declaration updates one key-value
1873 individually, and the second completely re-defines the property:
1877 \override VerticalAxisGroup #'staff-staff-spacing #'space = #10
1881 \override VerticalAxisGroup #'staff-staff-spacing =
1884 (minimum-distance . 9)
1885 (stretchability . 10))
1889 To change any spacing settings globally, put them in the
1890 @code{\layout} block:
1896 \override VerticalAxisGroup #'staff-staff-spacing #'space = #10
1901 Standard settings for the vertical spacing grob properties are
1902 listed in @rinternals{VerticalAxisGroup} and
1903 @rinternals{StaffGrouper}. Default overrides for specific types
1904 of non-staff lines are listed in the relevant context descriptions
1905 in @rinternals{Contexts}.
1908 @subsubheading Properties of the @code{VerticalAxisGroup} grob
1910 @code{VerticalAxisGroup} properties are typically adjusted with an
1911 @code{\override} at the @code{Staff} level (or equivalent).
1914 @item staff-staff-spacing
1915 The distance between the current staff and the staff just below it
1916 in the same system, even if one or more non-staff lines (such as
1917 @code{Lyrics}) are placed between the two staves. Does not apply
1918 to the bottom staff of a system. This replaces any settings
1919 inherited from the @code{StaffGrouper} grob of the containing
1920 staff-group, if there is one. If this is unset, and there are no
1921 @code{StaffGrouper} properties to inherit, the
1922 @code{default-staff-staff-spacing} property is used.
1924 @item default-staff-staff-spacing
1925 The settings to use for @code{staff-staff-spacing} when it is
1926 unset. This applies to ungrouped staves and to grouped staves
1927 that do not inherit settings from the @code{StaffGrouper} grob.
1929 @item staff-affinity
1930 The direction of the staff to use for spacing the current
1931 non-staff line. Choices are @code{UP}, @code{DOWN}, and
1932 @code{CENTER}. If @code{CENTER}, the non-staff line will be
1933 placed equidistant between the two nearest staves on either side,
1934 unless collisions or other spacing constraints prevent this.
1935 Adjacent non-staff lines should have non-increasing
1936 @code{staff-affinity} from top to bottom, e.g. a non-staff line
1937 set to @code{UP} should not immediately follow one that is set to
1938 @code{DOWN}. Non-staff lines at the top of a system should use
1939 @code{DOWN}; those at the bottom should use @code{UP}. Setting
1940 @code{staff-affinity} for a staff causes it to be treated as a
1941 non-staff line. Setting @code{staff-affinity} to @code{#f} causes
1942 a non-staff line to be treated as a staff.
1944 @c TODO: verify last clause below ("even if other...")
1946 @item nonstaff-relatedstaff-spacing
1947 The distance between the current non-staff line and the nearest
1948 staff in the direction of @code{staff-affinity}, if there are no
1949 non-staff lines between the two, and @code{staff-affinity} is
1950 either @code{UP} or @code{DOWN}. If @code{staff-affinity} is
1951 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
1952 for the nearest staves on @emph{both} sides, even if other
1953 non-staff lines appear between the current one and either of the
1956 @item nonstaff-nonstaff-spacing
1957 The distance between the current non-staff line and the next
1958 non-staff line in the direction of @code{staff-affinity}, if both
1959 are on the same side of the related staff, and
1960 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
1962 @item nonstaff-unrelatedstaff-spacing
1963 The distance between the current non-staff line and the staff in
1964 the opposite direction from @code{staff-affinity}, if there are no
1965 other non-staff lines between the two, and @code{staff-affinity}
1966 is either @code{UP} or @code{DOWN}. This can be used, for
1967 example, to require a minimum amount of padding between a
1968 @code{Lyrics} line and the staff to which it does not belong.
1972 @subsubheading Properties of the @code{StaffGrouper} grob
1974 @code{StaffGrouper} properties are typically adjusted with an
1975 @code{\override} at the @code{StaffGroup} level (or equivalent).
1978 @item staff-staff-spacing
1979 The distance between consecutive staves within the current
1980 staff-group. The @code{staff-staff-spacing} property of an
1981 individual staff's @code{VerticalAxisGroup} grob will be used
1982 instead for any staves in the staff-group that have it set. Also
1983 see @code{default-staff-staff-spacing}.
1985 @item staffgroup-staff-spacing
1986 The distance between the last staff of the current staff-group and
1987 the staff just below it in the same system, even if one or more
1988 non-staff lines (such as @code{Lyrics}) exist between the two
1989 staves. Does not apply to the bottom staff of a system. The
1990 @code{staff-staff-spacing} property of an individual staff's
1991 @code{VerticalAxisGroup} grob will be used instead for any staves
1992 in the staff-group that have it set. Also see
1993 @code{default-staff-staff-spacing}.
1998 @file{ly/engraver-init.ly},
1999 @file{scm/define-grobs.scm}.
2001 Internals Reference:
2002 @rinternals{Contexts},
2003 @rinternals{VerticalAxisGroup},
2004 @rinternals{StaffGrouper}.
2007 @node Spacing of ungrouped staves
2008 @unnumberedsubsubsec Spacing of ungrouped staves
2010 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
2011 @code{TabStaff}, etc.) are contexts that can contain one or more
2012 voice contexts, but cannot contain any other staves.
2014 The following properties affect the spacing of @emph{ungrouped}
2018 @item @code{VerticalAxisGroup} properties:
2020 @item @code{staff-staff-spacing}
2024 These grob properties are described individually above; see
2025 @ref{Within-system spacing properties}.
2027 Additional properties are involved for staves that are part of a
2028 staff-group; see @ref{Spacing of grouped staves}.
2030 The following example shows how the @code{staff-staff-spacing}
2031 property can affect the spacing of ungrouped staves:
2033 @lilypond[verbatim,quote,staffsize=16]
2037 \override VerticalAxisGroup #'staff-staff-spacing =
2040 (minimum-distance . 7))
2045 % The very low note here needs more room than 'space can
2046 % provide, so the distance between this staff and the next is
2047 % determined by 'padding.
2048 \new Staff { b,2 r | }
2050 % Here, 'space provides enough room, and there is no need to
2051 % compress the space (towards 'minimum-distance) to make room
2052 % for anything else on the page, so the distance between this
2053 % staff and the next is determined by 'space.
2054 \new Staff { \clef bass g2 r | }
2056 % By setting 'padding to a negative value, staves can be made to
2057 % collide. The lowest acceptable value for 'space is 0.
2059 \override VerticalAxisGroup #'staff-staff-spacing =
2062 } { \clef bass g2 r | }
2063 \new Staff { \clef bass g2 r | }
2069 @file{scm/define-grobs.scm}.
2074 Internals Reference:
2075 @rinternals{VerticalAxisGroup}.
2078 @node Spacing of grouped staves
2079 @unnumberedsubsubsec Spacing of grouped staves
2081 In orchestral and other large scores, it is common to place staves
2082 in groups. The space between groups is typically larger than the
2083 space between staves of the same group.
2085 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2086 etc.) are contexts that can contain one or more staves
2089 The following properties affect the spacing of staves inside
2093 @item @code{VerticalAxisGroup} properties:
2095 @item @code{staff-staff-spacing}
2096 @item @code{default-staff-staff-spacing}
2098 @item @code{StaffGrouper} properties:
2100 @item @code{staff-staff-spacing}
2101 @item @code{staffgroup-staff-spacing}
2105 These grob properties are described individually above; see
2106 @ref{Within-system spacing properties}.
2108 The following example shows how properties of the
2109 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2111 @lilypond[verbatim,quote,staffsize=16]
2115 \override StaffGrouper #'staff-staff-spacing #'padding = #0
2116 \override StaffGrouper #'staff-staff-spacing #'space = #1
2121 \new PianoStaff \with {
2122 \override StaffGrouper #'staffgroup-staff-spacing #'space = #20
2137 @file{scm/define-grobs.scm}.
2142 Internals Reference:
2143 @rinternals{VerticalAxisGroup},
2144 @rinternals{StaffGrouper}.
2147 @node Spacing of non-staff lines
2148 @unnumberedsubsubsec Spacing of non-staff lines
2150 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2151 etc.) are contexts whose layout objects are engraved like staves
2152 (i.e. in horizontal lines within systems). Specifically,
2153 non-staff lines are non-staff contexts that create the
2154 @code{VerticalAxisGroup} layout object.
2156 The following properties affect the spacing of non-staff lines:
2159 @item @code{VerticalAxisGroup} properties:
2161 @item @code{staff-affinity}
2162 @item @code{nonstaff-relatedstaff-spacing}
2163 @item @code{nonstaff-nonstaff-spacing}
2164 @item @code{nonstaff-unrelatedstaff-spacing}
2168 These grob properties are described individually above; see
2169 @ref{Within-system spacing properties}.
2171 The following example shows how the
2172 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2173 of consecutive non-staff lines. Here, by setting the
2174 @code{stretchability} key to a very high value, the lyrics are
2175 able to stretch much more than usual:
2177 @lilypond[verbatim,quote,staffsize=16]
2181 \override VerticalAxisGroup
2182 #'nonstaff-nonstaff-spacing #'stretchability = #1000
2189 \override VerticalAxisGroup #'staff-staff-spacing = #'((space . 30))
2192 \override VerticalAxisGroup #'staff-affinity = #UP
2195 \override VerticalAxisGroup #'staff-affinity = #CENTER
2196 } \lyricmode { center }
2198 \override VerticalAxisGroup #'staff-affinity = #DOWN
2199 } \lyricmode { down }
2207 @file{ly/engraver-init.ly},
2208 @file{scm/define-grobs.scm}.
2213 @c @lsr{spacing,page-spacing.ly},
2214 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2216 Internals Reference:
2217 @rinternals{Contexts},
2218 @rinternals{VerticalAxisGroup}.
2221 @node Explicit staff and system positioning
2222 @subsection Explicit staff and system positioning
2224 One way to understand the flexible vertical spacing mechanisms
2225 explained above is as a collection of settings that control the
2226 amount of vertical padding between staves and systems.
2228 It is possible to approach vertical spacing in a different way
2229 using @code{NonMusicalPaperColumn #'line-break-system-details}.
2230 While the flexible vertical spacing mechanisms specify vertical
2231 padding, @code{NonMusicalPaperColumn #'line-break-system-details}
2232 can specify exact vertical positions on the page.
2234 @code{NonMusicalPaperColumn #'line-break-system-details} accepts
2235 an associative list of three different settings:
2238 @item @code{X-offset}
2239 @item @code{Y-offset}
2240 @item @code{alignment-distances}
2243 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2244 below, can occur in any of three different places in an input file:
2247 @item in the middle of note entry directly
2248 @item in a @code{\context} block
2249 @item in the @code{\with} block
2252 When we override @code{NonMusicalPaperColumn}, we use the usual
2253 @code{\override} command in @code{\context} blocks and in the
2254 @code{\with} block. On the other hand, when we override
2255 @code{NonMusicalPaperColumn} in the middle of note entry,
2256 use the special @code{\overrideProperty} command. Here are some
2257 example @code{NonMusicalPaperColumn} overrides with the special
2258 @code{\overrideProperty} command:
2261 \overrideProperty NonMusicalPaperColumn
2262 #'line-break-system-details #'((X-offset . 20))
2264 \overrideProperty NonMusicalPaperColumn
2265 #'line-break-system-details #'((Y-offset . 40))
2267 \overrideProperty NonMusicalPaperColumn
2268 #'line-break-system-details #'((X-offset . 20)
2271 \overrideProperty NonMusicalPaperColumn
2272 #'line-break-system-details #'((alignment-distances . (15)))
2274 \overrideProperty NonMusicalPaperColumn
2275 #'line-break-system-details #'((X-offset . 20)
2277 (alignment-distances . (15)))
2280 To understand how each of these different settings work, we begin
2281 by looking at an example that includes no overrides at all.
2283 @c \book { } is required in these examples to ensure the spacing
2284 @c overrides can be seen between systems. -np
2286 @lilypond[verbatim,quote,staffsize=16]
2287 \header { tagline = ##f }
2288 \paper { left-margin = 0\mm }
2298 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2301 \repeat unfold 15 { d'4 d' d' d' }
2308 This score isolates line- and page-breaking information in a dedicated
2309 voice. This technique of creating a breaks voice will help keep layout
2310 separate from music entry as our example becomes more complicated.
2311 See @ref{Using an extra voice for breaks}.
2313 Explicit @code{\breaks} evenly divide the music into six measures per
2314 line. Vertical spacing results from LilyPond's defaults. To set
2315 the vertical startpoint of each system explicitly, we can set
2316 the @code{Y-offset} pair in the @code{line-break-system-details}
2317 attribute of the @code{NonMusicalPaperColumn} grob:
2319 @lilypond[verbatim,quote,staffsize=16]
2320 \header { tagline = ##f }
2321 \paper { left-margin = 0\mm }
2327 \overrideProperty #"Score.NonMusicalPaperColumn"
2328 #'line-break-system-details #'((Y-offset . 0))
2330 \overrideProperty #"Score.NonMusicalPaperColumn"
2331 #'line-break-system-details #'((Y-offset . 40))
2333 \overrideProperty #"Score.NonMusicalPaperColumn"
2334 #'line-break-system-details #'((Y-offset . 80))
2337 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2340 \repeat unfold 15 { d'4 d' d' d' }
2347 Note that @code{line-break-system-details} takes an associative list of
2348 potentially many values, but that we set only one value here. Note,
2349 too, that the @code{Y-offset} property here determines the exact vertical
2350 position on the page at which each new system will render.
2352 Now that we have set the vertical startpoint of each system
2353 explicitly, we can also set the vertical distances between staves
2354 within each system manually. We do this using the @code{alignment-distances}
2355 subproperty of @code{line-break-system-details}.
2357 @lilypond[verbatim,quote,staffsize=16]
2358 \header { tagline = ##f }
2359 \paper { left-margin = 0\mm }
2365 \overrideProperty #"Score.NonMusicalPaperColumn"
2366 #'line-break-system-details #'((Y-offset . 20)
2367 (alignment-distances . (15)))
2369 \overrideProperty #"Score.NonMusicalPaperColumn"
2370 #'line-break-system-details #'((Y-offset . 60)
2371 (alignment-distances . (15)))
2373 \overrideProperty #"Score.NonMusicalPaperColumn"
2374 #'line-break-system-details #'((Y-offset . 100)
2375 (alignment-distances . (15)))
2378 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2381 \repeat unfold 15 { d'4 d' d' d' }
2388 Note that here we assign two different values to the
2389 @code{line-break-system-details} attribute of the
2390 @code{NonMusicalPaperColumn} grob. Though the
2391 @code{line-break-system-details} attribute alist accepts many
2392 additional spacing parameters (including, for example, a corresponding
2393 @code{X-offset} pair), we need only set the @code{Y-offset} and
2394 @code{alignment-distances} pairs to control the vertical startpoint of
2395 every system and every staff. Finally, note that @code{alignment-distances}
2396 specifies the vertical positioning of staves but not of staff groups.
2398 @lilypond[verbatim,quote,staffsize=16]
2399 \header { tagline = ##f }
2400 \paper { left-margin = 0\mm }
2406 \overrideProperty #"Score.NonMusicalPaperColumn"
2407 #'line-break-system-details #'((Y-offset . 0)
2408 (alignment-distances . (30 10)))
2410 \overrideProperty #"Score.NonMusicalPaperColumn"
2411 #'line-break-system-details #'((Y-offset . 60)
2412 (alignment-distances . (10 10)))
2414 \overrideProperty #"Score.NonMusicalPaperColumn"
2415 #'line-break-system-details #'((Y-offset . 100)
2416 (alignment-distances . (10 30)))
2419 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2422 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2423 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2430 Some points to consider:
2433 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2434 do not count as a staff.
2436 @item The units of the numbers passed to @code{X-offset},
2437 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2438 of the distance between adjacent staff lines. Positive values move staves
2439 and lyrics up, negative values move staves and lyrics down.
2441 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
2442 settings given here allow the positioning of staves and systems anywhere
2443 on the page, it is possible to violate paper or margin boundaries or even
2444 to print staves or systems on top of one another. Reasonable values
2445 passed to these different settings will avoid this.
2454 @node Vertical collision avoidance
2455 @subsection Vertical collision avoidance
2457 @funindex outside-staff-priority
2458 @funindex outside-staff-padding
2459 @funindex outside-staff-horizontal-padding
2461 Intuitively, there are some objects in musical notation that belong
2462 to the staff and there are other objects that should be placed outside
2463 the staff. Objects belonging outside the staff include things such as
2464 rehearsal marks, text and dynamic markings (from now on, these will
2465 be called outside-staff objects). LilyPond's rule for the
2466 vertical placement of outside-staff objects is to place them as close
2467 to the staff as possible but not so close that they collide with
2470 LilyPond uses the @code{outside-staff-priority} property to determine
2471 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2472 is a number, the grob is an outside-staff object. In addition,
2473 @code{outside-staff-priority} tells LilyPond in which order the objects
2476 First, LilyPond places all the objects that do not belong outside
2477 the staff. Then it sorts the outside-staff objects according to their
2478 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
2479 takes the outside-staff objects and places them so that they do
2480 not collide with any objects that have already been placed. That
2481 is, if two outside-staff grobs are competing for the same space, the one
2482 with the lower @code{outside-staff-priority} will be placed closer to
2485 @lilypond[quote,ragged-right,relative=2,verbatim]
2488 \once \override TextScript #'outside-staff-priority = #1
2489 c4_"Text"\pp % this time the text will be closer to the staff
2491 % by setting outside-staff-priority to a non-number,
2492 % we disable the automatic collision avoidance
2493 \once \override TextScript #'outside-staff-priority = ##f
2494 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
2495 c4_"Text"\pp % now they will collide
2498 The vertical padding between an outside-staff object and the
2499 previously-positioned grobs can be controlled with
2500 @code{outside-staff-padding}.
2502 @lilypond[quote,ragged-right,relative=2,verbatim]
2503 \once \override TextScript #'outside-staff-padding = #0
2504 a'^"This text is placed very close to the note"
2505 \once \override TextScript #'outside-staff-padding = #3
2506 c^"This text is padded away from the previous text"
2507 c^"This text is placed close to the previous text"
2511 By default, outside-staff objects are placed only to avoid
2512 a horizontal collision with previously-positioned grobs. This
2513 can lead to situations in which objects are placed very close to each
2514 other horizontally. The vertical spacing between staves can
2515 also be set so that outside staff objects are interleaved.
2516 Setting @code{outside-staff-horizontal-padding}
2517 causes an object to be offset vertically so that such a situation
2520 @lilypond[quote,ragged-right,relative=2,verbatim]
2521 % the markup is too close to the following note
2525 % setting outside-staff-horizontal-padding fixes this
2527 \once \override TextScript #'outside-staff-horizontal-padding = #1
2539 @node Horizontal spacing
2540 @section Horizontal spacing
2542 @cindex horizontal spacing
2543 @cindex spacing, horizontal
2546 * Horizontal spacing overview::
2547 * New spacing area::
2548 * Changing horizontal spacing::
2550 * Proportional notation::
2554 @node Horizontal spacing overview
2555 @subsection Horizontal spacing overview
2557 The spacing engine translates differences in durations into stretchable
2558 distances (@q{springs}) of differing lengths. Longer durations get
2559 more space, shorter durations get less. The shortest durations get a
2560 fixed amount of space (which is controlled by
2561 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2562 object). The longer the duration, the more space it gets: doubling a
2563 duration adds a fixed amount (this amount is controlled by
2564 @code{spacing-increment}) of space to the note.
2566 For example, the following piece contains lots of half, quarter, and
2567 8th notes; the eighth note is followed by 1 note head width (NHW).
2568 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2570 @lilypond[quote,verbatim,relative=1]
2571 c2 c4. c8 c4. c8 c4. c8 c8
2575 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2576 approximately the width of a note head, and
2577 @code{shortest-duration-space} is set to 2.0, meaning that the
2578 shortest note gets 2.4 staff space (2.0 times the
2579 @code{spacing-increment}) of horizontal space. This space is counted
2580 from the left edge of the symbol, so the shortest notes are generally
2581 followed by one NHW of space.
2583 If one would follow the above procedure exactly, then adding a single
2584 32nd note to a score that uses 8th and 16th notes, would widen up the
2585 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2586 thus adding 1 NHW to every note. To prevent this, the shortest
2587 duration for spacing is not the shortest note in the score, but rather
2588 the one which occurs most frequently.
2591 The most common shortest duration is determined as follows: in every
2592 measure, the shortest duration is determined. The most common shortest
2593 duration is taken as the basis for the spacing, with the stipulation
2594 that this shortest duration should always be equal to or shorter than
2595 an 8th note. The shortest duration is printed when you run
2596 @code{lilypond} with the @code{--verbose} option.
2598 These durations may also be customized. If you set the
2599 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2600 this sets the base duration for spacing. The maximum duration for this
2601 base (normally an 8th), is set through @code{base-shortest-duration}.
2603 @funindex common-shortest-duration
2604 @funindex base-shortest-duration
2605 @funindex stem-spacing-correction
2608 Notes that are even shorter than the common shortest note are
2609 followed by a space that is proportional to their duration relative to
2610 the common shortest note. So if we were to add only a few 16th notes
2611 to the example above, they would be followed by half a NHW:
2613 @lilypond[quote,verbatim,relative=2]
2614 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2618 In the @emph{Essay on automated music engraving}, it was explained
2619 that stem directions influence spacing (see @ressay{Optical
2620 spacing}). This is controlled with the
2621 @code{stem-spacing-correction} property in the
2622 @rinternals{NoteSpacing}, object. These are generated for every
2623 @rinternals{Voice} context. The @code{StaffSpacing} object
2624 (generated in @rinternals{Staff} context) contains the same
2625 property for controlling the stem/bar line spacing. The following
2626 example shows these corrections, once with default settings, and
2627 once with exaggerated corrections:
2629 @lilypond[quote,ragged-right]
2633 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2634 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2640 Proportional notation is supported; see @ref{Proportional notation}.
2647 Internals Reference:
2648 @rinternals{SpacingSpanner},
2649 @rinternals{NoteSpacing},
2650 @rinternals{StaffSpacing},
2651 @rinternals{NonMusicalPaperColumn}.
2656 There is no convenient mechanism to manually override spacing. The
2657 following work-around may be used to insert extra space into a score,
2658 adjusting the padding value as necessary.
2660 \override Score.NonMusicalPaperColumn #'padding = #10
2663 No work-around exists for decreasing the amount of space.
2666 @node New spacing area
2667 @subsection New spacing area
2669 New sections with different spacing parameters can be started with
2670 @code{newSpacingSection}. This is useful when there are
2671 sections with a different notions of long and short notes.
2673 In the following example, the time signature change introduces a new
2674 section, and hence the 16ths notes are spaced wider.
2676 @lilypond[relative=1,verbatim,quote]
2679 c8 c c4 c16[ c c8] c4
2685 The @code{\newSpacingSection} command creates a new
2686 @code{SpacingSpanner} object, and hence new @code{\override}s
2687 may be used in that location.
2694 Internals Reference:
2695 @rinternals{SpacingSpanner}.
2698 @node Changing horizontal spacing
2699 @subsection Changing horizontal spacing
2701 Horizontal spacing may be altered with the
2702 @code{base-shortest-duration} property. Here
2703 we compare the same music; once without altering
2704 the property, and then altered. Larger values
2705 of @code{ly:make-moment} will produce smaller
2706 music. Note that @code{ly:make-moment} constructs
2707 a duration, so @code{1 4} is a longer duration
2710 @lilypond[verbatim,line-width=12\cm]
2713 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2714 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2715 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2716 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2721 @lilypond[verbatim,line-width=12\cm]
2724 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2725 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2726 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2727 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2732 \override SpacingSpanner
2733 #'base-shortest-duration = #(ly:make-moment 1 16)
2742 By default, spacing in tuplets depends on various non-duration
2743 factors (such as accidentals, clef changes, etc). To disregard
2744 such symbols and force uniform equal-duration spacing, use
2745 @code{Score.SpacingSpanner #'uniform-stretching}. This
2746 property can only be changed at the beginning of a score,
2748 @lilypond[quote,ragged-right,verbatim]
2767 \override SpacingSpanner #'uniform-stretching = ##t
2773 When @code{strict-note-spacing} is set, notes are spaced without
2774 regard for clefs, bar lines, and grace notes,
2776 @lilypond[quote,ragged-right,relative=2,verbatim]
2777 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2778 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2788 @subsection Line length
2791 @cindex breaking pages
2794 @funindex line-width
2795 @funindex ragged-right
2796 @funindex ragged-last
2798 @c Although line-width can be set in \layout, it should be set in paper
2799 @c block, to get page layout right.
2800 @c Setting indent in \paper block makes not much sense, but it works.
2802 @c Bit verbose and vague, use examples?
2803 The most basic settings influencing the spacing are @code{indent} and
2804 @code{line-width}. They are set in the @code{\layout} block. They
2805 control the indentation of the first line of music, and the lengths of
2808 If @code{ragged-right} is set to true in the @code{\layout} block, then
2809 systems ends at their natural horizontal length, instead of being spread
2810 horizontally to fill the whole line. This is useful for
2811 short fragments, and for checking how tight the natural spacing is.
2812 The normal default setting is false, but if the score has only one
2813 system the default value is true.
2816 @cindex vertical spacing
2818 The option @code{ragged-last} is similar to @code{ragged-right}, but
2819 only affects the last line of the piece. No restrictions are put on
2820 that line. The result is similar to formatting text paragraphs. In a
2821 paragraph, the last line simply takes its natural horizontal length.
2822 @c Note that for text there are several options for the last line.
2823 @c While Knuth TeX uses natural length, lead typesetters use the same
2824 @c stretch as the previous line. eTeX uses \lastlinefit to
2825 @c interpolate between both these solutions.
2841 @node Proportional notation
2842 @subsection Proportional notation
2844 LilyPond supports proportional notation, a type of horizontal spacing
2845 in which each note consumes an amount of horizontal space exactly
2846 equivalent to its rhythmic duration. This type of proportional spacing
2847 is comparable to horizontal spacing on top of graph paper. Some late
2848 20th- and early 21st-century scores use proportional notation to
2849 clarify complex rhythmic relationships or to facilitate the placement
2850 of timelines or other graphics directly in the score.
2852 LilyPond supports five different settings for proportional notation,
2853 which may be used together or alone:
2856 @item @code{proportionalNotationDuration}
2857 @item @code{uniform-stretching}
2858 @item @code{strict-note-spacing}
2859 @item @code{\remove Separating_line_group_engraver}
2860 @item @code{\override PaperColumn #'used = ##t}
2863 In the examples that follow, we explore these five different
2864 proportional notation settings and examine how these settings interact.
2866 We start with the following one-measure example, which uses classical
2867 spacing with ragged-right turned on.
2869 @lilypond[quote,verbatim,ragged-right]
2872 \new RhythmicStaff {
2876 c'16 c'16 c'16 c'16 c'16
2883 Notice that the half note which begins the measure takes up far less
2884 than half of the horizontal space of the measure. Likewise, the
2885 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
2886 which end the measure together take up far more than half the
2887 horizontal space of the measure.
2889 In classical engraving, this spacing may be exactly what we want
2890 because we can borrow horizontal space from the half note and conserve
2891 horizontal space across the measure as a whole.
2893 On the other hand, if we want to insert a measured timeline or other
2894 graphic above or below our score, we need proportional notation. We
2895 turn proportional notation on with the proportionalNotationDuration
2898 @lilypond[quote,verbatim,ragged-right]
2901 \new RhythmicStaff {
2905 c'16 c'16 c'16 c'16 c'16
2912 proportionalNotationDuration = #(ly:make-moment 1 20)
2918 The half note at the beginning of the measure and the faster notes in
2919 the second half of the measure now occupy equal amounts of horizontal
2920 space. We could place a measured timeline or graphic above or below
2923 The @code{proportionalNotationDuration} setting is a context setting
2924 that lives in @code{Score}. Remember that context settings can appear
2925 in one of three locations within our input file -- in a @code{\with}
2926 block, in a @code{\context} block, or directly in music entry preceded
2927 by the @code{\set} command. As with all context settings, users can
2928 pick which of the three different locations they would like to
2929 set @code{proportionalNotationDuration} in to.
2931 The @code{proportionalNotationDuration} setting takes a single argument,
2932 which is the reference duration against that all music will be spaced.
2933 The LilyPond Scheme function @code{make-moment} takes two arguments
2934 -- a numerator and denominator which together express some fraction of
2935 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces
2936 a reference duration of a twentieth note. Values such as
2937 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
2938 @code{#(ly:make-moment 3 97)} are all possible as well.
2940 How do we select the right reference duration to pass to
2941 @code{proportionalNotationDuration}? Usually by a process of trial
2942 and error, beginning with a duration close to the fastest (or smallest)
2943 duration in the piece. Smaller reference durations space music loosely;
2944 larger reference durations space music tightly.
2946 @lilypond[quote,verbatim,ragged-right]
2949 \new RhythmicStaff {
2953 c'16 c'16 c'16 c'16 c'16
2960 proportionalNotationDuration = #(ly:make-moment 1 8)
2967 \new RhythmicStaff {
2971 c'16 c'16 c'16 c'16 c'16
2978 proportionalNotationDuration = #(ly:make-moment 1 16)
2985 \new RhythmicStaff {
2989 c'16 c'16 c'16 c'16 c'16
2996 proportionalNotationDuration = #(ly:make-moment 1 32)
3002 Note that too large a reference duration -- such as the eighth note,
3003 above -- spaces music too tightly and can cause note head collisions.
3004 Also that proportional notation in general takes up more horizontal
3005 space than classical spacing. Proportional spacing provides rhythmic
3006 clarity at the expense of horizontal space.
3008 Next we examine how to optimally space overlapping tuplets.
3010 We start by examining what happens to our original example, with
3011 classical spacing, when we add a second staff with a different type of
3014 @lilypond[quote,verbatim,ragged-right]
3017 \new RhythmicStaff {
3021 c'16 c'16 c'16 c'16 c'16
3024 \new RhythmicStaff {
3026 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3033 The spacing is bad because the evenly spaced notes of the bottom staff
3034 do not stretch uniformly. Classical engravings include very few complex
3035 triplets and so classical engraving rules can generate this type of
3036 result. Setting @code{proportionalNotationDuration} fixes this.
3038 @lilypond[quote,verbatim,ragged-right]
3041 \new RhythmicStaff {
3045 c'16 c'16 c'16 c'16 c'16
3048 \new RhythmicStaff {
3050 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3057 proportionalNotationDuration = #(ly:make-moment 1 20)
3063 But if we look very carefully we can see that notes of the second half
3064 of the 9-tuplet space ever so slightly more widely than the notes
3065 of the first half of the 9-tuplet. To ensure uniform stretching, we
3066 turn on @code{uniform-stretching}, which is a property of
3067 @code{SpacingSpanner}.
3069 @lilypond[quote,verbatim,ragged-right]
3072 \new RhythmicStaff {
3076 c'16 c'16 c'16 c'16 c'16
3079 \new RhythmicStaff {
3081 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3088 proportionalNotationDuration = #(ly:make-moment 1 20)
3089 \override SpacingSpanner #'uniform-stretching = ##t
3095 Our two-staff example now spaces exactly, our rhythmic
3096 relationships are visually clear, and we can include a measured
3097 timeline or graphic if we want.
3099 Note that the LilyPond's proportional notation package expects
3100 that all proportional scores set the SpacingSpanner's
3101 'uniform-stretching attribute to ##t. Setting
3102 proportionalNotationDuration without also setting the
3103 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3104 example, cause Skips to consume an incorrect amount of horizontal
3107 The SpacingSpanner is an abstract grob that lives in the Score
3108 context. As with our settings of proportionalNotationDuration,
3109 overrides to the SpacingSpanner can occur in any of three
3110 different places in our input file – in the Score \with block, in
3111 a Score \context block, or in note entry directly.
3113 There is by default only one @code{SpacingSpanner} per @code{Score}. This
3114 means that, by default, @code{uniform-stretching} is either turned on for the
3115 entire score or turned off for the entire score. We can, however,
3116 override this behavior and turn on different spacing features at
3117 different places in the score. We do this with the command
3118 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
3120 Next we examine the effects of the @code{Separating_line_group_engraver} and
3121 see why proportional scores frequently remove this engraver. The following
3122 example shows that there is a small amount of @qq{preferatory} space
3123 just before the first note in each system.
3125 @lilypond[quote,verbatim,ragged-right]
3138 The amount of this preferatory space is the same whether after a time
3139 signature, a key signature or a clef. @code{Separating_line_group_engraver}
3140 is responsible for this space. Removing @code{Separating_line_group_engraver}
3141 reduces this space to zero.
3143 @lilypond[quote,verbatim,ragged-right]
3149 \remove Separating_line_group_engraver
3157 Nonmusical elements like time signatures, key signatures, clefs and
3158 accidentals are problematic in proportional notation. None of these
3159 elements has rhythmic duration. But all of these elements consume
3160 horizontal space. Different proportional scores approach these
3161 problems differently.
3163 It may be possible to avoid spacing problems with key signatures
3164 simply by not having any. This is a valid option since most
3165 proportional scores are contemporary music. The same may be true
3166 of time signatures, especially for those scores
3167 that include a measured timeline or other graphic. But these scores
3168 are exceptional and most proportional scores include at least some
3169 time signatures. Clefs and accidentals are even more essential.
3171 So what strategies exist for spacing nonmusical elements in a
3172 proportional context? One good option is the @code{strict-note-spacing}
3173 property of @code{SpacingSpanner}. Compare the two scores below:
3175 @lilypond[quote,verbatim,ragged-right]
3177 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3187 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3188 \override Score.SpacingSpanner #'strict-note-spacing = ##t
3198 Both scores are proportional, but the spacing in the first score
3199 is too loose because of the clef change. The spacing of the second
3200 score remains strict, however, because strict-note-spacing is
3201 turned on. Turning on strict-note-spacing causes the width of
3202 time signatures, key signatures, clefs and accidentals to play no
3203 part in the spacing algorithm.
3205 In addition to the settings given here, there are other settings
3206 that frequently appear in proportional scores. These include:
3209 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
3210 @item @code{tupletFullLength = ##t}
3211 @item @code{\override Beam #'breakable = ##t}
3212 @item @code{\override Glissando #'breakable = ##t}
3213 @item @code{\override TextSpanner #'breakable = ##t}
3214 @item @code{\remove Forbid_line_break_engraver in the Voice context}
3217 These settings space grace notes strictly, extend tuplet brackets to
3218 mark both rhythmic start- and stop-points, and allow spanning elements
3219 to break across systems and pages. See the respective parts of the manual
3220 for these related settings.
3225 @ref{New spacing area}.
3231 @node Fitting music onto fewer pages
3232 @section Fitting music onto fewer pages
3234 Sometimes you can end up with one or two staves on a second
3235 (or third, or fourth...) page. This is annoying, especially
3236 if you look at previous pages and it looks like there is plenty
3237 of room left on those.
3239 When investigating layout issues, @code{annotate-spacing} is an
3240 invaluable tool. This command prints the values of various layout
3241 spacing variables; for more details see the following section,
3242 @ref{Displaying spacing}.
3245 * Displaying spacing::
3246 * Changing spacing::
3250 @node Displaying spacing
3251 @subsection Displaying spacing
3253 @funindex annotate-spacing
3254 @cindex spacing, display of layout
3256 To graphically display the dimensions of vertical layout variables
3257 that may be altered for page formatting, set
3258 @code{annotate-spacing} in the @code{\paper} block:
3260 @c need to have \book{} otherwise we get the separate systems. -hwn
3261 @lilypond[verbatim,quote]
3262 #(set-default-paper-size "a6" 'landscape)
3265 \paper { annotate-spacing = ##t }
3271 All layout dimensions are displayed in staff-spaces, regardless
3272 of the units specified in the @code{\paper} or @code{\layout} block.
3273 In the above example, @code{paper-height} has a value of 59.75
3274 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3275 default value). Note that:
3277 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3280 @tab = (25.4/72.27) mm
3283 @tab = (@code{staff-size})/4 pts
3285 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3290 In this case, one @code{staff-space} is approximately equal to
3291 1.757mm. Thus the @code{paper-height} measurement of 59.75
3292 @code{staff-spaces} is equivalent to 105 millimeters, the height
3293 of @code{a6} paper in landscape orientation. The pairs
3294 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3295 edge and @var{b} the upper edge of the interval.
3300 @ref{Setting the staff size}.
3306 @node Changing spacing
3307 @subsection Changing spacing
3309 The output of @code{annotate-spacing} reveals vertical dimensions
3310 in great detail. For details about modifying margins and other
3311 layout variables, see @ref{Page layout}.
3313 Other than margins, there are a few other options to save space:
3317 Force systems to move as close together as possible (to fit as
3318 many systems as possible onto a page) while being spaced so that
3319 there is no blank space at the bottom of the page.
3323 system-system-spacing = #'((padding . 0) (space . 0.1))
3324 ragged-last-bottom = ##f
3330 Force the number of systems. This can help in two ways. Just
3331 setting a value, even the same value as the number of systems
3332 being typeset by default, will sometimes cause more systems to
3333 be fitted onto each page, as an estimation step is then bypassed,
3334 giving a more accurate fit to each page. Also, forcing an actual
3335 reduction in the number of systems may save a further page. For
3336 example, if the default layout has 11 systems, the following
3337 assignment will force a layout with 10 systems.
3346 Avoid (or reduce) objects that increase the vertical size of a
3347 system. For example, volta repeats (or alternate repeats) require
3348 extra space. If these repeats are spread over two systems, they
3349 will take up more space than one system with the volta repeats and
3350 another system without. For example, dynamics that @q{stick out} of
3351 a system can be moved closer to the staff:
3353 @lilypond[verbatim,quote,relative=1]
3355 e4 c g-\tweak #'X-offset #-2.7 -\tweak #'Y-offset #2.5 \f c
3359 Alter the horizontal spacing via @code{SpacingSpanner}. For more
3360 details, see @ref{Changing horizontal spacing}. The following
3361 example illustrates the default spacing:
3363 @lilypond[verbatim,quote]
3376 The next example modifies @code{common-shortest-duration} from a
3377 value of @code{1/4} to @code{1/2}. The quarter note is the most
3378 common and shortest duration in this example, so by making this
3379 duration longer, a @q{squeezing} effect occurs:
3381 @lilypond[verbatim,quote]
3393 \override SpacingSpanner
3394 #'common-shortest-duration = #(ly:make-moment 1 2)
3401 The @code{common-shortest-duration} property cannot be modified
3402 dynamically, so it must always be placed in a @code{\context}
3403 block so that it applies to the whole score.
3411 @ref{Changing horizontal spacing}.