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 c' { 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.
732 @cindex binding gutter
734 If set to true, use @code{inner-margin}, @code{outer-margin} and
735 @code{binding-offset} to determine margins depending on whether
736 the page number is odd or even. This overrides @code{left-margin}
737 and @code{right-margin}. Default: @code{##f}.
749 The default page header puts the page number and the @code{instrument}
750 field from the @code{\header} block on a line.
752 The titles (from the @code{\header@{@}} section) are treated as a
753 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
754 add space between the titles and the first system of the score.
758 @section Music layout
761 * Setting the staff size::
766 @node Setting the staff size
767 @subsection Setting the staff size
769 @cindex font size, setting
770 @cindex staff size, setting
771 @funindex layout file
773 The default @strong{staff size} is set to 20 points.
774 This may be changed in two ways:
776 To set the staff size globally for all scores in a file (or
777 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
780 #(set-global-staff-size 14)
784 This sets the global default size to 14pt staff height and scales all
787 To set the staff size individually for each score, use
792 #(layout-set-staff-size 15)
797 The Feta font provides musical symbols at eight different
798 sizes. Each font is tuned for a different staff size: at a smaller size
799 the font becomes heavier, to match the relatively heavier staff lines.
800 The recommended font sizes are listed in the following table:
803 @multitable @columnfractions .15 .2 .22 .2
806 @tab @b{staff height (pt)}
807 @tab @b{staff height (mm)}
849 @c modern rental material?
854 These fonts are available in any sizes. The context property
855 @code{fontSize} and the layout property @code{staff-space} (in
856 @rinternals{StaffSymbol}) can be used to tune the size for individual
857 staves. The sizes of individual staves are relative to the global size.
862 @ref{Selecting notation font size}.
870 @code{layout-set-staff-size} does not change the distance between the
875 @subsection Score layout
879 While @code{\paper} contains settings that relate to the page formatting
880 of the whole document, @code{\layout} contains settings for score-specific
887 \override VerticalAxisGroup #'minimum-Y-extent = #'(-6 . 6)
890 \override TextScript #'padding = #1.0
891 \override Glissando #'thickness = #3
899 @ref{Changing context default settings}.
911 * Optimal page breaking::
912 * Optimal page turning::
913 * Minimal page breaking::
915 * Using an extra voice for breaks::
920 @subsection Line breaking
923 @cindex breaking lines
925 Line breaks are normally determined automatically. They are chosen
926 so that lines look neither cramped nor loose, and consecutive
927 lines have similar density. Occasionally you might want to
928 override the automatic breaks; you can do this by specifying
929 @code{\break}. This will force a line break at this point. However,
930 line breaks can only occur at the end of @q{complete} bars, i.e.,
931 where there are no notes or tuplets left @q{hanging} over the bar
932 line. If you want to have a line break where there is no bar line,
933 you can force an invisible bar line by entering @code{\bar ""},
934 although again there must be no notes left hanging over in any of
935 the staves at this point, or it will be ignored.
937 The opposite command, @code{\noBreak}, forbids a line break at the
938 bar line where it is inserted.
940 The most basic settings influencing line spacing are @code{indent}
941 and @code{line-width}. They are set in the @code{\layout} block.
942 They control the indentation of the first line of music, and the
943 lengths of the lines.
945 If @code{ragged-right} is set to true in the @code{\layout} block,
946 then systems end at their natural horizontal length, instead of
947 being spread horizontally to fill the whole line. This is useful
948 for short fragments, and for checking how tight the natural
951 @c TODO Check and add para on default for ragged-right
953 The option @code{ragged-last} is similar to @code{ragged-right},
954 but affects only the last line of the piece.
966 @cindex regular line breaks
967 @cindex four bar music.
969 For line breaks at regular intervals use @code{\break} separated by
970 skips and repeated with @code{\repeat}. For example, this would
971 cause the following 28 measures (assuming 4/4 time) to be broken
972 every 4 measures, and only there:
975 << \repeat unfold 7 @{
976 s1 \noBreak s1 \noBreak
977 s1 \noBreak s1 \break @}
978 @emph{the real music}
983 A linebreaking configuration can be saved as a @code{.ly} file
984 automatically. This allows vertical alignments to be stretched to
985 fit pages in a second formatting run. This is fairly new and
986 complicated. More details are available in
1000 @rinternals{LineBreakEvent}.
1008 Line breaks can only occur if there is a @q{proper} bar line. A note
1009 which is hanging over a bar line is not proper, such as
1011 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1012 c4 c2 << c2 {s4 \break } >> % this does nothing
1013 c2 c4 | % a break here would work
1014 c4 c2 c4 ~ \break % as does this break
1018 This can be avoided by removing the @code{Forbid_line_break_engraver}.
1019 Note that manually forced line breaks have to be added in parallel
1022 @lilypond[quote,ragged-right,verbatim]
1024 \remove Forbid_line_break_engraver
1026 c4 c2 << c2 {s4 \break } >> % now the break is allowed
1031 Similarly, line breaks are normally forbidden when beams cross bar
1032 lines. This behavior can be changed by setting
1033 @code{\override Beam #'breakable = ##t}.
1037 @subsection Page breaking
1039 The default page breaking may be overridden by inserting
1040 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1041 analogous to @code{\break} and @code{\noBreak}. They should be
1042 inserted at a bar line. These commands force and forbid a page-break
1043 from happening. Of course, the @code{\pageBreak} command also forces
1046 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1047 inserted at top-level, between scores and top-level markups.
1049 There are also analogous settings to @code{ragged-right} and
1050 @code{ragged-last} which have the same effect on vertical spacing:
1051 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1052 @code{##t} the systems on all pages or just the last page
1053 respectively will not be justified vertically.
1055 For more details see @ref{Vertical spacing}.
1057 Page breaks are computed by the @code{page-breaking} function. LilyPond
1058 provides three algorithms for computing page breaks,
1059 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1060 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1061 but the value can be changed in the @code{\paper} block:
1065 #(define page-breaking ly:page-turn-breaking)
1071 When a book has many scores and pages, the page breaking problem may be
1072 difficult to solve, requiring large processing time and memory. To ease
1073 the page breaking process, @code{\bookpart} blocks are used to divide
1074 the book into several parts: the page breaking occurs separately on each
1075 part. Different page breaking functions may also be used in different
1081 subtitle = "Preface"
1084 %% In a part consisting mostly of text,
1085 %% ly:minimal-breaking may be prefered
1086 #(define page-breaking ly:minimal-breaking)
1088 \markup @{ @dots{} @}
1092 %% In this part, consisting of music, the default optimal
1093 %% page breaking function is used.
1095 subtitle = "First movement"
1097 \score @{ @dots{} @}
1104 @funindex \pageBreak
1106 @funindex \noPageBreak
1107 @code{\noPageBreak}.
1116 @node Optimal page breaking
1117 @subsection Optimal page breaking
1119 @funindex ly:optimal-breaking
1121 The @code{ly:optimal-breaking} function is LilyPond's default method of
1122 determining page breaks. It attempts to find a page breaking that minimizes
1123 cramping and stretching, both horizontally and vertically. Unlike
1124 @code{ly:page-turn-breaking}, it has no concept of page turns.
1132 @node Optimal page turning
1133 @subsection Optimal page turning
1135 @funindex ly:page-turn-breaking
1137 Often it is necessary to find a page breaking configuration so that there is
1138 a rest at the end of every second page. This way, the musician can turn the
1139 page without having to miss notes. The @code{ly:page-turn-breaking} function
1140 attempts to find a page breaking minimizing cramping and stretching, but with
1141 the additional restriction that it is only allowed to introduce page turns
1142 in specified places.
1144 There are two steps to using this page breaking function. First, you
1145 must enable it in the @code{\paper} block, as explained in @ref{Page
1146 breaking}. Then you must tell the function where you would like to allow
1149 There are two ways to achieve the second step. First, you can specify each
1150 potential page turn manually, by inserting @code{\allowPageTurn} into your
1151 input file at the appropriate places.
1153 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1154 Voice context. The @code{Page_turn_engraver} will scan the context for
1155 sections without notes (note that it does not scan for rests; it scans for
1156 the absence of notes. This is so that single-staff polyphony with rests in one
1157 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1158 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1159 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1160 there is a @q{special} bar line (such as a double bar), in which case the
1161 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1164 @funindex minimumPageTurnLength
1165 The @code{Page_turn_engraver} reads the context property
1166 @code{minimumPageTurnLength} to determine how long a note-free section must
1167 be before a page turn is considered. The default value for
1168 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
1169 to disable page turns, you can set it to something very large.
1172 \new Staff \with @{ \consists "Page_turn_engraver" @}
1175 R1 | % a page turn will be allowed here
1177 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1178 R1 | % a page turn will not be allowed here
1180 R1*2 | % a page turn will be allowed here
1185 @funindex minimumRepeatLengthForPageTurn
1186 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1187 turn during the repeat if there is enough time at the beginning and end of the
1188 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1189 page turns if the repeat is very short. If you set the context property
1190 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1191 only allow turns in repeats whose duration is longer than this value.
1193 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1194 @code{\allowPageTurn}, may also be used at top-level, between scores and
1201 @funindex \noPageTurn
1203 @funindex \allowPageTurn
1204 @code{\allowPageTurn}.
1215 There should only be one @code{Page_turn_engraver} in a score. If there is more
1216 than one, they will interfere with each other.
1219 @node Minimal page breaking
1220 @subsection Minimal page breaking
1222 @funindex ly:minimal-breaking
1224 The @code{ly:minimal-breaking} function performs minimal computations to
1225 calculate the page breaking: it fills a page with as many systems as
1226 possible before moving to the next one. Thus, it may be preferred for
1227 scores with many pages, where the other page breaking functions could be
1228 too slow or memory demanding, or a lot of texts. It is enabled using:
1232 #(define page-breaking ly:minimal-breaking)
1242 @node Explicit breaks
1243 @subsection Explicit breaks
1245 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1246 commands. There are two commands to override this behavior:
1249 \override NonMusicalPaperColumn #'line-break-permission = ##f
1250 \override NonMusicalPaperColumn #'page-break-permission = ##f
1253 When @code{line-break-permission} is overridden to false, Lily will insert
1254 line breaks at explicit @code{\break} commands and nowhere else. When
1255 @code{page-break-permission} is overridden to false, Lily will insert
1256 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1258 @lilypond[quote,verbatim]
1267 \override NonMusicalPaperColumn #'line-break-permission = ##f
1268 \override NonMusicalPaperColumn #'page-break-permission = ##f
1271 \repeat unfold 2 { c'8 c'8 c'8 c'8 } \break
1272 \repeat unfold 4 { 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 8 { c'8 c'8 c'8 c'8 } \pageBreak
1275 \repeat unfold 8 { c'8 c'8 c'8 c'8 } \break
1276 \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
1277 \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
1278 \repeat unfold 2 { c'8 c'8 c'8 c'8 }
1290 @node Using an extra voice for breaks
1291 @subsection Using an extra voice for breaks
1293 Line- and page-breaking information usually appears within note entry directly.
1298 \repeat unfold 2 @{ c'4 c'4 c'4 c'4 @}
1300 \repeat unfold 3 @{ c'4 c'4 c'4 c'4 @}
1305 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1306 music entry with information that specifies how music should lay out
1307 on the page. You can keep music entry and line- and page-breaking
1308 information in two separate places by introducing an extra voice to
1309 contain the breaks. This extra voice
1310 contains only skips together with @code{\break}, @code{pageBreak} and other
1311 breaking layout information.
1313 @lilypond[quote,verbatim]
1323 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1324 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1325 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1326 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1332 This pattern becomes especially helpful when overriding
1333 @code{line-break-system-details} and the other useful but long properties of
1334 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1336 @lilypond[quote,verbatim]
1341 \overrideProperty "Score.NonMusicalPaperColumn"
1342 #'line-break-system-details #'((Y-offset . 0))
1345 \overrideProperty "Score.NonMusicalPaperColumn"
1346 #'line-break-system-details #'((Y-offset . 35))
1349 \overrideProperty "Score.NonMusicalPaperColumn"
1350 #'line-break-system-details #'((Y-offset . 70))
1353 \overrideProperty "Score.NonMusicalPaperColumn"
1354 #'line-break-system-details #'((Y-offset . 105))
1358 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1359 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1360 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1361 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1370 @ref{Vertical spacing}.
1376 @node Vertical spacing
1377 @section Vertical spacing
1379 @cindex vertical spacing
1380 @cindex spacing, vertical
1382 Vertical spacing is controlled by three things: the amount of
1383 space available (i.e., paper size and margins), the amount of
1384 space between systems, and the amount of space between
1385 staves inside a system.
1388 * Vertical spacing inside a system::
1389 * Vertical spacing between systems::
1390 * Explicit staff and system positioning::
1391 * Vertical collision avoidance::
1395 @node Vertical spacing inside a system
1396 @subsection Vertical spacing inside a system
1398 @cindex distance between staves
1399 @cindex staff distance
1400 @cindex space between staves
1401 @cindex space inside systems
1403 The height of each system is determined in two steps. First, all of the
1404 staves are spaced according to the amount of space available. Then, the
1405 non-staff lines (eg. lyrics or chords) are distributed between the
1408 @unnumberedsubsubsec Spacing between staves
1409 Spacing between staves is controlled by the @var{next-staff-spacing}
1410 property of the @var{VerticalAxisGroup} grob. This property is an alist
1411 with four elements: @var{space}, @var{minimum-distance}, @var{padding}
1412 and @var{stretchability}:
1415 @var{space} is the size of the stretchable space between the center line
1416 of one staff to the center line of the next staff.
1419 @var{minimum-distance} provides a lower bound on the final distance
1420 between the center line of one staff to the center line of the next
1421 staff. That is, if a page has many systems and needs to be compressed,
1422 the distance from this staff to the next will never be compressed to
1423 less than @var{minimum-distance}.
1426 @var{padding} is the amount of whitespace that must be present between
1427 the bottom of one staff and the top of the next. It differs from
1428 @var{minimum-distance} in that the effect of @var{padding} depends on
1429 the height of objects in the staff. For example, @var{padding} is more
1430 likely to come into effect for staves with notes that are far below the
1434 @var{stretchability} controls the stretchable space's propensity to
1435 stretch when the system is stretched. Large values will cause a
1436 system to stretch more, while a value of zero will prevent the
1437 space from stretching at all. If unset, @var{stretchability}
1438 defaults to @code{space - minimum-distance}.
1442 #(set-global-staff-size 16)
1444 % Since space is small and there is no minimum-distance, the distance
1445 % between this staff and the next will be determined by padding.
1447 \override VerticalAxisGroup #'next-staff-spacing =
1448 #'((space . 1) (padding . 1))
1451 % Since space is small and nothing sticks out very far, the distance
1452 % between this staff and the next will be determined by minimum-distance.
1454 \override VerticalAxisGroup #'next-staff-spacing =
1455 #'((space . 1) (minimum-distance . 12))
1458 % By setting padding to a negative value, staves can be made to collide.
1460 \override VerticalAxisGroup #'next-staff-spacing =
1461 #'((space . 4) (padding . -10))
1464 \new Staff { \clef bass c, }
1469 In orchestral and other large scores, it is common to place staves in
1470 groups. The space between groups is typically larger than the space
1471 between staves of the same group. This spacing can be tweaked with the
1472 @var{StaffGrouper} grob: the default value of @var{next-staff-spacing}
1473 for @var{VerticalAxisGroup} is a callback function which operates by
1474 searching for a @var{StaffGrouper} grob containing the staff. If it
1475 finds a @var{StaffGrouper} grob and the staff in question is in the
1476 middle of a group, it reads the @var{between-staff-spacing} property of
1477 @var{StaffGrouper} and returns it. If the staff in question is the last
1478 staff of a group, the callback reads the @var{after-last-staff-spacing}
1479 property of @var{StaffGrouper} and returns it. If the callback did not
1480 find a @var{StaffGrouper} grob, it reads
1481 @var{default-next-staff-spacing} from its @var{VerticalAxisGroup} and
1485 #(set-global-staff-size 16)
1487 \new PianoStaff \with {
1488 \override StaffGrouper #'between-staff-spacing #'space = #1
1489 \override StaffGrouper #'between-staff-spacing #'padding = #0
1490 \override StaffGrouper #'after-last-staff-spacing #'space = #20
1497 \new StaffGroup \with {
1498 \override StaffGrouper #'between-staff-spacing #'space = #1
1499 \override StaffGrouper #'between-staff-spacing #'padding = #0
1509 @unnumberedsubsubsec Spacing of non-staff lines
1511 After the positions of the staves are determined, the non-staff lines
1512 are distributed between the staves. Each of these lines has a
1513 @var{staff-affinity} property which controls its vertical alignment.
1517 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #DOWN @}
1520 @noindent creates a lyrics context that will be placed close to the
1521 staff below it. Setting @var{staff-affinity} to something which is not
1522 a number (@code{#f}, for example) will cause that line to be treated
1523 like a staff. Conversely, setting @var{staff-affinity} for a staff will
1524 cause it to be treated like a non-staff.
1526 Non-staff lines admit three properties to control their spacing. Each
1527 of the these properties is an alist of the same format as
1528 @var{next-staff-spacing}, above.
1531 If the nearest line in the @var{staff-affinity} direction is a staff
1532 then @var{inter-staff-spacing} gives the spacing between the non-staff
1533 and the staff. If @var{staff-affinity} is @code{CENTER}, then
1534 @var{inter-staff-spacing} is used for both directions.
1537 If the nearest line in the @var{staff-affinity} direction is a non-staff
1538 then @var{inter-loose-line-spacing} gives the spacing between the two
1542 If the nearest line in the opposite direction to @var{staff-affinity} is
1543 a staff then @var{non-affinity-spacing} gives the spacing between the
1544 non-staff and the staff. This can be used, for example, to require
1545 a minimum amount of padding between a Lyrics line and the staff
1546 to which it does not belong.
1550 #(set-global-staff-size 16)
1554 % By default, Lyrics are placed close together. Here, we allow them to
1555 % be stretched more widely.
1556 \override VerticalAxisGroup
1557 #'inter-loose-line-spacing #'stretchability = #1000
1564 \override VerticalAxisGroup #'next-staff-spacing = #'((space . 30)) }
1567 \override VerticalAxisGroup #'staff-affinity = #UP }
1570 \override VerticalAxisGroup #'staff-affinity = #CENTER }
1571 \lyricmode { center }
1573 \override VerticalAxisGroup #'staff-affinity = #DOWN }
1584 @c @lsr{spacing,page-spacing.ly},
1585 @c @lsr{spacing,alignment-vertical-spacing.ly}.
1587 Internals Reference:
1588 @rinternals{VerticalAxisGroup},
1589 @rinternals{VerticalAlignment},
1590 @rinternals{Axis_group_engraver}.
1593 Adjacent non-staff lines should have non-increasing
1594 @var{staff-affinity} from top-to-bottom. For example, the behavior of
1598 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #DOWN @}
1599 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #UP @}
1605 A non-staff line at the bottom of a system should have
1606 @var{staff-affinity} set to @code{UP}. Similarly, a non-staff
1607 line at the top of a system should have @var{staff-affinity} set
1610 @node Vertical spacing between systems
1611 @subsection Vertical spacing between systems
1613 The mechanisms that control spacing between systems are similar to those
1614 that control spacing between staves within a system (see
1615 @ref{Vertical spacing inside a system}). The main difference is that
1616 the variables to control spacing between systems are set in the
1617 @code{\paper} block, rather than as grob properties. These paper block
1618 variables are @var{between-system-spacing},
1619 @var{between-scores-system-spacing}, @var{after-title-spacing},
1620 @var{before-title-spacing}, @var{between-title-spacing},
1621 @var{top-system-spacing}, @var{top-system-spacing},
1622 @var{top-title-spacing} and @var{bottom-system-spacing}. Note that
1623 these variables ignore non-staff lines. For example,
1624 @var{between-system-spacing} controls the spacing from the middle staff
1625 line of the bottom staff from one system to the middle staff line of the
1626 top staff of the next system, whether or not there are lyrics below the
1627 upper system. See @ref{Vertical dimensions} for a description of each
1630 There are two more @code{\paper} block variables that affect vertical
1631 spacing: if @var{ragged-bottom} is set to @code{##t} then no pages will
1632 be stretched (which means that neither the space between systems nor the
1633 space within systems will be stretched). If @var{ragged-last-bottom}
1634 is set to @code{##t} then the last page will not be stretched.
1641 @node Explicit staff and system positioning
1642 @subsection Explicit staff and system positioning
1644 One way to understand the @code{VerticalAxisGroup} and @code{\paper}
1645 settings explained in the previous two sections is as a collection of
1646 different settings that primarily concern the amount of vertical padding
1647 different staves and systems running down the page.
1649 It is possible to approach vertical spacing in a different way using
1650 @code{NonMusicalPaperColumn #'line-break-system-details}. Where
1651 @code{VerticalAxisGroup} and @code{\paper} settings specify vertical padding,
1652 @code{NonMusicalPaperColumn #'line-break-system-details} specifies exact
1653 vertical positions on the page.
1655 @code{NonMusicalPaperColumn #'line-break-system-details} accepts an associative
1656 list of three different settings:
1659 @item @code{X-offset}
1660 @item @code{Y-offset}
1661 @item @code{alignment-distances}
1664 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
1665 below, can occur in any of three different places in an input file:
1668 @item in the middle of note entry directly
1669 @item in a @code{\context} block
1670 @item in the @code{\with} block
1673 When we override @code{NonMusicalPaperColumn}, we use the usual
1674 @code{\override} command in @code{\context} blocks and in the
1675 @code{\with} block. On the other hand, when we override
1676 @code{NonMusicalPaperColumn} in the middle of note entry,
1677 use the special @code{\overrideProperty} command. Here are some
1678 example @code{NonMusicalPaperColumn} overrides with the special
1679 @code{\overrideProperty} command:
1682 \overrideProperty NonMusicalPaperColumn
1683 #'line-break-system-details #'((X-offset . 20))
1685 \overrideProperty NonMusicalPaperColumn
1686 #'line-break-system-details #'((Y-offset . 40))
1688 \overrideProperty NonMusicalPaperColumn
1689 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40))
1691 \overrideProperty NonMusicalPaperColumn
1692 #'line-break-system-details #'((alignment-distances . (15)))
1694 \overrideProperty NonMusicalPaperColumn
1695 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40)
1696 (alignment-distances . (15)))
1699 To understand how each of these different settings work, we begin
1700 by looking at an example that includes no overrides at all.
1702 @c \book { } is required in these examples to ensure the spacing
1703 @c overrides can be seen between systems. -np
1706 \header { tagline = ##f }
1707 \paper { left-margin = 0\mm }
1717 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1720 \repeat unfold 15 { d'4 d' d' d' }
1727 This score isolates line- and page-breaking information in a dedicated
1728 voice. This technique of creating a breaks voice will help keep layout
1729 separate from music entry as our example becomes more complicated.
1730 See @ref{Using an extra voice for breaks}.
1732 Explicit @code{\breaks} evenly divide the music into six measures per
1733 line. Vertical spacing results from LilyPond's defaults. To set
1734 the vertical startpoint of each system explicitly, we can set
1735 the @code{Y-offset} pair in the @code{line-break-system-details}
1736 attribute of the @code{NonMusicalPaperColumn} grob:
1739 \header { tagline = ##f }
1740 \paper { left-margin = 0\mm }
1746 \overrideProperty #"Score.NonMusicalPaperColumn"
1747 #'line-break-system-details #'((Y-offset . 0))
1749 \overrideProperty #"Score.NonMusicalPaperColumn"
1750 #'line-break-system-details #'((Y-offset . 40))
1752 \overrideProperty #"Score.NonMusicalPaperColumn"
1753 #'line-break-system-details #'((Y-offset . 80))
1756 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1759 \repeat unfold 15 { d'4 d' d' d' }
1766 Note that @code{line-break-system-details} takes an associative list of
1767 potentially many values, but that we set only one value here. Note,
1768 too, that the @code{Y-offset} property here determines the exact vertical
1769 position on the page at which each new system will render.
1771 Now that we have set the vertical startpoint of each system
1772 explicitly, we can also set the vertical distances between staves
1773 within each system manually. We do this using the @code{alignment-distances}
1774 subproperty of @code{line-break-system-details}.
1777 \header { tagline = ##f }
1778 \paper { left-margin = 0\mm }
1784 \overrideProperty #"Score.NonMusicalPaperColumn"
1785 #'line-break-system-details #'((Y-offset . 20)
1786 (alignment-distances . (15)))
1788 \overrideProperty #"Score.NonMusicalPaperColumn"
1789 #'line-break-system-details #'((Y-offset . 60)
1790 (alignment-distances . (15)))
1792 \overrideProperty #"Score.NonMusicalPaperColumn"
1793 #'line-break-system-details #'((Y-offset . 100)
1794 (alignment-distances . (15)))
1797 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1800 \repeat unfold 15 { d'4 d' d' d' }
1807 Note that here we assign two different values to the
1808 @code{line-break-system-details} attribute of the
1809 @code{NonMusicalPaperColumn} grob. Though the
1810 @code{line-break-system-details} attribute alist accepts many
1811 additional spacing parameters (including, for example, a corresponding
1812 @code{X-offset} pair), we need only set the @code{Y-offset} and
1813 @code{alignment-distances} pairs to control the vertical startpoint of
1814 every system and every staff. Finally, note that @code{alignment-distances}
1815 specifies the vertical positioning of staves but not of staff groups.
1818 \header { tagline = ##f }
1819 \paper { left-margin = 0\mm }
1825 \overrideProperty #"Score.NonMusicalPaperColumn"
1826 #'line-break-system-details #'((Y-offset . 0)
1827 (alignment-distances . (30 10)))
1829 \overrideProperty #"Score.NonMusicalPaperColumn"
1830 #'line-break-system-details #'((Y-offset . 60)
1831 (alignment-distances . (10 10)))
1833 \overrideProperty #"Score.NonMusicalPaperColumn"
1834 #'line-break-system-details #'((Y-offset . 100)
1835 (alignment-distances . (10 30)))
1838 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1841 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
1842 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
1849 Some points to consider:
1852 @item When using @code{alignment-distances}, lyrics and other non-staff lines
1853 do not count as a staff.
1855 @item The units of the numbers passed to @code{X-offset},
1856 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
1857 of the distance between adjacent staff lines. Positive values move staves
1858 and lyrics up, negative values move staves and lyrics down.
1860 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
1861 settings given here allow the positioning of staves and systems anywhere
1862 on the page, it is possible to violate paper or margin boundaries or even
1863 to print staves or systems on top of one another. Reasonable values
1864 passed to these different settings will avoid this.
1873 @node Vertical collision avoidance
1874 @subsection Vertical collision avoidance
1876 @funindex outside-staff-priority
1877 @funindex outside-staff-padding
1878 @funindex outside-staff-horizontal-padding
1880 Intuitively, there are some objects in musical notation that belong
1881 to the staff and there are other objects that should be placed outside
1882 the staff. Objects belonging outside the staff include things such as
1883 rehearsal marks, text and dynamic markings (from now on, these will
1884 be called outside-staff objects). LilyPond's rule for the
1885 vertical placement of outside-staff objects is to place them as close
1886 to the staff as possible but not so close that they collide with
1889 LilyPond uses the @code{outside-staff-priority} property to determine
1890 whether a grob is an outside-staff object: if @code{outside-staff-priority}
1891 is a number, the grob is an outside-staff object. In addition,
1892 @code{outside-staff-priority} tells LilyPond in which order the objects
1895 First, LilyPond places all the objects that do not belong outside
1896 the staff. Then it sorts the outside-staff objects according to their
1897 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
1898 takes the outside-staff objects and places them so that they do
1899 not collide with any objects that have already been placed. That
1900 is, if two outside-staff grobs are competing for the same space, the one
1901 with the lower @code{outside-staff-priority} will be placed closer to
1904 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1907 \once \override TextScript #'outside-staff-priority = #1
1908 c4_"Text"\pp % this time the text will be closer to the staff
1910 % by setting outside-staff-priority to a non-number,
1911 % we disable the automatic collision avoidance
1912 \once \override TextScript #'outside-staff-priority = ##f
1913 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
1914 c4_"Text"\pp % now they will collide
1917 The vertical padding between an outside-staff object and the
1918 previously-positioned grobs can be controlled with
1919 @code{outside-staff-padding}.
1921 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1922 \once \override TextScript #'outside-staff-padding = #0
1923 a'^"This text is placed very close to the note"
1924 \once \override TextScript #'outside-staff-padding = #3
1925 c^"This text is padded away from the previous text"
1926 c^"This text is placed close to the previous text"
1930 By default, outside-staff objects are placed only to avoid
1931 a horizontal collision with previously-positioned grobs. This
1932 can lead to situations in which objects are placed very close to each
1933 other horizontally. The vertical spacing between staffs can
1934 also be set so that outside staff objects are interleaved.
1935 Setting @code{outside-staff-horizontal-padding}
1936 causes an object to be offset vertically so that such a situation
1939 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1940 % the markup is too close to the following note
1944 % setting outside-staff-horizontal-padding fixes this
1946 \once \override TextScript #'outside-staff-horizontal-padding = #1
1958 @node Horizontal spacing
1959 @section Horizontal spacing
1961 @cindex horizontal spacing
1962 @cindex spacing, horizontal
1965 * Horizontal spacing overview::
1966 * New spacing area::
1967 * Changing horizontal spacing::
1969 * Proportional notation::
1973 @node Horizontal spacing overview
1974 @subsection Horizontal spacing overview
1976 The spacing engine translates differences in durations into stretchable
1977 distances (@q{springs}) of differing lengths. Longer durations get
1978 more space, shorter durations get less. The shortest durations get a
1979 fixed amount of space (which is controlled by
1980 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
1981 object). The longer the duration, the more space it gets: doubling a
1982 duration adds a fixed amount (this amount is controlled by
1983 @code{spacing-increment}) of space to the note.
1985 For example, the following piece contains lots of half, quarter, and
1986 8th notes; the eighth note is followed by 1 note head width (NHW).
1987 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
1989 @lilypond[quote,fragment,verbatim,relative=1]
1990 c2 c4. c8 c4. c8 c4. c8 c8
1994 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
1995 approximately the width of a note head, and
1996 @code{shortest-duration-space} is set to 2.0, meaning that the
1997 shortest note gets 2.4 staff space (2.0 times the
1998 @code{spacing-increment}) of horizontal space. This space is counted
1999 from the left edge of the symbol, so the shortest notes are generally
2000 followed by one NHW of space.
2002 If one would follow the above procedure exactly, then adding a single
2003 32nd note to a score that uses 8th and 16th notes, would widen up the
2004 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2005 thus adding 1 NHW to every note. To prevent this, the shortest
2006 duration for spacing is not the shortest note in the score, but rather
2007 the one which occurs most frequently.
2010 The most common shortest duration is determined as follows: in every
2011 measure, the shortest duration is determined. The most common shortest
2012 duration is taken as the basis for the spacing, with the stipulation
2013 that this shortest duration should always be equal to or shorter than
2014 an 8th note. The shortest duration is printed when you run
2015 @code{lilypond} with the @code{--verbose} option.
2017 These durations may also be customized. If you set the
2018 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2019 this sets the base duration for spacing. The maximum duration for this
2020 base (normally an 8th), is set through @code{base-shortest-duration}.
2022 @funindex common-shortest-duration
2023 @funindex base-shortest-duration
2024 @funindex stem-spacing-correction
2027 Notes that are even shorter than the common shortest note are
2028 followed by a space that is proportional to their duration relative to
2029 the common shortest note. So if we were to add only a few 16th notes
2030 to the example above, they would be followed by half a NHW:
2032 @lilypond[quote,fragment,verbatim,relative=2]
2033 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2037 In the @emph{Essay on automated music engraving}, it was explained
2038 that stem directions influence spacing (see @ressay{Optical
2039 spacing}). This is controlled with the
2040 @code{stem-spacing-correction} property in the
2041 @rinternals{NoteSpacing}, object. These are generated for every
2042 @rinternals{Voice} context. The @code{StaffSpacing} object
2043 (generated in @rinternals{Staff} context) contains the same
2044 property for controlling the stem/bar line spacing. The following
2045 example shows these corrections, once with default settings, and
2046 once with exaggerated corrections:
2048 @lilypond[quote,ragged-right]
2052 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2053 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2059 Proportional notation is supported; see @ref{Proportional notation}.
2066 Internals Reference:
2067 @rinternals{SpacingSpanner},
2068 @rinternals{NoteSpacing},
2069 @rinternals{StaffSpacing},
2070 @rinternals{NonMusicalPaperColumn}.
2075 There is no convenient mechanism to manually override spacing. The
2076 following work-around may be used to insert extra space into a score,
2077 adjusting the padding value as necessary.
2079 \override Score.NonMusicalPaperColumn #'padding = #10
2082 No work-around exists for decreasing the amount of space.
2085 @node New spacing area
2086 @subsection New spacing area
2088 New sections with different spacing parameters can be started with
2089 @code{newSpacingSection}. This is useful when there are
2090 sections with a different notions of long and short notes.
2092 In the following example, the time signature change introduces a new
2093 section, and hence the 16ths notes are spaced wider.
2095 @lilypond[relative,fragment,verbatim,quote]
2098 c8 c c4 c16[ c c8] c4
2104 The @code{\newSpacingSection} command creates a new
2105 @code{SpacingSpanner} object, and hence new @code{\override}s
2106 may be used in that location.
2113 Internals Reference:
2114 @rinternals{SpacingSpanner}.
2117 @node Changing horizontal spacing
2118 @subsection Changing horizontal spacing
2120 Horizontal spacing may be altered with the
2121 @code{base-shortest-duration} property. Here
2122 we compare the same music; once without altering
2123 the property, and then altered. Larger values
2124 of @code{ly:make-moment} will produce smaller
2125 music. Note that @code{ly:make-moment} constructs
2126 a duration, so @code{1 4} is a longer duration
2129 @lilypond[verbatim,line-width=12\cm]
2132 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2133 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2134 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2135 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2140 @lilypond[verbatim,line-width=12\cm]
2143 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2144 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2145 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2146 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2151 \override SpacingSpanner
2152 #'base-shortest-duration = #(ly:make-moment 1 16)
2161 By default, spacing in tuplets depends on various non-duration
2162 factors (such as accidentals, clef changes, etc). To disregard
2163 such symbols and force uniform equal-duration spacing, use
2164 @code{Score.SpacingSpanner #'uniform-stretching}. This
2165 property can only be changed at the beginning of a score,
2167 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
2169 \override SpacingSpanner #'uniform-stretching = ##t
2186 When @code{strict-note-spacing} is set, notes are spaced without
2187 regard for clefs, bar lines, and grace notes,
2189 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
2190 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2191 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2201 @subsection Line length
2204 @cindex breaking pages
2207 @funindex line-width
2208 @funindex ragged-right
2209 @funindex ragged-last
2211 @c Although line-width can be set in \layout, it should be set in paper
2212 @c block, to get page layout right.
2213 @c Setting indent in \paper block makes not much sense, but it works.
2215 @c Bit verbose and vague, use examples?
2216 The most basic settings influencing the spacing are @code{indent} and
2217 @code{line-width}. They are set in the @code{\layout} block. They
2218 control the indentation of the first line of music, and the lengths of
2221 If @code{ragged-right} is set to true in the @code{\layout} block, then
2222 systems ends at their natural horizontal length, instead of being spread
2223 horizontally to fill the whole line. This is useful for
2224 short fragments, and for checking how tight the natural spacing is.
2225 The normal default setting is false, but if the score has only one
2226 system the default value is true.
2229 @cindex vertical spacing
2231 The option @code{ragged-last} is similar to @code{ragged-right}, but
2232 only affects the last line of the piece. No restrictions are put on
2233 that line. The result is similar to formatting text paragraphs. In a
2234 paragraph, the last line simply takes its natural horizontal length.
2235 @c Note that for text there are several options for the last line.
2236 @c While Knuth TeX uses natural length, lead typesetters use the same
2237 @c stretch as the previous line. eTeX uses \lastlinefit to
2238 @c interpolate between both these solutions.
2254 @node Proportional notation
2255 @subsection Proportional notation
2257 LilyPond supports proportional notation, a type of horizontal spacing
2258 in which each note consumes an amount of horizontal space exactly
2259 equivalent to its rhythmic duration. This type of proportional spacing
2260 is comparable to horizontal spacing on top of graph paper. Some late
2261 20th- and early 21st-century scores use proportional notation to
2262 clarify complex rhythmic relationships or to facilitate the placement
2263 of timelines or other graphics directly in the score.
2265 LilyPond supports five different settings for proportional notation,
2266 which may be used together or alone:
2269 @item @code{proportionalNotationDuration}
2270 @item @code{uniform-stretching}
2271 @item @code{strict-note-spacing}
2272 @item @code{\remove Separating_line_group_engraver}
2273 @item @code{\override PaperColumn #'used = ##t}
2276 In the examples that follow, we explore these five different
2277 proportional notation settings and examine how these settings interact.
2279 We start with the following one-measure example, which uses classical
2280 spacing with ragged-right turned on.
2282 @lilypond[quote,verbatim,ragged-right]
2284 \new RhythmicStaff {
2288 c'16 c'16 c'16 c'16 c'16
2294 Notice that the half note which begins the measure takes up far less
2295 than half of the horizontal space of the measure. Likewise, the
2296 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
2297 which end the measure together take up far more than half the
2298 horizontal space of the measure.
2300 In classical engraving, this spacing may be exactly what we want
2301 because we can borrow horizontal space from the half note and conserve
2302 horizontal space across the measure as a whole.
2304 On the other hand, if we want to insert a measured timeline or other
2305 graphic above or below our score, we need proportional notation. We
2306 turn proportional notation on with the proportionalNotationDuration
2309 @lilypond[quote,verbatim,ragged-right]
2311 proportionalNotationDuration = #(ly:make-moment 1 20)
2313 \new RhythmicStaff {
2317 c'16 c'16 c'16 c'16 c'16
2323 The half note at the beginning of the measure and the faster notes in
2324 the second half of the measure now occupy equal amounts of horizontal
2325 space. We could place a measured timeline or graphic above or below
2328 The @code{proportionalNotationDuration} setting is a context setting that
2329 lives in @code{Score}. Recall that context settings appear in one of
2330 three locations in our input file -- in a @code{\with} block, in a
2331 @code{\context} block, or directly in music entry
2332 preceded by the @code{\set} command. As with all
2333 context settings, users can pick which of the three different
2334 locations they would like to set @code{proportionalNotationDuration}.
2336 The @code{proportionalNotationDuration} setting takes a single argument,
2337 which is the reference duration against which all music will be
2338 spaced. The LilyPond Scheme function make-moment takes two arguments
2339 -- a numerator and denominator which together express some fraction of
2340 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces a
2341 reference duration of a twentieth note. The values
2342 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
2343 @code{#(ly:make-moment 3 97)} are all possible as well.
2345 How do we select the right reference duration to pass to
2346 @code{proportionalNotationDuration}? Usually by a process of trial and error,
2347 beginning with a duration close to the fastest (or smallest) duration
2348 in the piece. Smaller reference durations space music loosely; larger
2349 reference durations space music tightly.
2351 @lilypond[quote,verbatim,ragged-right]
2353 proportionalNotationDuration = #(ly:make-moment 1 8)
2355 \new RhythmicStaff {
2359 c'16 c'16 c'16 c'16 c'16
2365 proportionalNotationDuration = #(ly:make-moment 1 16)
2367 \new RhythmicStaff {
2371 c'16 c'16 c'16 c'16 c'16
2377 proportionalNotationDuration = #(ly:make-moment 1 32)
2379 \new RhythmicStaff {
2383 c'16 c'16 c'16 c'16 c'16
2389 Note that too large a reference duration -- such as the eighth note,
2390 above -- spaces music too tightly and can cause note head collisions.
2391 Note also that proportional notation in general takes up more
2392 horizontal space that does classical spacing. Proportional spacing
2393 provides rhythmic clarity at the expense of horizontal space.
2395 Next we examine how to optimally space overlapping tuplets.
2397 We start by examining what happens to our original example, with
2398 classical spacing, when we add a second staff with a different type of
2401 @lilypond[quote,verbatim,ragged-right]
2403 \new RhythmicStaff {
2407 c'16 c'16 c'16 c'16 c'16
2410 \new RhythmicStaff {
2412 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2418 The spacing is bad because the evenly notes of the bottom staff do not
2419 stretch uniformly. Classical engraving includes very few complex
2420 triplets and so classical engraving rules can generate this type of
2421 result. Setting @code{proportionalNotationDuration} remedies this
2422 situation considerably.
2424 @lilypond[quote,verbatim,ragged-right]
2426 proportionalNotationDuration = #(ly:make-moment 1 20)
2428 \new RhythmicStaff {
2432 c'16 c'16 c'16 c'16 c'16
2435 \new RhythmicStaff {
2437 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2443 But if we look very carefully we can see that notes of the second half
2444 of the 9-tuplet space ever so slightly more widely than do the notes
2445 of the first half of the 9-tuplet. To ensure uniform stretching, we
2446 turn on @code{uniform-stretching}, which is a property of
2447 @code{SpacingSpanner}.
2449 @lilypond[quote,verbatim,ragged-right]
2451 proportionalNotationDuration = #(ly:make-moment 1 20)
2452 \override SpacingSpanner #'uniform-stretching = ##t
2454 \new RhythmicStaff {
2458 c'16 c'16 c'16 c'16 c'16
2461 \new RhythmicStaff {
2463 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2469 Our two-staff example now spaces exactly, our rhythmic
2470 relationships are visually clear, and we can include a measured
2471 timeline or graphic if we want.
2473 Note that the LilyPond's proportional notation package expects
2474 that all proportional scores set the SpacingSpanner's
2475 'uniform-stretching attribute to ##t. Setting
2476 proportionalNotationDuration without also setting the
2477 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
2478 example, cause Skips to consume an incorrect amount of horizontal
2481 The SpacingSpanner is an abstract grob that lives in the Score
2482 context. As with our settings of proportionalNotationDuration,
2483 overrides to the SpacingSpanner can occur in any of three
2484 different places in our input file – in the Score \with block, in
2485 a Score \context block, or in note entry directly.
2487 There is by default only one @code{SpacingSpanner} per @code{Score}. This
2488 means that, by default, @code{uniform-stretching} is either turned on for the
2489 entire score or turned off for the entire score. We can, however,
2490 override this behavior and turn on different spacing features at
2491 different places in the score. We do this with the command
2492 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
2494 Next we examine the effects of the @code{Separating_line_group_engraver} and
2495 see why proportional scores frequently remove this engraver. The following
2496 example shows that there is a small amount of @qq{preferatory} space
2497 just before the first note in each system.
2499 @lilypond[quote,verbatim,ragged-right]
2512 The amount of this preferatory space is the same whether after a time
2513 signature, a key signature or a clef. @code{Separating_line_group_engraver}
2514 is responsible for this space. Removing @code{Separating_line_group_engraver}
2515 reduces this space to zero.
2517 @lilypond[quote,verbatim,ragged-right]
2523 \remove Separating_line_group_engraver
2531 Nonmusical elements like time signatures, key signatures, clefs and
2532 accidentals are problematic in proportional notation. None of these
2533 elements has rhythmic duration. But all of these elements consume
2534 horizontal space. Different proportional scores approach these
2535 problems differently.
2537 It may be possible to avoid spacing problems with key signatures
2538 simply by not having any. This is a valid option since most
2539 proportional scores are contemporary music. The same may be true
2540 of time signatures, especially for those scores
2541 that include a measured timeline or other graphic. But these scores
2542 are exceptional and most proportional scores include at least some
2543 time signatures. Clefs and accidentals are even more essential.
2545 So what strategies exist for spacing nonmusical elements in a
2546 proportional context? One good option is the @code{strict-note-spacing}
2547 property of @code{SpacingSpanner}. Compare the two scores below:
2549 @lilypond[quote,verbatim,ragged-right]
2551 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
2561 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
2562 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2572 Both scores are proportional, but the spacing in the first score
2573 is too loose because of the clef change. The spacing of the second
2574 score remains strict, however, because strict-note-spacing is
2575 turned on. Turning on strict-note-spacing causes the width of
2576 time signatures, key signatures, clefs and accidentals to play no
2577 part in the spacing algorithm.
2579 In addition to the settings given here, there are other settings
2580 that frequently appear in proportional scores. These include:
2583 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
2584 @item @code{tupletFullLength = ##t}
2585 @item @code{\override Beam #'breakable = ##t}
2586 @item @code{\override Glissando #'breakable = ##t}
2587 @item @code{\override TextSpanner #'breakable = ##t}
2588 @item @code{\remove Forbid_line_break_engraver in the Voice context}
2591 These settings space grace notes strictly, extend tuplet brackets to
2592 mark both rhythmic start- and stop-points, and allow spanning elements
2593 to break across systems and pages. See the respective parts of the manual
2594 for these related settings.
2599 @ref{New spacing area}.
2605 @node Fitting music onto fewer pages
2606 @section Fitting music onto fewer pages
2608 Sometimes you can end up with one or two staves on a second
2609 (or third, or fourth...) page. This is annoying, especially
2610 if you look at previous pages and it looks like there is plenty
2611 of room left on those.
2613 When investigating layout issues, @code{annotate-spacing} is an
2614 invaluable tool. This command prints the values of various layout
2615 spacing variables; for more details see the following section,
2616 @ref{Displaying spacing}.
2619 * Displaying spacing::
2620 * Changing spacing::
2624 @node Displaying spacing
2625 @subsection Displaying spacing
2627 @funindex annotate-spacing
2628 @cindex spacing, display of layout
2630 To graphically display the dimensions of vertical layout variables
2631 that may be altered for page formatting, set
2632 @code{annotate-spacing} in the @code{\paper} block:
2634 @c need to have \book{} otherwise we get the separate systems. -hwn
2635 @lilypond[verbatim,quote]
2636 #(set-default-paper-size "a6" 'landscape)
2639 \paper { annotate-spacing = ##t }
2645 All layout dimensions are displayed in staff-spaces, regardless
2646 of the units specified in the @code{\paper} or @code{\layout} block.
2647 In the above example, @code{paper-height} has a value of 59.75
2648 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
2649 default value). Note that:
2651 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
2654 @tab = (25.4/72.27) mm
2657 @tab = (@code{staff-size})/4 pts
2659 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
2664 In this case, one @code{staff-space} is approximately equal to
2665 1.757mm. Thus the @code{paper-height} measurement of 59.75
2666 @code{staff-spaces} is equivalent to 105 millimeters, the height
2667 of @code{a6} paper in landscape orientation. The pairs
2668 (@var{a},@var{b}) are intervals, where @var{a} is the lower
2669 edge and @var{b} the upper edge of the interval.
2674 @ref{Setting the staff size}.
2680 @node Changing spacing
2681 @subsection Changing spacing
2683 The output of @code{annotate-spacing} reveals vertical dimensions
2684 in great detail. For details about modifying margins and other
2685 layout variables, see @ref{Page formatting}.
2687 Other than margins, there are a few other options to save space:
2691 Force systems to move as close together as possible (to fit as
2692 many systems as possible onto a page) while being spaced so that
2693 there is no blank space at the bottom of the page.
2697 between-system-spacing = #'((padding . 0) (space . 0.1))
2698 ragged-last-bottom = ##f
2704 Force the number of systems. This can help in two ways. Just
2705 setting a value, even the same value as the number of systems
2706 being typeset by default, will sometimes cause more systems to
2707 be fitted onto each page, as an estimation step is then bypassed,
2708 giving a more accurate fit to each page. Also, forcing an actual
2709 reduction in the number of systems may save a further page. For
2710 example, if the default layout has 11 systems, the following
2711 assignment will force a layout with 10 systems.
2720 Avoid (or reduce) objects that increase the vertical size of a
2721 system. For example, volta repeats (or alternate repeats) require
2722 extra space. If these repeats are spread over two systems, they
2723 will take up more space than one system with the volta repeats and
2724 another system without. For example, dynamics that @q{stick out} of
2725 a system can be moved closer to the staff:
2727 @lilypond[verbatim,quote,relative=1]
2729 \override DynamicText #'extra-offset = #'( -2.2 . 2.0)
2734 Alter the horizontal spacing via @code{SpacingSpanner}. For more
2735 details, see @ref{Changing horizontal spacing}. The following
2736 example illustrates the default spacing:
2738 @lilypond[verbatim,quote]
2751 The next example modifies @code{common-shortest-duration} from a
2752 value of @code{1/4} to @code{1/2}. The quarter note is the most
2753 common and shortest duration in this example, so by making this
2754 duration longer, a @q{squeezing} effect occurs:
2756 @lilypond[verbatim,quote]
2768 \override SpacingSpanner
2769 #'common-shortest-duration = #(ly:make-moment 1 2)
2776 The @code{common-shortest-duration} property cannot be modified
2777 dynamically, so it must always be placed in a @code{\context}
2778 block so that it applies to the whole score.
2785 @ref{Page formatting},
2786 @ref{Changing horizontal spacing}.