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 false. 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.
373 Explicitly defined paper-sizes will override any user-defined top or
374 bottom margin settings.
377 @node Flexible vertical spacing \paper variables
378 @subsection Flexible vertical spacing @code{\paper} variables
380 In most cases, it is preferable for the vertical distances between
381 certain items (such as margins, titles, systems, and separate
382 scores) to be flexible, so that they stretch and compress nicely
383 according to each situation. A number of @code{\paper} variables
384 (listed below) are available to fine-tune the stretching behavior
387 Note that the @code{\paper} variables discussed in this section do
388 not control the spacing of staves within individual systems.
389 Within-system spacing is controlled by grob properties, with
390 settings typically entered inside a @code{\score} or
391 @code{\layout} block, and not inside a @code{\paper} block. See
392 @ref{Flexible vertical spacing within systems}.
395 * Structure of flexible vertical spacing alists::
396 * List of flexible vertical spacing \paper variables::
400 @node Structure of flexible vertical spacing alists
401 @unnumberedsubsubsec Structure of flexible vertical spacing alists
403 Each of the flexible vertical spacing @code{\paper} variables is
404 an alist (association list) containing four @emph{keys}:
409 @code{basic-distance} -- the vertical distance, measured in
410 staff-spaces, between the @emph{reference points} of the two
411 items, when no collisions would result, and no stretching or
412 compressing is in effect. The reference point of a (title or
413 top-level) markup is its highest point, and the reference point of
414 a system is the vertical center of the nearest @code{StaffSymbol}
415 -- even if a non-staff line (such as a @code{Lyrics} context) is
416 in the way. Values for @code{basic-distance} that are less than
417 either @code{padding} or @code{minimum-distance} are not
418 meaningful, since the resulting distance will never be less than
419 either @code{padding} or @code{minimum-distance}.
422 @code{minimum-distance} -- the smallest allowable vertical
423 distance, measured in staff-spaces, between the reference points
424 of the two items, when compressing is in effect. Values for
425 @code{minimum-distance} that are less than @code{padding} are not
426 meaningful, since the resulting distance will never be less than
429 @c TODO: explain skylines somewhere and xref to it from here.
432 @code{padding} -- the minimum required amount of unobstructed
433 vertical whitespace between the bounding boxes (or skylines) of
434 the two items, measured in staff-spaces.
437 @code{stretchability} -- a unitless measure of the dimension's
438 relative propensity to stretch. If zero, the distance will not
439 stretch (unless collisions would result). When positive, the
440 significance of a particular dimension's @code{stretchability}
441 value lies only in its relation to the @code{stretchability}
442 values of the other dimensions. For example, if one dimension has
443 twice the @code{stretchability} of another, it will stretch twice
444 as easily. Values should be non-negative and finite. The value
445 @code{+inf.0} triggers a @code{programming_error} and is ignored,
446 but @code{1.0e7} can be used for an almost infinitely stretchable
447 spring. If unset, the default value is set to
448 @code{basic-distance}. Note that the dimension's propensity to
449 @emph{compress} cannot be directly set by the user and is equal to
450 (@code{basic-distance}@tie{}@minus{}@tie{}@code{minimum-distance}).
454 If a page has a ragged bottom, the resulting distance is the
460 @code{basic-distance},
463 @code{minimum-distance}, and
466 @code{padding} plus the smallest distance necessary to eliminate
471 For multi-page scores with a ragged bottom on the last page, the last
472 page uses the same spacing as the preceding page, provided there is
473 enough space for that.
475 Specific methods for modifying alists are discussed in
476 @ref{Modifying alists}. The following example demonstrates the
477 two ways these alists can be modified. The first declaration
478 updates one key-value individually, and the second completely
479 redefines the variable:
483 system-system-spacing #'basic-distance = #8
484 score-system-spacing =
485 #'((basic-distance . 12)
486 (minimum-distance . 6)
488 (stretchability . 12))
493 @node List of flexible vertical spacing \paper variables
494 @unnumberedsubsubsec List of flexible vertical spacing @code{\paper} variables
496 The names of these variables follow the format
497 @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}}
498 and @code{@var{lower}} are the items to be spaced. Each distance
499 is measured between the reference points of the two items (see the
500 description of the alist structure above). Note that in these
501 variable names, the term @q{@code{markup}} refers to both
502 @emph{title markups} (@code{bookTitleMarkup} or
503 @code{scoreTitleMarkup}) and @emph{top-level markups} (see
504 @ref{File structure}). All distances are measured in
507 Default settings are defined in @file{ly/paper-defaults-init.ly}.
509 @c TODO: Where do headers/footers fit in? -mp
512 @item markup-system-spacing
513 @funindex markup-system-spacing
515 the distance between a (title or top-level) markup and the system
518 @item score-markup-spacing
519 @funindex score-markup-spacing
521 the distance between the last system of a score and the (title or
522 top-level) markup that follows it.
524 @item score-system-spacing
525 @funindex score-system-spacing
527 the distance between the last system of a score and the first
528 system of the score that follows it, when no (title or top-level)
529 markup exists between them.
531 @item system-system-spacing
532 @funindex system-system-spacing
534 the distance between two systems in the same score.
536 @item markup-markup-spacing
537 @funindex markup-markup-spacing
539 the distance between two (title or top-level) markups.
541 @item last-bottom-spacing
542 @funindex last-bottom-spacing
544 the distance from the last system or top-level markup on a page to
545 the bottom of the printable area (i.e. the top of the bottom
548 @item top-system-spacing
549 @funindex top-system-spacing
551 the distance from the top of the printable area (i.e. the bottom
552 of the top margin) to the first system on a page, when there is no
553 (title or top-level) markup between the two.
555 @item top-markup-spacing
556 @funindex top-markup-spacing
558 the distance from the top of the printable area (i.e. the bottom
559 of the top margin) to the first (title or top-level) markup on a
560 page, when there is no system between the two.
565 @ref{Flexible vertical spacing within systems}.
568 @file{ly/paper-defaults-init.ly}.
574 @node Horizontal spacing \paper variables
575 @subsection Horizontal spacing @code{\paper} variables
577 @warning{Some @code{@bs{}paper} dimensions are automatically
578 scaled to the paper size, which may lead to unexpected behavior.
579 See @ref{Automatic scaling to paper size}.}
582 * \paper variables for widths and margins::
583 * \paper variables for two-sided mode::
584 * \paper variables for shifts and indents::
588 @node \paper variables for widths and margins
589 @unnumberedsubsubsec @code{\paper} variables for widths and margins
591 Default values (before scaling) that are not listed here are
592 defined in @file{ly/paper-defaults-init.ly}.
597 @funindex paper-width
599 The width of the page, unset by default. While @code{paper-width}
600 has no effect on the automatic scaling of some horizontal
601 dimensions, it does influence the @code{line-width} variable. If
602 both @code{paper-width} and @code{line-width} are set, then
603 @code{left-margin} and @code{right-margin} will also be updated.
604 Also see @code{check-consistency}.
609 The horizontal extent of the staff lines in unindented, non-ragged
611 @code{(paper-width@tie{}@minus{}@tie{}left-margin@tie{}@minus{}@tie{}right-margin)}
612 when unset. If @code{line-width} is set, and both
613 @code{left-margin} and @code{right-margin} are unset, then the
614 margins will be updated to center the systems on the page
615 automatically. Also see @code{check-consistency}. This variable
616 can also be set in a @code{\layout} block.
619 @funindex left-margin
621 The margin between the left edge of the page and the start of the
622 staff lines in unindented systems. If the paper size is modified,
623 this dimension's default value is scaled accordingly. If
624 @code{left-margin} is unset, and both @code{line-width} and
625 @code{right-margin} are set, then @code{left-margin} is set to
626 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}right-margin)}.
627 If only @code{line-width} is set, then both margins are set to
628 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
629 and the systems are consequently centered on the page. Also see
630 @code{check-consistency}.
633 @funindex right-margin
635 The margin between the right edge of the page and the end of the
636 staff lines in non-ragged systems. If the paper size is modified,
637 this dimension's default value is scaled accordingly. If
638 @code{right-margin} is unset, and both @code{line-width} and
639 @code{left-margin} are set, then @code{right-margin} is set to
640 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}left-margin)}.
641 If only @code{line-width} is set, then both margins are set to
642 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
643 and the systems are consequently centered on the page. Also see
644 @code{check-consistency}.
646 @item check-consistency
647 @funindex check-consistency
649 If set to true, print a warning if @code{left-margin},
650 @code{line-width}, and @code{right-margin} do not exactly add up
651 to @code{paper-width}, and replace each of these (except
652 @code{paper-width}) with its default value (scaled to the paper
653 size if necessary). If set to false, ignore any inconsistencies
654 and allow systems to run off the edge of the page.
657 @funindex ragged-right
659 If set to true, systems will not fill the line width. Instead,
660 systems end at their natural horizontal length. Default:
661 @code{#t} for scores with only one system, and @code{#f} for
662 scores with two or more systems. This variable can also be set in
663 a @code{\layout} block.
666 @funindex ragged-last
668 If set to true, the last system in the score will not fill the
669 line width. Instead the last system ends at its natural
670 horizontal length. Default: @code{#f}. This variable can also be
671 set in a @code{\layout} block.
677 @ref{Automatic scaling to paper size}.
680 @file{ly/paper-defaults-init.ly}.
684 Explicitly defined paper-sizes will override any user-defined left or
685 right margin settings.
688 @node \paper variables for two-sided mode
689 @unnumberedsubsubsec @code{\paper} variables for two-sided mode
691 Default values (before scaling) are defined in
692 @file{ly/paper-defaults-init.ly}.
700 @cindex binding gutter
702 If set to true, use @code{inner-margin}, @code{outer-margin} and
703 @code{binding-offset} to determine margins depending on whether
704 the page number is odd or even. This overrides @code{left-margin}
705 and @code{right-margin}.
708 @funindex inner-margin
710 The margin all pages have at the inner side if they are part of a
711 book. If the paper size is modified, this dimension's default
712 value is scaled accordingly. Works only with @code{two-sided} set
716 @funindex outer-margin
718 The margin all pages have at the outer side if they are part of a
719 book. If the paper size is modified, this dimension's default
720 value is scaled accordingly. Works only with @code{two-sided} set
724 @funindex binding-offset
726 The amount @code{inner-margin} is increased to make sure nothing
727 will be hidden by the binding. If the paper size is modified,
728 this dimension's default value is scaled accordingly. Works only
729 with @code{two-sided} set to true.
735 @ref{Automatic scaling to paper size}.
738 @file{ly/paper-defaults-init.ly}.
741 @node \paper variables for shifts and indents
742 @unnumberedsubsubsec @code{\paper} variables for shifts and indents
744 Default values (before scaling) that are not listed here are
745 defined in @file{ly/paper-defaults-init.ly}.
749 @item horizontal-shift
750 @funindex horizontal-shift
752 @c This default value is buried in the middle of page.scm. -mp
754 The amount that all systems (including titles and system
755 separators) are shifted to the right. Default: @code{0.0\mm}.
760 The level of indentation for the first system in a score. If the
761 paper size is modified, this dimension's default value is scaled
762 accordingly. This variable can also be set in a @code{\layout}
766 @funindex short-indent
768 The level of indentation for all systems in a score besides the
769 first system. If the paper size is modified, this dimension's
770 default value is scaled accordingly. This variable can also be
771 set in a @code{\layout} block.
777 @ref{Automatic scaling to paper size}.
780 @file{ly/paper-defaults-init.ly}.
786 @node Other \paper variables
787 @subsection Other @code{\paper} variables
790 * \paper variables for line breaking::
791 * \paper variables for page breaking::
792 * \paper variables for page numbering::
793 * Miscellaneous \paper variables::
797 @node \paper variables for line breaking
798 @unnumberedsubsubsec @code{\paper} variables for line breaking
800 @c TODO: Mention that ly:optimal-breaking is on by default? -mp
804 @item max-systems-per-page
805 @funindex max-systems-per-page
807 The maximum number of systems that will be placed on a page. This
808 is currently supported only by the @code{ly:optimal-breaking} algorithm.
811 @item min-systems-per-page
812 @funindex min-systems-per-page
814 The minimum number of systems that will be placed on a page. This
815 may cause pages to be overfilled if it is made too large. This is
816 currently supported only by the @code{ly:optimal-breaking} algorithm.
819 @item systems-per-page
820 @funindex systems-per-page
822 The number of systems that should be placed on each page.
823 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
827 @funindex system-count
829 The number of systems to be used for a score. Default: unset.
830 This variable can also be set in a @code{\layout} block.
839 @node \paper variables for page breaking
840 @unnumberedsubsubsec @code{\paper} variables for page breaking
842 Default values not listed here are defined in
843 @file{ly/paper-defaults-init.ly}
847 @item blank-after-score-page-force
848 @funindex blank-after-score-page-force
850 The penalty for having a blank page after the end of one score and
851 before the next. By default, this is smaller than
852 @code{blank-page-force}, so that we prefer blank pages after
853 scores to blank pages within a score.
855 @item blank-last-page-force
856 @funindex blank-last-page-force
858 The penalty for ending the score on an odd-numbered page.
860 @item blank-page-force
861 @funindex blank-page-force
863 The penalty for having a blank page in the middle of a
864 score. This is not used by @code{ly:optimal-breaking} since it will
865 never consider blank pages in the middle of a score.
868 @funindex page-breaking
870 The page-breaking algorithm to use. Choices are
871 @code{ly:minimal-breaking}, @code{ly:page-turn-breaking}, and
872 @code{ly:optimal-breaking}.
874 @item page-breaking-system-system-spacing
875 @funindex page-breaking-system-system-spacing
877 Tricks the page breaker into thinking that
878 @code{system-system-spacing} is set to something different than
879 it really is. For example, if
880 @code{page-breaking-system-system-spacing #'padding} is set to something
881 substantially larger than @code{system-system-spacing #'padding}, then the
882 page-breaker will put fewer systems on each page. Default: unset.
887 The number of pages to be used for a score, unset by default.
894 @ref{Optimal page breaking},
895 @ref{Optimal page turning},
896 @ref{Minimal page breaking}.
899 @file{ly/paper-defaults-init.ly}.
902 @node \paper variables for page numbering
903 @unnumberedsubsubsec @code{\paper} variables for page numbering
905 Default values not listed here are defined in
906 @file{ly/paper-defaults-init.ly}
910 @cindex page numbers, auto-numbering
911 @item auto-first-page-number
912 @funindex auto-first-page-number
914 The page breaking algorithm is affected by the first page number
915 being odd or even. If set to true, the page breaking algorithm
916 will decide whether to start with an odd or even number. This
917 will result in the first page number remaining as is or being
918 increased by one. Default: @code{#f}.
920 @cindex page numbers, specify the first
921 @item first-page-number
922 @funindex first-page-number
924 The value of the page number on the first page.
926 @item print-first-page-number
927 @funindex print-first-page-number
929 If set to true, a page number is printed on the first page.
931 @cindex page numbers, suppress
932 @item print-page-number
933 @funindex print-page-number
935 If set to false, page numbers are not printed.
941 @file{ly/paper-defaults-init.ly}.
944 Odd page numbers are always on the right. If you want the
945 music to start on page 1 there must be a blank page on the back
946 of the cover page so that page 1 is on the right hand side.
949 @node Miscellaneous \paper variables
950 @unnumberedsubsubsec Miscellaneous @code{\paper} variables
954 @item page-spacing-weight
955 @funindex page-spacing-weight
957 The relative importance of page (vertical) spacing and line
958 (horizontal) spacing. High values will make page spacing more
959 important. Default: @code{10}.
961 @item print-all-headers
962 @funindex print-all-headers
964 If set to true, this will print all headers for each @code{\score}
965 in the output. Normally only the @code{piece} and @code{opus}
966 header variables are printed. Default: @code{#f}.
968 @item system-separator-markup
969 @funindex system-separator-markup
971 A markup object that is inserted between systems, often used for
972 orchestral scores. Default: unset. The @code{\slashSeparator}
973 markup, defined in @file{ly/titling-init.ly}, is provided as a
974 sensible default, for example:
976 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
977 #(set-default-paper-size "a8")
981 system-separator-markup = \slashSeparator
987 \relative c'' { c1 \break c1 \break c1 }
997 @file{ly/titling-init.ly}.
1005 The default page header puts the page number and the @code{instrument}
1006 field from the @code{\header} block on a line.
1010 @section Score layout
1012 This section discusses score layout options for the @code{\layout}
1016 * The \layout block::
1017 * Setting the staff size::
1021 @node The \layout block
1022 @subsection The @code{\layout} block
1026 While the @code{\paper} block contains settings that relate to the
1027 page formatting of the whole document, the @code{\layout} block
1028 contains settings for score-specific layout. To set score layout
1029 options globally, enter them in a toplevel @code{\layout} block.
1030 To set layout options for an individual score, enter them in a
1031 @code{\layout} block inside the @code{\score} block, after the
1032 music. Settings that can appear in a @code{\layout} block
1036 @item the @code{layout-set-staff-size} scheme function,
1037 @item context modifications in @code{\context} blocks, and
1038 @item @code{\paper} variables that affect score layout.
1041 The @code{layout-set-staff-size} function is discussed in the next
1042 section, @ref{Setting the staff size}. Context modifications are
1043 discussed in a separate chapter; see
1044 @ref{Modifying context plug-ins} and
1045 @ref{Changing context default settings}. The @code{\paper}
1046 variables that can appear in a @code{\layout} block are:
1051 @code{line-width}, @code{ragged-right} and @code{ragged-last}
1052 (see @ref{\paper variables for widths and margins})
1055 @code{indent} and @code{short-indent}
1056 (see @ref{\paper variables for shifts and indents})
1060 (see @ref{\paper variables for line breaking})
1064 Here is an example @code{\layout} block:
1071 \override StaffGrouper #'staff-staff-spacing #'basic-distance = #8
1075 \override TextScript #'padding = #1
1076 \override Glissando #'thickness = #3
1084 @ref{Changing context default settings}.
1090 @node Setting the staff size
1091 @subsection Setting the staff size
1093 @cindex font size, setting
1094 @cindex staff size, setting
1095 @funindex layout file
1097 The default @strong{staff size} is set to 20 points.
1098 This may be changed in two ways:
1100 To set the staff size globally for all scores in a file (or
1101 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
1104 #(set-global-staff-size 14)
1108 This sets the global default size to 14pt staff height and scales all
1111 To set the staff size individually for each score, use
1116 #(layout-set-staff-size 15)
1121 The Feta font provides musical symbols at eight different
1122 sizes. Each font is tuned for a different staff size: at a smaller size
1123 the font becomes heavier, to match the relatively heavier staff lines.
1124 The recommended font sizes are listed in the following table:
1127 @multitable @columnfractions .15 .2 .22 .2
1130 @tab @b{staff height (pt)}
1131 @tab @b{staff height (mm)}
1173 @c modern rental material?
1178 These fonts are available in any sizes. The context property
1179 @code{fontSize} and the layout property @code{staff-space} (in
1180 @rinternals{StaffSymbol}) can be used to tune the size for individual
1181 staves. The sizes of individual staves are relative to the global size.
1186 @ref{Selecting notation font size}.
1194 @code{layout-set-staff-size} does not change the distance between the
1204 * Optimal page breaking::
1205 * Optimal page turning::
1206 * Minimal page breaking::
1208 * Using an extra voice for breaks::
1213 @subsection Line breaking
1216 @cindex breaking lines
1218 Line breaks are normally determined automatically. They are chosen
1219 so that lines look neither cramped nor loose, and consecutive
1220 lines have similar density.
1222 To manually force a line break at a bar line, use the
1223 @code{\break} command:
1225 @lilypond[quote,ragged-right,relative=2,verbatim]
1230 By default, a @code{\break} in the middle of a measure is ignored,
1231 and a warning is printed. To force a line break in the middle of
1232 a measure, add an invisible bar line with @w{@samp{\bar ""}}:
1234 @lilypond[quote,ragged-right,relative=2,verbatim]
1241 A @code{\break} occurring at a bar line is also ignored if the
1242 previous measure ends in the middle of a note, such as when a
1243 tuplet begins and ends in different measures. To allow
1244 @code{\break} commands to work in these situations, remove the
1245 @code{Forbid_line_break_engraver} from the @code{Voice} context.
1246 Note that manually forced line breaks have to be added in parallel
1249 @lilypond[quote,ragged-right,verbatim]
1251 \remove Forbid_line_break_engraver
1254 { c2. \times 2/3 { c4 c c } c2. | }
1255 { s1 | \break s1 | }
1260 Similarly, line breaks are normally forbidden when beams cross bar
1261 lines. This behavior can be changed by setting
1262 @code{\override Beam #'breakable = ##t}:
1264 @lilypond[quote,ragged-right,relative=2,verbatim]
1265 \override Beam #'breakable = ##t
1270 The @code{\noBreak} command forbids a line break at the bar line
1271 where it is inserted.
1273 The most basic settings influencing line spacing are @code{indent}
1274 and @code{line-width}. They are set in the @code{\layout} block.
1275 They control the indentation of the first line of music, and the
1276 lengths of the lines.
1278 If @code{ragged-right} is set to true in the @code{\layout} block,
1279 then systems end at their natural horizontal length, instead of
1280 being spread horizontally to fill the whole line. This is useful
1281 for short fragments, and for checking how tight the natural
1284 @c TODO Check and add para on default for ragged-right
1286 The option @code{ragged-last} is similar to @code{ragged-right},
1287 but affects only the last line of the piece.
1299 @cindex regular line breaks
1300 @cindex four bar music.
1302 For line breaks at regular intervals use @code{\break} separated by
1303 skips and repeated with @code{\repeat}. For example, this would
1304 cause the following 28 measures (assuming 4/4 time) to be broken
1305 every 4 measures, and only there:
1310 s1 \noBreak s1 \noBreak
1311 s1 \noBreak s1 \break
1313 @{ @var{the actual music@dots{}} @}
1318 A linebreaking configuration can be saved as a @file{.ly} file
1319 automatically. This allows vertical alignments to be stretched to
1320 fit pages in a second formatting run. This is fairly new and
1321 complicated. More details are available in
1335 @ref{\paper variables for line breaking}.
1340 Internals Reference:
1341 @rinternals{LineBreakEvent}.
1345 @subsection Page breaking
1347 The default page breaking may be overridden by inserting
1348 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1349 analogous to @code{\break} and @code{\noBreak}. They should be
1350 inserted at a bar line. These commands force and forbid a page-break
1351 from happening. Of course, the @code{\pageBreak} command also forces
1354 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1355 inserted at top-level, between scores and top-level markups.
1357 There are also analogous settings to @code{ragged-right} and
1358 @code{ragged-last} which have the same effect on vertical spacing:
1359 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1360 @code{#t} the systems on all pages or just the last page
1361 respectively will not be justified vertically. See
1362 @ref{Fixed vertical spacing \paper variables}.
1364 Page breaks are computed by the @code{page-breaking} function. LilyPond
1365 provides three algorithms for computing page breaks,
1366 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1367 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1368 but the value can be changed in the @code{\paper} block:
1372 page-breaking = #ly:page-turn-breaking
1378 When a book has many scores and pages, the page breaking problem may be
1379 difficult to solve, requiring large processing time and memory. To ease
1380 the page breaking process, @code{\bookpart} blocks are used to divide
1381 the book into several parts: the page breaking occurs separately on each
1382 part. Different page breaking functions may also be used in different
1388 subtitle = "Preface"
1391 %% In a part consisting mostly of text,
1392 %% ly:minimal-breaking may be preferred
1393 page-breaking = #ly:minimal-breaking
1395 \markup @{ @dots{} @}
1399 %% In this part, consisting of music, the default optimal
1400 %% page breaking function is used.
1402 subtitle = "First movement"
1404 \score @{ @dots{} @}
1411 @funindex \pageBreak
1413 @funindex \noPageBreak
1414 @code{\noPageBreak}.
1420 @ref{\paper variables for page breaking}.
1426 @node Optimal page breaking
1427 @subsection Optimal page breaking
1429 @funindex ly:optimal-breaking
1431 The @code{ly:optimal-breaking} function is LilyPond's default method of
1432 determining page breaks. It attempts to find a page breaking that minimizes
1433 cramping and stretching, both horizontally and vertically. Unlike
1434 @code{ly:page-turn-breaking}, it has no concept of page turns.
1442 @node Optimal page turning
1443 @subsection Optimal page turning
1445 @funindex ly:page-turn-breaking
1447 Often it is necessary to find a page breaking configuration so that there is
1448 a rest at the end of every second page. This way, the musician can turn the
1449 page without having to miss notes. The @code{ly:page-turn-breaking} function
1450 attempts to find a page breaking minimizing cramping and stretching, but with
1451 the additional restriction that it is only allowed to introduce page turns
1452 in specified places.
1454 There are two steps to using this page breaking function. First, you
1455 must enable it in the @code{\paper} block, as explained in @ref{Page
1456 breaking}. Then you must tell the function where you would like to allow
1459 There are two ways to achieve the second step. First, you can specify each
1460 potential page turn manually, by inserting @code{\allowPageTurn} into your
1461 input file at the appropriate places.
1463 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1464 Voice context. The @code{Page_turn_engraver} will scan the context for
1465 sections without notes (note that it does not scan for rests; it scans for
1466 the absence of notes. This is so that single-staff polyphony with rests in one
1467 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1468 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1469 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1470 there is a @q{special} bar line (such as a double bar), in which case the
1471 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1474 @funindex minimumPageTurnLength
1475 The @code{Page_turn_engraver} reads the context property
1476 @code{minimumPageTurnLength} to determine how long a note-free section must
1477 be before a page turn is considered. The default value for
1478 @code{minimumPageTurnLength} is @code{(ly:make-moment 1 1)}. If you want
1479 to disable page turns, you can set it to something very large.
1482 \new Staff \with @{ \consists "Page_turn_engraver" @}
1485 R1 | % a page turn will be allowed here
1487 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1488 R1 | % a page turn will not be allowed here
1490 R1*2 | % a page turn will be allowed here
1495 @funindex minimumRepeatLengthForPageTurn
1496 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1497 turn during the repeat if there is enough time at the beginning and end of the
1498 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1499 page turns if the repeat is very short. If you set the context property
1500 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1501 only allow turns in repeats whose duration is longer than this value.
1503 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1504 @code{\allowPageTurn}, may also be used at top-level, between scores and
1511 @funindex \noPageTurn
1513 @funindex \allowPageTurn
1514 @code{\allowPageTurn}.
1525 There should only be one @code{Page_turn_engraver} in a score. If there is more
1526 than one, they will interfere with each other.
1529 @node Minimal page breaking
1530 @subsection Minimal page breaking
1532 @funindex ly:minimal-breaking
1534 The @code{ly:minimal-breaking} function performs minimal computations to
1535 calculate the page breaking: it fills a page with as many systems as
1536 possible before moving to the next one. Thus, it may be preferred for
1537 scores with many pages, where the other page breaking functions could be
1538 too slow or memory demanding, or a lot of texts. It is enabled using:
1542 page-breaking = #ly:minimal-breaking
1552 @node Explicit breaks
1553 @subsection Explicit breaks
1555 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1556 commands. There are two commands to override this behavior:
1559 \override NonMusicalPaperColumn #'line-break-permission = ##f
1560 \override NonMusicalPaperColumn #'page-break-permission = ##f
1563 When @code{line-break-permission} is overridden to false, Lily will insert
1564 line breaks at explicit @code{\break} commands and nowhere else. When
1565 @code{page-break-permission} is overridden to false, Lily will insert
1566 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1568 @lilypond[quote,verbatim]
1575 music = \relative c'' { c8 c c c }
1579 \repeat unfold 2 { \music } \break
1580 \repeat unfold 4 { \music } \break
1581 \repeat unfold 6 { \music } \break
1582 \repeat unfold 8 { \music } \pageBreak
1583 \repeat unfold 8 { \music } \break
1584 \repeat unfold 6 { \music } \break
1585 \repeat unfold 4 { \music } \break
1586 \repeat unfold 2 { \music }
1591 \override NonMusicalPaperColumn #'line-break-permission = ##f
1592 \override NonMusicalPaperColumn #'page-break-permission = ##f
1604 @node Using an extra voice for breaks
1605 @subsection Using an extra voice for breaks
1607 Line- and page-breaking information usually appears within note entry directly.
1610 music = \relative c'' @{ c4 c c c @}
1614 \repeat unfold 2 @{ \music @} \break
1615 \repeat unfold 3 @{ \music @}
1620 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1621 music entry with information that specifies how music should lay out
1622 on the page. You can keep music entry and line- and page-breaking
1623 information in two separate places by introducing an extra voice to
1624 contain the breaks. This extra voice
1625 contains only skips together with @code{\break}, @code{pageBreak} and other
1626 breaking layout information.
1628 @lilypond[quote,verbatim]
1629 music = \relative c'' { c4 c c c }
1640 \repeat unfold 2 { \music }
1641 \repeat unfold 3 { \music }
1642 \repeat unfold 6 { \music }
1643 \repeat unfold 5 { \music }
1649 This pattern becomes especially helpful when overriding
1650 @code{line-break-system-details} and the other useful but long properties of
1651 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1653 @lilypond[quote,verbatim]
1654 music = \relative c'' { c4 c c c }
1659 \overrideProperty "Score.NonMusicalPaperColumn"
1660 #'line-break-system-details #'((Y-offset . 0))
1663 \overrideProperty "Score.NonMusicalPaperColumn"
1664 #'line-break-system-details #'((Y-offset . 35))
1667 \overrideProperty "Score.NonMusicalPaperColumn"
1668 #'line-break-system-details #'((Y-offset . 70))
1671 \overrideProperty "Score.NonMusicalPaperColumn"
1672 #'line-break-system-details #'((Y-offset . 105))
1676 \repeat unfold 2 { \music }
1677 \repeat unfold 3 { \music }
1678 \repeat unfold 6 { \music }
1679 \repeat unfold 5 { \music }
1688 @ref{Vertical spacing}.
1694 @node Vertical spacing
1695 @section Vertical spacing
1697 @cindex vertical spacing
1698 @cindex spacing, vertical
1700 Vertical spacing is controlled by three things: the amount of
1701 space available (i.e., paper size and margins), the amount of
1702 space between systems, and the amount of space between
1703 staves inside a system.
1706 * Flexible vertical spacing within systems::
1707 * Explicit staff and system positioning::
1708 * Vertical collision avoidance::
1712 @node Flexible vertical spacing within systems
1713 @subsection Flexible vertical spacing within systems
1715 @cindex distance between staves
1716 @cindex staff distance
1717 @cindex space between staves
1718 @cindex space inside systems
1720 Three separate mechanisms control the flexible vertical spacing
1721 within systems, one for each of the following categories:
1726 @emph{ungrouped staves},
1729 @emph{grouped staves} (staves within a staff-group such as
1730 @code{ChoirStaff}, etc.), and
1733 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1738 @c TODO: Clarify this. This almost implies that non-staff lines
1739 @c have NO effect on the spacing between staves. -mp
1741 The height of each system is determined in two steps. First, all
1742 of the staves are spaced according to the amount of space
1743 available. Then, the non-staff lines are distributed between the
1746 Note that the spacing mechanisms discussed in this section only
1747 control the vertical spacing of staves and non-staff lines within
1748 individual systems. The vertical spacing between separate
1749 systems, scores, markups, and margins is controlled by
1750 @code{\paper} variables, which are discussed in
1751 @ref{Flexible vertical spacing \paper variables}.
1754 * Within-system spacing properties::
1755 * Spacing of ungrouped staves::
1756 * Spacing of grouped staves::
1757 * Spacing of non-staff lines::
1761 @node Within-system spacing properties
1762 @unnumberedsubsubsec Within-system spacing properties
1764 @funindex staff-affinity
1765 @funindex staffgroup-staff-spacing
1766 @funindex staff-staff-spacing
1767 @funindex nonstaff-unrelatedstaff-spacing
1768 @funindex nonstaff-relatedstaff-spacing
1769 @funindex nonstaff-nonstaff-spacing
1770 @funindex default-staff-staff-spacing
1771 @funindex minimum-Y-extent
1772 @funindex extra-offset
1773 @funindex self-alignment-X
1775 @funindex VerticalAxisGroup
1777 The within-system vertical spacing mechanisms are controlled by
1778 two sets of grob properties. The first set is associated with the
1779 @code{VerticalAxisGroup} grob, which is created by all staves and
1780 non-staff lines. The second set is associated with the
1781 @code{StaffGrouper} grob, which can be created by staff-groups,
1782 but only if explicitly called. These properties are described
1783 individually at the end of this section.
1785 The names of these properties (except for @code{staff-affinity})
1786 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1787 @code{@var{item1}} and @code{@var{item2}} are the items to be
1788 spaced. Note that @code{@var{item2}} is not necessarily below
1789 @code{@var{item1}}; for example,
1790 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1791 non-staff line if @code{staff-affinity} is @code{UP}.
1793 Each distance is measured between the @emph{reference points} of
1794 the two items. The reference point for a staff is the vertical
1795 center of its @code{StaffSymbol} (i.e. the middle line if
1796 @code{line-count} is odd; the middle space if @code{line-count} is
1797 even). The reference points for individual non-staff lines are
1798 given in the following table:
1800 @multitable {Non-staff line} {Reference point}
1801 @headitem Non-staff line @tab Reference point
1802 @item @code{ChordNames} @tab baseline
1803 @item @code{NoteNames} @tab baseline
1804 @item @code{Lyrics} @tab baseline
1805 @item @code{Dynamics} @tab vertical center
1806 @item @code{FiguredBass} @tab highest point
1807 @item @code{FretBoards} @tab top line
1810 In the following image, horizontal lines indicate the positions
1811 of these reference points:
1813 @lilypond[quote,noragged-right,line-width=110\mm]
1814 #(define zero-space '((padding . -inf.0) (basic-distance . 0)))
1816 alignToZero = \with {
1817 \override VerticalAxisGroup #'nonstaff-relatedstaff-spacing = #zero-space
1818 \override VerticalAxisGroup #'nonstaff-nonstaff-spacing = #zero-space
1820 lowerCaseChords = \with {
1821 chordNameLowercaseMinor = ##t
1823 staffAffinityDown = \with {
1824 \override VerticalAxisGroup #'staff-affinity = #DOWN
1827 #(define-music-function
1828 (parser location context)
1830 #{ s1*0^\markup { \typewriter #context } #})
1833 \context { \Dynamics \alignToZero }
1834 \context { \FiguredBass \alignToZero }
1835 \context { \Lyrics \alignToZero }
1836 \context { \NoteNames \alignToZero \staffAffinityDown }
1837 \context { \ChordNames \alignToZero
1840 \context { \FretBoards \alignToZero \staffAffinityDown }
1842 \override BarLine #'stencil = ##f
1843 \override DynamicText #'self-alignment-X = #-1
1844 \override FretBoard #'X-offset = #1.75
1845 \override InstrumentName #'minimum-Y-extent = #'(-2 . 2)
1846 \override InstrumentName #'extra-offset = #'(0 . -0.5)
1847 \override TextScript #'minimum-Y-extent = #'(-2 . 3)
1848 \override TimeSignature #'stencil = ##f
1852 %% These contexts have reference points at the baseline:
1853 %% ChordNames, NoteNames, and Lyrics
1855 \new ChordNames { \chords { g1:m } }
1856 \new NoteNames { s1 | g1 | }
1857 \new RhythmicStaff {
1858 \set RhythmicStaff.instrumentName = #"baseline "
1860 \labelContext "ChordNames " s1 |
1861 \labelContext "NoteNames " s1 |
1862 \labelContext "Lyrics" s1 |
1864 \new Lyrics { \lyrics { \skip 1*2 | ghijk1 | } }
1867 %% The reference point for Dynamics is its vertical center
1869 \new RhythmicStaff {
1870 \set RhythmicStaff.instrumentName = #"vertical center "
1871 \labelContext "Dynamics" s1*3
1873 \new Dynamics { s1\mp s\fp }
1876 %% The reference point for FiguredBass is its highest point
1878 \new RhythmicStaff {
1879 \set RhythmicStaff.instrumentName = #"highest point "
1880 \labelContext "FiguredBass" s1
1882 \new FiguredBass { \figuremode { <6 5>1 } }
1885 %% The reference point for FretBoards is the top line
1886 \include "predefined-guitar-fretboards.ly"
1888 \new FretBoards { \chordmode { e1 } }
1889 \new RhythmicStaff {
1890 \set RhythmicStaff.instrumentName = #"top line "
1891 \labelContext "FretBoards " s1
1896 Each of the vertical spacing grob properties (except
1897 @code{staff-affinity}) uses the same alist structure as the
1898 @code{\paper} spacing variables discussed in
1899 @ref{Flexible vertical spacing \paper variables}. Specific methods
1900 for modifying alists are discussed in @ref{Modifying alists}.
1901 Grob properties should be adjusted with an @code{\override} inside
1902 a @code{\score} or @code{\layout} block, and not inside a
1903 @code{\paper} block.
1905 The following example demonstrates the two ways these alists can
1906 be modified. The first declaration updates one key-value
1907 individually, and the second completely re-defines the property:
1911 \override VerticalAxisGroup #'default-staff-staff-spacing
1912 #'basic-distance = #10
1916 \override VerticalAxisGroup #'default-staff-staff-spacing =
1917 #'((basic-distance . 10)
1918 (minimum-distance . 9)
1920 (stretchability . 10))
1924 To change any spacing settings globally, put them in the
1925 @code{\layout} block:
1931 \override VerticalAxisGroup #'default-staff-staff-spacing
1932 #'basic-distance = #10
1937 Standard settings for the vertical spacing grob properties are
1938 listed in @rinternals{VerticalAxisGroup} and
1939 @rinternals{StaffGrouper}. Default overrides for specific types
1940 of non-staff lines are listed in the relevant context descriptions
1941 in @rinternals{Contexts}.
1944 @subsubheading Properties of the @code{VerticalAxisGroup} grob
1946 @code{VerticalAxisGroup} properties are typically adjusted with an
1947 @code{\override} at the @code{Staff} level (or equivalent).
1950 @item staff-staff-spacing
1952 Used to determine the distance between the current staff and the
1953 staff just below it in the same system, even if one or more
1954 non-staff lines (such as @code{Lyrics}) are placed between the two
1955 staves. Does not apply to the bottom staff of a system.
1957 Initially, the @code{staff-staff-spacing} of a
1958 @code{VerticalAxisGroup} is a Scheme function that applies the
1959 properties of the @code{StaffGrouper} if the staff is part of a
1960 group, or the @code{default-staff-staff-spacing} of the staff
1961 otherwise. This allows staves to be spaced differently when they
1962 are grouped. For uniform spacing regardless of grouping, this
1963 function may be replaced by a flexible-spacing alist, using the
1964 complete-redefinition form of override shown above.
1966 @item default-staff-staff-spacing
1967 A flexible-spacing alist defining the @code{staff-staff-spacing} used for
1968 ungrouped staves, unless @code{staff-staff-spacing} has been explicitly
1969 set with an @code{\override}.
1971 @item staff-affinity
1972 The direction of the staff to use for spacing the current
1973 non-staff line. Choices are @code{UP}, @code{DOWN}, and
1974 @code{CENTER}. If @code{CENTER}, the non-staff line will be
1975 placed equidistant between the two nearest staves on either side,
1976 unless collisions or other spacing constraints prevent this.
1977 Adjacent non-staff lines should have non-increasing
1978 @code{staff-affinity} from top to bottom, e.g. a non-staff line
1979 set to @code{UP} should not immediately follow one that is set to
1980 @code{DOWN}. Non-staff lines at the top of a system should use
1981 @code{DOWN}; those at the bottom should use @code{UP}. Setting
1982 @code{staff-affinity} for a staff causes it to be treated as a
1983 non-staff line. Setting @code{staff-affinity} to @code{#f} causes
1984 a non-staff line to be treated as a staff. Setting
1985 @code{staff-affinity} to @code{UP}, @code{CENTER}, or @code{DOWN}
1986 causes a staff to be spaced as a non-staff line.
1988 @item nonstaff-relatedstaff-spacing
1989 The distance between the current non-staff line and the nearest
1990 staff in the direction of @code{staff-affinity}, if there are no
1991 non-staff lines between the two, and @code{staff-affinity} is
1992 either @code{UP} or @code{DOWN}. If @code{staff-affinity} is
1993 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
1994 for the nearest staves on @emph{both} sides, even if other
1995 non-staff lines appear between the current one and either of the
1996 staves. This means that the placement of a non-staff line depends
1997 on both the surrounding staves and the surrounding non-staff lines.
1998 Setting the @code{stretchability} of one of these types of spacing to
1999 a small value will make that spacing dominate. Setting the
2000 @code{stretchability} to a large value will make that spacing have
2003 @item nonstaff-nonstaff-spacing
2004 The distance between the current non-staff line and the next
2005 non-staff line in the direction of @code{staff-affinity}, if both
2006 are on the same side of the related staff, and
2007 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
2009 @item nonstaff-unrelatedstaff-spacing
2010 The distance between the current non-staff line and the staff in
2011 the opposite direction from @code{staff-affinity}, if there are no
2012 other non-staff lines between the two, and @code{staff-affinity}
2013 is either @code{UP} or @code{DOWN}. This can be used, for
2014 example, to require a minimum amount of padding between a
2015 @code{Lyrics} line and the staff to which it does not belong.
2019 @subsubheading Properties of the @code{StaffGrouper} grob
2021 @code{StaffGrouper} properties are typically adjusted with an
2022 @code{\override} at the @code{StaffGroup} level (or equivalent).
2025 @item staff-staff-spacing
2026 The distance between consecutive staves within the current
2027 staff-group. The @code{staff-staff-spacing} property of an
2028 individual staff's @code{VerticalAxisGroup} grob can be
2029 overriden with different spacing settings for that staff.
2031 @item staffgroup-staff-spacing
2032 The distance between the last staff of the current staff-group and
2033 the staff just below it in the same system, even if one or more
2034 non-staff lines (such as @code{Lyrics}) exist between the two
2035 staves. Does not apply to the bottom staff of a system. The
2036 @code{staff-staff-spacing} property of an individual staff's
2037 @code{VerticalAxisGroup} grob can be overriden with different
2038 spacing settings for that staff.
2043 @ref{Flexible vertical spacing \paper variables},
2044 @ref{Modifying alists}.
2046 Internals Reference:
2047 @rinternals{Contexts},
2048 @rinternals{VerticalAxisGroup},
2049 @rinternals{StaffGrouper}.
2052 @file{ly/engraver-init.ly},
2053 @file{scm/define-grobs.scm}.
2056 @node Spacing of ungrouped staves
2057 @unnumberedsubsubsec Spacing of ungrouped staves
2059 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
2060 @code{TabStaff}, etc.) are contexts that can contain one or more
2061 voice contexts, but cannot contain any other staves.
2063 The following properties affect the spacing of @emph{ungrouped}
2067 @item @code{VerticalAxisGroup} properties:
2069 @item @code{default-staff-staff-spacing}
2070 @item @code{staff-staff-spacing}
2074 These grob properties are described individually above; see
2075 @ref{Within-system spacing properties}.
2077 Additional properties are involved for staves that are part of a
2078 staff-group; see @ref{Spacing of grouped staves}.
2080 The following example shows how the @code{default-staff-staff-spacing}
2081 property can affect the spacing of ungrouped staves.
2082 The same overrides applied to @code{staff-staff-spacing} would
2083 have the same effect, but would also apply in cases where the staves
2084 are combined in a group or groups.
2086 @lilypond[verbatim,quote,staffsize=16]
2090 \override VerticalAxisGroup #'default-staff-staff-spacing =
2091 #'((basic-distance . 8)
2092 (minimum-distance . 7)
2098 % The very low note here needs more room than 'basic-distance
2099 % can provide, so the distance between this staff and the next
2100 % is determined by 'padding.
2101 \new Staff { b,2 r | }
2103 % Here, 'basic-distance provides enough room, and there is no
2104 % need to compress the space (towards 'minimum-distance) to make
2105 % room for anything else on the page, so the distance between
2106 % this staff and the next is determined by 'basic-distance.
2107 \new Staff { \clef bass g2 r | }
2109 % By setting 'padding to a negative value, staves can be made to
2110 % collide. The lowest acceptable value for 'basic-distance is 0.
2112 \override VerticalAxisGroup #'default-staff-staff-spacing =
2113 #'((basic-distance . 3.5)
2115 } { \clef bass g2 r | }
2116 \new Staff { \clef bass g2 r | }
2122 @file{scm/define-grobs.scm}.
2127 Internals Reference:
2128 @rinternals{VerticalAxisGroup}.
2131 @node Spacing of grouped staves
2132 @unnumberedsubsubsec Spacing of grouped staves
2134 In orchestral and other large scores, it is common to place staves
2135 in groups. The space between groups is typically larger than the
2136 space between staves of the same group.
2138 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2139 etc.) are contexts that can contain one or more staves
2142 The following properties affect the spacing of staves inside
2146 @item @code{VerticalAxisGroup} properties:
2148 @item @code{staff-staff-spacing}
2150 @item @code{StaffGrouper} properties:
2152 @item @code{staff-staff-spacing}
2153 @item @code{staffgroup-staff-spacing}
2157 These grob properties are described individually above; see
2158 @ref{Within-system spacing properties}.
2160 The following example shows how properties of the
2161 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2163 @lilypond[verbatim,quote,staffsize=16]
2167 \override StaffGrouper #'staff-staff-spacing #'padding = #0
2168 \override StaffGrouper #'staff-staff-spacing #'basic-distance = #1
2173 \new PianoStaff \with {
2174 \override StaffGrouper #'staffgroup-staff-spacing #'basic-distance = #20
2189 @file{scm/define-grobs.scm}.
2194 Internals Reference:
2195 @rinternals{VerticalAxisGroup},
2196 @rinternals{StaffGrouper}.
2199 @node Spacing of non-staff lines
2200 @unnumberedsubsubsec Spacing of non-staff lines
2202 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2203 etc.) are contexts whose layout objects are engraved like staves
2204 (i.e. in horizontal lines within systems). Specifically,
2205 non-staff lines are non-staff contexts that create the
2206 @code{VerticalAxisGroup} layout object.
2208 The following properties affect the spacing of non-staff lines:
2211 @item @code{VerticalAxisGroup} properties:
2213 @item @code{staff-affinity}
2214 @item @code{nonstaff-relatedstaff-spacing}
2215 @item @code{nonstaff-nonstaff-spacing}
2216 @item @code{nonstaff-unrelatedstaff-spacing}
2220 These grob properties are described individually above; see
2221 @ref{Within-system spacing properties}.
2223 The following example shows how the
2224 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2225 of consecutive non-staff lines. Here, by setting the
2226 @code{stretchability} key to a very high value, the lyrics are
2227 able to stretch much more than usual:
2229 @lilypond[verbatim,quote,staffsize=16]
2233 \override VerticalAxisGroup
2234 #'nonstaff-nonstaff-spacing #'stretchability = #1000
2241 \override VerticalAxisGroup #'staff-staff-spacing = #'((basic-distance . 30))
2244 \override VerticalAxisGroup #'staff-affinity = #UP
2247 \override VerticalAxisGroup #'staff-affinity = #CENTER
2248 } \lyricmode { center }
2250 \override VerticalAxisGroup #'staff-affinity = #DOWN
2251 } \lyricmode { down }
2259 @file{ly/engraver-init.ly},
2260 @file{scm/define-grobs.scm}.
2265 @c @lsr{spacing,page-spacing.ly},
2266 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2268 Internals Reference:
2269 @rinternals{Contexts},
2270 @rinternals{VerticalAxisGroup}.
2273 @node Explicit staff and system positioning
2274 @subsection Explicit staff and system positioning
2276 One way to understand the flexible vertical spacing mechanisms
2277 explained above is as a collection of settings that control the
2278 amount of vertical padding between staves and systems.
2280 It is possible to approach vertical spacing in a different way
2281 using @code{NonMusicalPaperColumn #'line-break-system-details}.
2282 While the flexible vertical spacing mechanisms specify vertical
2283 padding, @code{NonMusicalPaperColumn #'line-break-system-details}
2284 can specify exact vertical positions on the page.
2286 @code{NonMusicalPaperColumn #'line-break-system-details} accepts
2287 an associative list of three different settings:
2290 @item @code{X-offset}
2291 @item @code{Y-offset}
2292 @item @code{alignment-distances}
2295 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2296 below, can occur in any of three different places in an input file:
2299 @item in the middle of note entry directly
2300 @item in a @code{\context} block
2301 @item in the @code{\with} block
2304 When we override @code{NonMusicalPaperColumn}, we use the usual
2305 @code{\override} command in @code{\context} blocks and in the
2306 @code{\with} block. On the other hand, when we override
2307 @code{NonMusicalPaperColumn} in the middle of note entry,
2308 use the special @code{\overrideProperty} command. Here are some
2309 example @code{NonMusicalPaperColumn} overrides with the special
2310 @code{\overrideProperty} command:
2313 \overrideProperty NonMusicalPaperColumn
2314 #'line-break-system-details #'((X-offset . 20))
2316 \overrideProperty NonMusicalPaperColumn
2317 #'line-break-system-details #'((Y-offset . 40))
2319 \overrideProperty NonMusicalPaperColumn
2320 #'line-break-system-details #'((X-offset . 20)
2323 \overrideProperty NonMusicalPaperColumn
2324 #'line-break-system-details #'((alignment-distances . (15)))
2326 \overrideProperty NonMusicalPaperColumn
2327 #'line-break-system-details #'((X-offset . 20)
2329 (alignment-distances . (15)))
2332 To understand how each of these different settings work, we begin
2333 by looking at an example that includes no overrides at all.
2335 @c \book { } is required in these examples to ensure the spacing
2336 @c overrides can be seen between systems. -np
2338 @lilypond[verbatim,quote,staffsize=16]
2339 \header { tagline = ##f }
2340 \paper { left-margin = 0\mm }
2350 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2353 \repeat unfold 15 { d'4 d' d' d' }
2360 This score isolates line- and page-breaking information in a dedicated
2361 voice. This technique of creating a breaks voice will help keep layout
2362 separate from music entry as our example becomes more complicated.
2363 See @ref{Using an extra voice for breaks}.
2365 Explicit @code{\breaks} evenly divide the music into six measures per
2366 line. Vertical spacing results from LilyPond's defaults. To set
2367 the vertical startpoint of each system explicitly, we can set
2368 the @code{Y-offset} pair in the @code{line-break-system-details}
2369 attribute of the @code{NonMusicalPaperColumn} grob:
2371 @lilypond[verbatim,quote,staffsize=16]
2372 \header { tagline = ##f }
2373 \paper { left-margin = 0\mm }
2379 \overrideProperty #"Score.NonMusicalPaperColumn"
2380 #'line-break-system-details #'((Y-offset . 0))
2382 \overrideProperty #"Score.NonMusicalPaperColumn"
2383 #'line-break-system-details #'((Y-offset . 40))
2385 \overrideProperty #"Score.NonMusicalPaperColumn"
2386 #'line-break-system-details #'((Y-offset . 80))
2389 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2392 \repeat unfold 15 { d'4 d' d' d' }
2399 Note that @code{line-break-system-details} takes an associative list of
2400 potentially many values, but that we set only one value here. Note,
2401 too, that the @code{Y-offset} property here determines the exact vertical
2402 position on the page at which each new system will render.
2404 Now that we have set the vertical startpoint of each system
2405 explicitly, we can also set the vertical distances between staves
2406 within each system manually. We do this using the @code{alignment-distances}
2407 subproperty of @code{line-break-system-details}.
2409 @lilypond[verbatim,quote,staffsize=16]
2410 \header { tagline = ##f }
2411 \paper { left-margin = 0\mm }
2417 \overrideProperty #"Score.NonMusicalPaperColumn"
2418 #'line-break-system-details #'((Y-offset . 20)
2419 (alignment-distances . (15)))
2421 \overrideProperty #"Score.NonMusicalPaperColumn"
2422 #'line-break-system-details #'((Y-offset . 60)
2423 (alignment-distances . (15)))
2425 \overrideProperty #"Score.NonMusicalPaperColumn"
2426 #'line-break-system-details #'((Y-offset . 100)
2427 (alignment-distances . (15)))
2430 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2433 \repeat unfold 15 { d'4 d' d' d' }
2440 Note that here we assign two different values to the
2441 @code{line-break-system-details} attribute of the
2442 @code{NonMusicalPaperColumn} grob. Though the
2443 @code{line-break-system-details} attribute alist accepts many
2444 additional spacing parameters (including, for example, a corresponding
2445 @code{X-offset} pair), we need only set the @code{Y-offset} and
2446 @code{alignment-distances} pairs to control the vertical startpoint of
2447 every system and every staff. Finally, note that @code{alignment-distances}
2448 specifies the vertical positioning of staves but not of staff groups.
2450 @lilypond[verbatim,quote,staffsize=16]
2451 \header { tagline = ##f }
2452 \paper { left-margin = 0\mm }
2458 \overrideProperty #"Score.NonMusicalPaperColumn"
2459 #'line-break-system-details #'((Y-offset . 0)
2460 (alignment-distances . (30 10)))
2462 \overrideProperty #"Score.NonMusicalPaperColumn"
2463 #'line-break-system-details #'((Y-offset . 60)
2464 (alignment-distances . (10 10)))
2466 \overrideProperty #"Score.NonMusicalPaperColumn"
2467 #'line-break-system-details #'((Y-offset . 100)
2468 (alignment-distances . (10 30)))
2471 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2474 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2475 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2482 Some points to consider:
2485 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2486 do not count as a staff.
2488 @item The units of the numbers passed to @code{X-offset},
2489 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2490 of the distance between adjacent staff lines. Positive values move staves
2491 and lyrics up, negative values move staves and lyrics down.
2493 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
2494 settings given here allow the positioning of staves and systems anywhere
2495 on the page, it is possible to violate paper or margin boundaries or even
2496 to print staves or systems on top of one another. Reasonable values
2497 passed to these different settings will avoid this.
2506 @node Vertical collision avoidance
2507 @subsection Vertical collision avoidance
2509 @funindex outside-staff-priority
2510 @funindex outside-staff-padding
2511 @funindex outside-staff-horizontal-padding
2513 Intuitively, there are some objects in musical notation that belong
2514 to the staff and there are other objects that should be placed outside
2515 the staff. Objects belonging outside the staff include things such as
2516 rehearsal marks, text and dynamic markings (from now on, these will
2517 be called outside-staff objects). LilyPond's rule for the
2518 vertical placement of outside-staff objects is to place them as close
2519 to the staff as possible but not so close that they collide with
2522 LilyPond uses the @code{outside-staff-priority} property to determine
2523 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2524 is a number, the grob is an outside-staff object. In addition,
2525 @code{outside-staff-priority} tells LilyPond in which order the objects
2528 First, LilyPond places all the objects that do not belong outside
2529 the staff. Then it sorts the outside-staff objects according to their
2530 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
2531 takes the outside-staff objects and places them so that they do
2532 not collide with any objects that have already been placed. That
2533 is, if two outside-staff grobs are competing for the same space, the one
2534 with the lower @code{outside-staff-priority} will be placed closer to
2537 @lilypond[quote,ragged-right,relative=2,verbatim]
2540 \once \override TextScript #'outside-staff-priority = #1
2541 c4_"Text"\pp % this time the text will be closer to the staff
2543 % by setting outside-staff-priority to a non-number,
2544 % we disable the automatic collision avoidance
2545 \once \override TextScript #'outside-staff-priority = ##f
2546 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
2547 c4_"Text"\pp % now they will collide
2550 The vertical padding between an outside-staff object and the
2551 previously-positioned grobs can be controlled with
2552 @code{outside-staff-padding}.
2554 @lilypond[quote,ragged-right,relative=2,verbatim]
2555 \once \override TextScript #'outside-staff-padding = #0
2556 a'^"This text is placed very close to the note"
2557 \once \override TextScript #'outside-staff-padding = #3
2558 c^"This text is padded away from the previous text"
2559 c^"This text is placed close to the previous text"
2563 By default, outside-staff objects are placed only to avoid
2564 a horizontal collision with previously-positioned grobs. This
2565 can lead to situations in which objects are placed very close to each
2566 other horizontally. The vertical spacing between staves can
2567 also be set so that outside staff objects are interleaved.
2568 Setting @code{outside-staff-horizontal-padding}
2569 causes an object to be offset vertically so that such a situation
2572 @lilypond[quote,ragged-right,relative=2,verbatim]
2573 % the markup is too close to the following note
2577 % setting outside-staff-horizontal-padding fixes this
2579 \once \override TextScript #'outside-staff-horizontal-padding = #1
2591 @node Horizontal spacing
2592 @section Horizontal spacing
2594 @cindex horizontal spacing
2595 @cindex spacing, horizontal
2598 * Horizontal spacing overview::
2599 * New spacing area::
2600 * Changing horizontal spacing::
2602 * Proportional notation::
2606 @node Horizontal spacing overview
2607 @subsection Horizontal spacing overview
2609 The spacing engine translates differences in durations into stretchable
2610 distances (@q{springs}) of differing lengths. Longer durations get
2611 more space, shorter durations get less. The shortest durations get a
2612 fixed amount of space (which is controlled by
2613 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2614 object). The longer the duration, the more space it gets: doubling a
2615 duration adds a fixed amount (this amount is controlled by
2616 @code{spacing-increment}) of space to the note.
2618 For example, the following piece contains lots of half, quarter, and
2619 8th notes; the eighth note is followed by 1 note head width (NHW).
2620 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2622 @lilypond[quote,verbatim,relative=1]
2623 c2 c4. c8 c4. c8 c4. c8 c8
2627 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2628 approximately the width of a note head, and
2629 @code{shortest-duration-space} is set to 2.0, meaning that the
2630 shortest note gets 2.4 staff space (2.0 times the
2631 @code{spacing-increment}) of horizontal space. This space is counted
2632 from the left edge of the symbol, so the shortest notes are generally
2633 followed by one NHW of space.
2635 If one would follow the above procedure exactly, then adding a single
2636 32nd note to a score that uses 8th and 16th notes, would widen up the
2637 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2638 thus adding 1 NHW to every note. To prevent this, the shortest
2639 duration for spacing is not the shortest note in the score, but rather
2640 the one which occurs most frequently.
2643 The most common shortest duration is determined as follows: in every
2644 measure, the shortest duration is determined. The most common shortest
2645 duration is taken as the basis for the spacing, with the stipulation
2646 that this shortest duration should always be equal to or shorter than
2647 an 8th note. The shortest duration is printed when you run
2648 @code{lilypond} with the @option{--verbose} option.
2650 These durations may also be customized. If you set the
2651 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2652 this sets the base duration for spacing. The maximum duration for this
2653 base (normally an 8th), is set through @code{base-shortest-duration}.
2655 @funindex common-shortest-duration
2656 @funindex base-shortest-duration
2657 @funindex stem-spacing-correction
2660 Notes that are even shorter than the common shortest note are
2661 followed by a space that is proportional to their duration relative to
2662 the common shortest note. So if we were to add only a few 16th notes
2663 to the example above, they would be followed by half a NHW:
2665 @lilypond[quote,verbatim,relative=2]
2666 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2670 In the @emph{Essay on automated music engraving}, it was explained
2671 that stem directions influence spacing (see
2672 @ressay{Optical spacing}). This is controlled with the
2673 @code{stem-spacing-correction} property in the
2674 @rinternals{NoteSpacing}, object. These are generated for every
2675 @rinternals{Voice} context. The @code{StaffSpacing} object
2676 (generated in @rinternals{Staff} context) contains the same
2677 property for controlling the stem/bar line spacing. The following
2678 example shows these corrections, once with default settings, and
2679 once with exaggerated corrections:
2681 @lilypond[quote,ragged-right]
2685 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2686 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2692 Proportional notation is supported; see @ref{Proportional notation}.
2699 Internals Reference:
2700 @rinternals{SpacingSpanner},
2701 @rinternals{NoteSpacing},
2702 @rinternals{StaffSpacing},
2703 @rinternals{NonMusicalPaperColumn}.
2705 Essay on automated music engraving:
2706 @ressay{Optical spacing}.
2711 There is no convenient mechanism to manually override spacing. The
2712 following work-around may be used to insert extra space into a score,
2713 adjusting the padding value as necessary.
2715 \override Score.NonMusicalPaperColumn #'padding = #10
2718 No work-around exists for decreasing the amount of space.
2721 @node New spacing area
2722 @subsection New spacing area
2724 New sections with different spacing parameters can be started with
2725 @code{newSpacingSection}. This is useful when there are
2726 sections with a different notions of long and short notes.
2728 In the following example, the time signature change introduces a new
2729 section, and hence the 16ths notes are spaced wider.
2731 @lilypond[relative=1,verbatim,quote]
2734 c8 c c4 c16[ c c8] c4
2740 The @code{\newSpacingSection} command creates a new
2741 @code{SpacingSpanner} object, and hence new @code{\override}s
2742 may be used in that location.
2749 Internals Reference:
2750 @rinternals{SpacingSpanner}.
2753 @node Changing horizontal spacing
2754 @subsection Changing horizontal spacing
2756 Horizontal spacing may be altered with the
2757 @code{base-shortest-duration} property. Here
2758 we compare the same music; once without altering
2759 the property, and then altered. Larger values
2760 of @code{ly:make-moment} will produce smaller
2761 music. Note that @code{ly:make-moment} constructs
2762 a duration, so @code{1 4} is a longer duration
2765 @lilypond[verbatim,line-width=12\cm]
2768 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2769 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2770 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2771 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2776 @lilypond[verbatim,line-width=12\cm]
2779 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2780 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2781 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2782 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2787 \override SpacingSpanner
2788 #'base-shortest-duration = #(ly:make-moment 1 16)
2797 By default, spacing in tuplets depends on various non-duration
2798 factors (such as accidentals, clef changes, etc). To disregard
2799 such symbols and force uniform equal-duration spacing, use
2800 @code{Score.SpacingSpanner #'uniform-stretching}. This
2801 property can only be changed at the beginning of a score,
2803 @lilypond[quote,ragged-right,verbatim]
2822 \override SpacingSpanner #'uniform-stretching = ##t
2828 When @code{strict-note-spacing} is set, notes are spaced without
2829 regard for clefs, bar lines, and grace notes,
2831 @lilypond[quote,ragged-right,relative=2,verbatim]
2832 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2833 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2843 @subsection Line length
2846 @cindex breaking pages
2849 @funindex line-width
2850 @funindex ragged-right
2851 @funindex ragged-last
2853 @c Although line-width can be set in \layout, it should be set in paper
2854 @c block, to get page layout right.
2855 @c Setting indent in \paper block makes not much sense, but it works.
2857 @c Bit verbose and vague, use examples?
2858 The most basic settings influencing the spacing are @code{indent} and
2859 @code{line-width}. They are set in the @code{\layout} block. They
2860 control the indentation of the first line of music, and the lengths of
2863 If @code{ragged-right} is set to true in the @code{\layout} block, then
2864 systems ends at their natural horizontal length, instead of being spread
2865 horizontally to fill the whole line. This is useful for
2866 short fragments, and for checking how tight the natural spacing is.
2867 The normal default setting is false, but if the score has only one
2868 system the default value is true.
2871 @cindex vertical spacing
2873 The option @code{ragged-last} is similar to @code{ragged-right}, but
2874 only affects the last line of the piece. No restrictions are put on
2875 that line. The result is similar to formatting text paragraphs. In a
2876 paragraph, the last line simply takes its natural horizontal length.
2877 @c Note that for text there are several options for the last line.
2878 @c While Knuth TeX uses natural length, lead typesetters use the same
2879 @c stretch as the previous line. eTeX uses \lastlinefit to
2880 @c interpolate between both these solutions.
2896 @node Proportional notation
2897 @subsection Proportional notation
2899 LilyPond supports proportional notation, a type of horizontal spacing
2900 in which each note consumes an amount of horizontal space exactly
2901 equivalent to its rhythmic duration. This type of proportional spacing
2902 is comparable to horizontal spacing on top of graph paper. Some late
2903 20th- and early 21st-century scores use proportional notation to
2904 clarify complex rhythmic relationships or to facilitate the placement
2905 of timelines or other graphics directly in the score.
2907 LilyPond supports five different settings for proportional notation,
2908 which may be used together or alone:
2911 @item @code{proportionalNotationDuration}
2912 @item @code{uniform-stretching}
2913 @item @code{strict-note-spacing}
2914 @item @code{\remove Separating_line_group_engraver}
2915 @item @code{\override PaperColumn #'used = ##t}
2918 In the examples that follow, we explore these five different
2919 proportional notation settings and examine how these settings interact.
2921 We start with the following one-measure example, which uses classical
2922 spacing with ragged-right turned on.
2924 @lilypond[quote,verbatim,ragged-right]
2927 \new RhythmicStaff {
2931 c'16 c'16 c'16 c'16 c'16
2938 Notice that the half note which begins the measure takes up far less
2939 than half of the horizontal space of the measure. Likewise, the
2940 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
2941 which end the measure together take up far more than half the
2942 horizontal space of the measure.
2944 In classical engraving, this spacing may be exactly what we want
2945 because we can borrow horizontal space from the half note and conserve
2946 horizontal space across the measure as a whole.
2948 On the other hand, if we want to insert a measured timeline or other
2949 graphic above or below our score, we need proportional notation. We
2950 turn proportional notation on with the proportionalNotationDuration
2953 @lilypond[quote,verbatim,ragged-right]
2956 \new RhythmicStaff {
2960 c'16 c'16 c'16 c'16 c'16
2967 proportionalNotationDuration = #(ly:make-moment 1 20)
2973 The half note at the beginning of the measure and the faster notes in
2974 the second half of the measure now occupy equal amounts of horizontal
2975 space. We could place a measured timeline or graphic above or below
2978 The @code{proportionalNotationDuration} setting is a context setting
2979 that lives in @code{Score}. Remember that context settings can appear
2980 in one of three locations within our input file -- in a @code{\with}
2981 block, in a @code{\context} block, or directly in music entry preceded
2982 by the @code{\set} command. As with all context settings, users can
2983 pick which of the three different locations they would like to
2984 set @code{proportionalNotationDuration} in to.
2986 The @code{proportionalNotationDuration} setting takes a single argument,
2987 which is the reference duration against that all music will be spaced.
2988 The LilyPond Scheme function @code{make-moment} takes two arguments
2989 -- a numerator and denominator which together express some fraction of
2990 a whole note. The call @code{(ly:make-moment 1 20)} therefore produces
2991 a reference duration of a twentieth note. Values such as
2992 @code{(ly:make-moment 1 16)}, @code{(ly:make-moment 1 8)}, and
2993 @code{(ly:make-moment 3 97)} are all possible as well.
2995 How do we select the right reference duration to pass to
2996 @code{proportionalNotationDuration}? Usually by a process of trial
2997 and error, beginning with a duration close to the fastest (or smallest)
2998 duration in the piece. Smaller reference durations space music loosely;
2999 larger reference durations space music tightly.
3001 @lilypond[quote,verbatim,ragged-right]
3004 \new RhythmicStaff {
3008 c'16 c'16 c'16 c'16 c'16
3015 proportionalNotationDuration = #(ly:make-moment 1 8)
3022 \new RhythmicStaff {
3026 c'16 c'16 c'16 c'16 c'16
3033 proportionalNotationDuration = #(ly:make-moment 1 16)
3040 \new RhythmicStaff {
3044 c'16 c'16 c'16 c'16 c'16
3051 proportionalNotationDuration = #(ly:make-moment 1 32)
3057 Note that too large a reference duration -- such as the eighth note,
3058 above -- spaces music too tightly and can cause note head collisions.
3059 Also that proportional notation in general takes up more horizontal
3060 space than classical spacing. Proportional spacing provides rhythmic
3061 clarity at the expense of horizontal space.
3063 Next we examine how to optimally space overlapping tuplets.
3065 We start by examining what happens to our original example, with
3066 classical spacing, when we add a second staff with a different type of
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 The spacing is bad because the evenly spaced notes of the bottom staff
3089 do not stretch uniformly. Classical engravings include very few complex
3090 triplets and so classical engraving rules can generate this type of
3091 result. Setting @code{proportionalNotationDuration} fixes this.
3093 @lilypond[quote,verbatim,ragged-right]
3096 \new RhythmicStaff {
3100 c'16 c'16 c'16 c'16 c'16
3103 \new RhythmicStaff {
3105 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3112 proportionalNotationDuration = #(ly:make-moment 1 20)
3118 But if we look very carefully we can see that notes of the second half
3119 of the 9-tuplet space ever so slightly more widely than the notes
3120 of the first half of the 9-tuplet. To ensure uniform stretching, we
3121 turn on @code{uniform-stretching}, which is a property of
3122 @code{SpacingSpanner}.
3124 @lilypond[quote,verbatim,ragged-right]
3127 \new RhythmicStaff {
3131 c'16 c'16 c'16 c'16 c'16
3134 \new RhythmicStaff {
3136 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3143 proportionalNotationDuration = #(ly:make-moment 1 20)
3144 \override SpacingSpanner #'uniform-stretching = ##t
3150 Our two-staff example now spaces exactly, our rhythmic
3151 relationships are visually clear, and we can include a measured
3152 timeline or graphic if we want.
3154 Note that the LilyPond's proportional notation package expects
3155 that all proportional scores set the SpacingSpanner's
3156 'uniform-stretching attribute to ##t. Setting
3157 proportionalNotationDuration without also setting the
3158 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3159 example, cause Skips to consume an incorrect amount of horizontal
3162 The SpacingSpanner is an abstract grob that lives in the Score
3163 context. As with our settings of proportionalNotationDuration,
3164 overrides to the SpacingSpanner can occur in any of three
3165 different places in our input file – in the Score \with block, in
3166 a Score \context block, or in note entry directly.
3168 There is by default only one @code{SpacingSpanner} per @code{Score}. This
3169 means that, by default, @code{uniform-stretching} is either turned on for the
3170 entire score or turned off for the entire score. We can, however,
3171 override this behavior and turn on different spacing features at
3172 different places in the score. We do this with the command
3173 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
3175 Next we examine the effects of the @code{Separating_line_group_engraver} and
3176 see why proportional scores frequently remove this engraver. The following
3177 example shows that there is a small amount of @qq{prefatory} space
3178 just before the first note in each system.
3180 @lilypond[quote,verbatim,ragged-right]
3193 The amount of this prefatory space is the same whether after a time
3194 signature, a key signature or a clef. @code{Separating_line_group_engraver}
3195 is responsible for this space. Removing @code{Separating_line_group_engraver}
3196 reduces this space to zero.
3198 @lilypond[quote,verbatim,ragged-right]
3204 \remove Separating_line_group_engraver
3212 non-musical elements like time signatures, key signatures, clefs and
3213 accidentals are problematic in proportional notation. None of these
3214 elements has rhythmic duration. But all of these elements consume
3215 horizontal space. Different proportional scores approach these
3216 problems differently.
3218 It may be possible to avoid spacing problems with key signatures
3219 simply by not having any. This is a valid option since most
3220 proportional scores are contemporary music. The same may be true
3221 of time signatures, especially for those scores
3222 that include a measured timeline or other graphic. But these scores
3223 are exceptional and most proportional scores include at least some
3224 time signatures. Clefs and accidentals are even more essential.
3226 So what strategies exist for spacing non-musical elements in a
3227 proportional context? One good option is the @code{strict-note-spacing}
3228 property of @code{SpacingSpanner}. Compare the two scores below:
3230 @lilypond[quote,verbatim,ragged-right]
3232 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3242 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3243 \override Score.SpacingSpanner #'strict-note-spacing = ##t
3253 Both scores are proportional, but the spacing in the first score
3254 is too loose because of the clef change. The spacing of the second
3255 score remains strict, however, because strict-note-spacing is
3256 turned on. Turning on strict-note-spacing causes the width of
3257 time signatures, key signatures, clefs and accidentals to play no
3258 part in the spacing algorithm.
3260 In addition to the settings given here, there are other settings
3261 that frequently appear in proportional scores. These include:
3264 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
3265 @item @code{tupletFullLength = ##t}
3266 @item @code{\override Beam #'breakable = ##t}
3267 @item @code{\override Glissando #'breakable = ##t}
3268 @item @code{\override TextSpanner #'breakable = ##t}
3269 @item @code{\remove Forbid_line_break_engraver in the Voice context}
3272 These settings space grace notes strictly, extend tuplet brackets to
3273 mark both rhythmic start- and stop-points, and allow spanning elements
3274 to break across systems and pages. See the respective parts of the manual
3275 for these related settings.
3280 @ref{New spacing area}.
3286 @node Fitting music onto fewer pages
3287 @section Fitting music onto fewer pages
3289 Sometimes you can end up with one or two staves on a second
3290 (or third, or fourth@dots{}) page. This is annoying, especially
3291 if you look at previous pages and it looks like there is plenty
3292 of room left on those.
3294 When investigating layout issues, @code{annotate-spacing} is an
3295 invaluable tool. This command prints the values of various layout
3296 spacing variables; for more details see the following section,
3297 @ref{Displaying spacing}.
3300 * Displaying spacing::
3301 * Changing spacing::
3305 @node Displaying spacing
3306 @subsection Displaying spacing
3308 @funindex annotate-spacing
3309 @cindex spacing, display of layout
3311 To graphically display the dimensions of vertical layout variables
3312 that may be altered for page formatting, set
3313 @code{annotate-spacing} in the @code{\paper} block:
3315 @c need to have \book{} otherwise we get the separate systems. -hwn
3316 @lilypond[verbatim,quote]
3317 #(set-default-paper-size "a6" 'landscape)
3320 \paper { annotate-spacing = ##t }
3326 All layout dimensions are displayed in staff-spaces, regardless
3327 of the units specified in the @code{\paper} or @code{\layout} block.
3328 In the above example, @code{paper-height} has a value of 59.75
3329 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3330 default value). Note that:
3332 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3335 @tab = (25.4/72.27) mm
3338 @tab = (@code{staff-size})/4 pts
3340 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3345 In this case, one @code{staff-space} is approximately equal to
3346 1.757mm. Thus the @code{paper-height} measurement of 59.75
3347 @code{staff-spaces} is equivalent to 105 millimeters, the height
3348 of @code{a6} paper in landscape orientation. The pairs
3349 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3350 edge and @var{b} the upper edge of the interval.
3355 @ref{Setting the staff size}.
3361 @node Changing spacing
3362 @subsection Changing spacing
3364 The output of @code{annotate-spacing} reveals vertical dimensions
3365 in great detail. For details about modifying margins and other
3366 layout variables, see @ref{Page layout}.
3368 Other than margins, there are a few other options to save space:
3372 Force systems to move as close together as possible (to fit as
3373 many systems as possible onto a page) while being spaced so that
3374 there is no blank space at the bottom of the page.
3378 system-system-spacing = #'((basic-distance . 0.1) (padding . 0))
3379 ragged-last-bottom = ##f
3385 Force the number of systems. This can help in two ways. Just
3386 setting a value, even the same value as the number of systems
3387 being typeset by default, will sometimes cause more systems to
3388 be fitted onto each page, as an estimation step is then bypassed,
3389 giving a more accurate fit to each page. Also, forcing an actual
3390 reduction in the number of systems may save a further page. For
3391 example, if the default layout has 11 systems, the following
3392 assignment will force a layout with 10 systems.
3401 Avoid (or reduce) objects that increase the vertical size of a
3402 system. For example, volta repeats (or alternate repeats) require
3403 extra space. If these repeats are spread over two systems, they
3404 will take up more space than one system with the volta repeats and
3405 another system without. For example, dynamics that @q{stick out} of
3406 a system can be moved closer to the staff:
3408 @lilypond[verbatim,quote,relative=1]
3410 e4 c g-\tweak #'X-offset #-2.7 -\tweak #'Y-offset #2.5 \f c
3414 Alter the horizontal spacing via @code{SpacingSpanner}. For more
3415 details, see @ref{Changing horizontal spacing}. The following
3416 example illustrates the default spacing:
3418 @lilypond[verbatim,quote]
3431 The next example modifies @code{common-shortest-duration} from a
3432 value of @code{1/4} to @code{1/2}. The quarter note is the most
3433 common and shortest duration in this example, so by making this
3434 duration longer, a @q{squeezing} effect occurs:
3436 @lilypond[verbatim,quote]
3448 \override SpacingSpanner
3449 #'common-shortest-duration = #(ly:make-moment 1 2)
3456 The @code{common-shortest-duration} property cannot be modified
3457 dynamically, so it must always be placed in a @code{\context}
3458 block so that it applies to the whole score.
3466 @ref{Changing horizontal spacing}.