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 uncomplete
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
176 Margins, headers, and footers and other layout variables are
177 automatically set according to the paper size.
179 Default margin values are accessible in
180 @file{ly/@/paper@/-defaults@/-init@/.ly}. They apply to the default
181 paper size (a4, unless specified differently) and are scaled
182 accordingly for other paper sizes.
184 This section lists and describes a number of paper variables that
188 * Vertical dimensions::
189 * Horizontal dimensions::
190 * Other layout variables::
194 @node Vertical dimensions
195 @unnumberedsubsubsec Vertical dimensions
197 These variables are used to set different vertical dimensions on a
204 @item after-title-spacing
205 @funindex after-title-spacing
207 Specifies how to calculate the space between a title (or top-level markup)
208 and the system that follows it. This is an associative list with five
211 @item @var{space} -- the amount of stretchable space between the baseline
212 of a title and the center of the staff that follows it;
213 @item @var{padding} -- the minimum amount of whitespace that must be
214 present between a title and the staff that follows it;
215 @item @var{stretchability} -- the ease with which the stretchable
216 space increases when a page is stretched.
217 If this is zero, the distance to the next staff will not stretch at all;
218 @item @var{minimum-distance} -- the minimum distance to place between
219 the baseline of a title and the center of the staff that follows it. This differs
220 from @var{padding} in that the height of a staff has no effect on
221 the application of @var{minimum-distance} (whereas the height of a
222 staff is crucial for @var{padding}).
225 If a page has a ragged bottom, @var{space} is not stretched. In particular, the
226 resulting distance on such a page is the largest of
229 @item @var{minimum-distance}, and
230 @item @var{padding} plus the smallest distance necessary to eliminate overlap.
233 @item before-title-spacing
234 @funindex before-title-spacing
236 Specifies the spacing between a system and the title (or top-level markup) that
238 The distances are measured from the center of the last staff in the system to
239 the baseline of the title that follows it. See @var{after-title-spacing}.
241 @item between-scores-system-spacing
242 @funindex between-scores-system-spacing
244 Specifies the spacing between two systems if they are in different scores, but
245 there is no title between them. See @var{after-title-spacing}.
247 @item between-system-spacing
248 @funindex between-system-spacing
250 Specifies the spacing between the center of the bottom staff of one system
251 and the center of the top staff of the following system. See @var{after-title-spacing}.
253 @item between-title-spacing
254 @funindex between-title-spacing
256 Specifies the spacing between two titles (or top-level markups).
257 The distances are measured from the baseline of the first title to the baseline
258 of the second. See @var{after-title-spacing}.
261 @funindex bottom-margin
263 The margin between footer and bottom of the page. Default:
266 @item bottom-system-spacing
267 @funindex bottom-system-spacing
269 Specifies the spacing from the center of the last staff (or the
270 baseline of the last top-level markup) to the bottom of the
271 printable area (ie. the top of the bottom margin).
272 See @var{after-title-spacing}.
274 @item top-title-spacing
275 @funindex top-title-spacing
277 Specifies the spacing from the top of the printable area (ie.
278 the bottom of the top margin) to the baseline of the title.
279 See @var{after-title-spacing}.
281 @item top-system-spacing
282 @funindex top-system-spacing
284 Specifies the spacing from the top of the printable area (ie.
285 the bottom of the top margin) to the center of the first staff.
286 This only takes effect if there is no title at the top of the
287 page (in which case @var{top-title-spacing} is used instead).
288 See @var{after-title-spacing}.
291 @funindex paper-height
293 The height of the page. Default: the height of the current paper
294 size. For details, see @ref{Paper size}.
299 The margin between header and top of the page. Default:
307 The header and footer are created by the functions make-footer and
308 make-header, defined in \paper. The default implementations are in
309 ly/paper-defaults.ly and ly/titling-init.ly.
311 The page layout itself is done by two functions in the \paper block,
312 page-music-height and page-make-stencil. The former tells the
313 line-breaking algorithm how much space can be spent on a page, the
314 latter creates the actual page given the system to put on it.
316 You can define paper block values in Scheme. In that case mm, in, pt,
317 and cm are variables defined in paper-defaults.ly with values in
318 millimeters. That is why the value 2 cm must be multiplied in the
323 #(define bottom-margin (* 2 cm))
335 ragged-last-bottom = ##t
339 This second example centers page numbers at the bottom of every page.
343 print-page-number = ##t
344 print-first-page-number = ##t
345 oddHeaderMarkup = \markup \fill-line @{ " " @}
346 evenHeaderMarkup = \markup \fill-line @{ " " @}
347 oddFooterMarkup = \markup @{ \fill-line @{
348 \bold \fontsize #3 \on-the-fly #print-page-number-check-first
349 \fromproperty #'page:page-number-string @} @}
350 evenFooterMarkup = \markup @{ \fill-line @{
351 \bold \fontsize #3 \on-the-fly #print-page-number-check-first
352 \fromproperty #'page:page-number-string @} @}
356 You can also define these values in Scheme. In that case @code{mm},
357 @code{in}, @code{pt}, and @code{cm} are variables defined in
358 @file{paper@/-defaults@/-init@/.ly} with values in millimeters. That is why the
359 value must be multiplied in the example
363 #(define bottom-margin (* 2 cm))
367 The header and footer are created by the functions @code{make-footer}
368 and @code{make-header}, defined in @code{\paper}. The default
369 implementations are in @file{ly/@/paper@/-defaults@/-init@/.ly} and
370 @file{ly/@/titling@/-init@/.ly}.
372 The page layout itself is done by two functions in the
373 @code{\paper} block, @code{page-music-height} and
374 @code{page-make-stencil}. The former tells the line-breaking algorithm
375 how much space can be spent on a page, the latter creates the actual
376 page given the system to put on it.
381 @ref{Vertical spacing between systems}.
387 @node Horizontal dimensions
388 @unnumberedsubsubsec Horizontal dimensions
391 There are a few variables that determine the horizontal dimensions
397 @funindex binding-offset
399 The amount @code{inner-margin} is increased
400 to make sure nothing will be hidden by the binding.
401 Works only with @code{two-sided} set to true. Default:
404 @item horizontal-shift
405 @funindex horizontal-shift
407 The amount that all systems (including titles and system
408 separators) are shifted to the right. Default: @code{0.0}.
413 The level of indentation for the first system in a score.
414 Default: @code{15\mm}.
417 @funindex inner-margin
419 The margin all pages have at the inner side if they are part
420 of a book. Works only with @code{two-sided} set to true.
421 Default: @code{10\mm}.
424 @funindex left-margin
426 The margin between the left edge of the page and the beginning of
427 each system. Default: @code{10\mm}.
432 The width of music systems. Default: @code{paper-width} minus
433 @code{left-margin} and @code{right-margin}.
436 @funindex outer-margin
438 The margin all pages have at the outer side if they are part
439 of a book. Works only with @code{two-sided} set to true.
440 Default: @code{20\mm}.
443 @funindex paper-width
445 The width of the page. Default: the width of the current paper
446 size. For details, see @ref{Paper size}.
449 @funindex right-margin
451 The margin between the right edge of the page and the end of
452 each system. Default: @code{10\mm}.
455 @funindex short-indent
457 The level of indentation for all systems in a score besides the
458 first system. Default: @code{0}.
462 If some values are not set, defaults will be taken. Their exact
463 value is adjusted, depending on the paper size specified. Currently,
464 the following values are affected by this scaling:
467 @item @var{left-margin}
468 @item @var{right-margin}
469 @item @var{top-margin}
470 @item @var{bottom-margin}
471 @item @var{head-separation}
472 @item @var{foot-separation}
474 @item @var{short-indent}
477 The settings for @code{line-width}, @code{left-margin},
478 @code{right-margin} and @code{paper-width} depend on
479 each other, but they do not have to be specified
488 In this example, only @code{left-margin} is set. The value for
489 @code{right-margin} will remain default, @code{line-width} is
490 calculated automatically.
498 Here @code{left-margin} and @code{right-margin} will be set
499 to the same value. Therefore, @code{line-width} is subtracted
500 from @code{paper-width} and divided by two. That means systems
501 are centered on the page, if only @code{line-width} is
504 Some checks occur to ensure the values are set correctly.
505 If the values do not match or systems would run off the page,
506 a warning is printed and default values are set.
517 These checks can be avoided by setting @code{check-consistency}
525 check-consistency = ##f
529 @warning{If @code{paper-width} is manually set, @code{line-width},
530 @code{left-margin}, @code{indent}, and @code{short-indent} may
531 have to be adjusted as well.}
539 @node Other layout variables
540 @unnumberedsubsubsec Other layout variables
542 These variables can be used to adjust page layout in general.
546 @item auto-first-page-number
547 @funindex auto-first-page-number
549 The page breaking algorithm is affected by the first page number
550 being odd or even. If set to true, the page breaking algorithm
551 will decide whether to start with an odd or even number. This
552 will result in the first page number remaining as is or being
553 increased by one. Default: @code{##f}.
557 TODO: this variable is used, but I don't know what it does. -pm
558 @item blank-after-score-page-force
559 @funindex blank-after-score-page-force
565 @item blank-last-page-force
566 @funindex blank-last-page-force
568 The penalty for ending the score on an odd-numbered page.
571 @item blank-page-force
572 @funindex blank-page-force
574 The penalty for having a blank page in the middle of a
575 score. This is not used by @code{ly:optimal-breaking} since it will
576 never consider blank pages in the middle of a score. Default:
579 @item check-consistency
580 @funindex check-consistency
582 If set to true, check whether @code{left-margin}, @code{right-margin} and
583 @code{line-width} fit each other. Also make sure that their combination
584 does not exceed the available @code{paper-width}. Default: @code{##t}.
586 @item first-page-number
587 @funindex first-page-number
589 The value of the page number on the first page. Default:
592 @item max-systems-per-page
593 The maximum number of systems that will be placed on a page. This
594 is currently supported only by the @code{ly:optimal-breaking} algorithm.
597 @item min-systems-per-page
598 The minimum number of systems that will be placed on a page. This
599 may cause pages to be overfilled if it is made too large. This is
600 currently supported only by the @code{ly:optimal-breaking} algorithm.
603 @item page-breaking-between-system-padding
604 @funindex page-breaking-between-system-padding
606 Tricks the page breaker into thinking that
607 @code{between-system-padding} is set to something different than
608 it really is. For example, if this variable is set to something
609 substantially larger than @code{between-system-padding}, then the
610 page-breaker will put fewer systems on each page. Default: unset.
615 The number of pages to be used for a score. Default: unset.
617 @item page-limit-inter-system-space
618 @funindex page-limit-inter-system-space
620 If set to true, limits space between systems on a page with a lot
621 of space left. Default: @code{##f}. For details, see
622 @ref{Vertical spacing between systems}.
624 @item page-limit-inter-system-space-factor
625 @funindex page-limit-inter-system-space-factor
627 The factor used by @code{page-limit-inter-system-space}. Default:
628 @code{1.4}. For details, see
629 @ref{Vertical spacing between systems}.
631 @item page-spacing-weight
632 @funindex page-spacing-weight
634 The relative importance of page (vertical) spacing and line
635 (horizontal) spacing. High values will make page spacing more
636 important. Default: @code{#10}.
638 @item print-all-headers
639 @funindex print-all-headers
641 If set to true, this will print all headers for each \score in the
642 output. Normally only the piece and opus header variables are
643 printed. Default: @code{##f}.
645 @item print-first-page-number
646 @funindex print-first-page-number
648 If set to true, a page number is printed on the first page.
651 @item print-page-number
652 @funindex print-page-number
654 If set to false, page numbers are not printed. Default:
658 @funindex ragged-bottom
660 If set to true, systems will not spread vertically across the
661 page. This does not affect the last page. Default: @code{##f}.
663 This should be set to true for pieces that have only two or three
664 systems per page, for example orchestral scores.
667 @funindex ragged-last
669 If set to true, the last system in the score will not fill the
670 line width. Instead the last system ends at its natural
671 horizontal length. Default: @code{##f}.
673 @item ragged-last-bottom
674 @funindex ragged-last-bottom
676 If set to false, systems will spread vertically across the last
677 page. Default: @code{##t}.
679 Pieces that amply fill two pages or more should have this set to
682 It also affects the last page of book parts, ie parts of a book created
683 with @code{\bookpart} blocks.
686 @funindex ragged-right
688 If set to true, systems will not fill the line width. Instead,
689 systems end at their natural horizontal length. Default:
692 If the score has only one system, the default value is @code{##t}.
694 @item system-separator-markup
695 @funindex system-separator-markup
697 A markup object that is inserted between systems. This is often
698 used for orchestral scores. Default: unset.
700 The markup command @code{\slashSeparator} is provided as a sensible
703 @lilypond[quote,ragged-right]
704 #(set-default-paper-size "a6" 'landscape)
707 \relative { c1 \break c1 }
710 system-separator-markup = \slashSeparator
716 @funindex system-count
718 The number of systems to be used for a score.
721 @item systems-per-page
722 @funindex systems-per-page
724 The number of systems that should be placed on each page.
725 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
731 If set to true, use @code{inner-margin}, @code{outer-margin} and
732 @code{binding-offset} to determine margins depending on whether
733 the page number is odd or even. This overrides @code{left-margin}
734 and @code{right-margin}. Default: @code{##f}.
746 The default page header puts the page number and the @code{instrument}
747 field from the @code{\header} block on a line.
749 The titles (from the @code{\header@{@}} section) are treated as a
750 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
751 add space between the titles and the first system of the score.
755 @section Music layout
758 * Setting the staff size::
763 @node Setting the staff size
764 @subsection Setting the staff size
766 @cindex font size, setting
767 @cindex staff size, setting
768 @funindex layout file
770 The default @strong{staff size} is set to 20 points.
771 This may be changed in two ways:
773 To set the staff size globally for all scores in a file (or
774 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
777 #(set-global-staff-size 14)
781 This sets the global default size to 14pt staff height and scales all
784 To set the staff size individually for each score, use
789 #(layout-set-staff-size 15)
794 The Feta font provides musical symbols at eight different
795 sizes. Each font is tuned for a different staff size: at a smaller size
796 the font becomes heavier, to match the relatively heavier staff lines.
797 The recommended font sizes are listed in the following table:
800 @multitable @columnfractions .15 .2 .22 .2
803 @tab @b{staff height (pt)}
804 @tab @b{staff height (mm)}
846 @c modern rental material?
851 These fonts are available in any sizes. The context property
852 @code{fontSize} and the layout property @code{staff-space} (in
853 @rinternals{StaffSymbol}) can be used to tune the size for individual
854 staves. The sizes of individual staves are relative to the global size.
859 @ref{Selecting notation font size}.
867 @code{layout-set-staff-size} does not change the distance between the
872 @subsection Score layout
876 While @code{\paper} contains settings that relate to the page formatting
877 of the whole document, @code{\layout} contains settings for score-specific
884 \override VerticalAxisGroup #'minimum-Y-extent = #'(-6 . 6)
887 \override TextScript #'padding = #1.0
888 \override Glissando #'thickness = #3
896 @ref{Changing context default settings}.
908 * Optimal page breaking::
909 * Optimal page turning::
910 * Minimal page breaking::
912 * Using an extra voice for breaks::
917 @subsection Line breaking
920 @cindex breaking lines
922 Line breaks are normally determined automatically. They are chosen
923 so that lines look neither cramped nor loose, and consecutive
924 lines have similar density. Occasionally you might want to
925 override the automatic breaks; you can do this by specifying
926 @code{\break}. This will force a line break at this point. However,
927 line breaks can only occur at the end of @q{complete} bars, i.e.,
928 where there are no notes or tuplets left @q{hanging} over the bar
929 line. If you want to have a line break where there is no bar line,
930 you can force an invisible bar line by entering @code{\bar ""},
931 although again there must be no notes left hanging over in any of
932 the staves at this point, or it will be ignored.
934 The opposite command, @code{\noBreak}, forbids a line break at the
935 bar line where it is inserted.
937 The most basic settings influencing line spacing are @code{indent}
938 and @code{line-width}. They are set in the @code{\layout} block.
939 They control the indentation of the first line of music, and the
940 lengths of the lines.
942 If @code{ragged-right} is set to true in the @code{\layout} block,
943 then systems end at their natural horizontal length, instead of
944 being spread horizontally to fill the whole line. This is useful
945 for short fragments, and for checking how tight the natural
948 @c TODO Check and add para on default for ragged-right
950 The option @code{ragged-last} is similar to @code{ragged-right},
951 but affects only the last line of the piece.
963 @cindex regular line breaks
964 @cindex four bar music.
966 For line breaks at regular intervals use @code{\break} separated by
967 skips and repeated with @code{\repeat}. For example, this would
968 cause the following 28 measures (assuming 4/4 time) to be broken
969 every 4 measures, and only there:
972 << \repeat unfold 7 @{
973 s1 \noBreak s1 \noBreak
974 s1 \noBreak s1 \break @}
975 @emph{the real music}
980 A linebreaking configuration can be saved as a @code{.ly} file
981 automatically. This allows vertical alignments to be stretched to
982 fit pages in a second formatting run. This is fairly new and
983 complicated. More details are available in
997 @rinternals{LineBreakEvent}.
1005 Line breaks can only occur if there is a @q{proper} bar line. A note
1006 which is hanging over a bar line is not proper, such as
1008 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1009 c4 c2 << c2 {s4 \break } >> % this does nothing
1010 c2 c4 | % a break here would work
1011 c4 c2 c4 ~ \break % as does this break
1015 This can be avoided by removing the @code{Forbid_line_break_engraver}.
1016 Note that manually forced line breaks have to be added in parallel
1019 @lilypond[quote,ragged-right,verbatim]
1021 \remove Forbid_line_break_engraver
1023 c4 c2 << c2 {s4 \break } >> % now the break is allowed
1028 Similarly, line breaks are normally forbidden when beams cross bar
1029 lines. This behavior can be changed by setting
1030 @code{\override Beam #'breakable = ##t}.
1034 @subsection Page breaking
1036 The default page breaking may be overridden by inserting
1037 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1038 analogous to @code{\break} and @code{\noBreak}. They should be
1039 inserted at a bar line. These commands force and forbid a page-break
1040 from happening. Of course, the @code{\pageBreak} command also forces
1043 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1044 inserted at top-level, between scores and top-level markups.
1046 There are also analogous settings to @code{ragged-right} and
1047 @code{ragged-last} which have the same effect on vertical spacing:
1048 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1049 @code{##t} the systems on all pages or just the last page
1050 respectively will not be justified vertically.
1052 For more details see @ref{Vertical spacing}.
1054 Page breaks are computed by the @code{page-breaking} function. LilyPond
1055 provides three algorithms for computing page breaks,
1056 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1057 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1058 but the value can be changed in the @code{\paper} block:
1062 #(define page-breaking ly:page-turn-breaking)
1068 When a book has many scores and pages, the page breaking problem may be
1069 difficult to solve, requiring large processing time and memory. To ease
1070 the page breaking process, @code{\bookpart} blocks are used to divide
1071 the book into several parts: the page breaking occurs separately on each
1072 part. Different page breaking functions may also be used in different
1078 subtitle = "Preface"
1081 %% In a part consisting mostly of text,
1082 %% ly:minimal-breaking may be prefered
1083 #(define page-breaking ly:minimal-breaking)
1085 \markup @{ @dots{} @}
1089 %% In this part, consisting of music, the default optimal
1090 %% page breaking function is used.
1092 subtitle = "First movement"
1094 \score @{ @dots{} @}
1101 @funindex \pageBreak
1103 @funindex \noPageBreak
1104 @code{\noPageBreak}.
1113 @node Optimal page breaking
1114 @subsection Optimal page breaking
1116 @funindex ly:optimal-breaking
1118 The @code{ly:optimal-breaking} function is LilyPond's default method of
1119 determining page breaks. It attempts to find a page breaking that minimizes
1120 cramping and stretching, both horizontally and vertically. Unlike
1121 @code{ly:page-turn-breaking}, it has no concept of page turns.
1129 @node Optimal page turning
1130 @subsection Optimal page turning
1132 @funindex ly:page-turn-breaking
1134 Often it is necessary to find a page breaking configuration so that there is
1135 a rest at the end of every second page. This way, the musician can turn the
1136 page without having to miss notes. The @code{ly:page-turn-breaking} function
1137 attempts to find a page breaking minimizing cramping and stretching, but with
1138 the additional restriction that it is only allowed to introduce page turns
1139 in specified places.
1141 There are two steps to using this page breaking function. First, you
1142 must enable it in the @code{\paper} block, as explained in @ref{Page
1143 breaking}. Then you must tell the function where you would like to allow
1146 There are two ways to achieve the second step. First, you can specify each
1147 potential page turn manually, by inserting @code{\allowPageTurn} into your
1148 input file at the appropriate places.
1150 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1151 Voice context. The @code{Page_turn_engraver} will scan the context for
1152 sections without notes (note that it does not scan for rests; it scans for
1153 the absence of notes. This is so that single-staff polyphony with rests in one
1154 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1155 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1156 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1157 there is a @q{special} bar line (such as a double bar), in which case the
1158 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1161 @funindex minimumPageTurnLength
1162 The @code{Page_turn_engraver} reads the context property
1163 @code{minimumPageTurnLength} to determine how long a note-free section must
1164 be before a page turn is considered. The default value for
1165 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
1166 to disable page turns, you can set it to something very large.
1169 \new Staff \with @{ \consists "Page_turn_engraver" @}
1172 R1 | % a page turn will be allowed here
1174 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1175 R1 | % a page turn will not be allowed here
1177 R1*2 | % a page turn will be allowed here
1182 @funindex minimumRepeatLengthForPageTurn
1183 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1184 turn during the repeat if there is enough time at the beginning and end of the
1185 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1186 page turns if the repeat is very short. If you set the context property
1187 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1188 only allow turns in repeats whose duration is longer than this value.
1190 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1191 @code{\allowPageTurn}, may also be used at top-level, between scores and
1198 @funindex \noPageTurn
1200 @funindex \allowPageTurn
1201 @code{\allowPageTurn}.
1212 There should only be one @code{Page_turn_engraver} in a score. If there is more
1213 than one, they will interfere with each other.
1216 @node Minimal page breaking
1217 @subsection Minimal page breaking
1219 @funindex ly:minimal-breaking
1221 The @code{ly:minimal-breaking} function performs minimal computations to
1222 calculate the page breaking: it fills a page with as many systems as
1223 possible before moving to the next one. Thus, it may be preferred for
1224 scores with many pages, where the other page breaking functions could be
1225 too slow or memory demanding, or a lot of texts. It is enabled using:
1229 #(define page-breaking ly:minimal-breaking)
1239 @node Explicit breaks
1240 @subsection Explicit breaks
1242 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1243 commands. There are two commands to override this behavior:
1246 \override NonMusicalPaperColumn #'line-break-permission = ##f
1247 \override NonMusicalPaperColumn #'page-break-permission = ##f
1250 When @code{line-break-permission} is overridden to false, Lily will insert
1251 line breaks at explicit @code{\break} commands and nowhere else. When
1252 @code{page-break-permission} is overridden to false, Lily will insert
1253 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1255 @lilypond[quote,verbatim]
1264 \override NonMusicalPaperColumn #'line-break-permission = ##f
1265 \override NonMusicalPaperColumn #'page-break-permission = ##f
1268 \repeat unfold 2 { c'8 c'8 c'8 c'8 } \break
1269 \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
1270 \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
1271 \repeat unfold 8 { c'8 c'8 c'8 c'8 } \pageBreak
1272 \repeat unfold 8 { c'8 c'8 c'8 c'8 } \break
1273 \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
1274 \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
1275 \repeat unfold 2 { c'8 c'8 c'8 c'8 }
1287 @node Using an extra voice for breaks
1288 @subsection Using an extra voice for breaks
1290 Line- and page-breaking information usually appears within note entry directly.
1295 \repeat unfold 2 @{ c'4 c'4 c'4 c'4 @}
1297 \repeat unfold 3 @{ c'4 c'4 c'4 c'4 @}
1302 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1303 music entry with information that specifies how music should lay out
1304 on the page. You can keep music entry and line- and page-breaking
1305 information in two separate places by introducing an extra voice to
1306 contain the breaks. This extra voice
1307 contains only skips together with @code{\break}, @code{pageBreak} and other
1308 breaking layout information.
1310 @lilypond[quote,verbatim]
1320 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1321 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1322 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1323 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1329 This pattern becomes especially helpful when overriding
1330 @code{line-break-system-details} and the other useful but long properties of
1331 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1333 @lilypond[quote,verbatim]
1338 \overrideProperty "Score.NonMusicalPaperColumn"
1339 #'line-break-system-details #'((Y-offset . 0))
1342 \overrideProperty "Score.NonMusicalPaperColumn"
1343 #'line-break-system-details #'((Y-offset . 35))
1346 \overrideProperty "Score.NonMusicalPaperColumn"
1347 #'line-break-system-details #'((Y-offset . 70))
1350 \overrideProperty "Score.NonMusicalPaperColumn"
1351 #'line-break-system-details #'((Y-offset . 105))
1355 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1356 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1357 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1358 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1367 @ref{Vertical spacing}.
1373 @node Vertical spacing
1374 @section Vertical spacing
1376 @cindex vertical spacing
1377 @cindex spacing, vertical
1379 Vertical spacing is controlled by three things: the amount of
1380 space available (i.e., paper size and margins), the amount of
1381 space between systems, and the amount of space between
1382 staves inside a system.
1385 * Vertical spacing inside a system::
1386 * Vertical spacing between systems::
1387 * Explicit staff and system positioning::
1388 * Vertical collision avoidance::
1392 @node Vertical spacing inside a system
1393 @subsection Vertical spacing inside a system
1395 @cindex distance between staves
1396 @cindex staff distance
1397 @cindex space between staves
1398 @cindex space inside systems
1400 The height of each system is determined in two steps. First, all of the
1401 staves are spaced according to the amount of space available. Then, the
1402 non-staff lines (eg. lyrics or chords) are distributed between the
1405 @unnumberedsubsubsec Spacing between staves
1406 Spacing between staves is controlled by the @var{next-staff-spacing}
1407 property of the @var{VerticalAxisGroup} grob. This property is an alist
1408 with four elements: @var{space}, @var{minimum-distance}, @var{padding}
1409 and @var{stretchability}:
1412 @var{space} is the size of the stretchable space between the center line
1413 of one staff to the center line of the next staff.
1416 @var{minimum-distance} provides a lower bound on the final distance
1417 between the center line of one staff to the center line of the next
1418 staff. That is, if a page has many systems and needs to be compressed,
1419 the distance from this staff to the next will never be compressed to
1420 less than @var{minimum-distance}.
1423 @var{padding} is the amount of whitespace that must be present between
1424 the bottom of one staff and the top of the next. It differs from
1425 @var{minimum-distance} in that the effect of @var{padding} depends on
1426 the height of objects in the staff. For example, @var{padding} is more
1427 likely to come into effect for staves with notes that are far below the
1431 @var{stretchability} controls the stretchable space's propensity to
1432 stretch when the system is stretched. Large values will cause a
1433 system to stretch more, while a value of zero will prevent the
1434 space from stretching at all. If unset, @var{stretchability}
1435 defaults to @code{space - minimum-distance}.
1439 #(set-global-staff-size 16)
1441 % Since space is small and there is no minimum-distance, the distance
1442 % between this staff and the next will be determined by padding.
1444 \override VerticalAxisGroup #'next-staff-spacing =
1445 #'((space . 1) (padding . 1))
1448 % Since space is small and nothing sticks out very far, the distance
1449 % between this staff and the next will be determined by minimum-distance.
1451 \override VerticalAxisGroup #'next-staff-spacing =
1452 #'((space . 1) (minimum-distance . 12))
1455 % By setting padding to a negative value, staves can be made to collide.
1457 \override VerticalAxisGroup #'next-staff-spacing =
1458 #'((space . 4) (padding . -10))
1461 \new Staff { \clef bass c, }
1466 In orchestral and other large scores, it is common to place staves in
1467 groups. The space between groups is typically larger than the space
1468 between staves of the same group. This spacing can be tweaked with the
1469 @var{StaffGrouper} grob: the default value of @var{next-staff-spacing}
1470 for @var{VerticalAxisGroup} is a callback function which operates by
1471 searching for a @var{StaffGrouper} grob containing the staff. If it
1472 finds a @var{StaffGrouper} grob and the staff in question is in the
1473 middle of a group, it reads the @var{between-staff-spacing} property of
1474 @var{StaffGrouper} and returns it. If the staff in question is the last
1475 staff of a group, the callback reads the @var{after-last-staff-spacing}
1476 property of @var{StaffGrouper} and returns it. If the callback did not
1477 find a @var{StaffGrouper} grob, it reads
1478 @var{default-next-staff-spacing} from its @var{VerticalAxisGroup} and
1482 #(set-global-staff-size 16)
1484 \new PianoStaff \with {
1485 \override StaffGrouper #'between-staff-spacing #'space = #1
1486 \override StaffGrouper #'between-staff-spacing #'padding = #0
1487 \override StaffGrouper #'after-last-staff-spacing #'space = #20
1494 \new StaffGroup \with {
1495 \override StaffGrouper #'between-staff-spacing #'space = #1
1496 \override StaffGrouper #'between-staff-spacing #'padding = #0
1506 @unnumberedsubsubsec Spacing of non-staff lines
1508 After the positions of the staves are determined, the non-staff lines
1509 are distributed between the staves. Each of these lines has a
1510 @var{staff-affinity} property which controls its vertical alignment.
1514 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #DOWN @}
1517 @noindent creates a lyrics context that will be placed close to the
1518 staff below it. Setting @var{staff-affinity} to something which is not
1519 a number (@code{#f}, for example) will cause that line to be treated
1520 like a staff. Conversely, setting @var{staff-affinity} for a staff will
1521 cause it to be treated like a non-staff.
1523 Non-staff lines admit three properties to control their spacing. Each
1524 of the these properties is an alist of the same format as
1525 @var{next-staff-spacing}, above.
1528 If the nearest line in the @var{staff-affinity} direction is a staff
1529 then @var{inter-staff-spacing} gives the spacing between the non-staff
1530 and the staff. If @var{staff-affinity} is @code{CENTER}, then
1531 @var{inter-staff-spacing} is used for both directions.
1534 If the nearest line in the @var{staff-affinity} direction is a non-staff
1535 then @var{inter-loose-line-spacing} gives the spacing between the two
1539 If the nearest line in the opposite direction to @var{staff-affinity} is
1540 a staff then @var{non-affinity-spacing} gives the spacing between the
1541 non-staff and the staff. This can be used, for example, to require
1542 a minimum amount of padding between a Lyrics line and the staff
1543 to which it does not belong.
1547 #(set-global-staff-size 16)
1551 % By default, Lyrics are placed close together. Here, we allow them to
1552 % be stretched more widely.
1553 \override VerticalAxisGroup
1554 #'inter-loose-line-spacing #'stretchability = #1000
1561 \override VerticalAxisGroup #'next-staff-spacing = #'((space . 30)) }
1564 \override VerticalAxisGroup #'staff-affinity = #UP }
1567 \override VerticalAxisGroup #'staff-affinity = #CENTER }
1568 \lyricmode { center }
1570 \override VerticalAxisGroup #'staff-affinity = #DOWN }
1581 @c @lsr{spacing,page-spacing.ly},
1582 @c @lsr{spacing,alignment-vertical-spacing.ly}.
1584 Internals Reference:
1585 @rinternals{VerticalAxisGroup},
1586 @rinternals{VerticalAlignment},
1587 @rinternals{Axis_group_engraver}.
1590 Adjacent non-staff lines should have non-increasing
1591 @var{staff-affinity} from top-to-bottom. For example, the behavior of
1595 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #DOWN @}
1596 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #UP @}
1602 A non-staff line at the bottom of a system should have
1603 @var{staff-affinity} set to @code{UP}. Similarly, a non-staff
1604 line at the top of a system should have @var{staff-affinity} set
1607 @node Vertical spacing between systems
1608 @subsection Vertical spacing between systems
1610 The mechanisms that control spacing between systems are similar to those
1611 that control spacing between staves within a system (see
1612 @ref{Vertical spacing inside a system}). The main difference is that
1613 the variables to control spacing between systems are set in the
1614 @code{\paper} block, rather than as grob properties. These paper block
1615 variables are @var{between-system-spacing},
1616 @var{between-scores-system-spacing}, @var{after-title-spacing},
1617 @var{before-title-spacing}, @var{between-title-spacing},
1618 @var{top-system-spacing}, @var{top-system-spacing},
1619 @var{top-title-spacing} and @var{bottom-system-spacing}. Note that
1620 these variables ignore non-staff lines. For example,
1621 @var{between-system-spacing} controls the spacing from the middle staff
1622 line of the bottom staff from one system to the middle staff line of the
1623 top staff of the next system, whether or not there are lyrics below the
1624 upper system. See @ref{Vertical dimensions} for a description of each
1627 There are two more @code{\paper} block variables that affect vertical
1628 spacing: if @var{ragged-bottom} is set to @code{##t} then no pages will
1629 be stretched (which means that neither the space between systems nor the
1630 space within systems will be stretched). If @var{ragged-last-bottom}
1631 is set to @code{##t} then the last page will not be stretched.
1638 @node Explicit staff and system positioning
1639 @subsection Explicit staff and system positioning
1641 One way to understand the @code{VerticalAxisGroup} and @code{\paper}
1642 settings explained in the previous two sections is as a collection of
1643 different settings that primarily concern the amount of vertical padding
1644 different staves and systems running down the page.
1646 It is possible to approach vertical spacing in a different way using
1647 @code{NonMusicalPaperColumn #'line-break-system-details}. Where
1648 @code{VerticalAxisGroup} and @code{\paper} settings specify vertical padding,
1649 @code{NonMusicalPaperColumn #'line-break-system-details} specifies exact
1650 vertical positions on the page.
1652 @code{NonMusicalPaperColumn #'line-break-system-details} accepts an associative
1653 list of three different settings:
1656 @item @code{X-offset}
1657 @item @code{Y-offset}
1658 @item @code{alignment-distances}
1661 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
1662 below, can occur in any of three different places in an input file:
1665 @item in the middle of note entry directly
1666 @item in a @code{\context} block
1667 @item in the @code{\with} block
1670 When we override @code{NonMusicalPaperColumn}, we use the usual
1671 @code{\override} command in @code{\context} blocks and in the
1672 @code{\with} block. On the other hand, when we override
1673 @code{NonMusicalPaperColumn} in the middle of note entry,
1674 use the special @code{\overrideProperty} command. Here are some
1675 example @code{NonMusicalPaperColumn} overrides with the special
1676 @code{\overrideProperty} command:
1679 \overrideProperty NonMusicalPaperColumn
1680 #'line-break-system-details #'((X-offset . 20))
1682 \overrideProperty NonMusicalPaperColumn
1683 #'line-break-system-details #'((Y-offset . 40))
1685 \overrideProperty NonMusicalPaperColumn
1686 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40))
1688 \overrideProperty NonMusicalPaperColumn
1689 #'line-break-system-details #'((alignment-distances . (15)))
1691 \overrideProperty NonMusicalPaperColumn
1692 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40)
1693 (alignment-distances . (15)))
1696 To understand how each of these different settings work, we begin
1697 by looking at an example that includes no overrides at all.
1699 @c \book { } is required in these examples to ensure the spacing
1700 @c overrides can be seen between systems. -np
1703 \header { tagline = ##f }
1704 \paper { left-margin = 0\mm }
1714 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1717 \repeat unfold 15 { d'4 d' d' d' }
1724 This score isolates line- and page-breaking information in a dedicated
1725 voice. This technique of creating a breaks voice will help keep layout
1726 separate from music entry as our example becomes more complicated.
1727 See @ref{Using an extra voice for breaks}.
1729 Explicit @code{\breaks} evenly divide the music into six measures per
1730 line. Vertical spacing results from LilyPond's defaults. To set
1731 the vertical startpoint of each system explicitly, we can set
1732 the @code{Y-offset} pair in the @code{line-break-system-details}
1733 attribute of the @code{NonMusicalPaperColumn} grob:
1736 \header { tagline = ##f }
1737 \paper { left-margin = 0\mm }
1743 \overrideProperty #"Score.NonMusicalPaperColumn"
1744 #'line-break-system-details #'((Y-offset . 0))
1746 \overrideProperty #"Score.NonMusicalPaperColumn"
1747 #'line-break-system-details #'((Y-offset . 40))
1749 \overrideProperty #"Score.NonMusicalPaperColumn"
1750 #'line-break-system-details #'((Y-offset . 80))
1753 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1756 \repeat unfold 15 { d'4 d' d' d' }
1763 Note that @code{line-break-system-details} takes an associative list of
1764 potentially many values, but that we set only one value here. Note,
1765 too, that the @code{Y-offset} property here determines the exact vertical
1766 position on the page at which each new system will render.
1768 Now that we have set the vertical startpoint of each system
1769 explicitly, we can also set the vertical distances between staves
1770 within each system manually. We do this using the @code{alignment-distances}
1771 subproperty of @code{line-break-system-details}.
1774 \header { tagline = ##f }
1775 \paper { left-margin = 0\mm }
1781 \overrideProperty #"Score.NonMusicalPaperColumn"
1782 #'line-break-system-details #'((Y-offset . 20)
1783 (alignment-distances . (15)))
1785 \overrideProperty #"Score.NonMusicalPaperColumn"
1786 #'line-break-system-details #'((Y-offset . 60)
1787 (alignment-distances . (15)))
1789 \overrideProperty #"Score.NonMusicalPaperColumn"
1790 #'line-break-system-details #'((Y-offset . 100)
1791 (alignment-distances . (15)))
1794 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1797 \repeat unfold 15 { d'4 d' d' d' }
1804 Note that here we assign two different values to the
1805 @code{line-break-system-details} attribute of the
1806 @code{NonMusicalPaperColumn} grob. Though the
1807 @code{line-break-system-details} attribute alist accepts many
1808 additional spacing parameters (including, for example, a corresponding
1809 @code{X-offset} pair), we need only set the @code{Y-offset} and
1810 @code{alignment-distances} pairs to control the vertical startpoint of
1811 every system and every staff. Finally, note that @code{alignment-distances}
1812 specifies the vertical positioning of staves but not of staff groups.
1815 \header { tagline = ##f }
1816 \paper { left-margin = 0\mm }
1822 \overrideProperty #"Score.NonMusicalPaperColumn"
1823 #'line-break-system-details #'((Y-offset . 0)
1824 (alignment-distances . (30 10)))
1826 \overrideProperty #"Score.NonMusicalPaperColumn"
1827 #'line-break-system-details #'((Y-offset . 60)
1828 (alignment-distances . (10 10)))
1830 \overrideProperty #"Score.NonMusicalPaperColumn"
1831 #'line-break-system-details #'((Y-offset . 100)
1832 (alignment-distances . (10 30)))
1835 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1838 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
1839 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
1846 Some points to consider:
1849 @item When using @code{alignment-distances}, lyrics and other non-staff lines
1850 do not count as a staff.
1852 @item The units of the numbers passed to @code{X-offset},
1853 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
1854 of the distance between adjacent staff lines. Positive values move staves
1855 and lyrics up, negative values move staves and lyrics down.
1857 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
1858 settings given here allow the positioning of staves and systems anywhere
1859 on the page, it is possible to violate paper or margin boundaries or even
1860 to print staves or systems on top of one another. Reasonable values
1861 passed to these different settings will avoid this.
1870 @node Vertical collision avoidance
1871 @subsection Vertical collision avoidance
1873 @funindex outside-staff-priority
1874 @funindex outside-staff-padding
1875 @funindex outside-staff-horizontal-padding
1877 Intuitively, there are some objects in musical notation that belong
1878 to the staff and there are other objects that should be placed outside
1879 the staff. Objects belonging outside the staff include things such as
1880 rehearsal marks, text and dynamic markings (from now on, these will
1881 be called outside-staff objects). LilyPond's rule for the
1882 vertical placement of outside-staff objects is to place them as close
1883 to the staff as possible but not so close that they collide with
1886 LilyPond uses the @code{outside-staff-priority} property to determine
1887 whether a grob is an outside-staff object: if @code{outside-staff-priority}
1888 is a number, the grob is an outside-staff object. In addition,
1889 @code{outside-staff-priority} tells LilyPond in which order the objects
1892 First, LilyPond places all the objects that do not belong outside
1893 the staff. Then it sorts the outside-staff objects according to their
1894 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
1895 takes the outside-staff objects and places them so that they do
1896 not collide with any objects that have already been placed. That
1897 is, if two outside-staff grobs are competing for the same space, the one
1898 with the lower @code{outside-staff-priority} will be placed closer to
1901 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1904 \once \override TextScript #'outside-staff-priority = #1
1905 c4_"Text"\pp % this time the text will be closer to the staff
1907 % by setting outside-staff-priority to a non-number,
1908 % we disable the automatic collision avoidance
1909 \once \override TextScript #'outside-staff-priority = ##f
1910 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
1911 c4_"Text"\pp % now they will collide
1914 The vertical padding between an outside-staff object and the
1915 previously-positioned grobs can be controlled with
1916 @code{outside-staff-padding}.
1918 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1919 \once \override TextScript #'outside-staff-padding = #0
1920 a'^"This text is placed very close to the note"
1921 \once \override TextScript #'outside-staff-padding = #3
1922 c^"This text is padded away from the previous text"
1923 c^"This text is placed close to the previous text"
1927 By default, outside-staff objects are placed only to avoid
1928 a horizontal collision with previously-positioned grobs. This
1929 can lead to situations in which objects are placed very close to each
1930 other horizontally. The vertical spacing between staffs can
1931 also be set so that outside staff objects are interleaved.
1932 Setting @code{outside-staff-horizontal-padding}
1933 causes an object to be offset vertically so that such a situation
1936 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1937 % the markup is too close to the following note
1941 % setting outside-staff-horizontal-padding fixes this
1943 \once \override TextScript #'outside-staff-horizontal-padding = #1
1955 @node Horizontal spacing
1956 @section Horizontal spacing
1958 @cindex horizontal spacing
1959 @cindex spacing, horizontal
1962 * Horizontal spacing overview::
1963 * New spacing area::
1964 * Changing horizontal spacing::
1966 * Proportional notation::
1970 @node Horizontal spacing overview
1971 @subsection Horizontal spacing overview
1973 The spacing engine translates differences in durations into stretchable
1974 distances (@q{springs}) of differing lengths. Longer durations get
1975 more space, shorter durations get less. The shortest durations get a
1976 fixed amount of space (which is controlled by
1977 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
1978 object). The longer the duration, the more space it gets: doubling a
1979 duration adds a fixed amount (this amount is controlled by
1980 @code{spacing-increment}) of space to the note.
1982 For example, the following piece contains lots of half, quarter, and
1983 8th notes; the eighth note is followed by 1 note head width (NHW).
1984 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
1986 @lilypond[quote,fragment,verbatim,relative=1]
1987 c2 c4. c8 c4. c8 c4. c8 c8
1991 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
1992 approximately the width of a note head, and
1993 @code{shortest-duration-space} is set to 2.0, meaning that the
1994 shortest note gets 2.4 staff space (2.0 times the
1995 @code{spacing-increment}) of horizontal space. This space is counted
1996 from the left edge of the symbol, so the shortest notes are generally
1997 followed by one NHW of space.
1999 If one would follow the above procedure exactly, then adding a single
2000 32nd note to a score that uses 8th and 16th notes, would widen up the
2001 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2002 thus adding 1 NHW to every note. To prevent this, the shortest
2003 duration for spacing is not the shortest note in the score, but rather
2004 the one which occurs most frequently.
2007 The most common shortest duration is determined as follows: in every
2008 measure, the shortest duration is determined. The most common shortest
2009 duration is taken as the basis for the spacing, with the stipulation
2010 that this shortest duration should always be equal to or shorter than
2011 an 8th note. The shortest duration is printed when you run
2012 @code{lilypond} with the @code{--verbose} option.
2014 These durations may also be customized. If you set the
2015 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2016 this sets the base duration for spacing. The maximum duration for this
2017 base (normally an 8th), is set through @code{base-shortest-duration}.
2019 @funindex common-shortest-duration
2020 @funindex base-shortest-duration
2021 @funindex stem-spacing-correction
2024 Notes that are even shorter than the common shortest note are
2025 followed by a space that is proportional to their duration relative to
2026 the common shortest note. So if we were to add only a few 16th notes
2027 to the example above, they would be followed by half a NHW:
2029 @lilypond[quote,fragment,verbatim,relative=2]
2030 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2034 In the @emph{Essay on automated music engraving}, it was explained
2035 that stem directions influence spacing (see @ressay{Optical
2036 spacing}). This is controlled with the
2037 @code{stem-spacing-correction} property in the
2038 @rinternals{NoteSpacing}, object. These are generated for every
2039 @rinternals{Voice} context. The @code{StaffSpacing} object
2040 (generated in @rinternals{Staff} context) contains the same
2041 property for controlling the stem/bar line spacing. The following
2042 example shows these corrections, once with default settings, and
2043 once with exaggerated corrections:
2045 @lilypond[quote,ragged-right]
2049 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2050 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2056 Proportional notation is supported; see @ref{Proportional notation}.
2063 Internals Reference:
2064 @rinternals{SpacingSpanner},
2065 @rinternals{NoteSpacing},
2066 @rinternals{StaffSpacing},
2067 @rinternals{NonMusicalPaperColumn}.
2072 There is no convenient mechanism to manually override spacing. The
2073 following work-around may be used to insert extra space into a score,
2074 adjusting the padding value as necessary.
2076 \override Score.NonMusicalPaperColumn #'padding = #10
2079 No work-around exists for decreasing the amount of space.
2082 @node New spacing area
2083 @subsection New spacing area
2085 New sections with different spacing parameters can be started with
2086 @code{newSpacingSection}. This is useful when there are
2087 sections with a different notions of long and short notes.
2089 In the following example, the time signature change introduces a new
2090 section, and hence the 16ths notes are spaced wider.
2092 @lilypond[relative,fragment,verbatim,quote]
2095 c8 c c4 c16[ c c8] c4
2101 The @code{\newSpacingSection} command creates a new
2102 @code{SpacingSpanner} object, and hence new @code{\override}s
2103 may be used in that location.
2110 Internals Reference:
2111 @rinternals{SpacingSpanner}.
2114 @node Changing horizontal spacing
2115 @subsection Changing horizontal spacing
2117 Horizontal spacing may be altered with the
2118 @code{base-shortest-duration} property. Here
2119 we compare the same music; once without altering
2120 the property, and then altered. Larger values
2121 of @code{ly:make-moment} will produce smaller
2122 music. Note that @code{ly:make-moment} constructs
2123 a duration, so @code{1 4} is a longer duration
2126 @lilypond[verbatim,line-width=12\cm]
2129 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2130 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2131 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2132 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2137 @lilypond[verbatim,line-width=12\cm]
2140 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2141 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2142 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2143 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2148 \override SpacingSpanner
2149 #'base-shortest-duration = #(ly:make-moment 1 16)
2158 By default, spacing in tuplets depends on various non-duration
2159 factors (such as accidentals, clef changes, etc). To disregard
2160 such symbols and force uniform equal-duration spacing, use
2161 @code{Score.SpacingSpanner #'uniform-stretching}. This
2162 property can only be changed at the beginning of a score,
2164 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
2166 \override SpacingSpanner #'uniform-stretching = ##t
2183 When @code{strict-note-spacing} is set, notes are spaced without
2184 regard for clefs, bar lines, and grace notes,
2186 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
2187 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2188 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2198 @subsection Line length
2201 @cindex breaking pages
2204 @funindex line-width
2205 @funindex ragged-right
2206 @funindex ragged-last
2208 @c Although line-width can be set in \layout, it should be set in paper
2209 @c block, to get page layout right.
2210 @c Setting indent in \paper block makes not much sense, but it works.
2212 @c Bit verbose and vague, use examples?
2213 The most basic settings influencing the spacing are @code{indent} and
2214 @code{line-width}. They are set in the @code{\layout} block. They
2215 control the indentation of the first line of music, and the lengths of
2218 If @code{ragged-right} is set to true in the @code{\layout} block, then
2219 systems ends at their natural horizontal length, instead of being spread
2220 horizontally to fill the whole line. This is useful for
2221 short fragments, and for checking how tight the natural spacing is.
2222 The normal default setting is false, but if the score has only one
2223 system the default value is true.
2226 @cindex vertical spacing
2228 The option @code{ragged-last} is similar to @code{ragged-right}, but
2229 only affects the last line of the piece. No restrictions are put on
2230 that line. The result is similar to formatting text paragraphs. In a
2231 paragraph, the last line simply takes its natural horizontal length.
2232 @c Note that for text there are several options for the last line.
2233 @c While Knuth TeX uses natural length, lead typesetters use the same
2234 @c stretch as the previous line. eTeX uses \lastlinefit to
2235 @c interpolate between both these solutions.
2251 @node Proportional notation
2252 @subsection Proportional notation
2254 LilyPond supports proportional notation, a type of horizontal spacing
2255 in which each note consumes an amount of horizontal space exactly
2256 equivalent to its rhythmic duration. This type of proportional spacing
2257 is comparable to horizontal spacing on top of graph paper. Some late
2258 20th- and early 21st-century scores use proportional notation to
2259 clarify complex rhythmic relationships or to facilitate the placement
2260 of timelines or other graphics directly in the score.
2262 LilyPond supports five different settings for proportional notation,
2263 which may be used together or alone:
2266 @item @code{proportionalNotationDuration}
2267 @item @code{uniform-stretching}
2268 @item @code{strict-note-spacing}
2269 @item @code{\remove Separating_line_group_engraver}
2270 @item @code{\override PaperColumn #'used = ##t}
2273 In the examples that follow, we explore these five different
2274 proportional notation settings and examine how these settings interact.
2276 We start with the following one-measure example, which uses classical
2277 spacing with ragged-right turned on.
2279 @lilypond[quote,verbatim,ragged-right]
2281 \new RhythmicStaff {
2285 c'16 c'16 c'16 c'16 c'16
2291 Notice that the half note which begins the measure takes up far less
2292 than half of the horizontal space of the measure. Likewise, the
2293 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
2294 which end the measure together take up far more than half the
2295 horizontal space of the measure.
2297 In classical engraving, this spacing may be exactly what we want
2298 because we can borrow horizontal space from the half note and conserve
2299 horizontal space across the measure as a whole.
2301 On the other hand, if we want to insert a measured timeline or other
2302 graphic above or below our score, we need proportional notation. We
2303 turn proportional notation on with the proportionalNotationDuration
2306 @lilypond[quote,verbatim,ragged-right]
2308 proportionalNotationDuration = #(ly:make-moment 1 20)
2310 \new RhythmicStaff {
2314 c'16 c'16 c'16 c'16 c'16
2320 The half note at the beginning of the measure and the faster notes in
2321 the second half of the measure now occupy equal amounts of horizontal
2322 space. We could place a measured timeline or graphic above or below
2325 The @code{proportionalNotationDuration} setting is a context setting that
2326 lives in @code{Score}. Recall that context settings appear in one of
2327 three locations in our input file -- in a @code{\with} block, in a
2328 @code{\context} block, or directly in music entry
2329 preceded by the @code{\set} command. As with all
2330 context settings, users can pick which of the three different
2331 locations they would like to set @code{proportionalNotationDuration}.
2333 The @code{proportionalNotationDuration} setting takes a single argument,
2334 which is the reference duration against which all music will be
2335 spaced. The LilyPond Scheme function make-moment takes two arguments
2336 -- a numerator and denominator which together express some fraction of
2337 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces a
2338 reference duration of a twentieth note. The values
2339 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
2340 @code{#(ly:make-moment 3 97)} are all possible as well.
2342 How do we select the right reference duration to pass to
2343 @code{proportionalNotationDuration}? Usually by a process of trial and error,
2344 beginning with a duration close to the fastest (or smallest) duration
2345 in the piece. Smaller reference durations space music loosely; larger
2346 reference durations space music tightly.
2348 @lilypond[quote,verbatim,ragged-right]
2350 proportionalNotationDuration = #(ly:make-moment 1 8)
2352 \new RhythmicStaff {
2356 c'16 c'16 c'16 c'16 c'16
2362 proportionalNotationDuration = #(ly:make-moment 1 16)
2364 \new RhythmicStaff {
2368 c'16 c'16 c'16 c'16 c'16
2374 proportionalNotationDuration = #(ly:make-moment 1 32)
2376 \new RhythmicStaff {
2380 c'16 c'16 c'16 c'16 c'16
2386 Note that too large a reference duration -- such as the eighth note,
2387 above -- spaces music too tightly and can cause note head collisions.
2388 Note also that proportional notation in general takes up more
2389 horizontal space that does classical spacing. Proportional spacing
2390 provides rhythmic clarity at the expense of horizontal space.
2392 Next we examine how to optimally space overlapping tuplets.
2394 We start by examining what happens to our original example, with
2395 classical spacing, when we add a second staff with a different type of
2398 @lilypond[quote,verbatim,ragged-right]
2400 \new RhythmicStaff {
2404 c'16 c'16 c'16 c'16 c'16
2407 \new RhythmicStaff {
2409 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2415 The spacing is bad because the evenly notes of the bottom staff do not
2416 stretch uniformly. Classical engraving includes very few complex
2417 triplets and so classical engraving rules can generate this type of
2418 result. Setting @code{proportionalNotationDuration} remedies this
2419 situation considerably.
2421 @lilypond[quote,verbatim,ragged-right]
2423 proportionalNotationDuration = #(ly:make-moment 1 20)
2425 \new RhythmicStaff {
2429 c'16 c'16 c'16 c'16 c'16
2432 \new RhythmicStaff {
2434 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2440 But if we look very carefully we can see that notes of the second half
2441 of the 9-tuplet space ever so slightly more widely than do the notes
2442 of the first half of the 9-tuplet. To ensure uniform stretching, we
2443 turn on @code{uniform-stretching}, which is a property of
2444 @code{SpacingSpanner}.
2446 @lilypond[quote,verbatim,ragged-right]
2448 proportionalNotationDuration = #(ly:make-moment 1 20)
2449 \override SpacingSpanner #'uniform-stretching = ##t
2451 \new RhythmicStaff {
2455 c'16 c'16 c'16 c'16 c'16
2458 \new RhythmicStaff {
2460 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2466 Our two-staff example now spaces exactly, our rhythmic
2467 relationships are visually clear, and we can include a measured
2468 timeline or graphic if we want.
2470 Note that the LilyPond's proportional notation package expects
2471 that all proportional scores set the SpacingSpanner's
2472 'uniform-stretching attribute to ##t. Setting
2473 proportionalNotationDuration without also setting the
2474 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
2475 example, cause Skips to consume an incorrect amount of horizontal
2478 The SpacingSpanner is an abstract grob that lives in the Score
2479 context. As with our settings of proportionalNotationDuration,
2480 overrides to the SpacingSpanner can occur in any of three
2481 different places in our input file – in the Score \with block, in
2482 a Score \context block, or in note entry directly.
2484 There is by default only one @code{SpacingSpanner} per @code{Score}. This
2485 means that, by default, @code{uniform-stretching} is either turned on for the
2486 entire score or turned off for the entire score. We can, however,
2487 override this behavior and turn on different spacing features at
2488 different places in the score. We do this with the command
2489 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
2491 Next we examine the effects of the @code{Separating_line_group_engraver} and
2492 see why proportional scores frequently remove this engraver. The following
2493 example shows that there is a small amount of @qq{preferatory} space
2494 just before the first note in each system.
2496 @lilypond[quote,verbatim,ragged-right]
2509 The amount of this preferatory space is the same whether after a time
2510 signature, a key signature or a clef. @code{Separating_line_group_engraver}
2511 is responsible for this space. Removing @code{Separating_line_group_engraver}
2512 reduces this space to zero.
2514 @lilypond[quote,verbatim,ragged-right]
2520 \remove Separating_line_group_engraver
2528 Nonmusical elements like time signatures, key signatures, clefs and
2529 accidentals are problematic in proportional notation. None of these
2530 elements has rhythmic duration. But all of these elements consume
2531 horizontal space. Different proportional scores approach these
2532 problems differently.
2534 It may be possible to avoid spacing problems with key signatures
2535 simply by not having any. This is a valid option since most
2536 proportional scores are contemporary music. The same may be true
2537 of time signatures, especially for those scores
2538 that include a measured timeline or other graphic. But these scores
2539 are exceptional and most proportional scores include at least some
2540 time signatures. Clefs and accidentals are even more essential.
2542 So what strategies exist for spacing nonmusical elements in a
2543 proportional context? One good option is the @code{strict-note-spacing}
2544 property of @code{SpacingSpanner}. Compare the two scores below:
2546 @lilypond[quote,verbatim,ragged-right]
2548 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
2558 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
2559 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2569 Both scores are proportional, but the spacing in the first score
2570 is too loose because of the clef change. The spacing of the second
2571 score remains strict, however, because strict-note-spacing is
2572 turned on. Turning on strict-note-spacing causes the width of
2573 time signatures, key signatures, clefs and accidentals to play no
2574 part in the spacing algorithm.
2576 In addition to the settings given here, there are other settings
2577 that frequently appear in proportional scores. These include:
2580 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
2581 @item @code{tupletFullLength = ##t}
2582 @item @code{\override Beam #'breakable = ##t}
2583 @item @code{\override Glissando #'breakable = ##t}
2584 @item @code{\override TextSpanner #'breakable = ##t}
2585 @item @code{\remove Forbid_line_break_engraver in the Voice context}
2588 These settings space grace notes strictly, extend tuplet brackets to
2589 mark both rhythmic start- and stop-points, and allow spanning elements
2590 to break across systems and pages. See the respective parts of the manual
2591 for these related settings.
2596 @ref{New spacing area}.
2602 @node Fitting music onto fewer pages
2603 @section Fitting music onto fewer pages
2605 Sometimes you can end up with one or two staves on a second
2606 (or third, or fourth...) page. This is annoying, especially
2607 if you look at previous pages and it looks like there is plenty
2608 of room left on those.
2610 When investigating layout issues, @code{annotate-spacing} is an
2611 invaluable tool. This command prints the values of various layout
2612 spacing variables; for more details see the following section,
2613 @ref{Displaying spacing}.
2616 * Displaying spacing::
2617 * Changing spacing::
2621 @node Displaying spacing
2622 @subsection Displaying spacing
2624 @funindex annotate-spacing
2625 @cindex spacing, display of layout
2627 To graphically display the dimensions of vertical layout variables
2628 that may be altered for page formatting, set
2629 @code{annotate-spacing} in the @code{\paper} block:
2631 @c need to have \book{} otherwise we get the separate systems. -hwn
2632 @lilypond[verbatim,quote]
2633 #(set-default-paper-size "a6" 'landscape)
2636 \paper { annotate-spacing = ##t }
2642 All layout dimensions are displayed in staff-spaces, regardless
2643 of the units specified in the @code{\paper} or @code{\layout} block.
2644 In the above example, @code{paper-height} has a value of 59.75
2645 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
2646 default value). Note that:
2648 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
2651 @tab = (25.4/72.27) mm
2654 @tab = (@code{staff-size})/4 pts
2656 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
2661 In this case, one @code{staff-space} is approximately equal to
2662 1.757mm. Thus the @code{paper-height} measurement of 59.75
2663 @code{staff-spaces} is equivalent to 105 millimeters, the height
2664 of @code{a6} paper in landscape orientation. The pairs
2665 (@var{a},@var{b}) are intervals, where @var{a} is the lower
2666 edge and @var{b} the upper edge of the interval.
2671 @ref{Setting the staff size}.
2677 @node Changing spacing
2678 @subsection Changing spacing
2680 The output of @code{annotate-spacing} reveals vertical dimensions
2681 in great detail. For details about modifying margins and other
2682 layout variables, see @ref{Page formatting}.
2684 Other than margins, there are a few other options to save space:
2688 Force systems to move as close together as possible (to fit as
2689 many systems as possible onto a page) while being spaced so that
2690 there is no blank space at the bottom of the page.
2694 between-system-spacing = #'((padding . 0) (space . 0.1))
2695 ragged-last-bottom = ##f
2701 Force the number of systems. This can help in two ways. Just
2702 setting a value, even the same value as the number of systems
2703 being typeset by default, will sometimes cause more systems to
2704 be fitted onto each page, as an estimation step is then bypassed,
2705 giving a more accurate fit to each page. Also, forcing an actual
2706 reduction in the number of systems may save a further page. For
2707 example, if the default layout has 11 systems, the following
2708 assignment will force a layout with 10 systems.
2717 Avoid (or reduce) objects that increase the vertical size of a
2718 system. For example, volta repeats (or alternate repeats) require
2719 extra space. If these repeats are spread over two systems, they
2720 will take up more space than one system with the volta repeats and
2721 another system without. For example, dynamics that @q{stick out} of
2722 a system can be moved closer to the staff:
2724 @lilypond[verbatim,quote,relative=1]
2726 \override DynamicText #'extra-offset = #'( -2.2 . 2.0)
2731 Alter the horizontal spacing via @code{SpacingSpanner}. For more
2732 details, see @ref{Changing horizontal spacing}. The following
2733 example illustrates the default spacing:
2735 @lilypond[verbatim,quote]
2748 The next example modifies @code{common-shortest-duration} from a
2749 value of @code{1/4} to @code{1/2}. The quarter note is the most
2750 common and shortest duration in this example, so by making this
2751 duration longer, a @q{squeezing} effect occurs:
2753 @lilypond[verbatim,quote]
2765 \override SpacingSpanner
2766 #'common-shortest-duration = #(ly:make-moment 1 2)
2773 The @code{common-shortest-duration} property cannot be modified
2774 dynamically, so it must always be placed in a @code{\context}
2775 block so that it applies to the whole score.
2782 @ref{Page formatting},
2783 @ref{Changing horizontal spacing}.