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 Settings which influence layout may be placed in two blocks.
72 The @code{\paper @{...@}} block is placed outside any
73 @code{\score @{...@}} blocks and contains settings that
74 relate to the entire document. The @code{\layout @{...@}}
75 block is placed within a @code{\score @{...@}} block and
76 contains settings for that particular score. If you have
77 only one @code{\score @{...@}} block the two have the same
78 effect. In general the commands shown in this chapter can
86 * Horizontal spacing::
87 * Fitting music onto fewer pages::
92 @section Paper and pages
94 This section deals with the boundaries that define the area
95 within which music can be printed.
104 @subsection Paper size
109 Two functions are available for changing the paper size:
110 @code{set-default-paper-size} and @code{set-paper-size}.
111 @code{set-default-paper-size} must be placed in the toplevel
112 scope, and @code{set-paper-size} must be placed in a @code{\paper}
116 #(set-default-paper-size "a4")
121 #(set-paper-size "a4")
126 @code{set-default-paper-size} sets the size of all pages, whereas
127 @code{set-paper-size} only sets the size of the pages that the
128 @code{\paper} block applies to. For example, if the @code{\paper}
129 block is at the top of the file, then it will apply the paper size
130 to all pages. If the @code{\paper} block is inside a
131 @code{\book}, then the paper size will only apply to that book.
133 Common paper sizes are available, including @code{a4},
134 @code{letter}, @code{legal}, and @code{11x17} (also known as
135 tabloid). Many more paper sizes are supported by default. For
136 details, see @file{scm/@/paper@/.scm}, and search for the
137 definition of @code{paper-alist}.
139 @c TODO add a new appendix for paper sizes (auto-generated) -pm
141 @warning{The default paper size is @code{a4}.}
143 Extra sizes may be added by editing the definition of
144 @code{paper-alist} in the initialization file
145 @file{scm/@/paper@/.scm}, however they will be overridden on a
151 If the symbol @code{'landscape} is supplied as an argument to
152 @code{set-default-paper-size}, pages will be rotated by 90
153 degrees, and wider line widths will be set accordingly.
156 #(set-default-paper-size "a6" 'landscape)
159 Setting the paper size will adjust a number of @code{\paper}
160 variables, such as margins. To use a particular paper size with
161 altered @code{\paper} variables, set the paper size before setting
167 @file{scm/@/paper@/.scm}.
173 @node Page formatting
174 @subsection Page formatting
178 Margins, headers, and footers and other layout variables are
179 automatically set according to the paper size.
181 Default margin values are accessible in
182 @file{ly/@/paper@/-defaults@/-init@/.ly}. They apply to the default
183 paper size (a4, unless specified differently) and are scaled
184 accordingly for other paper sizes.
186 This section lists and describes a number of paper variables that
190 * Vertical dimensions::
191 * Horizontal dimensions::
192 * Other layout variables::
196 @node Vertical dimensions
197 @unnumberedsubsubsec Vertical dimensions
200 @subsubheading Fixed vertical dimensions
204 @funindex paper-height
206 The height of the page. Default: the height of the current paper
207 size. For details, see @ref{Paper size}.
212 The margin between the top of the page and the top of the
213 printable area. Default: @code{5\mm}.
216 @funindex bottom-margin
218 The margin between the bottom of the printable area and the bottom
219 of the page. Default: @code{6\mm}.
224 @subsubheading Flexible vertical dimensions
226 In most cases, it is preferable for the vertical distances between
227 certain items (such as margins, titles, systems, and separate
228 scores) to be flexible, so that they stretch and compress nicely
229 according to each situation. A number of @code{\paper} variables
230 (listed below) are available to fine-tune the stretching behavior
233 Each of these variables is an associative list containing four
237 @item @code{padding} -- the minimum required amount of
238 unobstructed vertical whitespace between two items. This can be
239 thought of as the minimum height of an unobstructed (invisible)
240 rectangle that extends from the leftmost to the rightmost point of
243 @item @code{space} -- the default vertical distance between the
244 @emph{reference points} of the two items, when no collisions would
245 result, and no stretching or compressing is in effect. The
246 reference point of a title or markup is its highest point, and the
247 reference point of a system is the middle line of the nearest
248 staff. Values for @code{space} that are less than either
249 @code{padding} or @code{minimum-distance} are not meaningful,
250 since the resulting space will never be less than either
251 @code{padding} or @code{minimum-distance}.
253 @item @code{minimum-distance} -- the minimum required vertical
254 distance between the reference points of the two items, when
255 compressing is in effect. Values for @code{minimum-distance} that
256 are less than @code{padding} are not meaningful, since the
257 resulting space will never be less than @code{padding.}
259 @item @code{stretchability} -- the stretchable space's propensity
260 to stretch. If zero, the space will not stretch (unless
261 collisions would result). When positive, the significance of a
262 particular dimension's @code{stretchability} value lies only in
263 its relation to the @code{stretchability} values of the other
264 dimensions. For example, if one dimension has twice the
265 @code{stretchability} of another, it will stretch twice as easily.
266 Values should be non-negative and finite. The value @code{+inf.0}
267 triggers a @code{programming_error} and is ignored, but
268 @code{1.0e7} can be used for an almost infinitely stretchable
269 spring. If unset, the default value is set to @code{space}. Note
270 that the stretchable space's propensity to @emph{compress} cannot
271 be directly set by the user and is equal to
272 (@code{space}@tie{}@minus{}@tie{}@code{minimum-distance}).
276 If a page has a ragged bottom, the resulting distance is the
281 @item @code{minimum-distance}, and
282 @item @code{padding} plus the smallest distance necessary to
283 eliminate collisions.
286 A single key for a flexible vertical dimension variable can be set
291 markup-system-spacing #'space = #5
295 Multiple keys for a single variable can be set simultaneously like
300 last-bottom-spacing =
303 (minimum-distance . 0)
304 (stretchability . 5))
308 The names of the flexible vertical dimension variables follow the
309 format @code{@var{upper}-@var{lower}-spacing}, where
310 @code{@var{upper}} and @code{@var{lower}} are the items to be
311 spaced. Each distance is measured between the reference points of
312 the two items: the reference point of a title or markup is its
313 highest point, and the reference point of a system is the middle
314 line of the nearest staff. Note that in these variable names, the
315 term @q{@code{markup}} refers to both @i{title markups}
316 (@code{bookTitleMarkup} or @code{scoreTitleMarkup}) and
317 @i{top-level markups} (see @ref{File structure}).
319 The flexible vertical dimension variables are:
324 @item markup-system-spacing
325 @funindex markup-system-spacing
327 the space between a (title or top-level) markup and the system
330 @item score-markup-spacing
331 @funindex score-markup-spacing
333 the space between the last system of a score and the (title or
334 top-level) markup that follows it.
336 @item score-system-spacing
337 @funindex score-system-spacing
339 the space between the last system of a score and the first system
340 of the score that follows it, when no (title or top-level) markup
343 @item system-system-spacing
344 @funindex system-system-spacing
346 the space between two systems in the same score.
348 @item markup-markup-spacing
349 @funindex markup-markup-spacing
351 the space between two (title or top-level) markups.
353 @item last-bottom-spacing
354 @funindex last-bottom-spacing
356 the space from the last system or top-level markup on a page to
357 the bottom of the printable area (i.e. the top of the bottom
360 @item top-system-spacing
361 @funindex top-system-spacing
363 the space from the top of the printable area (i.e. the bottom of
364 the top margin) to the first system on a page, when there is no
365 (title or top-level) markup between the two.
367 @item top-markup-spacing
368 @funindex top-markup-spacing
370 the space from the top of the printable area (i.e. the bottom of
371 the top margin) to the first (title or top-level) markup on a
372 page, when there is no system between the two.
379 The header and footer are created by the functions
380 @code{make-footer} and @code{make-header}, defined in
381 @code{\paper}. The default implementations are in
382 @file{ly/paper-defaults.ly} and @file{ly/titling-init.ly}.
384 The page layout itself is done by two functions in the
385 @code{\paper} block, @code{page-music-height} and
386 @code{page-make-stencil}. The former tells the line-breaking
387 algorithm how much space can be spent on a page, the latter
388 creates the actual page given the system to put on it.
390 You can define @code{\paper} block values in Scheme. In that case
391 @code{mm}, @code{in}, @code{pt}, and @code{cm} are variables
392 defined in @file{paper-defaults.ly} with values in millimeters.
393 That is why the value @w{@code{2 cm}} must be multiplied in the
398 #(define bottom-margin (* 2 cm))
410 ragged-last-bottom = ##t
414 This second example centers page numbers at the bottom of every page.
418 print-page-number = ##t
419 print-first-page-number = ##t
420 oddHeaderMarkup = \markup \fill-line @{ " " @}
421 evenHeaderMarkup = \markup \fill-line @{ " " @}
422 oddFooterMarkup = \markup @{ \fill-line @{
423 \bold \fontsize #3 \on-the-fly #print-page-number-check-first
424 \fromproperty #'page:page-number-string @} @}
425 evenFooterMarkup = \markup @{ \fill-line @{
426 \bold \fontsize #3 \on-the-fly #print-page-number-check-first
427 \fromproperty #'page:page-number-string @} @}
433 @ref{Vertical spacing between systems}.
439 @node Horizontal dimensions
440 @unnumberedsubsubsec Horizontal dimensions
443 There are a few variables that determine the horizontal dimensions
449 @funindex binding-offset
451 The amount @code{inner-margin} is increased
452 to make sure nothing will be hidden by the binding.
453 Works only with @code{two-sided} set to true. Default:
456 @item horizontal-shift
457 @funindex horizontal-shift
459 The amount that all systems (including titles and system
460 separators) are shifted to the right. Default: @code{0.0}.
465 The level of indentation for the first system in a score.
466 Default: @code{15\mm}.
469 @funindex inner-margin
471 The margin all pages have at the inner side if they are part
472 of a book. Works only with @code{two-sided} set to true.
473 Default: @code{10\mm}.
476 @funindex left-margin
478 The margin between the left edge of the page and the beginning of
479 each system. Default: @code{10\mm}.
484 The width of music systems. Default: @code{paper-width} minus
485 @code{left-margin} and @code{right-margin}.
488 @funindex outer-margin
490 The margin all pages have at the outer side if they are part
491 of a book. Works only with @code{two-sided} set to true.
492 Default: @code{20\mm}.
495 @funindex paper-width
497 The width of the page. Default: the width of the current paper
498 size. For details, see @ref{Paper size}.
501 @funindex right-margin
503 The margin between the right edge of the page and the end of
504 each system. Default: @code{10\mm}.
507 @funindex short-indent
509 The level of indentation for all systems in a score besides the
510 first system. Default: @code{0}.
514 If some values are not set, defaults will be taken. Their exact
515 value is adjusted, depending on the paper size specified. Currently,
516 the following values are affected by this scaling:
519 @item @var{left-margin}
520 @item @var{right-margin}
521 @item @var{top-margin}
522 @item @var{bottom-margin}
523 @item @var{head-separation}
524 @item @var{foot-separation}
526 @item @var{short-indent}
529 The settings for @code{line-width}, @code{left-margin},
530 @code{right-margin} and @code{paper-width} depend on
531 each other, but they do not have to be specified
540 In this example, only @code{left-margin} is set. The value for
541 @code{right-margin} will remain default, @code{line-width} is
542 calculated automatically.
550 Here @code{left-margin} and @code{right-margin} will be set
551 to the same value. Therefore, @code{line-width} is subtracted
552 from @code{paper-width} and divided by two. That means systems
553 are centered on the page, if only @code{line-width} is
556 Some checks occur to ensure the values are set correctly.
557 If the values do not match or systems would run off the page,
558 a warning is printed and default values are set.
569 These checks can be avoided by setting @code{check-consistency}
577 check-consistency = ##f
581 @warning{If @code{paper-width} is manually set, @code{line-width},
582 @code{left-margin}, @code{indent}, and @code{short-indent} may
583 have to be adjusted as well.}
591 @node Other layout variables
592 @unnumberedsubsubsec Other layout variables
594 These variables can be used to adjust page layout in general.
598 @item auto-first-page-number
599 @funindex auto-first-page-number
601 The page breaking algorithm is affected by the first page number
602 being odd or even. If set to true, the page breaking algorithm
603 will decide whether to start with an odd or even number. This
604 will result in the first page number remaining as is or being
605 increased by one. Default: @code{##f}.
609 TODO: this variable is used, but I don't know what it does. -pm
610 @item blank-after-score-page-force
611 @funindex blank-after-score-page-force
617 @item blank-last-page-force
618 @funindex blank-last-page-force
620 The penalty for ending the score on an odd-numbered page.
623 @item blank-page-force
624 @funindex blank-page-force
626 The penalty for having a blank page in the middle of a
627 score. This is not used by @code{ly:optimal-breaking} since it will
628 never consider blank pages in the middle of a score. Default:
631 @item check-consistency
632 @funindex check-consistency
634 If set to true, check whether @code{left-margin}, @code{right-margin} and
635 @code{line-width} fit each other. Also make sure that their combination
636 does not exceed the available @code{paper-width}. Default: @code{##t}.
638 @item first-page-number
639 @funindex first-page-number
641 The value of the page number on the first page. Default:
644 @item max-systems-per-page
645 @funindex max-systems-per-page
647 The maximum number of systems that will be placed on a page. This
648 is currently supported only by the @code{ly:optimal-breaking} algorithm.
651 @item min-systems-per-page
652 @funindex min-systems-per-page
654 The minimum number of systems that will be placed on a page. This
655 may cause pages to be overfilled if it is made too large. This is
656 currently supported only by the @code{ly:optimal-breaking} algorithm.
659 @item page-breaking-system-system-spacing
660 @funindex page-breaking-system-system-spacing
662 Tricks the page breaker into thinking that
663 @code{system-system-spacing} is set to something different than
664 it really is. For example, if
665 @code{page-breaking-system-system-spacing #'padding} is set to something
666 substantially larger than @code{system-system-spacing #'padding}, then the
667 page-breaker will put fewer systems on each page. Default: unset.
672 The number of pages to be used for a score. Default: unset.
674 @item page-limit-inter-system-space
675 @funindex page-limit-inter-system-space
677 If set to true, limits space between systems on a page with a lot
678 of space left. Default: @code{##f}. For details, see
679 @ref{Vertical spacing between systems}.
681 @item page-limit-inter-system-space-factor
682 @funindex page-limit-inter-system-space-factor
684 The factor used by @code{page-limit-inter-system-space}. Default:
685 @code{1.4}. For details, see
686 @ref{Vertical spacing between systems}.
688 @item page-spacing-weight
689 @funindex page-spacing-weight
691 The relative importance of page (vertical) spacing and line
692 (horizontal) spacing. High values will make page spacing more
693 important. Default: @code{#10}.
695 @item print-all-headers
696 @funindex print-all-headers
698 If set to true, this will print all headers for each \score in the
699 output. Normally only the piece and opus header variables are
700 printed. Default: @code{##f}.
702 @item print-first-page-number
703 @funindex print-first-page-number
705 If set to true, a page number is printed on the first page.
708 @item print-page-number
709 @funindex print-page-number
711 If set to false, page numbers are not printed. Default:
715 @funindex ragged-bottom
717 If set to true, systems will not spread vertically across the
718 page. This does not affect the last page. Default: @code{##f}.
720 This should be set to true for pieces that have only two or three
721 systems per page, for example orchestral scores.
724 @funindex ragged-last
726 If set to true, the last system in the score will not fill the
727 line width. Instead the last system ends at its natural
728 horizontal length. Default: @code{##f}.
730 @item ragged-last-bottom
731 @funindex ragged-last-bottom
733 If set to false, systems will spread vertically across the last
734 page. Default: @code{##t}.
736 Pieces that amply fill two pages or more should have this set to
739 It also affects the last page of book parts, ie parts of a book created
740 with @code{\bookpart} blocks.
743 @funindex ragged-right
745 If set to true, systems will not fill the line width. Instead,
746 systems end at their natural horizontal length. Default:
749 If the score has only one system, the default value is @code{##t}.
751 @item system-separator-markup
752 @funindex system-separator-markup
754 A markup object that is inserted between systems. This is often
755 used for orchestral scores. Default: unset.
757 The markup command @code{\slashSeparator} is provided as a sensible
760 @lilypond[quote,ragged-right]
761 #(set-default-paper-size "a6" 'landscape)
764 \relative c' { c1 \break c1 }
767 system-separator-markup = \slashSeparator
773 @funindex system-count
775 The number of systems to be used for a score.
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.
789 @cindex binding gutter
791 If set to true, use @code{inner-margin}, @code{outer-margin} and
792 @code{binding-offset} to determine margins depending on whether
793 the page number is odd or even. This overrides @code{left-margin}
794 and @code{right-margin}. Default: @code{##f}.
806 The default page header puts the page number and the @code{instrument}
807 field from the @code{\header} block on a line.
809 The titles (from the @code{\header@{@}} section) are treated as a
810 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
811 add space between the titles and the first system of the score.
815 @section Music layout
818 * Setting the staff size::
823 @node Setting the staff size
824 @subsection Setting the staff size
826 @cindex font size, setting
827 @cindex staff size, setting
828 @funindex layout file
830 The default @strong{staff size} is set to 20 points.
831 This may be changed in two ways:
833 To set the staff size globally for all scores in a file (or
834 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
837 #(set-global-staff-size 14)
841 This sets the global default size to 14pt staff height and scales all
844 To set the staff size individually for each score, use
849 #(layout-set-staff-size 15)
854 The Feta font provides musical symbols at eight different
855 sizes. Each font is tuned for a different staff size: at a smaller size
856 the font becomes heavier, to match the relatively heavier staff lines.
857 The recommended font sizes are listed in the following table:
860 @multitable @columnfractions .15 .2 .22 .2
863 @tab @b{staff height (pt)}
864 @tab @b{staff height (mm)}
906 @c modern rental material?
911 These fonts are available in any sizes. The context property
912 @code{fontSize} and the layout property @code{staff-space} (in
913 @rinternals{StaffSymbol}) can be used to tune the size for individual
914 staves. The sizes of individual staves are relative to the global size.
919 @ref{Selecting notation font size}.
927 @code{layout-set-staff-size} does not change the distance between the
932 @subsection Score layout
936 While @code{\paper} contains settings that relate to the page formatting
937 of the whole document, @code{\layout} contains settings for score-specific
944 \override VerticalAxisGroup #'minimum-Y-extent = #'(-6 . 6)
947 \override TextScript #'padding = #1.0
948 \override Glissando #'thickness = #3
956 @ref{Changing context default settings}.
968 * Optimal page breaking::
969 * Optimal page turning::
970 * Minimal page breaking::
972 * Using an extra voice for breaks::
977 @subsection Line breaking
980 @cindex breaking lines
982 Line breaks are normally determined automatically. They are chosen
983 so that lines look neither cramped nor loose, and consecutive
984 lines have similar density. Occasionally you might want to
985 override the automatic breaks; you can do this by specifying
986 @code{\break}. This will force a line break at this point. However,
987 line breaks can only occur at the end of @q{complete} bars, i.e.,
988 where there are no notes or tuplets left @q{hanging} over the bar
989 line. If you want to have a line break where there is no bar line,
990 you can force an invisible bar line by entering @code{\bar ""},
991 although again there must be no notes left hanging over in any of
992 the staves at this point, or it will be ignored.
994 The opposite command, @code{\noBreak}, forbids a line break at the
995 bar line where it is inserted.
997 The most basic settings influencing line spacing are @code{indent}
998 and @code{line-width}. They are set in the @code{\layout} block.
999 They control the indentation of the first line of music, and the
1000 lengths of the lines.
1002 If @code{ragged-right} is set to true in the @code{\layout} block,
1003 then systems end at their natural horizontal length, instead of
1004 being spread horizontally to fill the whole line. This is useful
1005 for short fragments, and for checking how tight the natural
1008 @c TODO Check and add para on default for ragged-right
1010 The option @code{ragged-last} is similar to @code{ragged-right},
1011 but affects only the last line of the piece.
1023 @cindex regular line breaks
1024 @cindex four bar music.
1026 For line breaks at regular intervals use @code{\break} separated by
1027 skips and repeated with @code{\repeat}. For example, this would
1028 cause the following 28 measures (assuming 4/4 time) to be broken
1029 every 4 measures, and only there:
1032 << \repeat unfold 7 @{
1033 s1 \noBreak s1 \noBreak
1034 s1 \noBreak s1 \break @}
1035 @emph{the real music}
1040 A linebreaking configuration can be saved as a @code{.ly} file
1041 automatically. This allows vertical alignments to be stretched to
1042 fit pages in a second formatting run. This is fairly new and
1043 complicated. More details are available in
1056 Internals Reference:
1057 @rinternals{LineBreakEvent}.
1065 Line breaks can only occur if there is a @q{proper} bar line. A note
1066 which is hanging over a bar line is not proper, such as
1068 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1069 c4 c2 << c2 {s4 \break } >> % this does nothing
1070 c2 c4 | % a break here would work
1071 c4 c2 c4 ~ \break % as does this break
1075 This can be avoided by removing the @code{Forbid_line_break_engraver}.
1076 Note that manually forced line breaks have to be added in parallel
1079 @lilypond[quote,ragged-right,verbatim]
1081 \remove Forbid_line_break_engraver
1083 c4 c2 << c2 {s4 \break } >> % now the break is allowed
1088 Similarly, line breaks are normally forbidden when beams cross bar
1089 lines. This behavior can be changed by setting
1090 @code{\override Beam #'breakable = ##t}.
1094 @subsection Page breaking
1096 The default page breaking may be overridden by inserting
1097 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1098 analogous to @code{\break} and @code{\noBreak}. They should be
1099 inserted at a bar line. These commands force and forbid a page-break
1100 from happening. Of course, the @code{\pageBreak} command also forces
1103 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1104 inserted at top-level, between scores and top-level markups.
1106 There are also analogous settings to @code{ragged-right} and
1107 @code{ragged-last} which have the same effect on vertical spacing:
1108 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1109 @code{##t} the systems on all pages or just the last page
1110 respectively will not be justified vertically.
1112 For more details see @ref{Vertical spacing}.
1114 Page breaks are computed by the @code{page-breaking} function. LilyPond
1115 provides three algorithms for computing page breaks,
1116 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1117 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1118 but the value can be changed in the @code{\paper} block:
1122 #(define page-breaking ly:page-turn-breaking)
1128 When a book has many scores and pages, the page breaking problem may be
1129 difficult to solve, requiring large processing time and memory. To ease
1130 the page breaking process, @code{\bookpart} blocks are used to divide
1131 the book into several parts: the page breaking occurs separately on each
1132 part. Different page breaking functions may also be used in different
1138 subtitle = "Preface"
1141 %% In a part consisting mostly of text,
1142 %% ly:minimal-breaking may be preferred
1143 #(define page-breaking ly:minimal-breaking)
1145 \markup @{ @dots{} @}
1149 %% In this part, consisting of music, the default optimal
1150 %% page breaking function is used.
1152 subtitle = "First movement"
1154 \score @{ @dots{} @}
1161 @funindex \pageBreak
1163 @funindex \noPageBreak
1164 @code{\noPageBreak}.
1173 @node Optimal page breaking
1174 @subsection Optimal page breaking
1176 @funindex ly:optimal-breaking
1178 The @code{ly:optimal-breaking} function is LilyPond's default method of
1179 determining page breaks. It attempts to find a page breaking that minimizes
1180 cramping and stretching, both horizontally and vertically. Unlike
1181 @code{ly:page-turn-breaking}, it has no concept of page turns.
1189 @node Optimal page turning
1190 @subsection Optimal page turning
1192 @funindex ly:page-turn-breaking
1194 Often it is necessary to find a page breaking configuration so that there is
1195 a rest at the end of every second page. This way, the musician can turn the
1196 page without having to miss notes. The @code{ly:page-turn-breaking} function
1197 attempts to find a page breaking minimizing cramping and stretching, but with
1198 the additional restriction that it is only allowed to introduce page turns
1199 in specified places.
1201 There are two steps to using this page breaking function. First, you
1202 must enable it in the @code{\paper} block, as explained in @ref{Page
1203 breaking}. Then you must tell the function where you would like to allow
1206 There are two ways to achieve the second step. First, you can specify each
1207 potential page turn manually, by inserting @code{\allowPageTurn} into your
1208 input file at the appropriate places.
1210 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1211 Voice context. The @code{Page_turn_engraver} will scan the context for
1212 sections without notes (note that it does not scan for rests; it scans for
1213 the absence of notes. This is so that single-staff polyphony with rests in one
1214 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1215 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1216 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1217 there is a @q{special} bar line (such as a double bar), in which case the
1218 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1221 @funindex minimumPageTurnLength
1222 The @code{Page_turn_engraver} reads the context property
1223 @code{minimumPageTurnLength} to determine how long a note-free section must
1224 be before a page turn is considered. The default value for
1225 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
1226 to disable page turns, you can set it to something very large.
1229 \new Staff \with @{ \consists "Page_turn_engraver" @}
1232 R1 | % a page turn will be allowed here
1234 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1235 R1 | % a page turn will not be allowed here
1237 R1*2 | % a page turn will be allowed here
1242 @funindex minimumRepeatLengthForPageTurn
1243 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1244 turn during the repeat if there is enough time at the beginning and end of the
1245 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1246 page turns if the repeat is very short. If you set the context property
1247 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1248 only allow turns in repeats whose duration is longer than this value.
1250 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1251 @code{\allowPageTurn}, may also be used at top-level, between scores and
1258 @funindex \noPageTurn
1260 @funindex \allowPageTurn
1261 @code{\allowPageTurn}.
1272 There should only be one @code{Page_turn_engraver} in a score. If there is more
1273 than one, they will interfere with each other.
1276 @node Minimal page breaking
1277 @subsection Minimal page breaking
1279 @funindex ly:minimal-breaking
1281 The @code{ly:minimal-breaking} function performs minimal computations to
1282 calculate the page breaking: it fills a page with as many systems as
1283 possible before moving to the next one. Thus, it may be preferred for
1284 scores with many pages, where the other page breaking functions could be
1285 too slow or memory demanding, or a lot of texts. It is enabled using:
1289 #(define page-breaking ly:minimal-breaking)
1299 @node Explicit breaks
1300 @subsection Explicit breaks
1302 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1303 commands. There are two commands to override this behavior:
1306 \override NonMusicalPaperColumn #'line-break-permission = ##f
1307 \override NonMusicalPaperColumn #'page-break-permission = ##f
1310 When @code{line-break-permission} is overridden to false, Lily will insert
1311 line breaks at explicit @code{\break} commands and nowhere else. When
1312 @code{page-break-permission} is overridden to false, Lily will insert
1313 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1315 @lilypond[quote,verbatim]
1324 \repeat unfold 2 { c'8 c'8 c'8 c'8 } \break
1325 \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
1326 \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
1327 \repeat unfold 8 { c'8 c'8 c'8 c'8 } \pageBreak
1328 \repeat unfold 8 { c'8 c'8 c'8 c'8 } \break
1329 \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
1330 \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
1331 \repeat unfold 2 { c'8 c'8 c'8 c'8 }
1336 \override NonMusicalPaperColumn #'line-break-permission = ##f
1337 \override NonMusicalPaperColumn #'page-break-permission = ##f
1349 @node Using an extra voice for breaks
1350 @subsection Using an extra voice for breaks
1352 Line- and page-breaking information usually appears within note entry directly.
1357 \repeat unfold 2 @{ c'4 c'4 c'4 c'4 @}
1359 \repeat unfold 3 @{ c'4 c'4 c'4 c'4 @}
1364 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1365 music entry with information that specifies how music should lay out
1366 on the page. You can keep music entry and line- and page-breaking
1367 information in two separate places by introducing an extra voice to
1368 contain the breaks. This extra voice
1369 contains only skips together with @code{\break}, @code{pageBreak} and other
1370 breaking layout information.
1372 @lilypond[quote,verbatim]
1382 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1383 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1384 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1385 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1391 This pattern becomes especially helpful when overriding
1392 @code{line-break-system-details} and the other useful but long properties of
1393 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1395 @lilypond[quote,verbatim]
1399 \overrideProperty "Score.NonMusicalPaperColumn"
1400 #'line-break-system-details #'((Y-offset . 0))
1403 \overrideProperty "Score.NonMusicalPaperColumn"
1404 #'line-break-system-details #'((Y-offset . 35))
1407 \overrideProperty "Score.NonMusicalPaperColumn"
1408 #'line-break-system-details #'((Y-offset . 70))
1411 \overrideProperty "Score.NonMusicalPaperColumn"
1412 #'line-break-system-details #'((Y-offset . 105))
1416 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1417 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1418 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1419 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1428 @ref{Vertical spacing}.
1434 @node Vertical spacing
1435 @section Vertical spacing
1437 @cindex vertical spacing
1438 @cindex spacing, vertical
1440 Vertical spacing is controlled by three things: the amount of
1441 space available (i.e., paper size and margins), the amount of
1442 space between systems, and the amount of space between
1443 staves inside a system.
1446 * Vertical spacing inside a system::
1447 * Vertical spacing between systems::
1448 * Explicit staff and system positioning::
1449 * Vertical collision avoidance::
1453 @node Vertical spacing inside a system
1454 @subsection Vertical spacing inside a system
1456 @cindex distance between staves
1457 @cindex staff distance
1458 @cindex space between staves
1459 @cindex space inside systems
1461 The height of each system is determined in two steps. First, all of the
1462 staves are spaced according to the amount of space available. Then, the
1463 non-staff lines (eg. lyrics or chords) are distributed between the
1466 @unnumberedsubsubsec Spacing between staves
1467 Spacing between staves is controlled by the @var{next-staff-spacing}
1468 property of the @var{VerticalAxisGroup} grob. This property is an alist
1469 with four elements: @var{space}, @var{minimum-distance}, @var{padding}
1470 and @var{stretchability}:
1473 @var{space} is the size of the stretchable space between the center line
1474 of one staff to the center line of the next staff.
1477 @var{minimum-distance} provides a lower bound on the final distance
1478 between the center line of one staff to the center line of the next
1479 staff. That is, if a page has many systems and needs to be compressed,
1480 the distance from this staff to the next will never be compressed to
1481 less than @var{minimum-distance}.
1484 @var{padding} is the amount of whitespace that must be present between
1485 the bottom of one staff and the top of the next. It differs from
1486 @var{minimum-distance} in that the effect of @var{padding} depends on
1487 the height of objects in the staff. For example, @var{padding} is more
1488 likely to come into effect for staves with notes that are far below the
1492 @var{stretchability} controls the stretchable space's propensity to
1493 stretch when the system is stretched. Large values will cause a
1494 system to stretch more, while a value of zero will prevent the
1495 space from stretching at all. If unset, @var{stretchability}
1496 defaults to @code{space - minimum-distance}.
1500 #(set-global-staff-size 16)
1502 % Since space is small and there is no minimum-distance, the distance
1503 % between this staff and the next will be determined by padding.
1505 \override VerticalAxisGroup #'next-staff-spacing =
1506 #'((space . 1) (padding . 1))
1509 % Since space is small and nothing sticks out very far, the distance
1510 % between this staff and the next will be determined by minimum-distance.
1512 \override VerticalAxisGroup #'next-staff-spacing =
1513 #'((space . 1) (minimum-distance . 12))
1516 % By setting padding to a negative value, staves can be made to collide.
1518 \override VerticalAxisGroup #'next-staff-spacing =
1519 #'((space . 4) (padding . -10))
1522 \new Staff { \clef bass c, }
1527 In orchestral and other large scores, it is common to place staves in
1528 groups. The space between groups is typically larger than the space
1529 between staves of the same group. This spacing can be tweaked with the
1530 @var{StaffGrouper} grob: the default value of @var{next-staff-spacing}
1531 for @var{VerticalAxisGroup} is a callback function which operates by
1532 searching for a @var{StaffGrouper} grob containing the staff. If it
1533 finds a @var{StaffGrouper} grob and the staff in question is in the
1534 middle of a group, it reads the @var{between-staff-spacing} property of
1535 @var{StaffGrouper} and returns it. If the staff in question is the last
1536 staff of a group, the callback reads the @var{after-last-staff-spacing}
1537 property of @var{StaffGrouper} and returns it. If the callback did not
1538 find a @var{StaffGrouper} grob, it reads
1539 @var{default-next-staff-spacing} from its @var{VerticalAxisGroup} and
1543 #(set-global-staff-size 16)
1545 \new PianoStaff \with {
1546 \override StaffGrouper #'between-staff-spacing #'space = #1
1547 \override StaffGrouper #'between-staff-spacing #'padding = #0
1548 \override StaffGrouper #'after-last-staff-spacing #'space = #20
1555 \new StaffGroup \with {
1556 \override StaffGrouper #'between-staff-spacing #'space = #1
1557 \override StaffGrouper #'between-staff-spacing #'padding = #0
1567 @unnumberedsubsubsec Spacing of non-staff lines
1569 After the positions of the staves are determined, the non-staff lines
1570 are distributed between the staves. Each of these lines has a
1571 @var{staff-affinity} property which controls its vertical alignment.
1575 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #DOWN @}
1578 @noindent creates a lyrics context that will be placed close to the
1579 staff below it. Setting @var{staff-affinity} to something which is not
1580 a number (@code{#f}, for example) will cause that line to be treated
1581 like a staff. Conversely, setting @var{staff-affinity} for a staff will
1582 cause it to be treated like a non-staff.
1584 Non-staff lines admit three properties to control their spacing. Each
1585 of the these properties is an alist of the same format as
1586 @var{next-staff-spacing}, above.
1589 If the nearest line in the @var{staff-affinity} direction is a staff
1590 then @var{inter-staff-spacing} gives the spacing between the non-staff
1591 and the staff. If @var{staff-affinity} is @code{CENTER}, then
1592 @var{inter-staff-spacing} is used for both directions.
1595 If the nearest line in the @var{staff-affinity} direction is a non-staff
1596 then @var{inter-loose-line-spacing} gives the spacing between the two
1600 If the nearest line in the opposite direction to @var{staff-affinity} is
1601 a staff then @var{non-affinity-spacing} gives the spacing between the
1602 non-staff and the staff. This can be used, for example, to require
1603 a minimum amount of padding between a Lyrics line and the staff
1604 to which it does not belong.
1608 #(set-global-staff-size 16)
1612 % By default, Lyrics are placed close together. Here, we allow them to
1613 % be stretched more widely.
1614 \override VerticalAxisGroup
1615 #'inter-loose-line-spacing #'stretchability = #1000
1622 \override VerticalAxisGroup #'next-staff-spacing = #'((space . 30)) }
1625 \override VerticalAxisGroup #'staff-affinity = #UP }
1628 \override VerticalAxisGroup #'staff-affinity = #CENTER }
1629 \lyricmode { center }
1631 \override VerticalAxisGroup #'staff-affinity = #DOWN }
1642 @c @lsr{spacing,page-spacing.ly},
1643 @c @lsr{spacing,alignment-vertical-spacing.ly}.
1645 Internals Reference:
1646 @rinternals{VerticalAxisGroup},
1647 @rinternals{VerticalAlignment},
1648 @rinternals{Axis_group_engraver}.
1651 Adjacent non-staff lines should have non-increasing
1652 @var{staff-affinity} from top-to-bottom. For example, the behavior of
1656 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #DOWN @}
1657 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #UP @}
1663 A non-staff line at the bottom of a system should have
1664 @var{staff-affinity} set to @code{UP}. Similarly, a non-staff
1665 line at the top of a system should have @var{staff-affinity} set
1668 @node Vertical spacing between systems
1669 @subsection Vertical spacing between systems
1671 The mechanisms that control spacing between systems are similar to those
1672 that control spacing between staves within a system (see
1673 @ref{Vertical spacing inside a system}). The main difference is that
1674 the variables to control spacing between systems are set in the
1675 @code{\paper} block, rather than as grob properties. These paper block
1676 variables are @var{system-system-spacing},
1677 @var{score-system-spacing}, @var{markup-system-spacing},
1678 @var{score-markup-spacing}, @var{markup-markup-spacing},
1679 @var{top-system-spacing}, @var{top-markup-spacing} and
1680 @var{last-bottom-spacing}. Note that these variables ignore non-staff
1681 lines. For example, @var{system-system-spacing} controls the spacing
1682 from the middle staff line of the bottom staff from one system to
1683 the middle staff line of the top staff of the next system, whether
1684 or not there are lyrics below the upper system.
1685 See @ref{Vertical dimensions} for a description of each of these
1688 There are two more @code{\paper} block variables that affect vertical
1689 spacing: if @var{ragged-bottom} is set to @code{##t} then no pages will
1690 be stretched (which means that neither the space between systems nor the
1691 space within systems will be stretched). If @var{ragged-last-bottom}
1692 is set to @code{##t} then the last page will not be stretched.
1699 @node Explicit staff and system positioning
1700 @subsection Explicit staff and system positioning
1702 One way to understand the @code{VerticalAxisGroup} and @code{\paper}
1703 settings explained in the previous two sections is as a collection of
1704 different settings that primarily concern the amount of vertical padding
1705 different staves and systems running down the page.
1707 It is possible to approach vertical spacing in a different way using
1708 @code{NonMusicalPaperColumn #'line-break-system-details}. Where
1709 @code{VerticalAxisGroup} and @code{\paper} settings specify vertical padding,
1710 @code{NonMusicalPaperColumn #'line-break-system-details} specifies exact
1711 vertical positions on the page.
1713 @code{NonMusicalPaperColumn #'line-break-system-details} accepts an associative
1714 list of three different settings:
1717 @item @code{X-offset}
1718 @item @code{Y-offset}
1719 @item @code{alignment-distances}
1722 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
1723 below, can occur in any of three different places in an input file:
1726 @item in the middle of note entry directly
1727 @item in a @code{\context} block
1728 @item in the @code{\with} block
1731 When we override @code{NonMusicalPaperColumn}, we use the usual
1732 @code{\override} command in @code{\context} blocks and in the
1733 @code{\with} block. On the other hand, when we override
1734 @code{NonMusicalPaperColumn} in the middle of note entry,
1735 use the special @code{\overrideProperty} command. Here are some
1736 example @code{NonMusicalPaperColumn} overrides with the special
1737 @code{\overrideProperty} command:
1740 \overrideProperty NonMusicalPaperColumn
1741 #'line-break-system-details #'((X-offset . 20))
1743 \overrideProperty NonMusicalPaperColumn
1744 #'line-break-system-details #'((Y-offset . 40))
1746 \overrideProperty NonMusicalPaperColumn
1747 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40))
1749 \overrideProperty NonMusicalPaperColumn
1750 #'line-break-system-details #'((alignment-distances . (15)))
1752 \overrideProperty NonMusicalPaperColumn
1753 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40)
1754 (alignment-distances . (15)))
1757 To understand how each of these different settings work, we begin
1758 by looking at an example that includes no overrides at all.
1760 @c \book { } is required in these examples to ensure the spacing
1761 @c overrides can be seen between systems. -np
1764 \header { tagline = ##f }
1765 \paper { left-margin = 0\mm }
1775 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1778 \repeat unfold 15 { d'4 d' d' d' }
1785 This score isolates line- and page-breaking information in a dedicated
1786 voice. This technique of creating a breaks voice will help keep layout
1787 separate from music entry as our example becomes more complicated.
1788 See @ref{Using an extra voice for breaks}.
1790 Explicit @code{\breaks} evenly divide the music into six measures per
1791 line. Vertical spacing results from LilyPond's defaults. To set
1792 the vertical startpoint of each system explicitly, we can set
1793 the @code{Y-offset} pair in the @code{line-break-system-details}
1794 attribute of the @code{NonMusicalPaperColumn} grob:
1797 \header { tagline = ##f }
1798 \paper { left-margin = 0\mm }
1804 \overrideProperty #"Score.NonMusicalPaperColumn"
1805 #'line-break-system-details #'((Y-offset . 0))
1807 \overrideProperty #"Score.NonMusicalPaperColumn"
1808 #'line-break-system-details #'((Y-offset . 40))
1810 \overrideProperty #"Score.NonMusicalPaperColumn"
1811 #'line-break-system-details #'((Y-offset . 80))
1814 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1817 \repeat unfold 15 { d'4 d' d' d' }
1824 Note that @code{line-break-system-details} takes an associative list of
1825 potentially many values, but that we set only one value here. Note,
1826 too, that the @code{Y-offset} property here determines the exact vertical
1827 position on the page at which each new system will render.
1829 Now that we have set the vertical startpoint of each system
1830 explicitly, we can also set the vertical distances between staves
1831 within each system manually. We do this using the @code{alignment-distances}
1832 subproperty of @code{line-break-system-details}.
1835 \header { tagline = ##f }
1836 \paper { left-margin = 0\mm }
1842 \overrideProperty #"Score.NonMusicalPaperColumn"
1843 #'line-break-system-details #'((Y-offset . 20)
1844 (alignment-distances . (15)))
1846 \overrideProperty #"Score.NonMusicalPaperColumn"
1847 #'line-break-system-details #'((Y-offset . 60)
1848 (alignment-distances . (15)))
1850 \overrideProperty #"Score.NonMusicalPaperColumn"
1851 #'line-break-system-details #'((Y-offset . 100)
1852 (alignment-distances . (15)))
1855 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1858 \repeat unfold 15 { d'4 d' d' d' }
1865 Note that here we assign two different values to the
1866 @code{line-break-system-details} attribute of the
1867 @code{NonMusicalPaperColumn} grob. Though the
1868 @code{line-break-system-details} attribute alist accepts many
1869 additional spacing parameters (including, for example, a corresponding
1870 @code{X-offset} pair), we need only set the @code{Y-offset} and
1871 @code{alignment-distances} pairs to control the vertical startpoint of
1872 every system and every staff. Finally, note that @code{alignment-distances}
1873 specifies the vertical positioning of staves but not of staff groups.
1876 \header { tagline = ##f }
1877 \paper { left-margin = 0\mm }
1883 \overrideProperty #"Score.NonMusicalPaperColumn"
1884 #'line-break-system-details #'((Y-offset . 0)
1885 (alignment-distances . (30 10)))
1887 \overrideProperty #"Score.NonMusicalPaperColumn"
1888 #'line-break-system-details #'((Y-offset . 60)
1889 (alignment-distances . (10 10)))
1891 \overrideProperty #"Score.NonMusicalPaperColumn"
1892 #'line-break-system-details #'((Y-offset . 100)
1893 (alignment-distances . (10 30)))
1896 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1899 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
1900 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
1907 Some points to consider:
1910 @item When using @code{alignment-distances}, lyrics and other non-staff lines
1911 do not count as a staff.
1913 @item The units of the numbers passed to @code{X-offset},
1914 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
1915 of the distance between adjacent staff lines. Positive values move staves
1916 and lyrics up, negative values move staves and lyrics down.
1918 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
1919 settings given here allow the positioning of staves and systems anywhere
1920 on the page, it is possible to violate paper or margin boundaries or even
1921 to print staves or systems on top of one another. Reasonable values
1922 passed to these different settings will avoid this.
1931 @node Vertical collision avoidance
1932 @subsection Vertical collision avoidance
1934 @funindex outside-staff-priority
1935 @funindex outside-staff-padding
1936 @funindex outside-staff-horizontal-padding
1938 Intuitively, there are some objects in musical notation that belong
1939 to the staff and there are other objects that should be placed outside
1940 the staff. Objects belonging outside the staff include things such as
1941 rehearsal marks, text and dynamic markings (from now on, these will
1942 be called outside-staff objects). LilyPond's rule for the
1943 vertical placement of outside-staff objects is to place them as close
1944 to the staff as possible but not so close that they collide with
1947 LilyPond uses the @code{outside-staff-priority} property to determine
1948 whether a grob is an outside-staff object: if @code{outside-staff-priority}
1949 is a number, the grob is an outside-staff object. In addition,
1950 @code{outside-staff-priority} tells LilyPond in which order the objects
1953 First, LilyPond places all the objects that do not belong outside
1954 the staff. Then it sorts the outside-staff objects according to their
1955 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
1956 takes the outside-staff objects and places them so that they do
1957 not collide with any objects that have already been placed. That
1958 is, if two outside-staff grobs are competing for the same space, the one
1959 with the lower @code{outside-staff-priority} will be placed closer to
1962 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1965 \once \override TextScript #'outside-staff-priority = #1
1966 c4_"Text"\pp % this time the text will be closer to the staff
1968 % by setting outside-staff-priority to a non-number,
1969 % we disable the automatic collision avoidance
1970 \once \override TextScript #'outside-staff-priority = ##f
1971 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
1972 c4_"Text"\pp % now they will collide
1975 The vertical padding between an outside-staff object and the
1976 previously-positioned grobs can be controlled with
1977 @code{outside-staff-padding}.
1979 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1980 \once \override TextScript #'outside-staff-padding = #0
1981 a'^"This text is placed very close to the note"
1982 \once \override TextScript #'outside-staff-padding = #3
1983 c^"This text is padded away from the previous text"
1984 c^"This text is placed close to the previous text"
1988 By default, outside-staff objects are placed only to avoid
1989 a horizontal collision with previously-positioned grobs. This
1990 can lead to situations in which objects are placed very close to each
1991 other horizontally. The vertical spacing between staves can
1992 also be set so that outside staff objects are interleaved.
1993 Setting @code{outside-staff-horizontal-padding}
1994 causes an object to be offset vertically so that such a situation
1997 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1998 % the markup is too close to the following note
2002 % setting outside-staff-horizontal-padding fixes this
2004 \once \override TextScript #'outside-staff-horizontal-padding = #1
2016 @node Horizontal spacing
2017 @section Horizontal spacing
2019 @cindex horizontal spacing
2020 @cindex spacing, horizontal
2023 * Horizontal spacing overview::
2024 * New spacing area::
2025 * Changing horizontal spacing::
2027 * Proportional notation::
2031 @node Horizontal spacing overview
2032 @subsection Horizontal spacing overview
2034 The spacing engine translates differences in durations into stretchable
2035 distances (@q{springs}) of differing lengths. Longer durations get
2036 more space, shorter durations get less. The shortest durations get a
2037 fixed amount of space (which is controlled by
2038 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
2039 object). The longer the duration, the more space it gets: doubling a
2040 duration adds a fixed amount (this amount is controlled by
2041 @code{spacing-increment}) of space to the note.
2043 For example, the following piece contains lots of half, quarter, and
2044 8th notes; the eighth note is followed by 1 note head width (NHW).
2045 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
2047 @lilypond[quote,fragment,verbatim,relative=1]
2048 c2 c4. c8 c4. c8 c4. c8 c8
2052 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2053 approximately the width of a note head, and
2054 @code{shortest-duration-space} is set to 2.0, meaning that the
2055 shortest note gets 2.4 staff space (2.0 times the
2056 @code{spacing-increment}) of horizontal space. This space is counted
2057 from the left edge of the symbol, so the shortest notes are generally
2058 followed by one NHW of space.
2060 If one would follow the above procedure exactly, then adding a single
2061 32nd note to a score that uses 8th and 16th notes, would widen up the
2062 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2063 thus adding 1 NHW to every note. To prevent this, the shortest
2064 duration for spacing is not the shortest note in the score, but rather
2065 the one which occurs most frequently.
2068 The most common shortest duration is determined as follows: in every
2069 measure, the shortest duration is determined. The most common shortest
2070 duration is taken as the basis for the spacing, with the stipulation
2071 that this shortest duration should always be equal to or shorter than
2072 an 8th note. The shortest duration is printed when you run
2073 @code{lilypond} with the @code{--verbose} option.
2075 These durations may also be customized. If you set the
2076 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2077 this sets the base duration for spacing. The maximum duration for this
2078 base (normally an 8th), is set through @code{base-shortest-duration}.
2080 @funindex common-shortest-duration
2081 @funindex base-shortest-duration
2082 @funindex stem-spacing-correction
2085 Notes that are even shorter than the common shortest note are
2086 followed by a space that is proportional to their duration relative to
2087 the common shortest note. So if we were to add only a few 16th notes
2088 to the example above, they would be followed by half a NHW:
2090 @lilypond[quote,fragment,verbatim,relative=2]
2091 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2095 In the @emph{Essay on automated music engraving}, it was explained
2096 that stem directions influence spacing (see @ressay{Optical
2097 spacing}). This is controlled with the
2098 @code{stem-spacing-correction} property in the
2099 @rinternals{NoteSpacing}, object. These are generated for every
2100 @rinternals{Voice} context. The @code{StaffSpacing} object
2101 (generated in @rinternals{Staff} context) contains the same
2102 property for controlling the stem/bar line spacing. The following
2103 example shows these corrections, once with default settings, and
2104 once with exaggerated corrections:
2106 @lilypond[quote,ragged-right]
2110 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2111 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2117 Proportional notation is supported; see @ref{Proportional notation}.
2124 Internals Reference:
2125 @rinternals{SpacingSpanner},
2126 @rinternals{NoteSpacing},
2127 @rinternals{StaffSpacing},
2128 @rinternals{NonMusicalPaperColumn}.
2133 There is no convenient mechanism to manually override spacing. The
2134 following work-around may be used to insert extra space into a score,
2135 adjusting the padding value as necessary.
2137 \override Score.NonMusicalPaperColumn #'padding = #10
2140 No work-around exists for decreasing the amount of space.
2143 @node New spacing area
2144 @subsection New spacing area
2146 New sections with different spacing parameters can be started with
2147 @code{newSpacingSection}. This is useful when there are
2148 sections with a different notions of long and short notes.
2150 In the following example, the time signature change introduces a new
2151 section, and hence the 16ths notes are spaced wider.
2153 @lilypond[relative,fragment,verbatim,quote]
2156 c8 c c4 c16[ c c8] c4
2162 The @code{\newSpacingSection} command creates a new
2163 @code{SpacingSpanner} object, and hence new @code{\override}s
2164 may be used in that location.
2171 Internals Reference:
2172 @rinternals{SpacingSpanner}.
2175 @node Changing horizontal spacing
2176 @subsection Changing horizontal spacing
2178 Horizontal spacing may be altered with the
2179 @code{base-shortest-duration} property. Here
2180 we compare the same music; once without altering
2181 the property, and then altered. Larger values
2182 of @code{ly:make-moment} will produce smaller
2183 music. Note that @code{ly:make-moment} constructs
2184 a duration, so @code{1 4} is a longer duration
2187 @lilypond[verbatim,line-width=12\cm]
2190 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2191 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2192 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2193 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2198 @lilypond[verbatim,line-width=12\cm]
2201 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2202 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2203 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2204 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2209 \override SpacingSpanner
2210 #'base-shortest-duration = #(ly:make-moment 1 16)
2219 By default, spacing in tuplets depends on various non-duration
2220 factors (such as accidentals, clef changes, etc). To disregard
2221 such symbols and force uniform equal-duration spacing, use
2222 @code{Score.SpacingSpanner #'uniform-stretching}. This
2223 property can only be changed at the beginning of a score,
2225 @lilypond[quote,ragged-right,verbatim]
2244 \override SpacingSpanner #'uniform-stretching = ##t
2250 When @code{strict-note-spacing} is set, notes are spaced without
2251 regard for clefs, bar lines, and grace notes,
2253 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
2254 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2255 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2265 @subsection Line length
2268 @cindex breaking pages
2271 @funindex line-width
2272 @funindex ragged-right
2273 @funindex ragged-last
2275 @c Although line-width can be set in \layout, it should be set in paper
2276 @c block, to get page layout right.
2277 @c Setting indent in \paper block makes not much sense, but it works.
2279 @c Bit verbose and vague, use examples?
2280 The most basic settings influencing the spacing are @code{indent} and
2281 @code{line-width}. They are set in the @code{\layout} block. They
2282 control the indentation of the first line of music, and the lengths of
2285 If @code{ragged-right} is set to true in the @code{\layout} block, then
2286 systems ends at their natural horizontal length, instead of being spread
2287 horizontally to fill the whole line. This is useful for
2288 short fragments, and for checking how tight the natural spacing is.
2289 The normal default setting is false, but if the score has only one
2290 system the default value is true.
2293 @cindex vertical spacing
2295 The option @code{ragged-last} is similar to @code{ragged-right}, but
2296 only affects the last line of the piece. No restrictions are put on
2297 that line. The result is similar to formatting text paragraphs. In a
2298 paragraph, the last line simply takes its natural horizontal length.
2299 @c Note that for text there are several options for the last line.
2300 @c While Knuth TeX uses natural length, lead typesetters use the same
2301 @c stretch as the previous line. eTeX uses \lastlinefit to
2302 @c interpolate between both these solutions.
2318 @node Proportional notation
2319 @subsection Proportional notation
2321 LilyPond supports proportional notation, a type of horizontal spacing
2322 in which each note consumes an amount of horizontal space exactly
2323 equivalent to its rhythmic duration. This type of proportional spacing
2324 is comparable to horizontal spacing on top of graph paper. Some late
2325 20th- and early 21st-century scores use proportional notation to
2326 clarify complex rhythmic relationships or to facilitate the placement
2327 of timelines or other graphics directly in the score.
2329 LilyPond supports five different settings for proportional notation,
2330 which may be used together or alone:
2333 @item @code{proportionalNotationDuration}
2334 @item @code{uniform-stretching}
2335 @item @code{strict-note-spacing}
2336 @item @code{\remove Separating_line_group_engraver}
2337 @item @code{\override PaperColumn #'used = ##t}
2340 In the examples that follow, we explore these five different
2341 proportional notation settings and examine how these settings interact.
2343 We start with the following one-measure example, which uses classical
2344 spacing with ragged-right turned on.
2346 @lilypond[quote,verbatim,ragged-right]
2349 \new RhythmicStaff {
2353 c'16 c'16 c'16 c'16 c'16
2360 Notice that the half note which begins the measure takes up far less
2361 than half of the horizontal space of the measure. Likewise, the
2362 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
2363 which end the measure together take up far more than half the
2364 horizontal space of the measure.
2366 In classical engraving, this spacing may be exactly what we want
2367 because we can borrow horizontal space from the half note and conserve
2368 horizontal space across the measure as a whole.
2370 On the other hand, if we want to insert a measured timeline or other
2371 graphic above or below our score, we need proportional notation. We
2372 turn proportional notation on with the proportionalNotationDuration
2375 @lilypond[quote,verbatim,ragged-right]
2378 \new RhythmicStaff {
2382 c'16 c'16 c'16 c'16 c'16
2389 proportionalNotationDuration = #(ly:make-moment 1 20)
2395 The half note at the beginning of the measure and the faster notes in
2396 the second half of the measure now occupy equal amounts of horizontal
2397 space. We could place a measured timeline or graphic above or below
2400 The @code{proportionalNotationDuration} setting is a context setting
2401 that lives in @code{Score}. Remember that context settings can appear
2402 in one of three locations within our input file -- in a @code{\with}
2403 block, in a @code{\context} block, or directly in music entry preceded
2404 by the @code{\set} command. As with all context settings, users can
2405 pick which of the three different locations they would like to
2406 set @code{proportionalNotationDuration} in to.
2408 The @code{proportionalNotationDuration} setting takes a single argument,
2409 which is the reference duration against that all music will be spaced.
2410 The LilyPond Scheme function @code{make-moment} takes two arguments
2411 -- a numerator and denominator which together express some fraction of
2412 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces
2413 a reference duration of a twentieth note. Values such as
2414 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
2415 @code{#(ly:make-moment 3 97)} are all possible as well.
2417 How do we select the right reference duration to pass to
2418 @code{proportionalNotationDuration}? Usually by a process of trial
2419 and error, beginning with a duration close to the fastest (or smallest)
2420 duration in the piece. Smaller reference durations space music loosely;
2421 larger reference durations space music tightly.
2423 @lilypond[quote,verbatim,ragged-right]
2426 \new RhythmicStaff {
2430 c'16 c'16 c'16 c'16 c'16
2437 proportionalNotationDuration = #(ly:make-moment 1 8)
2444 \new RhythmicStaff {
2448 c'16 c'16 c'16 c'16 c'16
2455 proportionalNotationDuration = #(ly:make-moment 1 16)
2462 \new RhythmicStaff {
2466 c'16 c'16 c'16 c'16 c'16
2473 proportionalNotationDuration = #(ly:make-moment 1 32)
2479 Note that too large a reference duration -- such as the eighth note,
2480 above -- spaces music too tightly and can cause note head collisions.
2481 Also that proportional notation in general takes up more horizontal
2482 space than classical spacing. Proportional spacing provides rhythmic
2483 clarity at the expense of horizontal space.
2485 Next we examine how to optimally space overlapping tuplets.
2487 We start by examining what happens to our original example, with
2488 classical spacing, when we add a second staff with a different type of
2491 @lilypond[quote,verbatim,ragged-right]
2494 \new RhythmicStaff {
2498 c'16 c'16 c'16 c'16 c'16
2501 \new RhythmicStaff {
2503 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2510 The spacing is bad because the evenly spaced notes of the bottom staff
2511 do not stretch uniformly. Classical engravings include very few complex
2512 triplets and so classical engraving rules can generate this type of
2513 result. Setting @code{proportionalNotationDuration} fixes this.
2515 @lilypond[quote,verbatim,ragged-right]
2518 \new RhythmicStaff {
2522 c'16 c'16 c'16 c'16 c'16
2525 \new RhythmicStaff {
2527 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2534 proportionalNotationDuration = #(ly:make-moment 1 20)
2540 But if we look very carefully we can see that notes of the second half
2541 of the 9-tuplet space ever so slightly more widely than the notes
2542 of the first half of the 9-tuplet. To ensure uniform stretching, we
2543 turn on @code{uniform-stretching}, which is a property of
2544 @code{SpacingSpanner}.
2546 @lilypond[quote,verbatim,ragged-right]
2549 \new RhythmicStaff {
2553 c'16 c'16 c'16 c'16 c'16
2556 \new RhythmicStaff {
2558 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2565 proportionalNotationDuration = #(ly:make-moment 1 20)
2566 \override SpacingSpanner #'uniform-stretching = ##t
2572 Our two-staff example now spaces exactly, our rhythmic
2573 relationships are visually clear, and we can include a measured
2574 timeline or graphic if we want.
2576 Note that the LilyPond's proportional notation package expects
2577 that all proportional scores set the SpacingSpanner's
2578 'uniform-stretching attribute to ##t. Setting
2579 proportionalNotationDuration without also setting the
2580 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
2581 example, cause Skips to consume an incorrect amount of horizontal
2584 The SpacingSpanner is an abstract grob that lives in the Score
2585 context. As with our settings of proportionalNotationDuration,
2586 overrides to the SpacingSpanner can occur in any of three
2587 different places in our input file – in the Score \with block, in
2588 a Score \context block, or in note entry directly.
2590 There is by default only one @code{SpacingSpanner} per @code{Score}. This
2591 means that, by default, @code{uniform-stretching} is either turned on for the
2592 entire score or turned off for the entire score. We can, however,
2593 override this behavior and turn on different spacing features at
2594 different places in the score. We do this with the command
2595 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
2597 Next we examine the effects of the @code{Separating_line_group_engraver} and
2598 see why proportional scores frequently remove this engraver. The following
2599 example shows that there is a small amount of @qq{preferatory} space
2600 just before the first note in each system.
2602 @lilypond[quote,verbatim,ragged-right]
2615 The amount of this preferatory space is the same whether after a time
2616 signature, a key signature or a clef. @code{Separating_line_group_engraver}
2617 is responsible for this space. Removing @code{Separating_line_group_engraver}
2618 reduces this space to zero.
2620 @lilypond[quote,verbatim,ragged-right]
2626 \remove Separating_line_group_engraver
2634 Nonmusical elements like time signatures, key signatures, clefs and
2635 accidentals are problematic in proportional notation. None of these
2636 elements has rhythmic duration. But all of these elements consume
2637 horizontal space. Different proportional scores approach these
2638 problems differently.
2640 It may be possible to avoid spacing problems with key signatures
2641 simply by not having any. This is a valid option since most
2642 proportional scores are contemporary music. The same may be true
2643 of time signatures, especially for those scores
2644 that include a measured timeline or other graphic. But these scores
2645 are exceptional and most proportional scores include at least some
2646 time signatures. Clefs and accidentals are even more essential.
2648 So what strategies exist for spacing nonmusical elements in a
2649 proportional context? One good option is the @code{strict-note-spacing}
2650 property of @code{SpacingSpanner}. Compare the two scores below:
2652 @lilypond[quote,verbatim,ragged-right]
2654 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
2664 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
2665 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2675 Both scores are proportional, but the spacing in the first score
2676 is too loose because of the clef change. The spacing of the second
2677 score remains strict, however, because strict-note-spacing is
2678 turned on. Turning on strict-note-spacing causes the width of
2679 time signatures, key signatures, clefs and accidentals to play no
2680 part in the spacing algorithm.
2682 In addition to the settings given here, there are other settings
2683 that frequently appear in proportional scores. These include:
2686 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
2687 @item @code{tupletFullLength = ##t}
2688 @item @code{\override Beam #'breakable = ##t}
2689 @item @code{\override Glissando #'breakable = ##t}
2690 @item @code{\override TextSpanner #'breakable = ##t}
2691 @item @code{\remove Forbid_line_break_engraver in the Voice context}
2694 These settings space grace notes strictly, extend tuplet brackets to
2695 mark both rhythmic start- and stop-points, and allow spanning elements
2696 to break across systems and pages. See the respective parts of the manual
2697 for these related settings.
2702 @ref{New spacing area}.
2708 @node Fitting music onto fewer pages
2709 @section Fitting music onto fewer pages
2711 Sometimes you can end up with one or two staves on a second
2712 (or third, or fourth...) page. This is annoying, especially
2713 if you look at previous pages and it looks like there is plenty
2714 of room left on those.
2716 When investigating layout issues, @code{annotate-spacing} is an
2717 invaluable tool. This command prints the values of various layout
2718 spacing variables; for more details see the following section,
2719 @ref{Displaying spacing}.
2722 * Displaying spacing::
2723 * Changing spacing::
2727 @node Displaying spacing
2728 @subsection Displaying spacing
2730 @funindex annotate-spacing
2731 @cindex spacing, display of layout
2733 To graphically display the dimensions of vertical layout variables
2734 that may be altered for page formatting, set
2735 @code{annotate-spacing} in the @code{\paper} block:
2737 @c need to have \book{} otherwise we get the separate systems. -hwn
2738 @lilypond[verbatim,quote]
2739 #(set-default-paper-size "a6" 'landscape)
2742 \paper { annotate-spacing = ##t }
2748 All layout dimensions are displayed in staff-spaces, regardless
2749 of the units specified in the @code{\paper} or @code{\layout} block.
2750 In the above example, @code{paper-height} has a value of 59.75
2751 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
2752 default value). Note that:
2754 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
2757 @tab = (25.4/72.27) mm
2760 @tab = (@code{staff-size})/4 pts
2762 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
2767 In this case, one @code{staff-space} is approximately equal to
2768 1.757mm. Thus the @code{paper-height} measurement of 59.75
2769 @code{staff-spaces} is equivalent to 105 millimeters, the height
2770 of @code{a6} paper in landscape orientation. The pairs
2771 (@var{a},@var{b}) are intervals, where @var{a} is the lower
2772 edge and @var{b} the upper edge of the interval.
2777 @ref{Setting the staff size}.
2783 @node Changing spacing
2784 @subsection Changing spacing
2786 The output of @code{annotate-spacing} reveals vertical dimensions
2787 in great detail. For details about modifying margins and other
2788 layout variables, see @ref{Page formatting}.
2790 Other than margins, there are a few other options to save space:
2794 Force systems to move as close together as possible (to fit as
2795 many systems as possible onto a page) while being spaced so that
2796 there is no blank space at the bottom of the page.
2800 system-system-spacing = #'((padding . 0) (space . 0.1))
2801 ragged-last-bottom = ##f
2807 Force the number of systems. This can help in two ways. Just
2808 setting a value, even the same value as the number of systems
2809 being typeset by default, will sometimes cause more systems to
2810 be fitted onto each page, as an estimation step is then bypassed,
2811 giving a more accurate fit to each page. Also, forcing an actual
2812 reduction in the number of systems may save a further page. For
2813 example, if the default layout has 11 systems, the following
2814 assignment will force a layout with 10 systems.
2823 Avoid (or reduce) objects that increase the vertical size of a
2824 system. For example, volta repeats (or alternate repeats) require
2825 extra space. If these repeats are spread over two systems, they
2826 will take up more space than one system with the volta repeats and
2827 another system without. For example, dynamics that @q{stick out} of
2828 a system can be moved closer to the staff:
2830 @lilypond[verbatim,quote,relative=1]
2832 e4 c g-\tweak #'X-offset #-2.7 -\tweak #'Y-offset #2.5 \f c
2836 Alter the horizontal spacing via @code{SpacingSpanner}. For more
2837 details, see @ref{Changing horizontal spacing}. The following
2838 example illustrates the default spacing:
2840 @lilypond[verbatim,quote]
2853 The next example modifies @code{common-shortest-duration} from a
2854 value of @code{1/4} to @code{1/2}. The quarter note is the most
2855 common and shortest duration in this example, so by making this
2856 duration longer, a @q{squeezing} effect occurs:
2858 @lilypond[verbatim,quote]
2870 \override SpacingSpanner
2871 #'common-shortest-duration = #(ly:make-moment 1 2)
2878 The @code{common-shortest-duration} property cannot be modified
2879 dynamically, so it must always be placed in a @code{\context}
2880 block so that it applies to the whole score.
2887 @ref{Page formatting},
2888 @ref{Changing horizontal spacing}.