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{Custom headers footers and titles}.
180 @file{ly/paper-defaults-init.ly}.
183 @node Paper size and automatic scaling
184 @subsection Paper size and automatic scaling
192 * Setting paper size::
193 * Automatic scaling to paper size::
197 @node Setting paper size
198 @unnumberedsubsubsec Setting paper size
200 Two functions are available for changing the paper size:
201 @code{set-default-paper-size} and @code{set-paper-size}.
202 @code{set-default-paper-size} must be placed in the toplevel
203 scope, and @code{set-paper-size} must be placed in a @code{\paper}
207 #(set-default-paper-size "a4")
212 #(set-paper-size "a4")
217 In the toplevel scope, the @code{set-default-paper-size} function
218 can safely be called anywhere before the first @code{\paper}
219 block. Within a @code{\paper} block, the safest place to call
220 @code{set-paper-size} is at the top, above the list of variable
221 declarations. The reasons for this are discussed in
222 @ref{Automatic scaling to paper size}.
224 @code{set-default-paper-size} sets the size of all pages, whereas
225 @code{set-paper-size} only sets the size of the pages that the
226 @code{\paper} block applies to. For example, if the @code{\paper}
227 block is at the top of the file, then it will apply the paper size
228 to all pages. If the @code{\paper} block is inside a
229 @code{\book}, then the paper size will only apply to that book.
231 Common paper sizes are available, including @code{a4},
232 @code{letter}, @code{legal}, and @code{11x17} (also known as
233 tabloid). Many more paper sizes are supported by default. For
234 details, see @file{scm/paper.scm}, and search for the
235 definition of @code{paper-alist}.
237 @c TODO add a new appendix for paper sizes (auto-generated) -pm
239 @warning{The default paper size is @code{a4}.}
241 Extra sizes may be added by editing the definition of
242 @code{paper-alist} in the initialization file
243 @file{scm/paper.scm}, however they will be overridden on a
249 If the symbol @code{'landscape} is supplied as an argument to
250 @code{set-default-paper-size}, pages will be rotated by 90
251 degrees, and wider line widths will be set accordingly.
254 #(set-default-paper-size "a6" 'landscape)
259 @file{scm/paper.scm}.
262 @node Automatic scaling to paper size
263 @unnumberedsubsubsec Automatic scaling to paper size
265 If the paper size is changed with one of the scheme functions
266 (@code{set-default-paper-size} or @code{set-paper-size}), the
267 values of several @code{\paper} variables are automatically scaled
268 to the new size. To bypass the automatic scaling for a particular
269 variable, set the variable after setting the paper size. Note
270 that the automatic scaling is not triggered by setting the
271 @code{paper-height} or @code{paper-width} variables, even though
272 @code{paper-width} can influence other values (this is separate
273 from scaling and is discussed below). The
274 @code{set-default-paper-size} and @code{set-paper-size} functions
275 are described in @ref{Setting paper size}.
277 The vertical dimensions affected by automatic scaling are
278 @code{top-margin} and @code{bottom-margin}. The horizontal
279 dimensions affected by automatic scaling are @code{left-margin},
280 @code{right-margin}, @code{inner-margin}, @code{outer-margin},
281 @code{binding-offset}, @code{indent}, and @code{short-indent}.
283 The default values for these dimensions are set in
284 @file{ly/paper-defaults-init.ly}, using internal variables named
285 @code{top-margin-default}, @code{bottom-margin-default}, etc.
286 These are the values that result at the default paper size
287 @code{a4}. For reference, with @code{a4} paper the
288 @code{paper-height} is @code{297\mm} and the @code{paper-width} is
293 @file{ly/paper-defaults-init.ly},
294 @file{scm/paper.scm}.
297 @node Fixed vertical spacing \paper variables
298 @subsection Fixed vertical spacing @code{\paper} variables
300 @warning{Some @code{@bs{}paper} dimensions are automatically
301 scaled to the paper size, which may lead to unexpected behavior.
302 See @ref{Automatic scaling to paper size}.}
304 Default values (before scaling) are defined in
305 @file{ly/paper-defaults-init.ly}.
309 @funindex paper-height
311 The height of the page, unset by default. Note that the automatic
312 scaling of some vertical dimensions is not affected by this.
317 The margin between the top of the page and the top of the
318 printable area. If the paper size is modified, this dimension's
319 default value is scaled accordingly.
322 @funindex bottom-margin
324 The margin between the bottom of the printable area and the bottom
325 of the page. If the paper size is modified, this dimension's
326 default value is scaled accordingly.
329 @funindex ragged-bottom
331 If set to true, systems will not spread vertically down the page.
332 This does not affect the last page. This should be set to true
333 for pieces that have only two or three systems per page, for
334 example orchestral scores.
336 @item ragged-last-bottom
337 @funindex ragged-last-bottom
339 If set to false, systems will spread vertically down the last
340 page. Pieces that amply fill two pages or more should have this
341 set to true. It also affects the last page of book parts, i.e.
342 parts of a book created with @code{\bookpart} blocks.
348 @file{ly/paper-defaults-init.ly}.
355 The titles (from the @code{\header} block) are treated as a
356 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
357 add space between the titles and the first system of the score.
360 @node Flexible vertical spacing \paper variables
361 @subsection Flexible vertical spacing @code{\paper} variables
363 In most cases, it is preferable for the vertical distances between
364 certain items (such as margins, titles, systems, and separate
365 scores) to be flexible, so that they stretch and compress nicely
366 according to each situation. A number of @code{\paper} variables
367 (listed below) are available to fine-tune the stretching behavior
370 Note that the @code{\paper} variables discussed in this section do
371 not control the spacing of staves within individual systems.
372 Within-system spacing is controlled by grob properties, with
373 settings typically entered inside a @code{\score} or
374 @code{\layout} block, and not inside a @code{\paper} block. See
375 @ref{Flexible vertical spacing within systems}.
378 * Structure of flexible vertical spacing alists::
379 * List of flexible vertical spacing \paper variables::
383 @node Structure of flexible vertical spacing alists
384 @unnumberedsubsubsec Structure of flexible vertical spacing alists
386 Each of the flexible vertical spacing @code{\paper} variables is
387 an alist (association list) containing four @emph{keys}:
392 @code{padding} -- the minimum required amount of unobstructed
393 vertical whitespace between two items, measured in staff-spaces.
394 This can be thought of as the minimum height of an unobstructed
395 (invisible) rectangle that extends from the leftmost to the
396 rightmost point of the combined items.
399 @code{space} -- the vertical distance, measured in staff-spaces,
400 between the @emph{reference points} of the two items, when no
401 collisions would result, and no stretching or compressing is in
402 effect. The reference point of a (title or top-level) markup is
403 its highest point, and the reference point of a system is the
404 vertical center of the nearest @code{StaffSymbol} -- even if a
405 non-staff line (such as a @code{Lyrics} context) is in the way.
406 Values for @code{space} that are less than either @code{padding}
407 or @code{minimum-distance} are not meaningful, since the resulting
408 distance will never be less than either @code{padding} or
409 @code{minimum-distance}.
412 @code{minimum-distance} -- the smallest allowable vertical
413 distance, measured in staff-spaces, between the reference points
414 of the two items, when compressing is in effect. Values for
415 @code{minimum-distance} that are less than @code{padding} are not
416 meaningful, since the resulting distance will never be less than
420 @code{stretchability} -- a unitless measure of the dimension's
421 relative propensity to stretch. If zero, the distance will not
422 stretch (unless collisions would result). When positive, the
423 significance of a particular dimension's @code{stretchability}
424 value lies only in its relation to the @code{stretchability}
425 values of the other dimensions. For example, if one dimension has
426 twice the @code{stretchability} of another, it will stretch twice
427 as easily. Values should be non-negative and finite. The value
428 @code{+inf.0} triggers a @code{programming_error} and is ignored,
429 but @code{1.0e7} can be used for an almost infinitely stretchable
430 spring. If unset, the default value is set to @code{space}. Note
431 that the dimension's propensity to @emph{compress} cannot be
432 directly set by the user and is equal to
433 (@code{space}@tie{}@minus{}@tie{}@code{minimum-distance}).
437 If a page has a ragged bottom, the resulting distance is the
446 @code{minimum-distance}, and
449 @code{padding} plus the smallest distance necessary to eliminate
454 Specific methods for modifying alists are discussed in
455 @ref{Modifying alists}. The following example demonstrates the
456 two ways these alists can be modified. The first declaration
457 updates one key-value individually, and the second completely
458 redefines the variable:
462 system-system-spacing #'space = #8
463 score-system-spacing =
466 (minimum-distance . 6)
467 (stretchability . 12))
472 @node List of flexible vertical spacing \paper variables
473 @unnumberedsubsubsec List of flexible vertical spacing @code{\paper} variables
475 The names of these variables follow the format
476 @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}}
477 and @code{@var{lower}} are the items to be spaced. Each distance
478 is measured between the reference points of the two items (see the
479 description of the alist structure above). Note that in these
480 variable names, the term @q{@code{markup}} refers to both
481 @emph{title markups} (@code{bookTitleMarkup} or
482 @code{scoreTitleMarkup}) and @emph{top-level markups} (see
483 @ref{File structure}). All distances are measured in
486 Default settings are defined in @file{ly/paper-defaults-init.ly}.
488 @c TODO: Where do headers/footers fit in? -mp
491 @item markup-system-spacing
492 @funindex markup-system-spacing
494 the distance between a (title or top-level) markup and the system
497 @item score-markup-spacing
498 @funindex score-markup-spacing
500 the distance between the last system of a score and the (title or
501 top-level) markup that follows it.
503 @item score-system-spacing
504 @funindex score-system-spacing
506 the distance between the last system of a score and the first
507 system of the score that follows it, when no (title or top-level)
508 markup exists between them.
510 @item system-system-spacing
511 @funindex system-system-spacing
513 the distance between two systems in the same score.
515 @item markup-markup-spacing
516 @funindex markup-markup-spacing
518 the distance between two (title or top-level) markups.
520 @item last-bottom-spacing
521 @funindex last-bottom-spacing
523 the distance from the last system or top-level markup on a page to
524 the bottom of the printable area (i.e. the top of the bottom
527 @item top-system-spacing
528 @funindex top-system-spacing
530 the distance from the top of the printable area (i.e. the bottom
531 of the top margin) to the first system on a page, when there is no
532 (title or top-level) markup between the two.
534 @item top-markup-spacing
535 @funindex top-markup-spacing
537 the distance from the top of the printable area (i.e. the bottom
538 of the top margin) to the first (title or top-level) markup on a
539 page, when there is no system between the two.
544 @ref{Flexible vertical spacing within systems}.
547 @file{ly/paper-defaults-init.ly}.
553 @node Horizontal spacing \paper variables
554 @subsection Horizontal spacing @code{\paper} variables
556 @warning{Some @code{@bs{}paper} dimensions are automatically
557 scaled to the paper size, which may lead to unexpected behavior.
558 See @ref{Automatic scaling to paper size}.}
561 * \paper variables for widths and margins::
562 * \paper variables for two-sided mode::
563 * \paper variables for shifts and indents::
567 @node \paper variables for widths and margins
568 @unnumberedsubsubsec @code{\paper} variables for widths and margins
570 Default values (before scaling) that are not listed here are
571 defined in @file{ly/paper-defaults-init.ly}.
576 @funindex paper-width
578 The width of the page, unset by default. While @code{paper-width}
579 has no effect on the automatic scaling of some horizontal
580 dimensions, it does influence the @code{line-width} variable. If
581 both @code{paper-width} and @code{line-width} are set, then
582 @code{left-margin} and @code{right-margin} will also be updated.
583 Also see @code{check-consistency}.
588 The horizontal extent of the staff lines in unindented, non-ragged
590 @code{(paper-width@tie{}@minus{}@tie{}left-margin@tie{}@minus{}@tie{}right-margin)}
591 when unset. If @code{line-width} is set, and both
592 @code{left-margin} and @code{right-margin} are unset, then the
593 margins will be updated to center the systems on the page
594 automatically. Also see @code{check-consistency}. This variable
595 can also be set in a @code{\layout} block.
598 @funindex left-margin
600 The margin between the left edge of the page and the start of the
601 staff lines in unindented systems. If the paper size is modified,
602 this dimension's default value is scaled accordingly. If
603 @code{left-margin} is unset, and both @code{line-width} and
604 @code{right-margin} are set, then @code{left-margin} is set to
605 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}right-margin)}.
606 If only @code{line-width} is set, then both margins are set to
607 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
608 and the systems are consequently centered on the page. Also see
609 @code{check-consistency}.
612 @funindex right-margin
614 The margin between the right edge of the page and the end of the
615 staff lines in non-ragged systems. If the paper size is modified,
616 this dimension's default value is scaled accordingly. If
617 @code{right-margin} is unset, and both @code{line-width} and
618 @code{left-margin} are set, then @code{right-margin} is set to
619 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}left-margin)}.
620 If only @code{line-width} is set, then both margins are set to
621 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
622 and the systems are consequently centered on the page. Also see
623 @code{check-consistency}.
625 @item check-consistency
626 @funindex check-consistency
628 If set to true, print a warning if @code{left-margin},
629 @code{line-width}, and @code{right-margin} do not exactly add up
630 to @code{paper-width}, and replace each of these (except
631 @code{paper-width}) with its default value (scaled to the paper
632 size if necessary). If set to false, ignore any inconsistencies
633 and allow systems to run off the edge of the page.
636 @funindex ragged-right
638 If set to true, systems will not fill the line width. Instead,
639 systems end at their natural horizontal length. Default:
640 @code{#t} for scores with only one system, and @code{#f} for
641 scores with two or more systems. This variable can also be set in
642 a @code{\layout} block.
645 @funindex ragged-last
647 If set to true, the last system in the score will not fill the
648 line width. Instead the last system ends at its natural
649 horizontal length. Default: @code{#f}. This variable can also be
650 set in a @code{\layout} block.
656 @file{ly/paper-defaults-init.ly}.
659 @node \paper variables for two-sided mode
660 @unnumberedsubsubsec @code{\paper} variables for two-sided mode
662 Default values (before scaling) are defined in
663 @file{ly/paper-defaults-init.ly}.
671 @cindex binding gutter
673 If set to true, use @code{inner-margin}, @code{outer-margin} and
674 @code{binding-offset} to determine margins depending on whether
675 the page number is odd or even. This overrides @code{left-margin}
676 and @code{right-margin}.
679 @funindex inner-margin
681 The margin all pages have at the inner side if they are part of a
682 book. If the paper size is modified, this dimension's default
683 value is scaled accordingly. Works only with @code{two-sided} set
687 @funindex outer-margin
689 The margin all pages have at the outer side if they are part of a
690 book. If the paper size is modified, this dimension's default
691 value is scaled accordingly. Works only with @code{two-sided} set
695 @funindex binding-offset
697 The amount @code{inner-margin} is increased to make sure nothing
698 will be hidden by the binding. If the paper size is modified,
699 this dimension's default value is scaled accordingly. Works only
700 with @code{two-sided} set to true.
706 @file{ly/paper-defaults-init.ly}.
709 @node \paper variables for shifts and indents
710 @unnumberedsubsubsec @code{\paper} variables for shifts and indents
712 Default values (before scaling) that are not listed here are
713 defined in @file{ly/paper-defaults-init.ly}.
717 @item horizontal-shift
718 @funindex horizontal-shift
720 @c This default value is buried in the middle of page.scm. -mp
722 The amount that all systems (including titles and system
723 separators) are shifted to the right. Default: @code{0.0\mm}.
728 The level of indentation for the first system in a score. If the
729 paper size is modified, this dimension's default value is scaled
730 accordingly. This variable can also be set in a @code{\layout}
734 @funindex short-indent
736 The level of indentation for all systems in a score besides the
737 first system. If the paper size is modified, this dimension's
738 default value is scaled accordingly. This variable can also be
739 set in a @code{\layout} block.
745 @file{ly/paper-defaults-init.ly}.
751 @node Other \paper variables
752 @subsection Other @code{\paper} variables
755 * \paper variables for line breaking::
756 * \paper variables for page breaking::
757 * \paper variables for page numbering::
758 * Miscellaneous \paper variables::
762 @node \paper variables for line breaking
763 @unnumberedsubsubsec @code{\paper} variables for line breaking
765 @c TODO: Mention that ly:optimal-breaking is on by default? -mp
769 @item max-systems-per-page
770 @funindex max-systems-per-page
772 The maximum number of systems that will be placed on a page. This
773 is currently supported only by the @code{ly:optimal-breaking} algorithm.
776 @item min-systems-per-page
777 @funindex min-systems-per-page
779 The minimum number of systems that will be placed on a page. This
780 may cause pages to be overfilled if it is made too large. This is
781 currently supported only by the @code{ly:optimal-breaking} algorithm.
784 @item systems-per-page
785 @funindex systems-per-page
787 The number of systems that should be placed on each page.
788 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
792 @funindex system-count
794 The number of systems to be used for a score. Default: unset.
795 This variable can also be set in a @code{\layout} block.
804 @node \paper variables for page breaking
805 @unnumberedsubsubsec @code{\paper} variables for page breaking
807 Default values not listed here are defined in
808 @file{ly/paper-defaults-init.ly}
812 @item blank-after-score-page-force
813 @funindex blank-after-score-page-force
815 The penalty for having a blank page after the end of one score and
816 before the next. By default, this is smaller than
817 @code{blank-page-force}, so that we prefer blank pages after
818 scores to blank pages within a score.
820 @item blank-last-page-force
821 @funindex blank-last-page-force
823 The penalty for ending the score on an odd-numbered page.
825 @item blank-page-force
826 @funindex blank-page-force
828 The penalty for having a blank page in the middle of a
829 score. This is not used by @code{ly:optimal-breaking} since it will
830 never consider blank pages in the middle of a score.
833 @funindex page-breaking
835 The page-breaking algorithm to use. Choices are
836 @code{ly:minimal-breaking}, @code{ly:page-turn-breaking}, and
837 @code{ly:optimal-breaking}.
839 @item page-breaking-system-system-spacing
840 @funindex page-breaking-system-system-spacing
842 Tricks the page breaker into thinking that
843 @code{system-system-spacing} is set to something different than
844 it really is. For example, if
845 @code{page-breaking-system-system-spacing #'padding} is set to something
846 substantially larger than @code{system-system-spacing #'padding}, then the
847 page-breaker will put fewer systems on each page. Default: unset.
852 The number of pages to be used for a score, unset by default.
859 @ref{Optimal page breaking},
860 @ref{Optimal page turning},
861 @ref{Minimal page breaking}.
864 @file{ly/paper-defaults-init.ly}.
867 @node \paper variables for page numbering
868 @unnumberedsubsubsec @code{\paper} variables for page numbering
870 Default values not listed here are defined in
871 @file{ly/paper-defaults-init.ly}
875 @item auto-first-page-number
876 @funindex auto-first-page-number
878 The page breaking algorithm is affected by the first page number
879 being odd or even. If set to true, the page breaking algorithm
880 will decide whether to start with an odd or even number. This
881 will result in the first page number remaining as is or being
882 increased by one. Default: @code{#f}.
884 @item first-page-number
885 @funindex first-page-number
887 The value of the page number on the first page.
889 @item print-first-page-number
890 @funindex print-first-page-number
892 If set to true, a page number is printed on the first page.
894 @item print-page-number
895 @funindex print-page-number
897 If set to false, page numbers are not printed.
903 @file{ly/paper-defaults-init.ly}.
906 @node Miscellaneous \paper variables
907 @unnumberedsubsubsec Miscellaneous @code{\paper} variables
911 @item page-spacing-weight
912 @funindex page-spacing-weight
914 The relative importance of page (vertical) spacing and line
915 (horizontal) spacing. High values will make page spacing more
916 important. Default: @code{#10}.
918 @item print-all-headers
919 @funindex print-all-headers
921 If set to true, this will print all headers for each @code{\score}
922 in the output. Normally only the @code{piece} and @code{opus}
923 header variables are printed. Default: @code{#f}.
925 @item system-separator-markup
926 @funindex system-separator-markup
928 A markup object that is inserted between systems, often used for
929 orchestral scores. Default: unset. The @code{\slashSeparator}
930 markup, defined in @file{ly/titling-init.ly}, is provided as a
931 sensible default, for example:
933 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
934 #(set-default-paper-size "a8")
938 system-separator-markup = \slashSeparator
944 \relative c'' { c1 \break c1 \break c1 }
954 @file{ly/titling-init.ly}.
962 The default page header puts the page number and the @code{instrument}
963 field from the @code{\header} block on a line.
967 @section Score layout
969 This section discusses score layout options for the @code{\layout}
973 * The \layout block::
974 * Setting the staff size::
978 @node The \layout block
979 @subsection The @code{\layout} block
983 While the @code{\paper} block contains settings that relate to the
984 page formatting of the whole document, the @code{\layout} block
985 contains settings for score-specific layout. To set score layout
986 options globally, enter them in a toplevel @code{\layout} block.
987 To set layout options for an individual score, enter them in a
988 @code{\layout} block inside the @code{\score} block, after the
989 music. Settings that can appear in a @code{\layout} block
993 @item the @code{layout-set-staff-size} scheme function,
994 @item context modifications in @code{\context} blocks, and
995 @item @code{\paper} variables that affect score layout.
998 The @code{layout-set-staff-size} function is discussed in the next
999 section, @ref{Setting the staff size}. Context modifications are
1000 discussed in a separate chapter; see
1001 @ref{Modifying context plug-ins} and
1002 @ref{Changing context default settings}. The @code{\paper}
1003 variables that can appear in a @code{\layout} block are:
1006 @item @code{line-width}
1007 @item @code{ragged-right}
1008 @item @code{ragged-last}
1010 @item @code{short-indent}
1011 @item @code{system-count}
1014 Here is an example @code{\layout} block:
1021 \override StaffGrouper #'staff-staff-spacing #space = #8
1025 \override TextScript #'padding = #1
1026 \override Glissando #'thickness = #3
1034 @ref{Changing context default settings}.
1040 @node Setting the staff size
1041 @subsection Setting the staff size
1043 @cindex font size, setting
1044 @cindex staff size, setting
1045 @funindex layout file
1047 The default @strong{staff size} is set to 20 points.
1048 This may be changed in two ways:
1050 To set the staff size globally for all scores in a file (or
1051 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
1054 #(set-global-staff-size 14)
1058 This sets the global default size to 14pt staff height and scales all
1061 To set the staff size individually for each score, use
1066 #(layout-set-staff-size 15)
1071 The Feta font provides musical symbols at eight different
1072 sizes. Each font is tuned for a different staff size: at a smaller size
1073 the font becomes heavier, to match the relatively heavier staff lines.
1074 The recommended font sizes are listed in the following table:
1077 @multitable @columnfractions .15 .2 .22 .2
1080 @tab @b{staff height (pt)}
1081 @tab @b{staff height (mm)}
1123 @c modern rental material?
1128 These fonts are available in any sizes. The context property
1129 @code{fontSize} and the layout property @code{staff-space} (in
1130 @rinternals{StaffSymbol}) can be used to tune the size for individual
1131 staves. The sizes of individual staves are relative to the global size.
1136 @ref{Selecting notation font size}.
1144 @code{layout-set-staff-size} does not change the distance between the
1154 * Optimal page breaking::
1155 * Optimal page turning::
1156 * Minimal page breaking::
1158 * Using an extra voice for breaks::
1163 @subsection Line breaking
1166 @cindex breaking lines
1168 Line breaks are normally determined automatically. They are chosen
1169 so that lines look neither cramped nor loose, and consecutive
1170 lines have similar density. Occasionally you might want to
1171 override the automatic breaks; you can do this by specifying
1172 @code{\break}. This will force a line break at this point. However,
1173 line breaks can only occur at the end of @q{complete} bars, i.e.,
1174 where there are no notes or tuplets left @q{hanging} over the bar
1175 line. If you want to have a line break where there is no bar line,
1176 you can force an invisible bar line by entering @code{\bar ""},
1177 although again there must be no notes left hanging over in any of
1178 the staves at this point, or it will be ignored.
1180 The opposite command, @code{\noBreak}, forbids a line break at the
1181 bar line where it is inserted.
1183 The most basic settings influencing line spacing are @code{indent}
1184 and @code{line-width}. They are set in the @code{\layout} block.
1185 They control the indentation of the first line of music, and the
1186 lengths of the lines.
1188 If @code{ragged-right} is set to true in the @code{\layout} block,
1189 then systems end at their natural horizontal length, instead of
1190 being spread horizontally to fill the whole line. This is useful
1191 for short fragments, and for checking how tight the natural
1194 @c TODO Check and add para on default for ragged-right
1196 The option @code{ragged-last} is similar to @code{ragged-right},
1197 but affects only the last line of the piece.
1209 @cindex regular line breaks
1210 @cindex four bar music.
1212 For line breaks at regular intervals use @code{\break} separated by
1213 skips and repeated with @code{\repeat}. For example, this would
1214 cause the following 28 measures (assuming 4/4 time) to be broken
1215 every 4 measures, and only there:
1220 s1 \noBreak s1 \noBreak
1221 s1 \noBreak s1 \break
1223 @{ @var{the actual music@dots{}} @}
1228 A linebreaking configuration can be saved as a @file{.ly} file
1229 automatically. This allows vertical alignments to be stretched to
1230 fit pages in a second formatting run. This is fairly new and
1231 complicated. More details are available in
1247 Internals Reference:
1248 @rinternals{LineBreakEvent}.
1253 Line breaks can only occur if there is a @q{proper} bar line. A note
1254 which is hanging over a bar line is not proper, such as
1256 @lilypond[quote,ragged-right,relative=2,verbatim]
1257 c4 c2 << c2 {s4 \break } >> % this does nothing
1258 c2 c4 | % a break here would work
1259 c4 c2 c4 ~ \break % as does this break
1263 This can be avoided by removing the @code{Forbid_line_break_engraver}.
1264 Note that manually forced line breaks have to be added in parallel
1267 @lilypond[quote,ragged-right,verbatim]
1269 \remove Forbid_line_break_engraver
1271 c4 c2 << c2 {s4 \break } >> % now the break is allowed
1276 Similarly, line breaks are normally forbidden when beams cross bar
1277 lines. This behavior can be changed by setting
1278 @code{\override Beam #'breakable = ##t}.
1282 @subsection Page breaking
1284 The default page breaking may be overridden by inserting
1285 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1286 analogous to @code{\break} and @code{\noBreak}. They should be
1287 inserted at a bar line. These commands force and forbid a page-break
1288 from happening. Of course, the @code{\pageBreak} command also forces
1291 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1292 inserted at top-level, between scores and top-level markups.
1294 There are also analogous settings to @code{ragged-right} and
1295 @code{ragged-last} which have the same effect on vertical spacing:
1296 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1297 @code{##t} the systems on all pages or just the last page
1298 respectively will not be justified vertically.
1300 For more details see @ref{Vertical spacing}.
1302 Page breaks are computed by the @code{page-breaking} function. LilyPond
1303 provides three algorithms for computing page breaks,
1304 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1305 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1306 but the value can be changed in the @code{\paper} block:
1310 page-breaking = #ly:page-turn-breaking
1316 When a book has many scores and pages, the page breaking problem may be
1317 difficult to solve, requiring large processing time and memory. To ease
1318 the page breaking process, @code{\bookpart} blocks are used to divide
1319 the book into several parts: the page breaking occurs separately on each
1320 part. Different page breaking functions may also be used in different
1326 subtitle = "Preface"
1329 %% In a part consisting mostly of text,
1330 %% ly:minimal-breaking may be preferred
1331 page-breaking = #ly:minimal-breaking
1333 \markup @{ @dots{} @}
1337 %% In this part, consisting of music, the default optimal
1338 %% page breaking function is used.
1340 subtitle = "First movement"
1342 \score @{ @dots{} @}
1349 @funindex \pageBreak
1351 @funindex \noPageBreak
1352 @code{\noPageBreak}.
1361 @node Optimal page breaking
1362 @subsection Optimal page breaking
1364 @funindex ly:optimal-breaking
1366 The @code{ly:optimal-breaking} function is LilyPond's default method of
1367 determining page breaks. It attempts to find a page breaking that minimizes
1368 cramping and stretching, both horizontally and vertically. Unlike
1369 @code{ly:page-turn-breaking}, it has no concept of page turns.
1377 @node Optimal page turning
1378 @subsection Optimal page turning
1380 @funindex ly:page-turn-breaking
1382 Often it is necessary to find a page breaking configuration so that there is
1383 a rest at the end of every second page. This way, the musician can turn the
1384 page without having to miss notes. The @code{ly:page-turn-breaking} function
1385 attempts to find a page breaking minimizing cramping and stretching, but with
1386 the additional restriction that it is only allowed to introduce page turns
1387 in specified places.
1389 There are two steps to using this page breaking function. First, you
1390 must enable it in the @code{\paper} block, as explained in @ref{Page
1391 breaking}. Then you must tell the function where you would like to allow
1394 There are two ways to achieve the second step. First, you can specify each
1395 potential page turn manually, by inserting @code{\allowPageTurn} into your
1396 input file at the appropriate places.
1398 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1399 Voice context. The @code{Page_turn_engraver} will scan the context for
1400 sections without notes (note that it does not scan for rests; it scans for
1401 the absence of notes. This is so that single-staff polyphony with rests in one
1402 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1403 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1404 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1405 there is a @q{special} bar line (such as a double bar), in which case the
1406 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1409 @funindex minimumPageTurnLength
1410 The @code{Page_turn_engraver} reads the context property
1411 @code{minimumPageTurnLength} to determine how long a note-free section must
1412 be before a page turn is considered. The default value for
1413 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
1414 to disable page turns, you can set it to something very large.
1417 \new Staff \with @{ \consists "Page_turn_engraver" @}
1420 R1 | % a page turn will be allowed here
1422 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1423 R1 | % a page turn will not be allowed here
1425 R1*2 | % a page turn will be allowed here
1430 @funindex minimumRepeatLengthForPageTurn
1431 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1432 turn during the repeat if there is enough time at the beginning and end of the
1433 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1434 page turns if the repeat is very short. If you set the context property
1435 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1436 only allow turns in repeats whose duration is longer than this value.
1438 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1439 @code{\allowPageTurn}, may also be used at top-level, between scores and
1446 @funindex \noPageTurn
1448 @funindex \allowPageTurn
1449 @code{\allowPageTurn}.
1460 There should only be one @code{Page_turn_engraver} in a score. If there is more
1461 than one, they will interfere with each other.
1464 @node Minimal page breaking
1465 @subsection Minimal page breaking
1467 @funindex ly:minimal-breaking
1469 The @code{ly:minimal-breaking} function performs minimal computations to
1470 calculate the page breaking: it fills a page with as many systems as
1471 possible before moving to the next one. Thus, it may be preferred for
1472 scores with many pages, where the other page breaking functions could be
1473 too slow or memory demanding, or a lot of texts. It is enabled using:
1477 page-breaking = #ly:minimal-breaking
1487 @node Explicit breaks
1488 @subsection Explicit breaks
1490 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1491 commands. There are two commands to override this behavior:
1494 \override NonMusicalPaperColumn #'line-break-permission = ##f
1495 \override NonMusicalPaperColumn #'page-break-permission = ##f
1498 When @code{line-break-permission} is overridden to false, Lily will insert
1499 line breaks at explicit @code{\break} commands and nowhere else. When
1500 @code{page-break-permission} is overridden to false, Lily will insert
1501 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1503 @lilypond[quote,verbatim]
1510 music = \relative c'' { c8 c c c }
1514 \repeat unfold 2 { \music } \break
1515 \repeat unfold 4 { \music } \break
1516 \repeat unfold 6 { \music } \break
1517 \repeat unfold 8 { \music } \pageBreak
1518 \repeat unfold 8 { \music } \break
1519 \repeat unfold 6 { \music } \break
1520 \repeat unfold 4 { \music } \break
1521 \repeat unfold 2 { \music }
1526 \override NonMusicalPaperColumn #'line-break-permission = ##f
1527 \override NonMusicalPaperColumn #'page-break-permission = ##f
1539 @node Using an extra voice for breaks
1540 @subsection Using an extra voice for breaks
1542 Line- and page-breaking information usually appears within note entry directly.
1545 music = \relative c'' @{ c4 c c c @}
1549 \repeat unfold 2 @{ \music @} \break
1550 \repeat unfold 3 @{ \music @}
1555 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1556 music entry with information that specifies how music should lay out
1557 on the page. You can keep music entry and line- and page-breaking
1558 information in two separate places by introducing an extra voice to
1559 contain the breaks. This extra voice
1560 contains only skips together with @code{\break}, @code{pageBreak} and other
1561 breaking layout information.
1563 @lilypond[quote,verbatim]
1564 music = \relative c'' { c4 c c c }
1575 \repeat unfold 2 { \music }
1576 \repeat unfold 3 { \music }
1577 \repeat unfold 6 { \music }
1578 \repeat unfold 5 { \music }
1584 This pattern becomes especially helpful when overriding
1585 @code{line-break-system-details} and the other useful but long properties of
1586 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1588 @lilypond[quote,verbatim]
1589 music = \relative c'' { c4 c c c }
1594 \overrideProperty "Score.NonMusicalPaperColumn"
1595 #'line-break-system-details #'((Y-offset . 0))
1598 \overrideProperty "Score.NonMusicalPaperColumn"
1599 #'line-break-system-details #'((Y-offset . 35))
1602 \overrideProperty "Score.NonMusicalPaperColumn"
1603 #'line-break-system-details #'((Y-offset . 70))
1606 \overrideProperty "Score.NonMusicalPaperColumn"
1607 #'line-break-system-details #'((Y-offset . 105))
1611 \repeat unfold 2 { \music }
1612 \repeat unfold 3 { \music }
1613 \repeat unfold 6 { \music }
1614 \repeat unfold 5 { \music }
1623 @ref{Vertical spacing}.
1629 @node Vertical spacing
1630 @section Vertical spacing
1632 @cindex vertical spacing
1633 @cindex spacing, vertical
1635 Vertical spacing is controlled by three things: the amount of
1636 space available (i.e., paper size and margins), the amount of
1637 space between systems, and the amount of space between
1638 staves inside a system.
1641 * Flexible vertical spacing within systems::
1642 * Explicit staff and system positioning::
1643 * Vertical collision avoidance::
1647 @node Flexible vertical spacing within systems
1648 @subsection Flexible vertical spacing within systems
1650 @cindex distance between staves
1651 @cindex staff distance
1652 @cindex space between staves
1653 @cindex space inside systems
1655 Three separate mechanisms control the flexible vertical spacing
1656 within systems, one for each of the following categories:
1661 @emph{ungrouped staves},
1664 @emph{grouped staves} (staves within a staff-group such as
1665 @code{ChoirStaff}, etc.), and
1668 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1673 @c TODO: Clarify this. This almost implies that non-staff lines
1674 @c have NO effect on the spacing between staves. -mp
1676 The height of each system is determined in two steps. First, all
1677 of the staves are spaced according to the amount of space
1678 available. Then, the non-staff lines are distributed between the
1681 Note that the spacing mechanisms discussed in this section only
1682 control the vertical spacing of staves and non-staff lines within
1683 individual systems. The vertical spacing between separate
1684 systems, scores, markups, and margins is controlled by
1685 @code{\paper} variables, which are discussed in
1686 @ref{Flexible vertical spacing \paper variables}.
1689 * Within-system spacing properties::
1690 * Spacing of ungrouped staves::
1691 * Spacing of grouped staves::
1692 * Spacing of non-staff lines::
1696 @node Within-system spacing properties
1697 @unnumberedsubsubsec Within-system spacing properties
1699 The within-system vertical spacing mechanisms are controlled by
1700 two sets of grob properties. The first set is associated with the
1701 @code{VerticalAxisGroup} grob, which is created by all staves and
1702 non-staff lines. The second set is associated with the
1703 @code{StaffGrouper} grob, which can be created by staff-groups,
1704 but only if explicitly called. These properties are described
1705 individually at the end of this section.
1707 The names of these properties (except for @code{staff-affinity})
1708 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1709 @code{@var{item1}} and @code{@var{item2}} are the items to be
1710 spaced. Note that @code{@var{item2}} is not necessarily below
1711 @code{@var{item1}}; for example,
1712 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1713 non-staff line if @code{staff-affinity} is @code{#UP}.
1715 Each distance is measured between the @emph{reference points} of
1716 the two items. The reference point for a staff is the vertical
1717 center of its @code{StaffSymbol} (i.e. the middle line if
1718 @code{line-count} is odd; the middle space if @code{line-count} is
1719 even). The reference points for individual non-staff lines are
1720 given in the following table:
1722 @multitable {Non-staff line} {Reference point}
1723 @headitem Non-staff line @tab Reference point
1724 @item @code{ChordNames} @tab baseline
1725 @item @code{NoteNames} @tab baseline
1726 @item @code{Lyrics} @tab baseline
1727 @item @code{Dynamics} @tab vertical center
1728 @item @code{FiguredBass} @tab highest point
1729 @item @code{FretBoards} @tab top line
1732 In the following image, horizontal lines indicate the positions
1733 of these reference points:
1735 @lilypond[quote,noragged-right,line-width=110\mm]
1736 #(define zero-space '((padding . -inf.0) (space . 0)))
1738 alignToZero = \with {
1739 \override VerticalAxisGroup #'nonstaff-relatedstaff-spacing = #zero-space
1740 \override VerticalAxisGroup #'nonstaff-nonstaff-spacing = #zero-space
1742 lowerCaseChords = \with {
1743 chordNameLowercaseMinor = ##t
1745 staffAffinityDown = \with {
1746 \override VerticalAxisGroup #'staff-affinity = #DOWN
1749 #(define-music-function
1750 (parser location context)
1752 #{ s1*0^\markup { \typewriter $context } #})
1755 \context { \Dynamics \alignToZero }
1756 \context { \FiguredBass \alignToZero }
1757 \context { \Lyrics \alignToZero }
1758 \context { \NoteNames \alignToZero }
1759 \context { \ChordNames \alignToZero \lowerCaseChords }
1760 \context { \FretBoards \alignToZero \staffAffinityDown }
1762 \override BarLine #'stencil = ##f
1763 \override DynamicText #'self-alignment-X = #-1
1764 \override FretBoard #'X-offset = #1.75
1765 \override InstrumentName #'minimum-Y-extent = #'(-2 . 2)
1766 \override InstrumentName #'extra-offset = #'(0 . -0.5)
1767 \override TextScript #'minimum-Y-extent = #'(-2 . 3)
1768 \override TimeSignature #'stencil = ##f
1772 %% These contexts have reference points at the baseline:
1773 %% ChordNames, NoteNames, and Lyrics
1775 \new ChordNames { \chords { g1:m } }
1776 \new NoteNames { s1 | g1 | }
1777 \new RhythmicStaff {
1778 \set RhythmicStaff.instrumentName = #"baseline "
1780 \labelContext "ChordNames" s1 |
1781 \labelContext "NoteNames" s1 |
1782 \labelContext "Lyrics" s1 |
1784 \new Lyrics { \lyrics { \skip 1*2 | ghijk1 | } }
1787 %% The reference point for Dynamics is its vertical center
1789 \new RhythmicStaff {
1790 \set RhythmicStaff.instrumentName = #"vertical center "
1791 \labelContext "Dynamics" s1*3
1793 \new Dynamics { s2\mp s\fp }
1796 %% The reference point for FiguredBass is its highest point
1798 \new RhythmicStaff {
1799 \set RhythmicStaff.instrumentName = #"highest point "
1800 \labelContext "FiguredBass" s1
1802 \new FiguredBass { \figuremode { <6 5>1 } }
1805 %% The reference point for FretBoards is the top line
1806 \include "predefined-guitar-fretboards.ly"
1808 \new FretBoards { \chordmode { e1 } }
1809 \new RhythmicStaff {
1810 \set RhythmicStaff.instrumentName = #"top line "
1811 \labelContext "FretBoards " s1
1816 Each of the vertical spacing grob properties (except
1817 @code{staff-affinity}) is stored as an alist (association list),
1818 and each uses the same alist structure as the @code{\paper}
1819 spacing variables discussed in
1820 @ref{Flexible vertical spacing \paper variables}. Specific methods
1821 for modifying alists are discussed in @ref{Modifying alists}.
1822 Grob properties should be adjusted with an @code{\override} inside
1823 a @code{\score} or @code{\layout} block, and not inside a
1824 @code{\paper} block.
1826 The following example demonstrates the two ways these alists can
1827 be modified. The first declaration updates one key-value
1828 individually, and the second completely re-defines the property:
1832 \override VerticalAxisGroup #'staff-staff-spacing #'space = #10
1836 \override VerticalAxisGroup #'staff-staff-spacing =
1839 (minimum-distance . 9)
1840 (stretchability . 10))
1844 To change any spacing settings globally, put them in the
1845 @code{\layout} block:
1851 \override VerticalAxisGroup #'staff-staff-spacing #'space = #10
1856 Standard settings for the vertical spacing grob properties are
1857 listed in @rinternals{VerticalAxisGroup} and
1858 @rinternals{StaffGrouper}. Default overrides for specific types
1859 of non-staff lines are listed in the relevant context descriptions
1860 in @rinternals{Contexts}.
1863 @subsubheading Properties of the @code{VerticalAxisGroup} grob
1865 @code{VerticalAxisGroup} properties are typically adjusted with an
1866 @code{\override} at the @code{Staff} level (or equivalent).
1869 @item staff-staff-spacing
1870 The distance between the current staff and the staff just below it
1871 in the same system, even if one or more non-staff lines (such as
1872 @code{Lyrics}) are placed between the two staves. Does not apply
1873 to the bottom staff of a system. This replaces any settings
1874 inherited from the @code{StaffGrouper} grob of the containing
1875 staff-group, if there is one. If this is unset, and there are no
1876 @code{StaffGrouper} properties to inherit, the
1877 @code{default-staff-staff-spacing} property is used.
1879 @item default-staff-staff-spacing
1880 The settings to use for @code{staff-staff-spacing} when it is
1881 unset. This applies to ungrouped staves and to grouped staves
1882 that do not inherit settings from the @code{StaffGrouper} grob.
1884 @item staff-affinity
1885 The direction of the staff to use for spacing the current
1886 non-staff line. Choices are @code{UP}, @code{DOWN}, and
1887 @code{CENTER}. If @code{CENTER}, the non-staff line will be
1888 placed equidistant between the two nearest staves on either side,
1889 unless collisions or other spacing constraints prevent this.
1890 Adjacent non-staff lines should have non-increasing
1891 @code{staff-affinity} from top to bottom, e.g. a non-staff line
1892 set to @code{UP} should not immediately follow one that is set to
1893 @code{DOWN}. Non-staff lines at the top of a system should use
1894 @code{DOWN}; those at the bottom should use @code{UP}. Setting
1895 @code{staff-affinity} for a staff causes it to be treated as a
1896 non-staff line. Setting @code{staff-affinity} to @code{#f} causes
1897 a non-staff line to be treated as a staff.
1899 @c TODO: verify last clause below ("even if other...")
1901 @item nonstaff-relatedstaff-spacing
1902 The distance between the current non-staff line and the nearest
1903 staff in the direction of @code{staff-affinity}, if there are no
1904 non-staff lines between the two, and @code{staff-affinity} is
1905 either @code{UP} or @code{DOWN}. If @code{staff-affinity} is
1906 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
1907 for the nearest staves on @emph{both} sides, even if other
1908 non-staff lines appear between the current one and either of the
1911 @item nonstaff-nonstaff-spacing
1912 The distance between the current non-staff line and the next
1913 non-staff line in the direction of @code{staff-affinity}, if both
1914 are on the same side of the related staff, and
1915 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
1917 @item nonstaff-unrelatedstaff-spacing
1918 The distance between the current non-staff line and the staff in
1919 the opposite direction from @code{staff-affinity}, if there are no
1920 other non-staff lines between the two, and @code{staff-affinity}
1921 is either @code{UP} or @code{DOWN}. This can be used, for
1922 example, to require a minimum amount of padding between a
1923 @code{Lyrics} line and the staff to which it does not belong.
1927 @subsubheading Properties of the @code{StaffGrouper} grob
1929 @code{StaffGrouper} properties are typically adjusted with an
1930 @code{\override} at the @code{StaffGroup} level (or equivalent).
1933 @item staff-staff-spacing
1934 The distance between consecutive staves within the current
1935 staff-group. The @code{staff-staff-spacing} property of an
1936 individual staff's @code{VerticalAxisGroup} grob will be used
1937 instead for any staves in the staff-group that have it set. Also
1938 see @code{default-staff-staff-spacing}.
1940 @item staffgroup-staff-spacing
1941 The distance between the last staff of the current staff-group and
1942 the staff just below it in the same system, even if one or more
1943 non-staff lines (such as @code{Lyrics}) exist between the two
1944 staves. Does not apply to the bottom staff of a system. The
1945 @code{staff-staff-spacing} property of an individual staff's
1946 @code{VerticalAxisGroup} grob will be used instead for any staves
1947 in the staff-group that have it set. Also see
1948 @code{default-staff-staff-spacing}.
1953 @file{ly/engraver-init.ly},
1954 @file{scm/define-grobs.scm}.
1956 Internals Reference:
1957 @rinternals{Contexts},
1958 @rinternals{VerticalAxisGroup},
1959 @rinternals{StaffGrouper}.
1962 @node Spacing of ungrouped staves
1963 @unnumberedsubsubsec Spacing of ungrouped staves
1965 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
1966 @code{TabStaff}, etc.) are contexts that can contain one or more
1967 voice contexts, but cannot contain any other staves.
1969 The following properties affect the spacing of @emph{ungrouped}
1973 @item @code{VerticalAxisGroup} properties:
1975 @item @code{staff-staff-spacing}
1979 These grob properties are described individually above; see
1980 @ref{Within-system spacing properties}.
1982 Additional properties are involved for staves that are part of a
1983 staff-group; see @ref{Spacing of grouped staves}.
1985 The following example shows how the @code{staff-staff-spacing}
1986 property can affect the spacing of ungrouped staves:
1988 @lilypond[verbatim,quote,staffsize=16]
1992 \override VerticalAxisGroup #'staff-staff-spacing =
1995 (minimum-distance . 7))
2000 % The very low note here needs more room than 'space can
2001 % provide, so the distance between this staff and the next is
2002 % determined by 'padding.
2003 \new Staff { b,2 r | }
2005 % Here, 'space provides enough room, and there is no need to
2006 % compress the space (towards 'minimum-distance) to make room
2007 % for anything else on the page, so the distance between this
2008 % staff and the next is determined by 'space.
2009 \new Staff { \clef bass g2 r | }
2011 % By setting 'padding to a negative value, staves can be made to
2012 % collide. The lowest acceptable value for 'space is 0.
2014 \override VerticalAxisGroup #'staff-staff-spacing =
2017 } { \clef bass g2 r | }
2018 \new Staff { \clef bass g2 r | }
2024 @file{scm/define-grobs.scm}.
2029 Internals Reference:
2030 @rinternals{VerticalAxisGroup}.
2033 @node Spacing of grouped staves
2034 @unnumberedsubsubsec Spacing of grouped staves
2036 In orchestral and other large scores, it is common to place staves
2037 in groups. The space between groups is typically larger than the
2038 space between staves of the same group.
2040 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2041 etc.) are contexts that can contain one or more staves
2044 The following properties affect the spacing of staves inside
2048 @item @code{VerticalAxisGroup} properties:
2050 @item @code{staff-staff-spacing}
2051 @item @code{default-staff-staff-spacing}
2053 @item @code{StaffGrouper} properties:
2055 @item @code{staff-staff-spacing}
2056 @item @code{staffgroup-staff-spacing}
2060 These grob properties are described individually above; see
2061 @ref{Within-system spacing properties}.
2063 The following example shows how properties of the
2064 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2066 @lilypond[verbatim,quote,staffsize=16]
2070 \override StaffGrouper #'staff-staff-spacing #'padding = #0
2071 \override StaffGrouper #'staff-staff-spacing #'space = #1
2076 \new PianoStaff \with {
2077 \override StaffGrouper #'staffgroup-staff-spacing #'space = #20
2092 @file{scm/define-grobs.scm}.
2097 Internals Reference:
2098 @rinternals{VerticalAxisGroup},
2099 @rinternals{StaffGrouper}.
2102 @node Spacing of non-staff lines
2103 @unnumberedsubsubsec Spacing of non-staff lines
2105 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2106 etc.) are contexts whose layout objects are engraved like staves
2107 (i.e. in horizontal lines within systems). Specifically,
2108 non-staff lines are non-staff contexts that create the
2109 @code{VerticalAxisGroup} layout object.
2111 The following properties affect the spacing of non-staff lines:
2114 @item @code{VerticalAxisGroup} properties:
2116 @item @code{staff-affinity}
2117 @item @code{nonstaff-relatedstaff-spacing}
2118 @item @code{nonstaff-nonstaff-spacing}
2119 @item @code{nonstaff-unrelatedstaff-spacing}
2123 These grob properties are described individually above; see
2124 @ref{Within-system spacing properties}.
2126 The following example shows how the
2127 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2128 of consecutive non-staff lines. Here, by setting the
2129 @code{stretchability} key to a very high value, the lyrics are
2130 able to stretch much more than usual:
2132 @lilypond[verbatim,quote,staffsize=16]
2136 \override VerticalAxisGroup
2137 #'nonstaff-nonstaff-spacing #'stretchability = #1000
2144 \override VerticalAxisGroup #'staff-staff-spacing = #'((space . 30))
2147 \override VerticalAxisGroup #'staff-affinity = #UP
2150 \override VerticalAxisGroup #'staff-affinity = #CENTER
2151 } \lyricmode { center }
2153 \override VerticalAxisGroup #'staff-affinity = #DOWN
2154 } \lyricmode { down }
2162 @file{ly/engraver-init.ly},
2163 @file{scm/define-grobs.scm}.
2168 @c @lsr{spacing,page-spacing.ly},
2169 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2171 Internals Reference:
2172 @rinternals{Contexts},
2173 @rinternals{VerticalAxisGroup}.
2176 @node Explicit staff and system positioning
2177 @subsection Explicit staff and system positioning
2179 One way to understand the flexible vertical spacing mechanisms
2180 explained above is as a collection of settings that control the
2181 amount of vertical padding between staves and systems.
2183 It is possible to approach vertical spacing in a different way
2184 using @code{NonMusicalPaperColumn #'line-break-system-details}.
2185 While the flexible vertical spacing mechanisms specify vertical
2186 padding, @code{NonMusicalPaperColumn #'line-break-system-details}
2187 can specify exact vertical positions on the page.
2189 @code{NonMusicalPaperColumn #'line-break-system-details} accepts
2190 an associative list of three different settings:
2193 @item @code{X-offset}
2194 @item @code{Y-offset}
2195 @item @code{alignment-distances}
2198 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2199 below, can occur in any of three different places in an input file:
2202 @item in the middle of note entry directly
2203 @item in a @code{\context} block
2204 @item in the @code{\with} block
2207 When we override @code{NonMusicalPaperColumn}, we use the usual
2208 @code{\override} command in @code{\context} blocks and in the
2209 @code{\with} block. On the other hand, when we override
2210 @code{NonMusicalPaperColumn} in the middle of note entry,
2211 use the special @code{\overrideProperty} command. Here are some
2212 example @code{NonMusicalPaperColumn} overrides with the special
2213 @code{\overrideProperty} command:
2216 \overrideProperty NonMusicalPaperColumn
2217 #'line-break-system-details #'((X-offset . 20))
2219 \overrideProperty NonMusicalPaperColumn
2220 #'line-break-system-details #'((Y-offset . 40))
2222 \overrideProperty NonMusicalPaperColumn
2223 #'line-break-system-details #'((X-offset . 20)
2226 \overrideProperty NonMusicalPaperColumn
2227 #'line-break-system-details #'((alignment-distances . (15)))
2229 \overrideProperty NonMusicalPaperColumn
2230 #'line-break-system-details #'((X-offset . 20)
2232 (alignment-distances . (15)))
2235 To understand how each of these different settings work, we begin
2236 by looking at an example that includes no overrides at all.
2238 @c \book { } is required in these examples to ensure the spacing
2239 @c overrides can be seen between systems. -np
2241 @lilypond[verbatim,quote,staffsize=16]
2242 \header { tagline = ##f }
2243 \paper { left-margin = 0\mm }
2253 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2256 \repeat unfold 15 { d'4 d' d' d' }
2263 This score isolates line- and page-breaking information in a dedicated
2264 voice. This technique of creating a breaks voice will help keep layout
2265 separate from music entry as our example becomes more complicated.
2266 See @ref{Using an extra voice for breaks}.
2268 Explicit @code{\breaks} evenly divide the music into six measures per
2269 line. Vertical spacing results from LilyPond's defaults. To set
2270 the vertical startpoint of each system explicitly, we can set
2271 the @code{Y-offset} pair in the @code{line-break-system-details}
2272 attribute of the @code{NonMusicalPaperColumn} grob:
2274 @lilypond[verbatim,quote,staffsize=16]
2275 \header { tagline = ##f }
2276 \paper { left-margin = 0\mm }
2282 \overrideProperty #"Score.NonMusicalPaperColumn"
2283 #'line-break-system-details #'((Y-offset . 0))
2285 \overrideProperty #"Score.NonMusicalPaperColumn"
2286 #'line-break-system-details #'((Y-offset . 40))
2288 \overrideProperty #"Score.NonMusicalPaperColumn"
2289 #'line-break-system-details #'((Y-offset . 80))
2292 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2295 \repeat unfold 15 { d'4 d' d' d' }
2302 Note that @code{line-break-system-details} takes an associative list of
2303 potentially many values, but that we set only one value here. Note,
2304 too, that the @code{Y-offset} property here determines the exact vertical
2305 position on the page at which each new system will render.
2307 Now that we have set the vertical startpoint of each system
2308 explicitly, we can also set the vertical distances between staves
2309 within each system manually. We do this using the @code{alignment-distances}
2310 subproperty of @code{line-break-system-details}.
2312 @lilypond[verbatim,quote,staffsize=16]
2313 \header { tagline = ##f }
2314 \paper { left-margin = 0\mm }
2320 \overrideProperty #"Score.NonMusicalPaperColumn"
2321 #'line-break-system-details #'((Y-offset . 20)
2322 (alignment-distances . (15)))
2324 \overrideProperty #"Score.NonMusicalPaperColumn"
2325 #'line-break-system-details #'((Y-offset . 60)
2326 (alignment-distances . (15)))
2328 \overrideProperty #"Score.NonMusicalPaperColumn"
2329 #'line-break-system-details #'((Y-offset . 100)
2330 (alignment-distances . (15)))
2333 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2336 \repeat unfold 15 { d'4 d' d' d' }
2343 Note that here we assign two different values to the
2344 @code{line-break-system-details} attribute of the
2345 @code{NonMusicalPaperColumn} grob. Though the
2346 @code{line-break-system-details} attribute alist accepts many
2347 additional spacing parameters (including, for example, a corresponding
2348 @code{X-offset} pair), we need only set the @code{Y-offset} and
2349 @code{alignment-distances} pairs to control the vertical startpoint of
2350 every system and every staff. Finally, note that @code{alignment-distances}
2351 specifies the vertical positioning of staves but not of staff groups.
2353 @lilypond[verbatim,quote,staffsize=16]
2354 \header { tagline = ##f }
2355 \paper { left-margin = 0\mm }
2361 \overrideProperty #"Score.NonMusicalPaperColumn"
2362 #'line-break-system-details #'((Y-offset . 0)
2363 (alignment-distances . (30 10)))
2365 \overrideProperty #"Score.NonMusicalPaperColumn"
2366 #'line-break-system-details #'((Y-offset . 60)
2367 (alignment-distances . (10 10)))
2369 \overrideProperty #"Score.NonMusicalPaperColumn"
2370 #'line-break-system-details #'((Y-offset . 100)
2371 (alignment-distances . (10 30)))
2374 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2377 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2378 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2385 Some points to consider:
2388 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2389 do not count as a staff.
2391 @item The units of the numbers passed to @code{X-offset},
2392 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2393 of the distance between adjacent staff lines. Positive values move staves
2394 and lyrics up, negative values move staves and lyrics down.
2396 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
2397 settings given here allow the positioning of staves and systems anywhere
2398 on the page, it is possible to violate paper or margin boundaries or even
2399 to print staves or systems on top of one another. Reasonable values
2400 passed to these different settings will avoid this.
2409 @node Vertical collision avoidance
2410 @subsection Vertical collision avoidance
2412 @funindex outside-staff-priority
2413 @funindex outside-staff-padding
2414 @funindex outside-staff-horizontal-padding
2416 Intuitively, there are some objects in musical notation that belong
2417 to the staff and there are other objects that should be placed outside
2418 the staff. Objects belonging outside the staff include things such as
2419 rehearsal marks, text and dynamic markings (from now on, these will
2420 be called outside-staff objects). LilyPond's rule for the
2421 vertical placement of outside-staff objects is to place them as close
2422 to the staff as possible but not so close that they collide with
2425 LilyPond uses the @code{outside-staff-priority} property to determine
2426 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2427 is a number, the grob is an outside-staff object. In addition,
2428 @code{outside-staff-priority} tells LilyPond in which order the objects
2431 First, LilyPond places all the objects that do not belong outside
2432 the staff. Then it sorts the outside-staff objects according to their
2433 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
2434 takes the outside-staff objects and places them so that they do
2435 not collide with any objects that have already been placed. That
2436 is, if two outside-staff grobs are competing for the same space, the one
2437 with the lower @code{outside-staff-priority} will be placed closer to
2440 @lilypond[quote,ragged-right,relative=2,verbatim]
2443 \once \override TextScript #'outside-staff-priority = #1
2444 c4_"Text"\pp % this time the text will be closer to the staff
2446 % by setting outside-staff-priority to a non-number,
2447 % we disable the automatic collision avoidance
2448 \once \override TextScript #'outside-staff-priority = ##f
2449 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
2450 c4_"Text"\pp % now they will collide
2453 The vertical padding between an outside-staff object and the
2454 previously-positioned grobs can be controlled with
2455 @code{outside-staff-padding}.
2457 @lilypond[quote,ragged-right,relative=2,verbatim]
2458 \once \override TextScript #'outside-staff-padding = #0
2459 a'^"This text is placed very close to the note"
2460 \once \override TextScript #'outside-staff-padding = #3
2461 c^"This text is padded away from the previous text"
2462 c^"This text is placed close to the previous text"
2466 By default, outside-staff objects are placed only to avoid
2467 a horizontal collision with previously-positioned grobs. This
2468 can lead to situations in which objects are placed very close to each
2469 other horizontally. The vertical spacing between staves can
2470 also be set so that outside staff objects are interleaved.
2471 Setting @code{outside-staff-horizontal-padding}
2472 causes an object to be offset vertically so that such a situation
2475 @lilypond[quote,ragged-right,relative=2,verbatim]
2476 % the markup is too close to the following note
2480 % setting outside-staff-horizontal-padding fixes this
2482 \once \override TextScript #'outside-staff-horizontal-padding = #1
2494 @node Horizontal spacing
2495 @section Horizontal spacing
2497 @cindex horizontal spacing
2498 @cindex spacing, horizontal
2501 * Horizontal spacing overview::
2502 * New spacing area::
2503 * Changing horizontal spacing::
2505 * Proportional notation::
2509 @node Horizontal spacing overview
2510 @subsection Horizontal spacing overview
2512 The spacing engine translates differences in durations into stretchable
2513 distances (@q{springs}) of differing lengths. Longer durations get
2514 more space, shorter durations get less. The shortest durations get a
2515 fixed amount of space (which is controlled by
2516 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2517 object). The longer the duration, the more space it gets: doubling a
2518 duration adds a fixed amount (this amount is controlled by
2519 @code{spacing-increment}) of space to the note.
2521 For example, the following piece contains lots of half, quarter, and
2522 8th notes; the eighth note is followed by 1 note head width (NHW).
2523 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2525 @lilypond[quote,verbatim,relative=1]
2526 c2 c4. c8 c4. c8 c4. c8 c8
2530 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2531 approximately the width of a note head, and
2532 @code{shortest-duration-space} is set to 2.0, meaning that the
2533 shortest note gets 2.4 staff space (2.0 times the
2534 @code{spacing-increment}) of horizontal space. This space is counted
2535 from the left edge of the symbol, so the shortest notes are generally
2536 followed by one NHW of space.
2538 If one would follow the above procedure exactly, then adding a single
2539 32nd note to a score that uses 8th and 16th notes, would widen up the
2540 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2541 thus adding 1 NHW to every note. To prevent this, the shortest
2542 duration for spacing is not the shortest note in the score, but rather
2543 the one which occurs most frequently.
2546 The most common shortest duration is determined as follows: in every
2547 measure, the shortest duration is determined. The most common shortest
2548 duration is taken as the basis for the spacing, with the stipulation
2549 that this shortest duration should always be equal to or shorter than
2550 an 8th note. The shortest duration is printed when you run
2551 @code{lilypond} with the @code{--verbose} option.
2553 These durations may also be customized. If you set the
2554 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2555 this sets the base duration for spacing. The maximum duration for this
2556 base (normally an 8th), is set through @code{base-shortest-duration}.
2558 @funindex common-shortest-duration
2559 @funindex base-shortest-duration
2560 @funindex stem-spacing-correction
2563 Notes that are even shorter than the common shortest note are
2564 followed by a space that is proportional to their duration relative to
2565 the common shortest note. So if we were to add only a few 16th notes
2566 to the example above, they would be followed by half a NHW:
2568 @lilypond[quote,verbatim,relative=2]
2569 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2573 In the @emph{Essay on automated music engraving}, it was explained
2574 that stem directions influence spacing (see @ressay{Optical
2575 spacing}). This is controlled with the
2576 @code{stem-spacing-correction} property in the
2577 @rinternals{NoteSpacing}, object. These are generated for every
2578 @rinternals{Voice} context. The @code{StaffSpacing} object
2579 (generated in @rinternals{Staff} context) contains the same
2580 property for controlling the stem/bar line spacing. The following
2581 example shows these corrections, once with default settings, and
2582 once with exaggerated corrections:
2584 @lilypond[quote,ragged-right]
2588 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2589 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2595 Proportional notation is supported; see @ref{Proportional notation}.
2602 Internals Reference:
2603 @rinternals{SpacingSpanner},
2604 @rinternals{NoteSpacing},
2605 @rinternals{StaffSpacing},
2606 @rinternals{NonMusicalPaperColumn}.
2611 There is no convenient mechanism to manually override spacing. The
2612 following work-around may be used to insert extra space into a score,
2613 adjusting the padding value as necessary.
2615 \override Score.NonMusicalPaperColumn #'padding = #10
2618 No work-around exists for decreasing the amount of space.
2621 @node New spacing area
2622 @subsection New spacing area
2624 New sections with different spacing parameters can be started with
2625 @code{newSpacingSection}. This is useful when there are
2626 sections with a different notions of long and short notes.
2628 In the following example, the time signature change introduces a new
2629 section, and hence the 16ths notes are spaced wider.
2631 @lilypond[relative=1,verbatim,quote]
2634 c8 c c4 c16[ c c8] c4
2640 The @code{\newSpacingSection} command creates a new
2641 @code{SpacingSpanner} object, and hence new @code{\override}s
2642 may be used in that location.
2649 Internals Reference:
2650 @rinternals{SpacingSpanner}.
2653 @node Changing horizontal spacing
2654 @subsection Changing horizontal spacing
2656 Horizontal spacing may be altered with the
2657 @code{base-shortest-duration} property. Here
2658 we compare the same music; once without altering
2659 the property, and then altered. Larger values
2660 of @code{ly:make-moment} will produce smaller
2661 music. Note that @code{ly:make-moment} constructs
2662 a duration, so @code{1 4} is a longer duration
2665 @lilypond[verbatim,line-width=12\cm]
2668 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2669 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2670 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2671 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2676 @lilypond[verbatim,line-width=12\cm]
2679 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2680 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2681 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2682 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2687 \override SpacingSpanner
2688 #'base-shortest-duration = #(ly:make-moment 1 16)
2697 By default, spacing in tuplets depends on various non-duration
2698 factors (such as accidentals, clef changes, etc). To disregard
2699 such symbols and force uniform equal-duration spacing, use
2700 @code{Score.SpacingSpanner #'uniform-stretching}. This
2701 property can only be changed at the beginning of a score,
2703 @lilypond[quote,ragged-right,verbatim]
2722 \override SpacingSpanner #'uniform-stretching = ##t
2728 When @code{strict-note-spacing} is set, notes are spaced without
2729 regard for clefs, bar lines, and grace notes,
2731 @lilypond[quote,ragged-right,relative=2,verbatim]
2732 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2733 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2743 @subsection Line length
2746 @cindex breaking pages
2749 @funindex line-width
2750 @funindex ragged-right
2751 @funindex ragged-last
2753 @c Although line-width can be set in \layout, it should be set in paper
2754 @c block, to get page layout right.
2755 @c Setting indent in \paper block makes not much sense, but it works.
2757 @c Bit verbose and vague, use examples?
2758 The most basic settings influencing the spacing are @code{indent} and
2759 @code{line-width}. They are set in the @code{\layout} block. They
2760 control the indentation of the first line of music, and the lengths of
2763 If @code{ragged-right} is set to true in the @code{\layout} block, then
2764 systems ends at their natural horizontal length, instead of being spread
2765 horizontally to fill the whole line. This is useful for
2766 short fragments, and for checking how tight the natural spacing is.
2767 The normal default setting is false, but if the score has only one
2768 system the default value is true.
2771 @cindex vertical spacing
2773 The option @code{ragged-last} is similar to @code{ragged-right}, but
2774 only affects the last line of the piece. No restrictions are put on
2775 that line. The result is similar to formatting text paragraphs. In a
2776 paragraph, the last line simply takes its natural horizontal length.
2777 @c Note that for text there are several options for the last line.
2778 @c While Knuth TeX uses natural length, lead typesetters use the same
2779 @c stretch as the previous line. eTeX uses \lastlinefit to
2780 @c interpolate between both these solutions.
2796 @node Proportional notation
2797 @subsection Proportional notation
2799 LilyPond supports proportional notation, a type of horizontal spacing
2800 in which each note consumes an amount of horizontal space exactly
2801 equivalent to its rhythmic duration. This type of proportional spacing
2802 is comparable to horizontal spacing on top of graph paper. Some late
2803 20th- and early 21st-century scores use proportional notation to
2804 clarify complex rhythmic relationships or to facilitate the placement
2805 of timelines or other graphics directly in the score.
2807 LilyPond supports five different settings for proportional notation,
2808 which may be used together or alone:
2811 @item @code{proportionalNotationDuration}
2812 @item @code{uniform-stretching}
2813 @item @code{strict-note-spacing}
2814 @item @code{\remove Separating_line_group_engraver}
2815 @item @code{\override PaperColumn #'used = ##t}
2818 In the examples that follow, we explore these five different
2819 proportional notation settings and examine how these settings interact.
2821 We start with the following one-measure example, which uses classical
2822 spacing with ragged-right turned on.
2824 @lilypond[quote,verbatim,ragged-right]
2827 \new RhythmicStaff {
2831 c'16 c'16 c'16 c'16 c'16
2838 Notice that the half note which begins the measure takes up far less
2839 than half of the horizontal space of the measure. Likewise, the
2840 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
2841 which end the measure together take up far more than half the
2842 horizontal space of the measure.
2844 In classical engraving, this spacing may be exactly what we want
2845 because we can borrow horizontal space from the half note and conserve
2846 horizontal space across the measure as a whole.
2848 On the other hand, if we want to insert a measured timeline or other
2849 graphic above or below our score, we need proportional notation. We
2850 turn proportional notation on with the proportionalNotationDuration
2853 @lilypond[quote,verbatim,ragged-right]
2856 \new RhythmicStaff {
2860 c'16 c'16 c'16 c'16 c'16
2867 proportionalNotationDuration = #(ly:make-moment 1 20)
2873 The half note at the beginning of the measure and the faster notes in
2874 the second half of the measure now occupy equal amounts of horizontal
2875 space. We could place a measured timeline or graphic above or below
2878 The @code{proportionalNotationDuration} setting is a context setting
2879 that lives in @code{Score}. Remember that context settings can appear
2880 in one of three locations within our input file -- in a @code{\with}
2881 block, in a @code{\context} block, or directly in music entry preceded
2882 by the @code{\set} command. As with all context settings, users can
2883 pick which of the three different locations they would like to
2884 set @code{proportionalNotationDuration} in to.
2886 The @code{proportionalNotationDuration} setting takes a single argument,
2887 which is the reference duration against that all music will be spaced.
2888 The LilyPond Scheme function @code{make-moment} takes two arguments
2889 -- a numerator and denominator which together express some fraction of
2890 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces
2891 a reference duration of a twentieth note. Values such as
2892 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
2893 @code{#(ly:make-moment 3 97)} are all possible as well.
2895 How do we select the right reference duration to pass to
2896 @code{proportionalNotationDuration}? Usually by a process of trial
2897 and error, beginning with a duration close to the fastest (or smallest)
2898 duration in the piece. Smaller reference durations space music loosely;
2899 larger reference durations space music tightly.
2901 @lilypond[quote,verbatim,ragged-right]
2904 \new RhythmicStaff {
2908 c'16 c'16 c'16 c'16 c'16
2915 proportionalNotationDuration = #(ly:make-moment 1 8)
2922 \new RhythmicStaff {
2926 c'16 c'16 c'16 c'16 c'16
2933 proportionalNotationDuration = #(ly:make-moment 1 16)
2940 \new RhythmicStaff {
2944 c'16 c'16 c'16 c'16 c'16
2951 proportionalNotationDuration = #(ly:make-moment 1 32)
2957 Note that too large a reference duration -- such as the eighth note,
2958 above -- spaces music too tightly and can cause note head collisions.
2959 Also that proportional notation in general takes up more horizontal
2960 space than classical spacing. Proportional spacing provides rhythmic
2961 clarity at the expense of horizontal space.
2963 Next we examine how to optimally space overlapping tuplets.
2965 We start by examining what happens to our original example, with
2966 classical spacing, when we add a second staff with a different type of
2969 @lilypond[quote,verbatim,ragged-right]
2972 \new RhythmicStaff {
2976 c'16 c'16 c'16 c'16 c'16
2979 \new RhythmicStaff {
2981 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2988 The spacing is bad because the evenly spaced notes of the bottom staff
2989 do not stretch uniformly. Classical engravings include very few complex
2990 triplets and so classical engraving rules can generate this type of
2991 result. Setting @code{proportionalNotationDuration} fixes this.
2993 @lilypond[quote,verbatim,ragged-right]
2996 \new RhythmicStaff {
3000 c'16 c'16 c'16 c'16 c'16
3003 \new RhythmicStaff {
3005 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3012 proportionalNotationDuration = #(ly:make-moment 1 20)
3018 But if we look very carefully we can see that notes of the second half
3019 of the 9-tuplet space ever so slightly more widely than the notes
3020 of the first half of the 9-tuplet. To ensure uniform stretching, we
3021 turn on @code{uniform-stretching}, which is a property of
3022 @code{SpacingSpanner}.
3024 @lilypond[quote,verbatim,ragged-right]
3027 \new RhythmicStaff {
3031 c'16 c'16 c'16 c'16 c'16
3034 \new RhythmicStaff {
3036 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3043 proportionalNotationDuration = #(ly:make-moment 1 20)
3044 \override SpacingSpanner #'uniform-stretching = ##t
3050 Our two-staff example now spaces exactly, our rhythmic
3051 relationships are visually clear, and we can include a measured
3052 timeline or graphic if we want.
3054 Note that the LilyPond's proportional notation package expects
3055 that all proportional scores set the SpacingSpanner's
3056 'uniform-stretching attribute to ##t. Setting
3057 proportionalNotationDuration without also setting the
3058 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3059 example, cause Skips to consume an incorrect amount of horizontal
3062 The SpacingSpanner is an abstract grob that lives in the Score
3063 context. As with our settings of proportionalNotationDuration,
3064 overrides to the SpacingSpanner can occur in any of three
3065 different places in our input file – in the Score \with block, in
3066 a Score \context block, or in note entry directly.
3068 There is by default only one @code{SpacingSpanner} per @code{Score}. This
3069 means that, by default, @code{uniform-stretching} is either turned on for the
3070 entire score or turned off for the entire score. We can, however,
3071 override this behavior and turn on different spacing features at
3072 different places in the score. We do this with the command
3073 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
3075 Next we examine the effects of the @code{Separating_line_group_engraver} and
3076 see why proportional scores frequently remove this engraver. The following
3077 example shows that there is a small amount of @qq{preferatory} space
3078 just before the first note in each system.
3080 @lilypond[quote,verbatim,ragged-right]
3093 The amount of this preferatory space is the same whether after a time
3094 signature, a key signature or a clef. @code{Separating_line_group_engraver}
3095 is responsible for this space. Removing @code{Separating_line_group_engraver}
3096 reduces this space to zero.
3098 @lilypond[quote,verbatim,ragged-right]
3104 \remove Separating_line_group_engraver
3112 Nonmusical elements like time signatures, key signatures, clefs and
3113 accidentals are problematic in proportional notation. None of these
3114 elements has rhythmic duration. But all of these elements consume
3115 horizontal space. Different proportional scores approach these
3116 problems differently.
3118 It may be possible to avoid spacing problems with key signatures
3119 simply by not having any. This is a valid option since most
3120 proportional scores are contemporary music. The same may be true
3121 of time signatures, especially for those scores
3122 that include a measured timeline or other graphic. But these scores
3123 are exceptional and most proportional scores include at least some
3124 time signatures. Clefs and accidentals are even more essential.
3126 So what strategies exist for spacing nonmusical elements in a
3127 proportional context? One good option is the @code{strict-note-spacing}
3128 property of @code{SpacingSpanner}. Compare the two scores below:
3130 @lilypond[quote,verbatim,ragged-right]
3132 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3142 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3143 \override Score.SpacingSpanner #'strict-note-spacing = ##t
3153 Both scores are proportional, but the spacing in the first score
3154 is too loose because of the clef change. The spacing of the second
3155 score remains strict, however, because strict-note-spacing is
3156 turned on. Turning on strict-note-spacing causes the width of
3157 time signatures, key signatures, clefs and accidentals to play no
3158 part in the spacing algorithm.
3160 In addition to the settings given here, there are other settings
3161 that frequently appear in proportional scores. These include:
3164 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
3165 @item @code{tupletFullLength = ##t}
3166 @item @code{\override Beam #'breakable = ##t}
3167 @item @code{\override Glissando #'breakable = ##t}
3168 @item @code{\override TextSpanner #'breakable = ##t}
3169 @item @code{\remove Forbid_line_break_engraver in the Voice context}
3172 These settings space grace notes strictly, extend tuplet brackets to
3173 mark both rhythmic start- and stop-points, and allow spanning elements
3174 to break across systems and pages. See the respective parts of the manual
3175 for these related settings.
3180 @ref{New spacing area}.
3186 @node Fitting music onto fewer pages
3187 @section Fitting music onto fewer pages
3189 Sometimes you can end up with one or two staves on a second
3190 (or third, or fourth...) page. This is annoying, especially
3191 if you look at previous pages and it looks like there is plenty
3192 of room left on those.
3194 When investigating layout issues, @code{annotate-spacing} is an
3195 invaluable tool. This command prints the values of various layout
3196 spacing variables; for more details see the following section,
3197 @ref{Displaying spacing}.
3200 * Displaying spacing::
3201 * Changing spacing::
3205 @node Displaying spacing
3206 @subsection Displaying spacing
3208 @funindex annotate-spacing
3209 @cindex spacing, display of layout
3211 To graphically display the dimensions of vertical layout variables
3212 that may be altered for page formatting, set
3213 @code{annotate-spacing} in the @code{\paper} block:
3215 @c need to have \book{} otherwise we get the separate systems. -hwn
3216 @lilypond[verbatim,quote]
3217 #(set-default-paper-size "a6" 'landscape)
3220 \paper { annotate-spacing = ##t }
3226 All layout dimensions are displayed in staff-spaces, regardless
3227 of the units specified in the @code{\paper} or @code{\layout} block.
3228 In the above example, @code{paper-height} has a value of 59.75
3229 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3230 default value). Note that:
3232 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3235 @tab = (25.4/72.27) mm
3238 @tab = (@code{staff-size})/4 pts
3240 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3245 In this case, one @code{staff-space} is approximately equal to
3246 1.757mm. Thus the @code{paper-height} measurement of 59.75
3247 @code{staff-spaces} is equivalent to 105 millimeters, the height
3248 of @code{a6} paper in landscape orientation. The pairs
3249 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3250 edge and @var{b} the upper edge of the interval.
3255 @ref{Setting the staff size}.
3261 @node Changing spacing
3262 @subsection Changing spacing
3264 The output of @code{annotate-spacing} reveals vertical dimensions
3265 in great detail. For details about modifying margins and other
3266 layout variables, see @ref{Page layout}.
3268 Other than margins, there are a few other options to save space:
3272 Force systems to move as close together as possible (to fit as
3273 many systems as possible onto a page) while being spaced so that
3274 there is no blank space at the bottom of the page.
3278 system-system-spacing = #'((padding . 0) (space . 0.1))
3279 ragged-last-bottom = ##f
3285 Force the number of systems. This can help in two ways. Just
3286 setting a value, even the same value as the number of systems
3287 being typeset by default, will sometimes cause more systems to
3288 be fitted onto each page, as an estimation step is then bypassed,
3289 giving a more accurate fit to each page. Also, forcing an actual
3290 reduction in the number of systems may save a further page. For
3291 example, if the default layout has 11 systems, the following
3292 assignment will force a layout with 10 systems.
3301 Avoid (or reduce) objects that increase the vertical size of a
3302 system. For example, volta repeats (or alternate repeats) require
3303 extra space. If these repeats are spread over two systems, they
3304 will take up more space than one system with the volta repeats and
3305 another system without. For example, dynamics that @q{stick out} of
3306 a system can be moved closer to the staff:
3308 @lilypond[verbatim,quote,relative=1]
3310 e4 c g-\tweak #'X-offset #-2.7 -\tweak #'Y-offset #2.5 \f c
3314 Alter the horizontal spacing via @code{SpacingSpanner}. For more
3315 details, see @ref{Changing horizontal spacing}. The following
3316 example illustrates the default spacing:
3318 @lilypond[verbatim,quote]
3331 The next example modifies @code{common-shortest-duration} from a
3332 value of @code{1/4} to @code{1/2}. The quarter note is the most
3333 common and shortest duration in this example, so by making this
3334 duration longer, a @q{squeezing} effect occurs:
3336 @lilypond[verbatim,quote]
3348 \override SpacingSpanner
3349 #'common-shortest-duration = #(ly:make-moment 1 2)
3356 The @code{common-shortest-duration} property cannot be modified
3357 dynamically, so it must always be placed in a @code{\context}
3358 block so that it applies to the whole score.
3366 @ref{Changing horizontal spacing}.