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}. For the sake of clarity, when using
161 millimeters, the @code{\mm} is typically included in the code,
162 even though it is not technically necessary.
164 It is also possible to define @code{\paper} values using Scheme.
165 The Scheme equivalent of the above example is:
169 #(define top-margin (* 0.5 in))
175 @ref{Custom headers footers and titles}.
178 @node Paper size and automatic scaling
179 @subsection Paper size and automatic scaling
187 * Setting paper size::
188 * Automatic scaling to paper size::
192 @node Setting paper size
193 @unnumberedsubsubsec Setting paper size
195 Two functions are available for changing the paper size:
196 @code{set-default-paper-size} and @code{set-paper-size}.
197 @code{set-default-paper-size} must be placed in the toplevel
198 scope, and @code{set-paper-size} must be placed in a @code{\paper}
202 #(set-default-paper-size "a4")
207 #(set-paper-size "a4")
212 In the toplevel scope, the @code{set-default-paper-size} function
213 can safely be called anywhere before the first @code{\paper}
214 block. Within a @code{\paper} block, the safest place to call
215 @code{set-paper-size} is at the top, above the list of variable
216 declarations. The reasons for this are discussed in
217 @ref{Automatic scaling to paper size}.
219 @code{set-default-paper-size} sets the size of all pages, whereas
220 @code{set-paper-size} only sets the size of the pages that the
221 @code{\paper} block applies to. For example, if the @code{\paper}
222 block is at the top of the file, then it will apply the paper size
223 to all pages. If the @code{\paper} block is inside a
224 @code{\book}, then the paper size will only apply to that book.
226 Common paper sizes are available, including @code{a4},
227 @code{letter}, @code{legal}, and @code{11x17} (also known as
228 tabloid). Many more paper sizes are supported by default. For
229 details, see @file{scm/@/paper@/.scm}, and search for the
230 definition of @code{paper-alist}.
232 @c TODO add a new appendix for paper sizes (auto-generated) -pm
234 @warning{The default paper size is @code{a4}.}
236 Extra sizes may be added by editing the definition of
237 @code{paper-alist} in the initialization file
238 @file{scm/@/paper@/.scm}, however they will be overridden on a
244 If the symbol @code{'landscape} is supplied as an argument to
245 @code{set-default-paper-size}, pages will be rotated by 90
246 degrees, and wider line widths will be set accordingly.
249 #(set-default-paper-size "a6" 'landscape)
254 @file{scm/@/paper@/.scm}.
257 @node Automatic scaling to paper size
258 @unnumberedsubsubsec Automatic scaling to paper size
260 If the paper size is changed with one of the scheme functions
261 (@code{set-default-paper-size} or @code{set-paper-size}), the
262 values of several @code{\paper} variables are automatically scaled
263 to the new size. To bypass the automatic scaling for a particular
264 variable, set the variable after setting the paper size. Note
265 that the automatic scaling is not triggered by setting
266 @code{paper-height} or @code{paper-width}, even though
267 @code{paper-width} can influence other values (this is separate
268 from scaling and is discussed below). The
269 @code{set-default-paper-size} and @code{set-paper-size} functions
270 are described in @ref{Setting paper size}.
272 The vertical dimensions affected by automatic scaling are
273 @code{top-margin} and @code{bottom-margin}. The horizontal
274 dimensions affected by automatic scaling are @code{left-margin},
275 @code{right-margin}, @code{inner-margin}, @code{outer-margin},
276 @code{binding-offset}, @code{indent}, and @code{short-indent}.
278 The default values for these dimensions are set in
279 @file{ly/paper-defaults-init.ly}, using internal variables named
280 @code{top-margin-default}, @code{bottom-margin-default}, etc.
281 These are the values that result at the default paper size
282 @code{a4}. For reference, with @code{a4} paper the
283 @code{paper-height} is @code{297\mm} and the @code{paper-width} is
288 @file{ly/paper-defaults-init.ly},
289 @file{scm/paper.scm}.
292 @node Fixed vertical spacing \paper variables
293 @subsection Fixed vertical spacing @code{\paper} variables
295 @warning{Some @code{@bs{}paper} dimensions are automatically
296 scaled to the paper size, which may lead to unexpected behavior.
297 See @ref{Automatic scaling to paper size}.}
299 Default values (before scaling) are defined in
300 @file{ly/paper-defaults-init.ly}.
304 @funindex paper-height
306 The height of the page, unset by default. Note that the automatic
307 scaling of some vertical dimensions is not affected by this.
312 The margin between the top of the page and the top of the
313 printable area. If the paper size is modified, this dimension's
314 default value is scaled accordingly.
317 @funindex bottom-margin
319 The margin between the bottom of the printable area and the bottom
320 of the page. If the paper size is modified, this dimension's
321 default value is scaled accordingly.
324 @funindex ragged-bottom
326 If set to true, systems will not spread vertically down the page.
327 This does not affect the last page. This should be set to true
328 for pieces that have only two or three systems per page, for
329 example orchestral scores.
331 @item ragged-last-bottom
332 @funindex ragged-last-bottom
334 If set to false, systems will spread vertically down the last
335 page. Pieces that amply fill two pages or more should have this
336 set to true. It also affects the last page of book parts, i.e.
337 parts of a book created with @code{\bookpart} blocks.
343 @file{ly/paper-defaults-init.ly}.
350 The titles (from the @code{\header} block) are treated as a
351 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
352 add space between the titles and the first system of the score.
355 @node Flexible vertical spacing \paper variables
356 @subsection Flexible vertical spacing @code{\paper} variables
358 In most cases, it is preferable for the vertical distances between
359 certain items (such as margins, titles, systems, and separate
360 scores) to be flexible, so that they stretch and compress nicely
361 according to each situation. A number of @code{\paper} variables
362 (listed below) are available to fine-tune the stretching behavior
365 Note that the @code{\paper} variables discussed in this section do
366 not control the spacing of staves within individual systems.
367 Within-system spacing is controlled by grob properties, with
368 settings typically entered inside a @code{\score} or
369 @code{\layout} block, and not inside a @code{\paper} block. See
370 @ref{Flexible vertical spacing within systems}.
373 * Structure of flexible vertical spacing alists::
374 * List of flexible vertical spacing \paper variables::
378 @node Structure of flexible vertical spacing alists
379 @unnumberedsubsubsec Structure of flexible vertical spacing alists
381 Each of the flexible vertical spacing @code{\paper} variables is
382 an alist (association list) containing four @emph{keys}:
387 @code{padding} -- the minimum required amount of unobstructed
388 vertical whitespace between two items, measured in staff-spaces.
389 This can be thought of as the minimum height of an unobstructed
390 (invisible) rectangle that extends from the leftmost to the
391 rightmost point of the combined items.
394 @code{space} -- the vertical distance, measured in staff-spaces,
395 between the @emph{reference points} of the two items, when no
396 collisions would result, and no stretching or compressing is in
397 effect. The reference point of a (title or top-level) markup is
398 its highest point, and the reference point of a system is the
399 vertical center of the nearest @code{StaffSymbol} -- even if a
400 non-staff line (such as a @code{Lyrics} context) is in the way.
401 Values for @code{space} that are less than either @code{padding}
402 or @code{minimum-distance} are not meaningful, since the resulting
403 distance will never be less than either @code{padding} or
404 @code{minimum-distance}.
407 @code{minimum-distance} -- the smallest allowable vertical
408 distance, measured in staff-spaces, between the reference points
409 of the two items, when compressing is in effect. Values for
410 @code{minimum-distance} that are less than @code{padding} are not
411 meaningful, since the resulting distance will never be less than
415 @code{stretchability} -- a unitless measure of the dimension's
416 relative propensity to stretch. If zero, the distance will not
417 stretch (unless collisions would result). When positive, the
418 significance of a particular dimension's @code{stretchability}
419 value lies only in its relation to the @code{stretchability}
420 values of the other dimensions. For example, if one dimension has
421 twice the @code{stretchability} of another, it will stretch twice
422 as easily. Values should be non-negative and finite. The value
423 @code{+inf.0} triggers a @code{programming_error} and is ignored,
424 but @code{1.0e7} can be used for an almost infinitely stretchable
425 spring. If unset, the default value is set to @code{space}. Note
426 that the dimension's propensity to @emph{compress} cannot be
427 directly set by the user and is equal to
428 (@code{space}@tie{}@minus{}@tie{}@code{minimum-distance}).
432 If a page has a ragged bottom, the resulting distance is the
441 @code{minimum-distance}, and
444 @code{padding} plus the smallest distance necessary to eliminate
449 Specific methods for modifying alists are discussed in
450 @ref{Modifying alists}. The following example demonstrates the
451 two ways these alists can be modified. The first declaration
452 updates one key-value individually, and the second completely
453 redefines the variable:
457 system-system-spacing #'space = #8
458 score-system-spacing =
461 (minimum-distance . 6)
462 (stretchability . 12))
467 @node List of flexible vertical spacing \paper variables
468 @unnumberedsubsubsec List of flexible vertical spacing @code{\paper} variables
470 The names of these variables follow the format
471 @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}}
472 and @code{@var{lower}} are the items to be spaced. Each distance
473 is measured between the reference points of the two items (see the
474 description of the alist structure above). Note that in these
475 variable names, the term @q{@code{markup}} refers to both
476 @emph{title markups} (@code{bookTitleMarkup} or
477 @code{scoreTitleMarkup}) and @emph{top-level markups} (see
478 @ref{File structure}). All distances are measured in
481 Default settings are defined in @file{ly/paper-defaults-init.ly}.
483 @c TODO: Where do headers/footers fit in? -mp
486 @item markup-system-spacing
487 @funindex markup-system-spacing
489 the distance between a (title or top-level) markup and the system
492 @item score-markup-spacing
493 @funindex score-markup-spacing
495 the distance between the last system of a score and the (title or
496 top-level) markup that follows it.
498 @item score-system-spacing
499 @funindex score-system-spacing
501 the distance between the last system of a score and the first
502 system of the score that follows it, when no (title or top-level)
503 markup exists between them.
505 @item system-system-spacing
506 @funindex system-system-spacing
508 the distance between two systems in the same score.
510 @item markup-markup-spacing
511 @funindex markup-markup-spacing
513 the distance between two (title or top-level) markups.
515 @item last-bottom-spacing
516 @funindex last-bottom-spacing
518 the distance from the last system or top-level markup on a page to
519 the bottom of the printable area (i.e. the top of the bottom
522 @item top-system-spacing
523 @funindex top-system-spacing
525 the distance from the top of the printable area (i.e. the bottom
526 of the top margin) to the first system on a page, when there is no
527 (title or top-level) markup between the two.
529 @item top-markup-spacing
530 @funindex top-markup-spacing
532 the distance from the top of the printable area (i.e. the bottom
533 of the top margin) to the first (title or top-level) markup on a
534 page, when there is no system between the two.
539 @ref{Flexible vertical spacing within systems}.
542 @file{ly/paper-defaults-init.ly}.
548 @node Horizontal spacing \paper variables
549 @subsection Horizontal spacing @code{\paper} variables
551 @warning{Some @code{@bs{}paper} dimensions are automatically
552 scaled to the paper size, which may lead to unexpected behavior.
553 See @ref{Automatic scaling to paper size}.}
556 * \paper variables for widths and margins::
557 * \paper variables for two-sided mode::
558 * \paper variables for shifts and indents::
562 @node \paper variables for widths and margins
563 @unnumberedsubsubsec @code{\paper} variables for widths and margins
565 Default values (before scaling) that are not listed here are
566 defined in @file{ly/paper-defaults-init.ly}.
571 @funindex paper-width
573 The width of the page, unset by default. While @code{paper-width}
574 has no effect on the automatic scaling of some horizontal
575 dimensions, it does influence the @code{line-width} variable. If
576 both @code{paper-width} and @code{line-width} are set, then
577 @code{left-margin} and @code{right-margin} will also be updated.
578 Also see @code{check-consistency}.
583 The horizontal extent of the staff lines in unindented, non-ragged
585 @code{(paper-width@tie{}@minus{}@tie{}left-margin@tie{}@minus{}@tie{}right-margin)}
586 when unset. If @code{line-width} is set, and both
587 @code{left-margin} and @code{right-margin} are unset, then the
588 margins will be updated to center the systems on the page
589 automatically. Also see @code{check-consistency}.
592 @funindex left-margin
594 The margin between the left edge of the page and the start of the
595 staff lines in unindented systems. If the paper size is modified,
596 this dimension's default value is scaled accordingly. If
597 @code{left-margin} is unset, and both @code{line-width} and
598 @code{right-margin} are set, then @code{left-margin} is set to
599 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}right-margin)}.
600 If only @code{line-width} is set, then both margins are set to
601 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
602 and the systems are consequently centered on the page. Also see
603 @code{check-consistency}.
606 @funindex right-margin
608 The margin between the right edge of the page and the end of the
609 staff lines in non-ragged systems. If the paper size is modified,
610 this dimension's default value is scaled accordingly. If
611 @code{right-margin} is unset, and both @code{line-width} and
612 @code{left-margin} are set, then @code{right-margin} is set to
613 @code{(paper-width@tie{}@minus{}@tie{}line-width@tie{}@minus{}@tie{}left-margin)}.
614 If only @code{line-width} is set, then both margins are set to
615 @code{((paper-width@tie{}@minus{}@tie{}line-width)@tie{}/@tie{}2)},
616 and the systems are consequently centered on the page. Also see
617 @code{check-consistency}.
619 @item check-consistency
620 @funindex check-consistency
622 If set to true, print a warning if @code{left-margin},
623 @code{line-width}, and @code{right-margin} do not exactly add up
624 to @code{paper-width}, and replace each of these (except
625 @code{paper-width}) with its default value (scaled to the paper
626 size if necessary). If set to false, ignore any inconsistencies
627 and allow systems to run off the edge of the page.
630 @funindex ragged-right
632 If set to true, systems will not fill the line width. Instead,
633 systems end at their natural horizontal length. Default:
634 @code{#t} for scores with only one system, and @code{#f} for
635 scores with two or more systems. This variable can also be set in
636 a @code{\layout} block.
639 @funindex ragged-last
641 If set to true, the last system in the score will not fill the
642 line width. Instead the last system ends at its natural
643 horizontal length. Default: @code{#f}. This variable can also be
644 set in a @code{\layout} block.
650 @file{ly/paper-defaults-init.ly}.
653 @node \paper variables for two-sided mode
654 @unnumberedsubsubsec @code{\paper} variables for two-sided mode
656 Default values (before scaling) are defined in
657 @file{ly/paper-defaults-init.ly}.
665 @cindex binding gutter
667 If set to true, use @code{inner-margin}, @code{outer-margin} and
668 @code{binding-offset} to determine margins depending on whether
669 the page number is odd or even. This overrides @code{left-margin}
670 and @code{right-margin}.
673 @funindex inner-margin
675 The margin all pages have at the inner side if they are part of a
676 book. If the paper size is modified, this dimension's default
677 value is scaled accordingly. Works only with @code{two-sided} set
681 @funindex outer-margin
683 The margin all pages have at the outer side if they are part of a
684 book. If the paper size is modified, this dimension's default
685 value is scaled accordingly. Works only with @code{two-sided} set
689 @funindex binding-offset
691 The amount @code{inner-margin} is increased to make sure nothing
692 will be hidden by the binding. If the paper size is modified,
693 this dimension's default value is scaled accordingly. Works only
694 with @code{two-sided} set to true.
700 @file{ly/paper-defaults-init.ly}.
703 @node \paper variables for shifts and indents
704 @unnumberedsubsubsec @code{\paper} variables for shifts and indents
706 Default values (before scaling) that are not listed here are
707 defined in @file{ly/paper-defaults-init.ly}.
711 @item horizontal-shift
712 @funindex horizontal-shift
714 @c This default value is buried in the middle of page.scm. -mp
716 The amount that all systems (including titles and system
717 separators) are shifted to the right. Default: @code{0.0\mm}.
722 The level of indentation for the first system in a score. If the
723 paper size is modified, this dimension's default value is scaled
724 accordingly. This variable can also be set in a @code{\layout}
728 @funindex short-indent
730 The level of indentation for all systems in a score besides the
731 first system. If the paper size is modified, this dimension's
732 default value is scaled accordingly. This variable can also be
733 set in a @code{\layout} block.
739 @file{ly/paper-defaults-init.ly}.
745 @node Other \paper variables
746 @subsection Other @code{\paper} variables
749 * \paper variables for line breaking::
750 * \paper variables for page breaking::
751 * \paper variables for page numbering::
752 * Miscellaneous \paper variables::
756 @node \paper variables for line breaking
757 @unnumberedsubsubsec @code{\paper} variables for line breaking
759 @c TODO: Mention that ly:optimal-breaking is on by default? -mp
763 @item max-systems-per-page
764 @funindex max-systems-per-page
766 The maximum number of systems that will be placed on a page. This
767 is currently supported only by the @code{ly:optimal-breaking} algorithm.
770 @item min-systems-per-page
771 @funindex min-systems-per-page
773 The minimum number of systems that will be placed on a page. This
774 may cause pages to be overfilled if it is made too large. This is
775 currently supported only by the @code{ly:optimal-breaking} algorithm.
778 @item systems-per-page
779 @funindex systems-per-page
781 The number of systems that should be placed on each page.
782 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
786 @funindex system-count
788 The number of systems to be used for a score. Default: unset.
789 This variable can also be set in a @code{\layout} block.
798 @node \paper variables for page breaking
799 @unnumberedsubsubsec @code{\paper} variables for page breaking
801 Default values not listed here are defined in
802 @file{ly/paper-defaults-init.ly}
806 @item blank-after-score-page-force
807 @funindex blank-after-score-page-force
809 The penalty for having a blank page after the end of one score and
810 before the next. By default, this is smaller than
811 @code{blank-page-force}, so that we prefer blank pages after
812 scores to blank pages within a score.
814 @item blank-last-page-force
815 @funindex blank-last-page-force
817 The penalty for ending the score on an odd-numbered page.
819 @item blank-page-force
820 @funindex blank-page-force
822 The penalty for having a blank page in the middle of a
823 score. This is not used by @code{ly:optimal-breaking} since it will
824 never consider blank pages in the middle of a score.
827 @funindex page-breaking
829 The page-breaking algorithm to use. Choices are
830 @code{ly:minimal-breaking}, @code{ly:page-turn-breaking}, and
831 @code{ly:optimal-breaking}.
833 @item page-breaking-system-system-spacing
834 @funindex page-breaking-system-system-spacing
836 Tricks the page breaker into thinking that
837 @code{system-system-spacing} is set to something different than
838 it really is. For example, if
839 @code{page-breaking-system-system-spacing #'padding} is set to something
840 substantially larger than @code{system-system-spacing #'padding}, then the
841 page-breaker will put fewer systems on each page. Default: unset.
846 The number of pages to be used for a score, unset by default.
853 @ref{Optimal page breaking},
854 @ref{Optimal page turning},
855 @ref{Minimal page breaking}.
858 @file{ly/paper-defaults-init.ly}.
861 @node \paper variables for page numbering
862 @unnumberedsubsubsec @code{\paper} variables for page numbering
864 Default values not listed here are defined in
865 @file{ly/paper-defaults-init.ly}
869 @item auto-first-page-number
870 @funindex auto-first-page-number
872 The page breaking algorithm is affected by the first page number
873 being odd or even. If set to true, the page breaking algorithm
874 will decide whether to start with an odd or even number. This
875 will result in the first page number remaining as is or being
876 increased by one. Default: @code{#f}.
878 @item first-page-number
879 @funindex first-page-number
881 The value of the page number on the first page.
883 @item print-first-page-number
884 @funindex print-first-page-number
886 If set to true, a page number is printed on the first page.
888 @item print-page-number
889 @funindex print-page-number
891 If set to false, page numbers are not printed.
897 @file{ly/paper-defaults-init.ly}.
900 @node Miscellaneous \paper variables
901 @unnumberedsubsubsec Miscellaneous @code{\paper} variables
905 @item page-spacing-weight
906 @funindex page-spacing-weight
908 The relative importance of page (vertical) spacing and line
909 (horizontal) spacing. High values will make page spacing more
910 important. Default: @code{#10}.
912 @item print-all-headers
913 @funindex print-all-headers
915 If set to true, this will print all headers for each @code{\score}
916 in the output. Normally only the @code{piece} and @code{opus}
917 header variables are printed. Default: @code{#f}.
919 @item system-separator-markup
920 @funindex system-separator-markup
922 A markup object that is inserted between systems, often used for
923 orchestral scores. Default: unset. The @code{\slashSeparator}
924 markup, defined in @file{ly/titling-init.ly}, is provided as a
925 sensible default, for example:
927 @lilypond[quote,verbatim,noragged-right,line-width=30\mm]
928 #(set-default-paper-size "a8")
932 system-separator-markup = \slashSeparator
938 \relative c'' { c1 \break c1 \break c1 }
948 @file{ly/titling-init.ly}.
956 The default page header puts the page number and the @code{instrument}
957 field from the @code{\header} block on a line.
961 @section Score layout
963 This section discusses score layout options for the @code{\layout}
967 * The \layout block::
968 * Setting the staff size::
972 @node The \layout block
973 @subsection The @code{\layout} block
977 While the @code{\paper} block contains settings that relate to the
978 page formatting of the whole document, the @code{\layout} block
979 contains settings for score-specific layout. To set score layout
980 options globally, enter them in a toplevel @code{\layout} block.
981 To set layout options for an individual score, enter them in a
982 @code{\layout} block inside the @code{\score} block, after the
983 music. Settings that can appear in a @code{\layout} block
987 @item the @code{layout-set-staff-size} scheme function,
988 @item context modifications in @code{\context} blocks, and
989 @item @code{\paper} variables that affect score layout.
992 The @code{layout-set-staff-size} function is discussed in the next
993 section, @ref{Setting the staff size}. Context modifications are
994 discussed in a separate chapter; see
995 @ref{Modifying context plug-ins} and
996 @ref{Changing context default settings}. The @code{\paper}
997 variables that can appear in a @code{\layout} block are:
1000 @item @code{ragged-right}
1001 @item @code{ragged-last}
1003 @item @code{short-indent}
1004 @item @code{system-count}
1007 Here is an example @code{\layout} block:
1014 \override StaffGrouper #'staff-staff-spacing #space = #8
1018 \override TextScript #'padding = #1.0
1019 \override Glissando #'thickness = #3
1027 @ref{Changing context default settings}.
1033 @node Setting the staff size
1034 @subsection Setting the staff size
1036 @cindex font size, setting
1037 @cindex staff size, setting
1038 @funindex layout file
1040 The default @strong{staff size} is set to 20 points.
1041 This may be changed in two ways:
1043 To set the staff size globally for all scores in a file (or
1044 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
1047 #(set-global-staff-size 14)
1051 This sets the global default size to 14pt staff height and scales all
1054 To set the staff size individually for each score, use
1059 #(layout-set-staff-size 15)
1064 The Feta font provides musical symbols at eight different
1065 sizes. Each font is tuned for a different staff size: at a smaller size
1066 the font becomes heavier, to match the relatively heavier staff lines.
1067 The recommended font sizes are listed in the following table:
1070 @multitable @columnfractions .15 .2 .22 .2
1073 @tab @b{staff height (pt)}
1074 @tab @b{staff height (mm)}
1116 @c modern rental material?
1121 These fonts are available in any sizes. The context property
1122 @code{fontSize} and the layout property @code{staff-space} (in
1123 @rinternals{StaffSymbol}) can be used to tune the size for individual
1124 staves. The sizes of individual staves are relative to the global size.
1129 @ref{Selecting notation font size}.
1137 @code{layout-set-staff-size} does not change the distance between the
1147 * Optimal page breaking::
1148 * Optimal page turning::
1149 * Minimal page breaking::
1151 * Using an extra voice for breaks::
1156 @subsection Line breaking
1159 @cindex breaking lines
1161 Line breaks are normally determined automatically. They are chosen
1162 so that lines look neither cramped nor loose, and consecutive
1163 lines have similar density. Occasionally you might want to
1164 override the automatic breaks; you can do this by specifying
1165 @code{\break}. This will force a line break at this point. However,
1166 line breaks can only occur at the end of @q{complete} bars, i.e.,
1167 where there are no notes or tuplets left @q{hanging} over the bar
1168 line. If you want to have a line break where there is no bar line,
1169 you can force an invisible bar line by entering @code{\bar ""},
1170 although again there must be no notes left hanging over in any of
1171 the staves at this point, or it will be ignored.
1173 The opposite command, @code{\noBreak}, forbids a line break at the
1174 bar line where it is inserted.
1176 The most basic settings influencing line spacing are @code{indent}
1177 and @code{line-width}. They are set in the @code{\layout} block.
1178 They control the indentation of the first line of music, and the
1179 lengths of the lines.
1181 If @code{ragged-right} is set to true in the @code{\layout} block,
1182 then systems end at their natural horizontal length, instead of
1183 being spread horizontally to fill the whole line. This is useful
1184 for short fragments, and for checking how tight the natural
1187 @c TODO Check and add para on default for ragged-right
1189 The option @code{ragged-last} is similar to @code{ragged-right},
1190 but affects only the last line of the piece.
1202 @cindex regular line breaks
1203 @cindex four bar music.
1205 For line breaks at regular intervals use @code{\break} separated by
1206 skips and repeated with @code{\repeat}. For example, this would
1207 cause the following 28 measures (assuming 4/4 time) to be broken
1208 every 4 measures, and only there:
1211 << \repeat unfold 7 @{
1212 s1 \noBreak s1 \noBreak
1213 s1 \noBreak s1 \break @}
1214 @emph{the real music}
1219 A linebreaking configuration can be saved as a @code{.ly} file
1220 automatically. This allows vertical alignments to be stretched to
1221 fit pages in a second formatting run. This is fairly new and
1222 complicated. More details are available in
1238 Internals Reference:
1239 @rinternals{LineBreakEvent}.
1244 Line breaks can only occur if there is a @q{proper} bar line. A note
1245 which is hanging over a bar line is not proper, such as
1247 @lilypond[quote,ragged-right,relative=2,verbatim]
1248 c4 c2 << c2 {s4 \break } >> % this does nothing
1249 c2 c4 | % a break here would work
1250 c4 c2 c4 ~ \break % as does this break
1254 This can be avoided by removing the @code{Forbid_line_break_engraver}.
1255 Note that manually forced line breaks have to be added in parallel
1258 @lilypond[quote,ragged-right,verbatim]
1260 \remove Forbid_line_break_engraver
1262 c4 c2 << c2 {s4 \break } >> % now the break is allowed
1267 Similarly, line breaks are normally forbidden when beams cross bar
1268 lines. This behavior can be changed by setting
1269 @code{\override Beam #'breakable = ##t}.
1273 @subsection Page breaking
1275 The default page breaking may be overridden by inserting
1276 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1277 analogous to @code{\break} and @code{\noBreak}. They should be
1278 inserted at a bar line. These commands force and forbid a page-break
1279 from happening. Of course, the @code{\pageBreak} command also forces
1282 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1283 inserted at top-level, between scores and top-level markups.
1285 There are also analogous settings to @code{ragged-right} and
1286 @code{ragged-last} which have the same effect on vertical spacing:
1287 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1288 @code{##t} the systems on all pages or just the last page
1289 respectively will not be justified vertically.
1291 For more details see @ref{Vertical spacing}.
1293 Page breaks are computed by the @code{page-breaking} function. LilyPond
1294 provides three algorithms for computing page breaks,
1295 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1296 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1297 but the value can be changed in the @code{\paper} block:
1301 #(define page-breaking ly:page-turn-breaking)
1307 When a book has many scores and pages, the page breaking problem may be
1308 difficult to solve, requiring large processing time and memory. To ease
1309 the page breaking process, @code{\bookpart} blocks are used to divide
1310 the book into several parts: the page breaking occurs separately on each
1311 part. Different page breaking functions may also be used in different
1317 subtitle = "Preface"
1320 %% In a part consisting mostly of text,
1321 %% ly:minimal-breaking may be preferred
1322 #(define page-breaking ly:minimal-breaking)
1324 \markup @{ @dots{} @}
1328 %% In this part, consisting of music, the default optimal
1329 %% page breaking function is used.
1331 subtitle = "First movement"
1333 \score @{ @dots{} @}
1340 @funindex \pageBreak
1342 @funindex \noPageBreak
1343 @code{\noPageBreak}.
1352 @node Optimal page breaking
1353 @subsection Optimal page breaking
1355 @funindex ly:optimal-breaking
1357 The @code{ly:optimal-breaking} function is LilyPond's default method of
1358 determining page breaks. It attempts to find a page breaking that minimizes
1359 cramping and stretching, both horizontally and vertically. Unlike
1360 @code{ly:page-turn-breaking}, it has no concept of page turns.
1368 @node Optimal page turning
1369 @subsection Optimal page turning
1371 @funindex ly:page-turn-breaking
1373 Often it is necessary to find a page breaking configuration so that there is
1374 a rest at the end of every second page. This way, the musician can turn the
1375 page without having to miss notes. The @code{ly:page-turn-breaking} function
1376 attempts to find a page breaking minimizing cramping and stretching, but with
1377 the additional restriction that it is only allowed to introduce page turns
1378 in specified places.
1380 There are two steps to using this page breaking function. First, you
1381 must enable it in the @code{\paper} block, as explained in @ref{Page
1382 breaking}. Then you must tell the function where you would like to allow
1385 There are two ways to achieve the second step. First, you can specify each
1386 potential page turn manually, by inserting @code{\allowPageTurn} into your
1387 input file at the appropriate places.
1389 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1390 Voice context. The @code{Page_turn_engraver} will scan the context for
1391 sections without notes (note that it does not scan for rests; it scans for
1392 the absence of notes. This is so that single-staff polyphony with rests in one
1393 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1394 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1395 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1396 there is a @q{special} bar line (such as a double bar), in which case the
1397 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1400 @funindex minimumPageTurnLength
1401 The @code{Page_turn_engraver} reads the context property
1402 @code{minimumPageTurnLength} to determine how long a note-free section must
1403 be before a page turn is considered. The default value for
1404 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
1405 to disable page turns, you can set it to something very large.
1408 \new Staff \with @{ \consists "Page_turn_engraver" @}
1411 R1 | % a page turn will be allowed here
1413 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1414 R1 | % a page turn will not be allowed here
1416 R1*2 | % a page turn will be allowed here
1421 @funindex minimumRepeatLengthForPageTurn
1422 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1423 turn during the repeat if there is enough time at the beginning and end of the
1424 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1425 page turns if the repeat is very short. If you set the context property
1426 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1427 only allow turns in repeats whose duration is longer than this value.
1429 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1430 @code{\allowPageTurn}, may also be used at top-level, between scores and
1437 @funindex \noPageTurn
1439 @funindex \allowPageTurn
1440 @code{\allowPageTurn}.
1451 There should only be one @code{Page_turn_engraver} in a score. If there is more
1452 than one, they will interfere with each other.
1455 @node Minimal page breaking
1456 @subsection Minimal page breaking
1458 @funindex ly:minimal-breaking
1460 The @code{ly:minimal-breaking} function performs minimal computations to
1461 calculate the page breaking: it fills a page with as many systems as
1462 possible before moving to the next one. Thus, it may be preferred for
1463 scores with many pages, where the other page breaking functions could be
1464 too slow or memory demanding, or a lot of texts. It is enabled using:
1468 #(define page-breaking ly:minimal-breaking)
1478 @node Explicit breaks
1479 @subsection Explicit breaks
1481 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1482 commands. There are two commands to override this behavior:
1485 \override NonMusicalPaperColumn #'line-break-permission = ##f
1486 \override NonMusicalPaperColumn #'page-break-permission = ##f
1489 When @code{line-break-permission} is overridden to false, Lily will insert
1490 line breaks at explicit @code{\break} commands and nowhere else. When
1491 @code{page-break-permission} is overridden to false, Lily will insert
1492 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1494 @lilypond[quote,verbatim]
1503 \repeat unfold 2 { c'8 c'8 c'8 c'8 } \break
1504 \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
1505 \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
1506 \repeat unfold 8 { c'8 c'8 c'8 c'8 } \pageBreak
1507 \repeat unfold 8 { c'8 c'8 c'8 c'8 } \break
1508 \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
1509 \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
1510 \repeat unfold 2 { c'8 c'8 c'8 c'8 }
1515 \override NonMusicalPaperColumn #'line-break-permission = ##f
1516 \override NonMusicalPaperColumn #'page-break-permission = ##f
1528 @node Using an extra voice for breaks
1529 @subsection Using an extra voice for breaks
1531 Line- and page-breaking information usually appears within note entry directly.
1536 \repeat unfold 2 @{ c'4 c'4 c'4 c'4 @}
1538 \repeat unfold 3 @{ c'4 c'4 c'4 c'4 @}
1543 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1544 music entry with information that specifies how music should lay out
1545 on the page. You can keep music entry and line- and page-breaking
1546 information in two separate places by introducing an extra voice to
1547 contain the breaks. This extra voice
1548 contains only skips together with @code{\break}, @code{pageBreak} and other
1549 breaking layout information.
1551 @lilypond[quote,verbatim]
1561 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1562 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1563 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1564 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1570 This pattern becomes especially helpful when overriding
1571 @code{line-break-system-details} and the other useful but long properties of
1572 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1574 @lilypond[quote,verbatim]
1578 \overrideProperty "Score.NonMusicalPaperColumn"
1579 #'line-break-system-details #'((Y-offset . 0))
1582 \overrideProperty "Score.NonMusicalPaperColumn"
1583 #'line-break-system-details #'((Y-offset . 35))
1586 \overrideProperty "Score.NonMusicalPaperColumn"
1587 #'line-break-system-details #'((Y-offset . 70))
1590 \overrideProperty "Score.NonMusicalPaperColumn"
1591 #'line-break-system-details #'((Y-offset . 105))
1595 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1596 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1597 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1598 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1607 @ref{Vertical spacing}.
1613 @node Vertical spacing
1614 @section Vertical spacing
1616 @cindex vertical spacing
1617 @cindex spacing, vertical
1619 Vertical spacing is controlled by three things: the amount of
1620 space available (i.e., paper size and margins), the amount of
1621 space between systems, and the amount of space between
1622 staves inside a system.
1625 * Flexible vertical spacing within systems::
1626 * Explicit staff and system positioning::
1627 * Vertical collision avoidance::
1631 @node Flexible vertical spacing within systems
1632 @subsection Flexible vertical spacing within systems
1634 @cindex distance between staves
1635 @cindex staff distance
1636 @cindex space between staves
1637 @cindex space inside systems
1639 Three separate mechanisms control the flexible vertical spacing
1640 within systems, one for each of the following categories:
1645 @emph{ungrouped staves},
1648 @emph{grouped staves} (staves within a staff-group such as
1649 @code{ChoirStaff}, etc.), and
1652 @emph{non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
1657 @c TODO: Clarify this. This almost implies that non-staff lines
1658 @c have NO effect on the spacing between staves. -mp
1660 The height of each system is determined in two steps. First, all
1661 of the staves are spaced according to the amount of space
1662 available. Then, the non-staff lines are distributed between the
1665 Note that the spacing mechanisms discussed in this section only
1666 control the vertical spacing of staves and non-staff lines within
1667 individual systems. The vertical spacing between separate
1668 systems, scores, markups, and margins is controlled by
1669 @code{\paper} variables, which are discussed in
1670 @ref{Flexible vertical spacing \paper variables}.
1673 * Within-system spacing properties::
1674 * Spacing of ungrouped staves::
1675 * Spacing of grouped staves::
1676 * Spacing of non-staff lines::
1680 @node Within-system spacing properties
1681 @unnumberedsubsubsec Within-system spacing properties
1683 The within-system vertical spacing mechanisms are controlled by
1684 two sets of grob properties. The first set is associated with the
1685 @code{VerticalAxisGroup} grob, which is created by all staves and
1686 non-staff lines. The second set is associated with the
1687 @code{StaffGrouper} grob, which can be created by staff-groups,
1688 but only if explicitly called. These properties are described
1689 individually at the end of this section.
1691 The names of these properties (except for @code{staff-affinity})
1692 follow the format @code{@var{item1}-@var{item2}-spacing}, where
1693 @code{@var{item1}} and @code{@var{item2}} are the items to be
1694 spaced. Note that @code{@var{item2}} is not necessarily below
1695 @code{@var{item1}}; for example,
1696 @code{nonstaff-relatedstaff-spacing} will measure upwards from the
1697 non-staff line if @code{staff-affinity} is @code{#UP}.
1699 Each distance is measured between the @emph{reference points} of
1700 the two items. The reference point for a staff is the vertical
1701 center of its @code{StaffSymbol} (i.e. the middle line if
1702 @code{line-count} is odd; the middle space if @code{line-count} is
1703 even). The reference points for individual non-staff lines are
1704 given in the following table:
1706 @multitable {Non-staff line} {Reference point}
1707 @headitem Non-staff line @tab Reference point
1708 @item @code{ChordNames} @tab baseline
1709 @item @code{NoteNames} @tab baseline
1710 @item @code{Lyrics} @tab baseline
1711 @item @code{Dynamics} @tab vertical center
1712 @item @code{FiguredBass} @tab highest point
1713 @item @code{FretBoards} @tab top line
1716 In the following image, horizontal lines indicate the positions
1717 of these reference points:
1719 @lilypond[quote,noragged-right,line-width=110\mm]
1720 #(define zero-space '((padding . -inf.0) (space . 0)))
1722 alignToZero = \with {
1723 \override VerticalAxisGroup #'nonstaff-relatedstaff-spacing = #zero-space
1724 \override VerticalAxisGroup #'nonstaff-nonstaff-spacing = #zero-space
1726 lowerCaseChords = \with {
1727 chordNameLowercaseMinor = ##t
1729 staffAffinityDown = \with {
1730 \override VerticalAxisGroup #'staff-affinity = #DOWN
1733 #(define-music-function
1734 (parser location context)
1736 #{ s1*0^\markup { \typewriter $context } #})
1739 \context { \Dynamics \alignToZero }
1740 \context { \FiguredBass \alignToZero }
1741 \context { \Lyrics \alignToZero }
1742 \context { \NoteNames \alignToZero }
1743 \context { \ChordNames \alignToZero \lowerCaseChords }
1744 \context { \FretBoards \alignToZero \staffAffinityDown }
1746 \override BarLine #'stencil = ##f
1747 \override DynamicText #'self-alignment-X = #-1
1748 \override FretBoard #'X-offset = #1.75
1749 \override InstrumentName #'minimum-Y-extent = #'(-2 . 2)
1750 \override InstrumentName #'extra-offset = #'(0 . -0.5)
1751 \override TextScript #'minimum-Y-extent = #'(-2 . 3)
1752 \override TimeSignature #'stencil = ##f
1756 %% These contexts have reference points at the baseline:
1757 %% ChordNames, NoteNames, and Lyrics
1759 \new ChordNames { \chords { g1:m } }
1760 \new NoteNames { s1 | g1 | }
1761 \new RhythmicStaff {
1762 \set RhythmicStaff.instrumentName = #"baseline "
1764 \labelContext "ChordNames" s1 |
1765 \labelContext "NoteNames" s1 |
1766 \labelContext "Lyrics" s1 |
1768 \new Lyrics { \lyrics { \skip 1*2 | ghijk1 | } }
1771 %% The reference point for Dynamics is its vertical center
1773 \new RhythmicStaff {
1774 \set RhythmicStaff.instrumentName = #"vertical center "
1775 \labelContext "Dynamics" s1*3
1777 \new Dynamics { s2\mp s\fp }
1780 %% The reference point for FiguredBass is its highest point
1782 \new RhythmicStaff {
1783 \set RhythmicStaff.instrumentName = #"highest point "
1784 \labelContext "FiguredBass" s1
1786 \new FiguredBass { \figuremode { <6 5>1 } }
1789 %% The reference point for FretBoards is the top line
1790 \include "predefined-guitar-fretboards.ly"
1792 \new FretBoards { \chordmode { e1 } }
1793 \new RhythmicStaff {
1794 \set RhythmicStaff.instrumentName = #"top line "
1795 \labelContext "FretBoards " s1
1800 Each of the vertical spacing grob properties (except
1801 @code{staff-affinity}) is stored as an alist (association list),
1802 and each uses the same alist structure as the @code{\paper}
1803 spacing variables discussed in
1804 @ref{Flexible vertical spacing \paper variables}. Specific methods
1805 for modifying alists are discussed in @ref{Modifying alists}.
1806 Grob properties should be adjusted with an @code{\override} inside
1807 a @code{\score} or @code{\layout} block, and not inside a
1808 @code{\paper} block.
1810 The following example demonstrates the two ways these alists can
1811 be modified. The first declaration updates one key-value
1812 individually, and the second completely re-defines the property:
1816 \override VerticalAxisGroup #'staff-staff-spacing #'space = #10
1820 \override VerticalAxisGroup #'staff-staff-spacing =
1823 (minimum-distance . 9)
1824 (stretchability . 10))
1828 To change any spacing settings globally, put them in the
1829 @code{\layout} block:
1835 \override VerticalAxisGroup #'staff-staff-spacing #'space = #10
1840 Standard settings for the vertical spacing grob properties are
1841 listed in @rinternals{VerticalAxisGroup} and
1842 @rinternals{StaffGrouper}. Default overrides for specific types
1843 of non-staff lines are listed in the relevant context descriptions
1844 in @rinternals{Contexts}.
1847 @subsubheading Properties of the @code{VerticalAxisGroup} grob
1849 @code{VerticalAxisGroup} properties are typically adjusted with an
1850 @code{\override} at the @code{Staff} level (or equivalent).
1853 @item staff-staff-spacing
1854 The distance between the current staff and the staff just below it
1855 in the same system, even if one or more non-staff lines (such as
1856 @code{Lyrics}) are placed between the two staves. Does not apply
1857 to the bottom staff of a system. This replaces any settings
1858 inherited from the @code{StaffGrouper} grob of the containing
1859 staff-group, if there is one. If this is unset, and there are no
1860 @code{StaffGrouper} properties to inherit, the
1861 @code{default-staff-staff-spacing} property is used.
1863 @item default-staff-staff-spacing
1864 The settings to use for @code{staff-staff-spacing} when it is
1865 unset. This applies to ungrouped staves and to grouped staves
1866 that do not inherit settings from the @code{StaffGrouper} grob.
1868 @item staff-affinity
1869 The direction of the staff to use for spacing the current
1870 non-staff line. Choices are @code{UP}, @code{DOWN}, and
1871 @code{CENTER}. If @code{CENTER}, the non-staff line will be
1872 placed equidistant between the two nearest staves on either side,
1873 unless collisions or other spacing constraints prevent this.
1874 Adjacent non-staff lines should have non-increasing
1875 @code{staff-affinity} from top to bottom, e.g. a non-staff line
1876 set to @code{UP} should not immediately follow one that is set to
1877 @code{DOWN}. Non-staff lines at the top of a system should use
1878 @code{DOWN}; those at the bottom should use @code{UP}. Setting
1879 @code{staff-affinity} for a staff causes it to be treated as a
1880 non-staff line. Setting @code{staff-affinity} to @code{#f} causes
1881 a non-staff line to be treated as a staff.
1883 @c TODO: verify last clause below ("even if other...")
1885 @item nonstaff-relatedstaff-spacing
1886 The distance between the current non-staff line and the nearest
1887 staff in the direction of @code{staff-affinity}, if there are no
1888 non-staff lines between the two, and @code{staff-affinity} is
1889 either @code{UP} or @code{DOWN}. If @code{staff-affinity} is
1890 @code{CENTER}, then @code{nonstaff-relatedstaff-spacing} is used
1891 for the nearest staves on @emph{both} sides, even if other
1892 non-staff lines appear between the current one and either of the
1895 @item nonstaff-nonstaff-spacing
1896 The distance between the current non-staff line and the next
1897 non-staff line in the direction of @code{staff-affinity}, if both
1898 are on the same side of the related staff, and
1899 @code{staff-affinity} is either @code{UP} or @code{DOWN}.
1901 @item nonstaff-unrelatedstaff-spacing
1902 The distance between the current non-staff line and the staff in
1903 the opposite direction from @code{staff-affinity}, if there are no
1904 other non-staff lines between the two, and @code{staff-affinity}
1905 is either @code{UP} or @code{DOWN}. This can be used, for
1906 example, to require a minimum amount of padding between a
1907 @code{Lyrics} line and the staff to which it does not belong.
1911 @subsubheading Properties of the @code{StaffGrouper} grob
1913 @code{StaffGrouper} properties are typically adjusted with an
1914 @code{\override} at the @code{StaffGroup} level (or equivalent).
1917 @item staff-staff-spacing
1918 The distance between consecutive staves within the current
1919 staff-group. The @code{staff-staff-spacing} property of an
1920 individual staff's @code{VerticalAxisGroup} grob will be used
1921 instead for any staves in the staff-group that have it set. Also
1922 see @code{default-staff-staff-spacing}.
1924 @item staffgroup-staff-spacing
1925 The distance between the last staff of the current staff-group and
1926 the staff just below it in the same system, even if one or more
1927 non-staff lines (such as @code{Lyrics}) exist between the two
1928 staves. Does not apply to the bottom staff of a system. The
1929 @code{staff-staff-spacing} property of an individual staff's
1930 @code{VerticalAxisGroup} grob will be used instead for any staves
1931 in the staff-group that have it set. Also see
1932 @code{default-staff-staff-spacing}.
1937 @file{ly/engraver-init.ly},
1938 @file{scm/define-grobs.scm}.
1940 Internals Reference:
1941 @rinternals{Contexts},
1942 @rinternals{VerticalAxisGroup},
1943 @rinternals{StaffGrouper}.
1946 @node Spacing of ungrouped staves
1947 @unnumberedsubsubsec Spacing of ungrouped staves
1949 @emph{Staves} (such as @code{Staff}, @code{DrumStaff},
1950 @code{TabStaff}, etc.) are contexts that can contain one or more
1951 voice contexts, but cannot contain any other staves.
1953 The following properties affect the spacing of @emph{ungrouped}
1957 @item @code{VerticalAxisGroup} properties:
1959 @item @code{staff-staff-spacing}
1963 These grob properties are described individually above; see
1964 @ref{Within-system spacing properties}.
1966 Additional properties are involved for staves that are part of a
1967 staff-group; see @ref{Spacing of grouped staves}.
1969 The following example shows how the @code{staff-staff-spacing}
1970 property can affect the spacing of ungrouped staves:
1972 @lilypond[verbatim,quote,staffsize=16]
1976 \override VerticalAxisGroup #'staff-staff-spacing =
1979 (minimum-distance . 7))
1984 % The very low note here needs more room than 'space can
1985 % provide, so the distance between this staff and the next is
1986 % determined by 'padding.
1987 \new Staff { b,2 r | }
1989 % Here, 'space provides enough room, and there is no need to
1990 % compress the space (towards 'minimum-distance) to make room
1991 % for anything else on the page, so the distance between this
1992 % staff and the next is determined by 'space.
1993 \new Staff { \clef bass g2 r | }
1995 % By setting 'padding to a negative value, staves can be made to
1996 % collide. The lowest acceptable value for 'space is 0.
1998 \override VerticalAxisGroup #'staff-staff-spacing =
2001 } { \clef bass g2 r | }
2002 \new Staff { \clef bass g2 r | }
2008 @file{scm/define-grobs.scm}.
2013 Internals Reference:
2014 @rinternals{VerticalAxisGroup}.
2017 @node Spacing of grouped staves
2018 @unnumberedsubsubsec Spacing of grouped staves
2020 In orchestral and other large scores, it is common to place staves
2021 in groups. The space between groups is typically larger than the
2022 space between staves of the same group.
2024 @emph{Staff-groups} (such as @code{StaffGroup}, @code{ChoirStaff},
2025 etc.) are contexts that can contain one or more staves
2028 The following properties affect the spacing of staves inside
2032 @item @code{VerticalAxisGroup} properties:
2034 @item @code{staff-staff-spacing}
2035 @item @code{default-staff-staff-spacing}
2037 @item @code{StaffGrouper} properties:
2039 @item @code{staff-staff-spacing}
2040 @item @code{staffgroup-staff-spacing}
2044 These grob properties are described individually above; see
2045 @ref{Within-system spacing properties}.
2047 The following example shows how properties of the
2048 @code{StaffGrouper} grob can affect the spacing of grouped staves:
2050 @lilypond[verbatim,quote,staffsize=16]
2054 \override StaffGrouper #'staff-staff-spacing #'padding = #0
2055 \override StaffGrouper #'staff-staff-spacing #'space = #1
2060 \new PianoStaff \with {
2061 \override StaffGrouper #'staffgroup-staff-spacing #'space = #20
2076 @file{scm/define-grobs.scm}.
2081 Internals Reference:
2082 @rinternals{VerticalAxisGroup},
2083 @rinternals{StaffGrouper}.
2086 @node Spacing of non-staff lines
2087 @unnumberedsubsubsec Spacing of non-staff lines
2089 @emph{Non-staff lines} (such as @code{Lyrics}, @code{ChordNames},
2090 etc.) are contexts whose layout objects are engraved like staves
2091 (i.e. in horizontal lines within systems). Specifically,
2092 non-staff lines are non-staff contexts that create the
2093 @code{VerticalAxisGroup} layout object.
2095 The following properties affect the spacing of non-staff lines:
2098 @item @code{VerticalAxisGroup} properties:
2100 @item @code{staff-affinity}
2101 @item @code{nonstaff-relatedstaff-spacing}
2102 @item @code{nonstaff-nonstaff-spacing}
2103 @item @code{nonstaff-unrelatedstaff-spacing}
2107 These grob properties are described individually above; see
2108 @ref{Within-system spacing properties}.
2110 The following example shows how the
2111 @code{nonstaff-nonstaff-spacing} property can affect the spacing
2112 of consecutive non-staff lines. Here, by setting the
2113 @code{stretchability} key to a very high value, the lyrics are
2114 able to stretch much more than usual:
2116 @lilypond[verbatim,quote,staffsize=16]
2120 \override VerticalAxisGroup
2121 #'nonstaff-nonstaff-spacing #'stretchability = #1000
2128 \override VerticalAxisGroup #'staff-staff-spacing = #'((space . 30))
2131 \override VerticalAxisGroup #'staff-affinity = #UP
2134 \override VerticalAxisGroup #'staff-affinity = #CENTER
2135 } \lyricmode { center }
2137 \override VerticalAxisGroup #'staff-affinity = #DOWN
2138 } \lyricmode { down }
2146 @file{ly/engraver-init.ly},
2147 @file{scm/define-grobs.scm}.
2152 @c @lsr{spacing,page-spacing.ly},
2153 @c @lsr{spacing,alignment-vertical-spacing.ly}.
2155 Internals Reference:
2156 @rinternals{Contexts},
2157 @rinternals{VerticalAxisGroup}.
2160 @node Explicit staff and system positioning
2161 @subsection Explicit staff and system positioning
2163 One way to understand the @code{VerticalAxisGroup} and @code{\paper}
2164 settings explained in the previous two sections is as a collection of
2165 different settings that primarily concern the amount of vertical padding
2166 different staves and systems running down the page.
2168 It is possible to approach vertical spacing in a different way using
2169 @code{NonMusicalPaperColumn #'line-break-system-details}. Where
2170 @code{VerticalAxisGroup} and @code{\paper} settings specify vertical padding,
2171 @code{NonMusicalPaperColumn #'line-break-system-details} specifies exact
2172 vertical positions on the page.
2174 @code{NonMusicalPaperColumn #'line-break-system-details} accepts an associative
2175 list of three different settings:
2178 @item @code{X-offset}
2179 @item @code{Y-offset}
2180 @item @code{alignment-distances}
2183 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
2184 below, can occur in any of three different places in an input file:
2187 @item in the middle of note entry directly
2188 @item in a @code{\context} block
2189 @item in the @code{\with} block
2192 When we override @code{NonMusicalPaperColumn}, we use the usual
2193 @code{\override} command in @code{\context} blocks and in the
2194 @code{\with} block. On the other hand, when we override
2195 @code{NonMusicalPaperColumn} in the middle of note entry,
2196 use the special @code{\overrideProperty} command. Here are some
2197 example @code{NonMusicalPaperColumn} overrides with the special
2198 @code{\overrideProperty} command:
2201 \overrideProperty NonMusicalPaperColumn
2202 #'line-break-system-details #'((X-offset . 20))
2204 \overrideProperty NonMusicalPaperColumn
2205 #'line-break-system-details #'((Y-offset . 40))
2207 \overrideProperty NonMusicalPaperColumn
2208 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40))
2210 \overrideProperty NonMusicalPaperColumn
2211 #'line-break-system-details #'((alignment-distances . (15)))
2213 \overrideProperty NonMusicalPaperColumn
2214 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40)
2215 (alignment-distances . (15)))
2218 To understand how each of these different settings work, we begin
2219 by looking at an example that includes no overrides at all.
2221 @c \book { } is required in these examples to ensure the spacing
2222 @c overrides can be seen between systems. -np
2225 \header { tagline = ##f }
2226 \paper { left-margin = 0\mm }
2236 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2239 \repeat unfold 15 { d'4 d' d' d' }
2246 This score isolates line- and page-breaking information in a dedicated
2247 voice. This technique of creating a breaks voice will help keep layout
2248 separate from music entry as our example becomes more complicated.
2249 See @ref{Using an extra voice for breaks}.
2251 Explicit @code{\breaks} evenly divide the music into six measures per
2252 line. Vertical spacing results from LilyPond's defaults. To set
2253 the vertical startpoint of each system explicitly, we can set
2254 the @code{Y-offset} pair in the @code{line-break-system-details}
2255 attribute of the @code{NonMusicalPaperColumn} grob:
2258 \header { tagline = ##f }
2259 \paper { left-margin = 0\mm }
2265 \overrideProperty #"Score.NonMusicalPaperColumn"
2266 #'line-break-system-details #'((Y-offset . 0))
2268 \overrideProperty #"Score.NonMusicalPaperColumn"
2269 #'line-break-system-details #'((Y-offset . 40))
2271 \overrideProperty #"Score.NonMusicalPaperColumn"
2272 #'line-break-system-details #'((Y-offset . 80))
2275 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2278 \repeat unfold 15 { d'4 d' d' d' }
2285 Note that @code{line-break-system-details} takes an associative list of
2286 potentially many values, but that we set only one value here. Note,
2287 too, that the @code{Y-offset} property here determines the exact vertical
2288 position on the page at which each new system will render.
2290 Now that we have set the vertical startpoint of each system
2291 explicitly, we can also set the vertical distances between staves
2292 within each system manually. We do this using the @code{alignment-distances}
2293 subproperty of @code{line-break-system-details}.
2296 \header { tagline = ##f }
2297 \paper { left-margin = 0\mm }
2303 \overrideProperty #"Score.NonMusicalPaperColumn"
2304 #'line-break-system-details #'((Y-offset . 20)
2305 (alignment-distances . (15)))
2307 \overrideProperty #"Score.NonMusicalPaperColumn"
2308 #'line-break-system-details #'((Y-offset . 60)
2309 (alignment-distances . (15)))
2311 \overrideProperty #"Score.NonMusicalPaperColumn"
2312 #'line-break-system-details #'((Y-offset . 100)
2313 (alignment-distances . (15)))
2316 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2319 \repeat unfold 15 { d'4 d' d' d' }
2326 Note that here we assign two different values to the
2327 @code{line-break-system-details} attribute of the
2328 @code{NonMusicalPaperColumn} grob. Though the
2329 @code{line-break-system-details} attribute alist accepts many
2330 additional spacing parameters (including, for example, a corresponding
2331 @code{X-offset} pair), we need only set the @code{Y-offset} and
2332 @code{alignment-distances} pairs to control the vertical startpoint of
2333 every system and every staff. Finally, note that @code{alignment-distances}
2334 specifies the vertical positioning of staves but not of staff groups.
2337 \header { tagline = ##f }
2338 \paper { left-margin = 0\mm }
2344 \overrideProperty #"Score.NonMusicalPaperColumn"
2345 #'line-break-system-details #'((Y-offset . 0)
2346 (alignment-distances . (30 10)))
2348 \overrideProperty #"Score.NonMusicalPaperColumn"
2349 #'line-break-system-details #'((Y-offset . 60)
2350 (alignment-distances . (10 10)))
2352 \overrideProperty #"Score.NonMusicalPaperColumn"
2353 #'line-break-system-details #'((Y-offset . 100)
2354 (alignment-distances . (10 30)))
2357 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
2360 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
2361 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
2368 Some points to consider:
2371 @item When using @code{alignment-distances}, lyrics and other non-staff lines
2372 do not count as a staff.
2374 @item The units of the numbers passed to @code{X-offset},
2375 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
2376 of the distance between adjacent staff lines. Positive values move staves
2377 and lyrics up, negative values move staves and lyrics down.
2379 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
2380 settings given here allow the positioning of staves and systems anywhere
2381 on the page, it is possible to violate paper or margin boundaries or even
2382 to print staves or systems on top of one another. Reasonable values
2383 passed to these different settings will avoid this.
2392 @node Vertical collision avoidance
2393 @subsection Vertical collision avoidance
2395 @funindex outside-staff-priority
2396 @funindex outside-staff-padding
2397 @funindex outside-staff-horizontal-padding
2399 Intuitively, there are some objects in musical notation that belong
2400 to the staff and there are other objects that should be placed outside
2401 the staff. Objects belonging outside the staff include things such as
2402 rehearsal marks, text and dynamic markings (from now on, these will
2403 be called outside-staff objects). LilyPond's rule for the
2404 vertical placement of outside-staff objects is to place them as close
2405 to the staff as possible but not so close that they collide with
2408 LilyPond uses the @code{outside-staff-priority} property to determine
2409 whether a grob is an outside-staff object: if @code{outside-staff-priority}
2410 is a number, the grob is an outside-staff object. In addition,
2411 @code{outside-staff-priority} tells LilyPond in which order the objects
2414 First, LilyPond places all the objects that do not belong outside
2415 the staff. Then it sorts the outside-staff objects according to their
2416 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
2417 takes the outside-staff objects and places them so that they do
2418 not collide with any objects that have already been placed. That
2419 is, if two outside-staff grobs are competing for the same space, the one
2420 with the lower @code{outside-staff-priority} will be placed closer to
2423 @lilypond[quote,ragged-right,relative=2,verbatim]
2426 \once \override TextScript #'outside-staff-priority = #1
2427 c4_"Text"\pp % this time the text will be closer to the staff
2429 % by setting outside-staff-priority to a non-number,
2430 % we disable the automatic collision avoidance
2431 \once \override TextScript #'outside-staff-priority = ##f
2432 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
2433 c4_"Text"\pp % now they will collide
2436 The vertical padding between an outside-staff object and the
2437 previously-positioned grobs can be controlled with
2438 @code{outside-staff-padding}.
2440 @lilypond[quote,ragged-right,relative=2,verbatim]
2441 \once \override TextScript #'outside-staff-padding = #0
2442 a'^"This text is placed very close to the note"
2443 \once \override TextScript #'outside-staff-padding = #3
2444 c^"This text is padded away from the previous text"
2445 c^"This text is placed close to the previous text"
2449 By default, outside-staff objects are placed only to avoid
2450 a horizontal collision with previously-positioned grobs. This
2451 can lead to situations in which objects are placed very close to each
2452 other horizontally. The vertical spacing between staves can
2453 also be set so that outside staff objects are interleaved.
2454 Setting @code{outside-staff-horizontal-padding}
2455 causes an object to be offset vertically so that such a situation
2458 @lilypond[quote,ragged-right,relative=2,verbatim]
2459 % the markup is too close to the following note
2463 % setting outside-staff-horizontal-padding fixes this
2465 \once \override TextScript #'outside-staff-horizontal-padding = #1
2477 @node Horizontal spacing
2478 @section Horizontal spacing
2480 @cindex horizontal spacing
2481 @cindex spacing, horizontal
2484 * Horizontal spacing overview::
2485 * New spacing area::
2486 * Changing horizontal spacing::
2488 * Proportional notation::
2492 @node Horizontal spacing overview
2493 @subsection Horizontal spacing overview
2495 The spacing engine translates differences in durations into stretchable
2496 distances (@q{springs}) of differing lengths. Longer durations get
2497 more space, shorter durations get less. The shortest durations get a
2498 fixed amount of space (which is controlled by
2499 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2500 object). The longer the duration, the more space it gets: doubling a
2501 duration adds a fixed amount (this amount is controlled by
2502 @code{spacing-increment}) of space to the note.
2504 For example, the following piece contains lots of half, quarter, and
2505 8th notes; the eighth note is followed by 1 note head width (NHW).
2506 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2508 @lilypond[quote,verbatim,relative=1]
2509 c2 c4. c8 c4. c8 c4. c8 c8
2513 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2514 approximately the width of a note head, and
2515 @code{shortest-duration-space} is set to 2.0, meaning that the
2516 shortest note gets 2.4 staff space (2.0 times the
2517 @code{spacing-increment}) of horizontal space. This space is counted
2518 from the left edge of the symbol, so the shortest notes are generally
2519 followed by one NHW of space.
2521 If one would follow the above procedure exactly, then adding a single
2522 32nd note to a score that uses 8th and 16th notes, would widen up the
2523 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2524 thus adding 1 NHW to every note. To prevent this, the shortest
2525 duration for spacing is not the shortest note in the score, but rather
2526 the one which occurs most frequently.
2529 The most common shortest duration is determined as follows: in every
2530 measure, the shortest duration is determined. The most common shortest
2531 duration is taken as the basis for the spacing, with the stipulation
2532 that this shortest duration should always be equal to or shorter than
2533 an 8th note. The shortest duration is printed when you run
2534 @code{lilypond} with the @code{--verbose} option.
2536 These durations may also be customized. If you set the
2537 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2538 this sets the base duration for spacing. The maximum duration for this
2539 base (normally an 8th), is set through @code{base-shortest-duration}.
2541 @funindex common-shortest-duration
2542 @funindex base-shortest-duration
2543 @funindex stem-spacing-correction
2546 Notes that are even shorter than the common shortest note are
2547 followed by a space that is proportional to their duration relative to
2548 the common shortest note. So if we were to add only a few 16th notes
2549 to the example above, they would be followed by half a NHW:
2551 @lilypond[quote,verbatim,relative=2]
2552 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2556 In the @emph{Essay on automated music engraving}, it was explained
2557 that stem directions influence spacing (see @ressay{Optical
2558 spacing}). This is controlled with the
2559 @code{stem-spacing-correction} property in the
2560 @rinternals{NoteSpacing}, object. These are generated for every
2561 @rinternals{Voice} context. The @code{StaffSpacing} object
2562 (generated in @rinternals{Staff} context) contains the same
2563 property for controlling the stem/bar line spacing. The following
2564 example shows these corrections, once with default settings, and
2565 once with exaggerated corrections:
2567 @lilypond[quote,ragged-right]
2571 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2572 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2578 Proportional notation is supported; see @ref{Proportional notation}.
2585 Internals Reference:
2586 @rinternals{SpacingSpanner},
2587 @rinternals{NoteSpacing},
2588 @rinternals{StaffSpacing},
2589 @rinternals{NonMusicalPaperColumn}.
2594 There is no convenient mechanism to manually override spacing. The
2595 following work-around may be used to insert extra space into a score,
2596 adjusting the padding value as necessary.
2598 \override Score.NonMusicalPaperColumn #'padding = #10
2601 No work-around exists for decreasing the amount of space.
2604 @node New spacing area
2605 @subsection New spacing area
2607 New sections with different spacing parameters can be started with
2608 @code{newSpacingSection}. This is useful when there are
2609 sections with a different notions of long and short notes.
2611 In the following example, the time signature change introduces a new
2612 section, and hence the 16ths notes are spaced wider.
2614 @lilypond[relative=1,verbatim,quote]
2617 c8 c c4 c16[ c c8] c4
2623 The @code{\newSpacingSection} command creates a new
2624 @code{SpacingSpanner} object, and hence new @code{\override}s
2625 may be used in that location.
2632 Internals Reference:
2633 @rinternals{SpacingSpanner}.
2636 @node Changing horizontal spacing
2637 @subsection Changing horizontal spacing
2639 Horizontal spacing may be altered with the
2640 @code{base-shortest-duration} property. Here
2641 we compare the same music; once without altering
2642 the property, and then altered. Larger values
2643 of @code{ly:make-moment} will produce smaller
2644 music. Note that @code{ly:make-moment} constructs
2645 a duration, so @code{1 4} is a longer duration
2648 @lilypond[verbatim,line-width=12\cm]
2651 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2652 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2653 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2654 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2659 @lilypond[verbatim,line-width=12\cm]
2662 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2663 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2664 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2665 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2670 \override SpacingSpanner
2671 #'base-shortest-duration = #(ly:make-moment 1 16)
2680 By default, spacing in tuplets depends on various non-duration
2681 factors (such as accidentals, clef changes, etc). To disregard
2682 such symbols and force uniform equal-duration spacing, use
2683 @code{Score.SpacingSpanner #'uniform-stretching}. This
2684 property can only be changed at the beginning of a score,
2686 @lilypond[quote,ragged-right,verbatim]
2705 \override SpacingSpanner #'uniform-stretching = ##t
2711 When @code{strict-note-spacing} is set, notes are spaced without
2712 regard for clefs, bar lines, and grace notes,
2714 @lilypond[quote,ragged-right,relative=2,verbatim]
2715 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2716 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2726 @subsection Line length
2729 @cindex breaking pages
2732 @funindex line-width
2733 @funindex ragged-right
2734 @funindex ragged-last
2736 @c Although line-width can be set in \layout, it should be set in paper
2737 @c block, to get page layout right.
2738 @c Setting indent in \paper block makes not much sense, but it works.
2740 @c Bit verbose and vague, use examples?
2741 The most basic settings influencing the spacing are @code{indent} and
2742 @code{line-width}. They are set in the @code{\layout} block. They
2743 control the indentation of the first line of music, and the lengths of
2746 If @code{ragged-right} is set to true in the @code{\layout} block, then
2747 systems ends at their natural horizontal length, instead of being spread
2748 horizontally to fill the whole line. This is useful for
2749 short fragments, and for checking how tight the natural spacing is.
2750 The normal default setting is false, but if the score has only one
2751 system the default value is true.
2754 @cindex vertical spacing
2756 The option @code{ragged-last} is similar to @code{ragged-right}, but
2757 only affects the last line of the piece. No restrictions are put on
2758 that line. The result is similar to formatting text paragraphs. In a
2759 paragraph, the last line simply takes its natural horizontal length.
2760 @c Note that for text there are several options for the last line.
2761 @c While Knuth TeX uses natural length, lead typesetters use the same
2762 @c stretch as the previous line. eTeX uses \lastlinefit to
2763 @c interpolate between both these solutions.
2779 @node Proportional notation
2780 @subsection Proportional notation
2782 LilyPond supports proportional notation, a type of horizontal spacing
2783 in which each note consumes an amount of horizontal space exactly
2784 equivalent to its rhythmic duration. This type of proportional spacing
2785 is comparable to horizontal spacing on top of graph paper. Some late
2786 20th- and early 21st-century scores use proportional notation to
2787 clarify complex rhythmic relationships or to facilitate the placement
2788 of timelines or other graphics directly in the score.
2790 LilyPond supports five different settings for proportional notation,
2791 which may be used together or alone:
2794 @item @code{proportionalNotationDuration}
2795 @item @code{uniform-stretching}
2796 @item @code{strict-note-spacing}
2797 @item @code{\remove Separating_line_group_engraver}
2798 @item @code{\override PaperColumn #'used = ##t}
2801 In the examples that follow, we explore these five different
2802 proportional notation settings and examine how these settings interact.
2804 We start with the following one-measure example, which uses classical
2805 spacing with ragged-right turned on.
2807 @lilypond[quote,verbatim,ragged-right]
2810 \new RhythmicStaff {
2814 c'16 c'16 c'16 c'16 c'16
2821 Notice that the half note which begins the measure takes up far less
2822 than half of the horizontal space of the measure. Likewise, the
2823 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
2824 which end the measure together take up far more than half the
2825 horizontal space of the measure.
2827 In classical engraving, this spacing may be exactly what we want
2828 because we can borrow horizontal space from the half note and conserve
2829 horizontal space across the measure as a whole.
2831 On the other hand, if we want to insert a measured timeline or other
2832 graphic above or below our score, we need proportional notation. We
2833 turn proportional notation on with the proportionalNotationDuration
2836 @lilypond[quote,verbatim,ragged-right]
2839 \new RhythmicStaff {
2843 c'16 c'16 c'16 c'16 c'16
2850 proportionalNotationDuration = #(ly:make-moment 1 20)
2856 The half note at the beginning of the measure and the faster notes in
2857 the second half of the measure now occupy equal amounts of horizontal
2858 space. We could place a measured timeline or graphic above or below
2861 The @code{proportionalNotationDuration} setting is a context setting
2862 that lives in @code{Score}. Remember that context settings can appear
2863 in one of three locations within our input file -- in a @code{\with}
2864 block, in a @code{\context} block, or directly in music entry preceded
2865 by the @code{\set} command. As with all context settings, users can
2866 pick which of the three different locations they would like to
2867 set @code{proportionalNotationDuration} in to.
2869 The @code{proportionalNotationDuration} setting takes a single argument,
2870 which is the reference duration against that all music will be spaced.
2871 The LilyPond Scheme function @code{make-moment} takes two arguments
2872 -- a numerator and denominator which together express some fraction of
2873 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces
2874 a reference duration of a twentieth note. Values such as
2875 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
2876 @code{#(ly:make-moment 3 97)} are all possible as well.
2878 How do we select the right reference duration to pass to
2879 @code{proportionalNotationDuration}? Usually by a process of trial
2880 and error, beginning with a duration close to the fastest (or smallest)
2881 duration in the piece. Smaller reference durations space music loosely;
2882 larger reference durations space music tightly.
2884 @lilypond[quote,verbatim,ragged-right]
2887 \new RhythmicStaff {
2891 c'16 c'16 c'16 c'16 c'16
2898 proportionalNotationDuration = #(ly:make-moment 1 8)
2905 \new RhythmicStaff {
2909 c'16 c'16 c'16 c'16 c'16
2916 proportionalNotationDuration = #(ly:make-moment 1 16)
2923 \new RhythmicStaff {
2927 c'16 c'16 c'16 c'16 c'16
2934 proportionalNotationDuration = #(ly:make-moment 1 32)
2940 Note that too large a reference duration -- such as the eighth note,
2941 above -- spaces music too tightly and can cause note head collisions.
2942 Also that proportional notation in general takes up more horizontal
2943 space than classical spacing. Proportional spacing provides rhythmic
2944 clarity at the expense of horizontal space.
2946 Next we examine how to optimally space overlapping tuplets.
2948 We start by examining what happens to our original example, with
2949 classical spacing, when we add a second staff with a different type of
2952 @lilypond[quote,verbatim,ragged-right]
2955 \new RhythmicStaff {
2959 c'16 c'16 c'16 c'16 c'16
2962 \new RhythmicStaff {
2964 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2971 The spacing is bad because the evenly spaced notes of the bottom staff
2972 do not stretch uniformly. Classical engravings include very few complex
2973 triplets and so classical engraving rules can generate this type of
2974 result. Setting @code{proportionalNotationDuration} fixes this.
2976 @lilypond[quote,verbatim,ragged-right]
2979 \new RhythmicStaff {
2983 c'16 c'16 c'16 c'16 c'16
2986 \new RhythmicStaff {
2988 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2995 proportionalNotationDuration = #(ly:make-moment 1 20)
3001 But if we look very carefully we can see that notes of the second half
3002 of the 9-tuplet space ever so slightly more widely than the notes
3003 of the first half of the 9-tuplet. To ensure uniform stretching, we
3004 turn on @code{uniform-stretching}, which is a property of
3005 @code{SpacingSpanner}.
3007 @lilypond[quote,verbatim,ragged-right]
3010 \new RhythmicStaff {
3014 c'16 c'16 c'16 c'16 c'16
3017 \new RhythmicStaff {
3019 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
3026 proportionalNotationDuration = #(ly:make-moment 1 20)
3027 \override SpacingSpanner #'uniform-stretching = ##t
3033 Our two-staff example now spaces exactly, our rhythmic
3034 relationships are visually clear, and we can include a measured
3035 timeline or graphic if we want.
3037 Note that the LilyPond's proportional notation package expects
3038 that all proportional scores set the SpacingSpanner's
3039 'uniform-stretching attribute to ##t. Setting
3040 proportionalNotationDuration without also setting the
3041 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
3042 example, cause Skips to consume an incorrect amount of horizontal
3045 The SpacingSpanner is an abstract grob that lives in the Score
3046 context. As with our settings of proportionalNotationDuration,
3047 overrides to the SpacingSpanner can occur in any of three
3048 different places in our input file – in the Score \with block, in
3049 a Score \context block, or in note entry directly.
3051 There is by default only one @code{SpacingSpanner} per @code{Score}. This
3052 means that, by default, @code{uniform-stretching} is either turned on for the
3053 entire score or turned off for the entire score. We can, however,
3054 override this behavior and turn on different spacing features at
3055 different places in the score. We do this with the command
3056 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
3058 Next we examine the effects of the @code{Separating_line_group_engraver} and
3059 see why proportional scores frequently remove this engraver. The following
3060 example shows that there is a small amount of @qq{preferatory} space
3061 just before the first note in each system.
3063 @lilypond[quote,verbatim,ragged-right]
3076 The amount of this preferatory space is the same whether after a time
3077 signature, a key signature or a clef. @code{Separating_line_group_engraver}
3078 is responsible for this space. Removing @code{Separating_line_group_engraver}
3079 reduces this space to zero.
3081 @lilypond[quote,verbatim,ragged-right]
3087 \remove Separating_line_group_engraver
3095 Nonmusical elements like time signatures, key signatures, clefs and
3096 accidentals are problematic in proportional notation. None of these
3097 elements has rhythmic duration. But all of these elements consume
3098 horizontal space. Different proportional scores approach these
3099 problems differently.
3101 It may be possible to avoid spacing problems with key signatures
3102 simply by not having any. This is a valid option since most
3103 proportional scores are contemporary music. The same may be true
3104 of time signatures, especially for those scores
3105 that include a measured timeline or other graphic. But these scores
3106 are exceptional and most proportional scores include at least some
3107 time signatures. Clefs and accidentals are even more essential.
3109 So what strategies exist for spacing nonmusical elements in a
3110 proportional context? One good option is the @code{strict-note-spacing}
3111 property of @code{SpacingSpanner}. Compare the two scores below:
3113 @lilypond[quote,verbatim,ragged-right]
3115 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3125 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
3126 \override Score.SpacingSpanner #'strict-note-spacing = ##t
3136 Both scores are proportional, but the spacing in the first score
3137 is too loose because of the clef change. The spacing of the second
3138 score remains strict, however, because strict-note-spacing is
3139 turned on. Turning on strict-note-spacing causes the width of
3140 time signatures, key signatures, clefs and accidentals to play no
3141 part in the spacing algorithm.
3143 In addition to the settings given here, there are other settings
3144 that frequently appear in proportional scores. These include:
3147 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
3148 @item @code{tupletFullLength = ##t}
3149 @item @code{\override Beam #'breakable = ##t}
3150 @item @code{\override Glissando #'breakable = ##t}
3151 @item @code{\override TextSpanner #'breakable = ##t}
3152 @item @code{\remove Forbid_line_break_engraver in the Voice context}
3155 These settings space grace notes strictly, extend tuplet brackets to
3156 mark both rhythmic start- and stop-points, and allow spanning elements
3157 to break across systems and pages. See the respective parts of the manual
3158 for these related settings.
3163 @ref{New spacing area}.
3169 @node Fitting music onto fewer pages
3170 @section Fitting music onto fewer pages
3172 Sometimes you can end up with one or two staves on a second
3173 (or third, or fourth...) page. This is annoying, especially
3174 if you look at previous pages and it looks like there is plenty
3175 of room left on those.
3177 When investigating layout issues, @code{annotate-spacing} is an
3178 invaluable tool. This command prints the values of various layout
3179 spacing variables; for more details see the following section,
3180 @ref{Displaying spacing}.
3183 * Displaying spacing::
3184 * Changing spacing::
3188 @node Displaying spacing
3189 @subsection Displaying spacing
3191 @funindex annotate-spacing
3192 @cindex spacing, display of layout
3194 To graphically display the dimensions of vertical layout variables
3195 that may be altered for page formatting, set
3196 @code{annotate-spacing} in the @code{\paper} block:
3198 @c need to have \book{} otherwise we get the separate systems. -hwn
3199 @lilypond[verbatim,quote]
3200 #(set-default-paper-size "a6" 'landscape)
3203 \paper { annotate-spacing = ##t }
3209 All layout dimensions are displayed in staff-spaces, regardless
3210 of the units specified in the @code{\paper} or @code{\layout} block.
3211 In the above example, @code{paper-height} has a value of 59.75
3212 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
3213 default value). Note that:
3215 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
3218 @tab = (25.4/72.27) mm
3221 @tab = (@code{staff-size})/4 pts
3223 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
3228 In this case, one @code{staff-space} is approximately equal to
3229 1.757mm. Thus the @code{paper-height} measurement of 59.75
3230 @code{staff-spaces} is equivalent to 105 millimeters, the height
3231 of @code{a6} paper in landscape orientation. The pairs
3232 (@var{a},@var{b}) are intervals, where @var{a} is the lower
3233 edge and @var{b} the upper edge of the interval.
3238 @ref{Setting the staff size}.
3244 @node Changing spacing
3245 @subsection Changing spacing
3247 The output of @code{annotate-spacing} reveals vertical dimensions
3248 in great detail. For details about modifying margins and other
3249 layout variables, see @ref{Page layout}.
3251 Other than margins, there are a few other options to save space:
3255 Force systems to move as close together as possible (to fit as
3256 many systems as possible onto a page) while being spaced so that
3257 there is no blank space at the bottom of the page.
3261 system-system-spacing = #'((padding . 0) (space . 0.1))
3262 ragged-last-bottom = ##f
3268 Force the number of systems. This can help in two ways. Just
3269 setting a value, even the same value as the number of systems
3270 being typeset by default, will sometimes cause more systems to
3271 be fitted onto each page, as an estimation step is then bypassed,
3272 giving a more accurate fit to each page. Also, forcing an actual
3273 reduction in the number of systems may save a further page. For
3274 example, if the default layout has 11 systems, the following
3275 assignment will force a layout with 10 systems.
3284 Avoid (or reduce) objects that increase the vertical size of a
3285 system. For example, volta repeats (or alternate repeats) require
3286 extra space. If these repeats are spread over two systems, they
3287 will take up more space than one system with the volta repeats and
3288 another system without. For example, dynamics that @q{stick out} of
3289 a system can be moved closer to the staff:
3291 @lilypond[verbatim,quote,relative=1]
3293 e4 c g-\tweak #'X-offset #-2.7 -\tweak #'Y-offset #2.5 \f c
3297 Alter the horizontal spacing via @code{SpacingSpanner}. For more
3298 details, see @ref{Changing horizontal spacing}. The following
3299 example illustrates the default spacing:
3301 @lilypond[verbatim,quote]
3314 The next example modifies @code{common-shortest-duration} from a
3315 value of @code{1/4} to @code{1/2}. The quarter note is the most
3316 common and shortest duration in this example, so by making this
3317 duration longer, a @q{squeezing} effect occurs:
3319 @lilypond[verbatim,quote]
3331 \override SpacingSpanner
3332 #'common-shortest-duration = #(ly:make-moment 1 2)
3339 The @code{common-shortest-duration} property cannot be modified
3340 dynamically, so it must always be placed in a @code{\context}
3341 block so that it applies to the whole score.
3349 @ref{Changing horizontal spacing}.