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 For example, the default is:
228 after-title-spacing = #'((space . 2) (padding . 0.5))
232 If a page has a ragged bottom, @var{space} is not stretched. In particular, the
233 resulting distance on such a page is the largest of
236 @item @var{minimum-distance}, and
237 @item @var{padding} plus the smallest distance necessary to eliminate overlap.
240 @item before-title-spacing
241 @funindex before-title-spacing
243 Specifies the spacing between a system and the title (or top-level markup) that
245 The distances are measured from the center of the last staff in the system to
246 the baseline of the title that follows it. See @var{after-title-spacing}.
248 @item between-scores-system-spacing
249 @funindex between-scores-system-spacing
251 Specifies the spacing between two systems if they are in different scores, but
252 there is no title between them. See @var{after-title-spacing}.
254 @item between-system-spacing
255 @funindex between-system-spacing
257 Specifies the spacing between the center of the bottom staff of one system
258 and the center of the top staff of the following system. See @var{after-title-spacing}.
260 @item between-title-spacing
261 @funindex between-title-spacing
263 Specifies the spacing between two titles (or top-level markups).
264 The distances are measured from the baseline of the first title to the baseline
265 of the second. See @var{after-title-spacing}.
268 @funindex bottom-margin
270 The margin between footer and bottom of the page. Default:
273 @item bottom-system-spacing
274 @funindex bottom-system-spacing
276 Specifies the spacing from the center of the last staff (or the
277 baseline of the last top-level markup) to the bottom of the
278 printable area (ie. the top of the bottom margin).
279 See @var{after-title-spacing}.
281 @item top-title-spacing
282 @funindex top-title-spacing
284 Specifies the spacing from the top of the printable area (ie.
285 the bottom of the top margin) to the baseline of the title.
286 See @var{after-title-spacing}.
288 @item top-system-spacing
289 @funindex top-system-spacing
291 Specifies the spacing from the top of the printable area (ie.
292 the bottom of the top margin) to the center of the first staff.
293 This only takes effect if there is no title at the top of the
294 page (in which case @var{top-title-spacing} is used instead).
295 See @var{after-title-spacing}.
298 @funindex paper-height
300 The height of the page. Default: the height of the current paper
301 size. For details, see @ref{Paper size}.
306 The margin between header and top of the page. Default:
314 The header and footer are created by the functions make-footer and
315 make-header, defined in \paper. The default implementations are in
316 ly/paper-defaults.ly and ly/titling-init.ly.
318 The page layout itself is done by two functions in the \paper block,
319 page-music-height and page-make-stencil. The former tells the
320 line-breaking algorithm how much space can be spent on a page, the
321 latter creates the actual page given the system to put on it.
323 You can define paper block values in Scheme. In that case mm, in, pt,
324 and cm are variables defined in paper-defaults.ly with values in
325 millimeters. That is why the value 2 cm must be multiplied in the
330 #(define bottom-margin (* 2 cm))
342 ragged-last-bottom = ##t
346 This second example centers page numbers at the bottom of every page.
350 print-page-number = ##t
351 print-first-page-number = ##t
352 oddHeaderMarkup = \markup \fill-line @{ " " @}
353 evenHeaderMarkup = \markup \fill-line @{ " " @}
354 oddFooterMarkup = \markup @{ \fill-line @{
355 \bold \fontsize #3 \on-the-fly #print-page-number-check-first
356 \fromproperty #'page:page-number-string @} @}
357 evenFooterMarkup = \markup @{ \fill-line @{
358 \bold \fontsize #3 \on-the-fly #print-page-number-check-first
359 \fromproperty #'page:page-number-string @} @}
363 You can also define these values in Scheme. In that case @code{mm},
364 @code{in}, @code{pt}, and @code{cm} are variables defined in
365 @file{paper@/-defaults@/-init@/.ly} with values in millimeters. That is why the
366 value must be multiplied in the example
370 #(define bottom-margin (* 2 cm))
374 The header and footer are created by the functions @code{make-footer}
375 and @code{make-header}, defined in @code{\paper}. The default
376 implementations are in @file{ly/@/paper@/-defaults@/-init@/.ly} and
377 @file{ly/@/titling@/-init@/.ly}.
379 The page layout itself is done by two functions in the
380 @code{\paper} block, @code{page-music-height} and
381 @code{page-make-stencil}. The former tells the line-breaking algorithm
382 how much space can be spent on a page, the latter creates the actual
383 page given the system to put on it.
388 @ref{Vertical spacing between systems}.
394 @node Horizontal dimensions
395 @unnumberedsubsubsec Horizontal dimensions
398 There are a few variables that determine the horizontal dimensions
404 @funindex binding-offset
406 The amount @code{inner-margin} is increased
407 to make sure nothing will be hidden by the binding.
408 Works only with @code{two-sided} set to true. Default:
411 @item horizontal-shift
412 @funindex horizontal-shift
414 The amount that all systems (including titles and system
415 separators) are shifted to the right. Default: @code{0.0}.
420 The level of indentation for the first system in a score.
421 Default: @code{15\mm}.
424 @funindex inner-margin
426 The margin all pages have at the inner side if they are part
427 of a book. Works only with @code{two-sided} set to true.
428 Default: @code{10\mm}.
431 @funindex left-margin
433 The margin between the left edge of the page and the beginning of
434 each system. Default: @code{10\mm}.
439 The width of music systems. Default: @code{paper-width} minus
440 @code{left-margin} and @code{right-margin}.
443 @funindex outer-margin
445 The margin all pages have at the outer side if they are part
446 of a book. Works only with @code{two-sided} set to true.
447 Default: @code{20\mm}.
450 @funindex paper-width
452 The width of the page. Default: the width of the current paper
453 size. For details, see @ref{Paper size}.
456 @funindex right-margin
458 The margin between the right edge of the page and the end of
459 each system. Default: @code{10\mm}.
462 @funindex short-indent
464 The level of indentation for all systems in a score besides the
465 first system. Default: @code{0}.
469 If some values are not set, defaults will be taken. Their exact
470 value is adjusted, depending on the paper size specified. Currently,
471 the following values are affected by this scaling:
474 @item @var{left-margin}
475 @item @var{right-margin}
476 @item @var{top-margin}
477 @item @var{bottom-margin}
478 @item @var{head-separation}
479 @item @var{foot-separation}
481 @item @var{short-indent}
484 The settings for @code{line-width}, @code{left-margin},
485 @code{right-margin} and @code{paper-width} depend on
486 each other, but they do not have to be specified
495 In this example, only @code{left-margin} is set. The value for
496 @code{right-margin} will remain default, @code{line-width} is
497 calculated automatically.
505 Here @code{left-margin} and @code{right-margin} will be set
506 to the same value. Therefore, @code{line-width} is subtracted
507 from @code{paper-width} and divided by two. That means systems
508 are centered on the page, if only @code{line-width} is
511 Some checks occur to ensure the values are set correctly.
512 If the values do not match or systems would run off the page,
513 a warning is printed and default values are set.
524 These checks can be avoided by setting @code{check-consistency}
532 check-consistency = ##f
536 @warning{If @code{paper-width} is manually set, @code{line-width},
537 @code{left-margin}, @code{indent}, and @code{short-indent} may
538 have to be adjusted as well.}
546 @node Other layout variables
547 @unnumberedsubsubsec Other layout variables
549 These variables can be used to adjust page layout in general.
553 @item auto-first-page-number
554 @funindex auto-first-page-number
556 The page breaking algorithm is affected by the first page number
557 being odd or even. If set to true, the page breaking algorithm
558 will decide whether to start with an odd or even number. This
559 will result in the first page number remaining as is or being
560 increased by one. Default: @code{##f}.
564 TODO: this variable is used, but I don't know what it does. -pm
565 @item blank-after-score-page-force
566 @funindex blank-after-score-page-force
572 @item blank-last-page-force
573 @funindex blank-last-page-force
575 The penalty for ending the score on an odd-numbered page.
578 @item blank-page-force
579 @funindex blank-page-force
581 The penalty for having a blank page in the middle of a
582 score. This is not used by @code{ly:optimal-breaking} since it will
583 never consider blank pages in the middle of a score. Default:
586 @item check-consistency
587 @funindex check-consistency
589 If set to true, check whether @code{left-margin}, @code{right-margin} and
590 @code{line-width} fit each other. Also make sure that their combination
591 does not exceed the available @code{paper-width}. Default: @code{##t}.
593 @item first-page-number
594 @funindex first-page-number
596 The value of the page number on the first page. Default:
599 @item max-systems-per-page
600 The maximum number of systems that will be placed on a page. This
601 is currently supported only by the @code{ly:optimal-breaking} algorithm.
604 @item min-systems-per-page
605 The minimum number of systems that will be placed on a page. This
606 may cause pages to be overfilled if it is made too large. This is
607 currently supported only by the @code{ly:optimal-breaking} algorithm.
610 @item page-breaking-between-system-padding
611 @funindex page-breaking-between-system-padding
613 Tricks the page breaker into thinking that
614 @code{between-system-padding} is set to something different than
615 it really is. For example, if this variable is set to something
616 substantially larger than @code{between-system-padding}, then the
617 page-breaker will put fewer systems on each page. Default: unset.
622 The number of pages to be used for a score. Default: unset.
624 @item page-limit-inter-system-space
625 @funindex page-limit-inter-system-space
627 If set to true, limits space between systems on a page with a lot
628 of space left. Default: @code{##f}. For details, see
629 @ref{Vertical spacing between systems}.
631 @item page-limit-inter-system-space-factor
632 @funindex page-limit-inter-system-space-factor
634 The factor used by @code{page-limit-inter-system-space}. Default:
635 @code{1.4}. For details, see
636 @ref{Vertical spacing between systems}.
638 @item page-spacing-weight
639 @funindex page-spacing-weight
641 The relative importance of page (vertical) spacing and line
642 (horizontal) spacing. High values will make page spacing more
643 important. Default: @code{#10}.
645 @item print-all-headers
646 @funindex print-all-headers
648 If set to true, this will print all headers for each \score in the
649 output. Normally only the piece and opus header variables are
650 printed. Default: @code{##f}.
652 @item print-first-page-number
653 @funindex print-first-page-number
655 If set to true, a page number is printed on the first page.
658 @item print-page-number
659 @funindex print-page-number
661 If set to false, page numbers are not printed. Default:
665 @funindex ragged-bottom
667 If set to true, systems will not spread vertically across the
668 page. This does not affect the last page. Default: @code{##f}.
670 This should be set to true for pieces that have only two or three
671 systems per page, for example orchestral scores.
674 @funindex ragged-last
676 If set to true, the last system in the score will not fill the
677 line width. Instead the last system ends at its natural
678 horizontal length. Default: @code{##f}.
680 @item ragged-last-bottom
681 @funindex ragged-last-bottom
683 If set to false, systems will spread vertically across the last
684 page. Default: @code{##t}.
686 Pieces that amply fill two pages or more should have this set to
689 It also affects the last page of book parts, ie parts of a book created
690 with @code{\bookpart} blocks.
693 @funindex ragged-right
695 If set to true, systems will not fill the line width. Instead,
696 systems end at their natural horizontal length. Default:
699 If the score has only one system, the default value is @code{##t}.
701 @item system-separator-markup
702 @funindex system-separator-markup
704 A markup object that is inserted between systems. This is often
705 used for orchestral scores. Default: unset.
707 The markup command @code{\slashSeparator} is provided as a sensible
710 @lilypond[quote,ragged-right]
711 #(set-default-paper-size "a6" 'landscape)
714 \relative c' { c1 \break c1 }
717 system-separator-markup = \slashSeparator
723 @funindex system-count
725 The number of systems to be used for a score.
728 @item systems-per-page
729 @funindex systems-per-page
731 The number of systems that should be placed on each page.
732 This is currently supported only by the @code{ly:optimal-breaking} algorithm.
739 @cindex binding gutter
741 If set to true, use @code{inner-margin}, @code{outer-margin} and
742 @code{binding-offset} to determine margins depending on whether
743 the page number is odd or even. This overrides @code{left-margin}
744 and @code{right-margin}. Default: @code{##f}.
756 The default page header puts the page number and the @code{instrument}
757 field from the @code{\header} block on a line.
759 The titles (from the @code{\header@{@}} section) are treated as a
760 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
761 add space between the titles and the first system of the score.
765 @section Music layout
768 * Setting the staff size::
773 @node Setting the staff size
774 @subsection Setting the staff size
776 @cindex font size, setting
777 @cindex staff size, setting
778 @funindex layout file
780 The default @strong{staff size} is set to 20 points.
781 This may be changed in two ways:
783 To set the staff size globally for all scores in a file (or
784 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
787 #(set-global-staff-size 14)
791 This sets the global default size to 14pt staff height and scales all
794 To set the staff size individually for each score, use
799 #(layout-set-staff-size 15)
804 The Feta font provides musical symbols at eight different
805 sizes. Each font is tuned for a different staff size: at a smaller size
806 the font becomes heavier, to match the relatively heavier staff lines.
807 The recommended font sizes are listed in the following table:
810 @multitable @columnfractions .15 .2 .22 .2
813 @tab @b{staff height (pt)}
814 @tab @b{staff height (mm)}
856 @c modern rental material?
861 These fonts are available in any sizes. The context property
862 @code{fontSize} and the layout property @code{staff-space} (in
863 @rinternals{StaffSymbol}) can be used to tune the size for individual
864 staves. The sizes of individual staves are relative to the global size.
869 @ref{Selecting notation font size}.
877 @code{layout-set-staff-size} does not change the distance between the
882 @subsection Score layout
886 While @code{\paper} contains settings that relate to the page formatting
887 of the whole document, @code{\layout} contains settings for score-specific
894 \override VerticalAxisGroup #'minimum-Y-extent = #'(-6 . 6)
897 \override TextScript #'padding = #1.0
898 \override Glissando #'thickness = #3
906 @ref{Changing context default settings}.
918 * Optimal page breaking::
919 * Optimal page turning::
920 * Minimal page breaking::
922 * Using an extra voice for breaks::
927 @subsection Line breaking
930 @cindex breaking lines
932 Line breaks are normally determined automatically. They are chosen
933 so that lines look neither cramped nor loose, and consecutive
934 lines have similar density. Occasionally you might want to
935 override the automatic breaks; you can do this by specifying
936 @code{\break}. This will force a line break at this point. However,
937 line breaks can only occur at the end of @q{complete} bars, i.e.,
938 where there are no notes or tuplets left @q{hanging} over the bar
939 line. If you want to have a line break where there is no bar line,
940 you can force an invisible bar line by entering @code{\bar ""},
941 although again there must be no notes left hanging over in any of
942 the staves at this point, or it will be ignored.
944 The opposite command, @code{\noBreak}, forbids a line break at the
945 bar line where it is inserted.
947 The most basic settings influencing line spacing are @code{indent}
948 and @code{line-width}. They are set in the @code{\layout} block.
949 They control the indentation of the first line of music, and the
950 lengths of the lines.
952 If @code{ragged-right} is set to true in the @code{\layout} block,
953 then systems end at their natural horizontal length, instead of
954 being spread horizontally to fill the whole line. This is useful
955 for short fragments, and for checking how tight the natural
958 @c TODO Check and add para on default for ragged-right
960 The option @code{ragged-last} is similar to @code{ragged-right},
961 but affects only the last line of the piece.
973 @cindex regular line breaks
974 @cindex four bar music.
976 For line breaks at regular intervals use @code{\break} separated by
977 skips and repeated with @code{\repeat}. For example, this would
978 cause the following 28 measures (assuming 4/4 time) to be broken
979 every 4 measures, and only there:
982 << \repeat unfold 7 @{
983 s1 \noBreak s1 \noBreak
984 s1 \noBreak s1 \break @}
985 @emph{the real music}
990 A linebreaking configuration can be saved as a @code{.ly} file
991 automatically. This allows vertical alignments to be stretched to
992 fit pages in a second formatting run. This is fairly new and
993 complicated. More details are available in
1006 Internals Reference:
1007 @rinternals{LineBreakEvent}.
1015 Line breaks can only occur if there is a @q{proper} bar line. A note
1016 which is hanging over a bar line is not proper, such as
1018 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1019 c4 c2 << c2 {s4 \break } >> % this does nothing
1020 c2 c4 | % a break here would work
1021 c4 c2 c4 ~ \break % as does this break
1025 This can be avoided by removing the @code{Forbid_line_break_engraver}.
1026 Note that manually forced line breaks have to be added in parallel
1029 @lilypond[quote,ragged-right,verbatim]
1031 \remove Forbid_line_break_engraver
1033 c4 c2 << c2 {s4 \break } >> % now the break is allowed
1038 Similarly, line breaks are normally forbidden when beams cross bar
1039 lines. This behavior can be changed by setting
1040 @code{\override Beam #'breakable = ##t}.
1044 @subsection Page breaking
1046 The default page breaking may be overridden by inserting
1047 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1048 analogous to @code{\break} and @code{\noBreak}. They should be
1049 inserted at a bar line. These commands force and forbid a page-break
1050 from happening. Of course, the @code{\pageBreak} command also forces
1053 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
1054 inserted at top-level, between scores and top-level markups.
1056 There are also analogous settings to @code{ragged-right} and
1057 @code{ragged-last} which have the same effect on vertical spacing:
1058 @code{ragged-bottom} and @code{ragged-last-bottom}. If set to
1059 @code{##t} the systems on all pages or just the last page
1060 respectively will not be justified vertically.
1062 For more details see @ref{Vertical spacing}.
1064 Page breaks are computed by the @code{page-breaking} function. LilyPond
1065 provides three algorithms for computing page breaks,
1066 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
1067 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
1068 but the value can be changed in the @code{\paper} block:
1072 #(define page-breaking ly:page-turn-breaking)
1078 When a book has many scores and pages, the page breaking problem may be
1079 difficult to solve, requiring large processing time and memory. To ease
1080 the page breaking process, @code{\bookpart} blocks are used to divide
1081 the book into several parts: the page breaking occurs separately on each
1082 part. Different page breaking functions may also be used in different
1088 subtitle = "Preface"
1091 %% In a part consisting mostly of text,
1092 %% ly:minimal-breaking may be prefered
1093 #(define page-breaking ly:minimal-breaking)
1095 \markup @{ @dots{} @}
1099 %% In this part, consisting of music, the default optimal
1100 %% page breaking function is used.
1102 subtitle = "First movement"
1104 \score @{ @dots{} @}
1111 @funindex \pageBreak
1113 @funindex \noPageBreak
1114 @code{\noPageBreak}.
1123 @node Optimal page breaking
1124 @subsection Optimal page breaking
1126 @funindex ly:optimal-breaking
1128 The @code{ly:optimal-breaking} function is LilyPond's default method of
1129 determining page breaks. It attempts to find a page breaking that minimizes
1130 cramping and stretching, both horizontally and vertically. Unlike
1131 @code{ly:page-turn-breaking}, it has no concept of page turns.
1139 @node Optimal page turning
1140 @subsection Optimal page turning
1142 @funindex ly:page-turn-breaking
1144 Often it is necessary to find a page breaking configuration so that there is
1145 a rest at the end of every second page. This way, the musician can turn the
1146 page without having to miss notes. The @code{ly:page-turn-breaking} function
1147 attempts to find a page breaking minimizing cramping and stretching, but with
1148 the additional restriction that it is only allowed to introduce page turns
1149 in specified places.
1151 There are two steps to using this page breaking function. First, you
1152 must enable it in the @code{\paper} block, as explained in @ref{Page
1153 breaking}. Then you must tell the function where you would like to allow
1156 There are two ways to achieve the second step. First, you can specify each
1157 potential page turn manually, by inserting @code{\allowPageTurn} into your
1158 input file at the appropriate places.
1160 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
1161 Voice context. The @code{Page_turn_engraver} will scan the context for
1162 sections without notes (note that it does not scan for rests; it scans for
1163 the absence of notes. This is so that single-staff polyphony with rests in one
1164 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
1165 a sufficiently long section without notes, the @code{Page_turn_engraver} will
1166 insert an @code{\allowPageTurn} at the final bar line in that section, unless
1167 there is a @q{special} bar line (such as a double bar), in which case the
1168 @code{\allowPageTurn} will be inserted at the final @q{special} bar line in
1171 @funindex minimumPageTurnLength
1172 The @code{Page_turn_engraver} reads the context property
1173 @code{minimumPageTurnLength} to determine how long a note-free section must
1174 be before a page turn is considered. The default value for
1175 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
1176 to disable page turns, you can set it to something very large.
1179 \new Staff \with @{ \consists "Page_turn_engraver" @}
1182 R1 | % a page turn will be allowed here
1184 \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
1185 R1 | % a page turn will not be allowed here
1187 R1*2 | % a page turn will be allowed here
1192 @funindex minimumRepeatLengthForPageTurn
1193 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
1194 turn during the repeat if there is enough time at the beginning and end of the
1195 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
1196 page turns if the repeat is very short. If you set the context property
1197 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
1198 only allow turns in repeats whose duration is longer than this value.
1200 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
1201 @code{\allowPageTurn}, may also be used at top-level, between scores and
1208 @funindex \noPageTurn
1210 @funindex \allowPageTurn
1211 @code{\allowPageTurn}.
1222 There should only be one @code{Page_turn_engraver} in a score. If there is more
1223 than one, they will interfere with each other.
1226 @node Minimal page breaking
1227 @subsection Minimal page breaking
1229 @funindex ly:minimal-breaking
1231 The @code{ly:minimal-breaking} function performs minimal computations to
1232 calculate the page breaking: it fills a page with as many systems as
1233 possible before moving to the next one. Thus, it may be preferred for
1234 scores with many pages, where the other page breaking functions could be
1235 too slow or memory demanding, or a lot of texts. It is enabled using:
1239 #(define page-breaking ly:minimal-breaking)
1249 @node Explicit breaks
1250 @subsection Explicit breaks
1252 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
1253 commands. There are two commands to override this behavior:
1256 \override NonMusicalPaperColumn #'line-break-permission = ##f
1257 \override NonMusicalPaperColumn #'page-break-permission = ##f
1260 When @code{line-break-permission} is overridden to false, Lily will insert
1261 line breaks at explicit @code{\break} commands and nowhere else. When
1262 @code{page-break-permission} is overridden to false, Lily will insert
1263 page breaks at explicit @code{\pageBreak} commands and nowhere else.
1265 @lilypond[quote,verbatim]
1274 \override NonMusicalPaperColumn #'line-break-permission = ##f
1275 \override NonMusicalPaperColumn #'page-break-permission = ##f
1278 \repeat unfold 2 { c'8 c'8 c'8 c'8 } \break
1279 \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
1280 \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
1281 \repeat unfold 8 { c'8 c'8 c'8 c'8 } \pageBreak
1282 \repeat unfold 8 { c'8 c'8 c'8 c'8 } \break
1283 \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
1284 \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
1285 \repeat unfold 2 { c'8 c'8 c'8 c'8 }
1297 @node Using an extra voice for breaks
1298 @subsection Using an extra voice for breaks
1300 Line- and page-breaking information usually appears within note entry directly.
1305 \repeat unfold 2 @{ c'4 c'4 c'4 c'4 @}
1307 \repeat unfold 3 @{ c'4 c'4 c'4 c'4 @}
1312 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
1313 music entry with information that specifies how music should lay out
1314 on the page. You can keep music entry and line- and page-breaking
1315 information in two separate places by introducing an extra voice to
1316 contain the breaks. This extra voice
1317 contains only skips together with @code{\break}, @code{pageBreak} and other
1318 breaking layout information.
1320 @lilypond[quote,verbatim]
1330 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1331 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1332 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1333 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1339 This pattern becomes especially helpful when overriding
1340 @code{line-break-system-details} and the other useful but long properties of
1341 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
1343 @lilypond[quote,verbatim]
1348 \overrideProperty "Score.NonMusicalPaperColumn"
1349 #'line-break-system-details #'((Y-offset . 0))
1352 \overrideProperty "Score.NonMusicalPaperColumn"
1353 #'line-break-system-details #'((Y-offset . 35))
1356 \overrideProperty "Score.NonMusicalPaperColumn"
1357 #'line-break-system-details #'((Y-offset . 70))
1360 \overrideProperty "Score.NonMusicalPaperColumn"
1361 #'line-break-system-details #'((Y-offset . 105))
1365 \repeat unfold 2 { c'4 c'4 c'4 c'4 }
1366 \repeat unfold 3 { c'4 c'4 c'4 c'4 }
1367 \repeat unfold 6 { c'4 c'4 c'4 c'4 }
1368 \repeat unfold 5 { c'4 c'4 c'4 c'4 }
1377 @ref{Vertical spacing}.
1383 @node Vertical spacing
1384 @section Vertical spacing
1386 @cindex vertical spacing
1387 @cindex spacing, vertical
1389 Vertical spacing is controlled by three things: the amount of
1390 space available (i.e., paper size and margins), the amount of
1391 space between systems, and the amount of space between
1392 staves inside a system.
1395 * Vertical spacing inside a system::
1396 * Vertical spacing between systems::
1397 * Explicit staff and system positioning::
1398 * Vertical collision avoidance::
1402 @node Vertical spacing inside a system
1403 @subsection Vertical spacing inside a system
1405 @cindex distance between staves
1406 @cindex staff distance
1407 @cindex space between staves
1408 @cindex space inside systems
1410 The height of each system is determined in two steps. First, all of the
1411 staves are spaced according to the amount of space available. Then, the
1412 non-staff lines (eg. lyrics or chords) are distributed between the
1415 @unnumberedsubsubsec Spacing between staves
1416 Spacing between staves is controlled by the @var{next-staff-spacing}
1417 property of the @var{VerticalAxisGroup} grob. This property is an alist
1418 with four elements: @var{space}, @var{minimum-distance}, @var{padding}
1419 and @var{stretchability}:
1422 @var{space} is the size of the stretchable space between the center line
1423 of one staff to the center line of the next staff.
1426 @var{minimum-distance} provides a lower bound on the final distance
1427 between the center line of one staff to the center line of the next
1428 staff. That is, if a page has many systems and needs to be compressed,
1429 the distance from this staff to the next will never be compressed to
1430 less than @var{minimum-distance}.
1433 @var{padding} is the amount of whitespace that must be present between
1434 the bottom of one staff and the top of the next. It differs from
1435 @var{minimum-distance} in that the effect of @var{padding} depends on
1436 the height of objects in the staff. For example, @var{padding} is more
1437 likely to come into effect for staves with notes that are far below the
1441 @var{stretchability} controls the stretchable space's propensity to
1442 stretch when the system is stretched. Large values will cause a
1443 system to stretch more, while a value of zero will prevent the
1444 space from stretching at all. If unset, @var{stretchability}
1445 defaults to @code{space - minimum-distance}.
1449 #(set-global-staff-size 16)
1451 % Since space is small and there is no minimum-distance, the distance
1452 % between this staff and the next will be determined by padding.
1454 \override VerticalAxisGroup #'next-staff-spacing =
1455 #'((space . 1) (padding . 1))
1458 % Since space is small and nothing sticks out very far, the distance
1459 % between this staff and the next will be determined by minimum-distance.
1461 \override VerticalAxisGroup #'next-staff-spacing =
1462 #'((space . 1) (minimum-distance . 12))
1465 % By setting padding to a negative value, staves can be made to collide.
1467 \override VerticalAxisGroup #'next-staff-spacing =
1468 #'((space . 4) (padding . -10))
1471 \new Staff { \clef bass c, }
1476 In orchestral and other large scores, it is common to place staves in
1477 groups. The space between groups is typically larger than the space
1478 between staves of the same group. This spacing can be tweaked with the
1479 @var{StaffGrouper} grob: the default value of @var{next-staff-spacing}
1480 for @var{VerticalAxisGroup} is a callback function which operates by
1481 searching for a @var{StaffGrouper} grob containing the staff. If it
1482 finds a @var{StaffGrouper} grob and the staff in question is in the
1483 middle of a group, it reads the @var{between-staff-spacing} property of
1484 @var{StaffGrouper} and returns it. If the staff in question is the last
1485 staff of a group, the callback reads the @var{after-last-staff-spacing}
1486 property of @var{StaffGrouper} and returns it. If the callback did not
1487 find a @var{StaffGrouper} grob, it reads
1488 @var{default-next-staff-spacing} from its @var{VerticalAxisGroup} and
1492 #(set-global-staff-size 16)
1494 \new PianoStaff \with {
1495 \override StaffGrouper #'between-staff-spacing #'space = #1
1496 \override StaffGrouper #'between-staff-spacing #'padding = #0
1497 \override StaffGrouper #'after-last-staff-spacing #'space = #20
1504 \new StaffGroup \with {
1505 \override StaffGrouper #'between-staff-spacing #'space = #1
1506 \override StaffGrouper #'between-staff-spacing #'padding = #0
1516 @unnumberedsubsubsec Spacing of non-staff lines
1518 After the positions of the staves are determined, the non-staff lines
1519 are distributed between the staves. Each of these lines has a
1520 @var{staff-affinity} property which controls its vertical alignment.
1524 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #DOWN @}
1527 @noindent creates a lyrics context that will be placed close to the
1528 staff below it. Setting @var{staff-affinity} to something which is not
1529 a number (@code{#f}, for example) will cause that line to be treated
1530 like a staff. Conversely, setting @var{staff-affinity} for a staff will
1531 cause it to be treated like a non-staff.
1533 Non-staff lines admit three properties to control their spacing. Each
1534 of the these properties is an alist of the same format as
1535 @var{next-staff-spacing}, above.
1538 If the nearest line in the @var{staff-affinity} direction is a staff
1539 then @var{inter-staff-spacing} gives the spacing between the non-staff
1540 and the staff. If @var{staff-affinity} is @code{CENTER}, then
1541 @var{inter-staff-spacing} is used for both directions.
1544 If the nearest line in the @var{staff-affinity} direction is a non-staff
1545 then @var{inter-loose-line-spacing} gives the spacing between the two
1549 If the nearest line in the opposite direction to @var{staff-affinity} is
1550 a staff then @var{non-affinity-spacing} gives the spacing between the
1551 non-staff and the staff. This can be used, for example, to require
1552 a minimum amount of padding between a Lyrics line and the staff
1553 to which it does not belong.
1557 #(set-global-staff-size 16)
1561 % By default, Lyrics are placed close together. Here, we allow them to
1562 % be stretched more widely.
1563 \override VerticalAxisGroup
1564 #'inter-loose-line-spacing #'stretchability = #1000
1571 \override VerticalAxisGroup #'next-staff-spacing = #'((space . 30)) }
1574 \override VerticalAxisGroup #'staff-affinity = #UP }
1577 \override VerticalAxisGroup #'staff-affinity = #CENTER }
1578 \lyricmode { center }
1580 \override VerticalAxisGroup #'staff-affinity = #DOWN }
1591 @c @lsr{spacing,page-spacing.ly},
1592 @c @lsr{spacing,alignment-vertical-spacing.ly}.
1594 Internals Reference:
1595 @rinternals{VerticalAxisGroup},
1596 @rinternals{VerticalAlignment},
1597 @rinternals{Axis_group_engraver}.
1600 Adjacent non-staff lines should have non-increasing
1601 @var{staff-affinity} from top-to-bottom. For example, the behavior of
1605 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #DOWN @}
1606 \new Lyrics \with @{ \override VerticalAxisGroup #'staff-affinity = #UP @}
1612 A non-staff line at the bottom of a system should have
1613 @var{staff-affinity} set to @code{UP}. Similarly, a non-staff
1614 line at the top of a system should have @var{staff-affinity} set
1617 @node Vertical spacing between systems
1618 @subsection Vertical spacing between systems
1620 The mechanisms that control spacing between systems are similar to those
1621 that control spacing between staves within a system (see
1622 @ref{Vertical spacing inside a system}). The main difference is that
1623 the variables to control spacing between systems are set in the
1624 @code{\paper} block, rather than as grob properties. These paper block
1625 variables are @var{between-system-spacing},
1626 @var{between-scores-system-spacing}, @var{after-title-spacing},
1627 @var{before-title-spacing}, @var{between-title-spacing},
1628 @var{top-system-spacing}, @var{top-title-spacing} and
1629 @var{bottom-system-spacing}. Note that these variables ignore non-staff
1630 lines. For example, @var{between-system-spacing} controls the spacing
1631 from the middle staff line of the bottom staff from one system to
1632 the middle staff line of the top staff of the next system, whether
1633 or not there are lyrics below the upper system.
1634 See @ref{Vertical dimensions} for a description of each of these
1637 There are two more @code{\paper} block variables that affect vertical
1638 spacing: if @var{ragged-bottom} is set to @code{##t} then no pages will
1639 be stretched (which means that neither the space between systems nor the
1640 space within systems will be stretched). If @var{ragged-last-bottom}
1641 is set to @code{##t} then the last page will not be stretched.
1648 @node Explicit staff and system positioning
1649 @subsection Explicit staff and system positioning
1651 One way to understand the @code{VerticalAxisGroup} and @code{\paper}
1652 settings explained in the previous two sections is as a collection of
1653 different settings that primarily concern the amount of vertical padding
1654 different staves and systems running down the page.
1656 It is possible to approach vertical spacing in a different way using
1657 @code{NonMusicalPaperColumn #'line-break-system-details}. Where
1658 @code{VerticalAxisGroup} and @code{\paper} settings specify vertical padding,
1659 @code{NonMusicalPaperColumn #'line-break-system-details} specifies exact
1660 vertical positions on the page.
1662 @code{NonMusicalPaperColumn #'line-break-system-details} accepts an associative
1663 list of three different settings:
1666 @item @code{X-offset}
1667 @item @code{Y-offset}
1668 @item @code{alignment-distances}
1671 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
1672 below, can occur in any of three different places in an input file:
1675 @item in the middle of note entry directly
1676 @item in a @code{\context} block
1677 @item in the @code{\with} block
1680 When we override @code{NonMusicalPaperColumn}, we use the usual
1681 @code{\override} command in @code{\context} blocks and in the
1682 @code{\with} block. On the other hand, when we override
1683 @code{NonMusicalPaperColumn} in the middle of note entry,
1684 use the special @code{\overrideProperty} command. Here are some
1685 example @code{NonMusicalPaperColumn} overrides with the special
1686 @code{\overrideProperty} command:
1689 \overrideProperty NonMusicalPaperColumn
1690 #'line-break-system-details #'((X-offset . 20))
1692 \overrideProperty NonMusicalPaperColumn
1693 #'line-break-system-details #'((Y-offset . 40))
1695 \overrideProperty NonMusicalPaperColumn
1696 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40))
1698 \overrideProperty NonMusicalPaperColumn
1699 #'line-break-system-details #'((alignment-distances . (15)))
1701 \overrideProperty NonMusicalPaperColumn
1702 #'line-break-system-details #'((X-offset . 20) (Y-offset . 40)
1703 (alignment-distances . (15)))
1706 To understand how each of these different settings work, we begin
1707 by looking at an example that includes no overrides at all.
1709 @c \book { } is required in these examples to ensure the spacing
1710 @c overrides can be seen between systems. -np
1713 \header { tagline = ##f }
1714 \paper { left-margin = 0\mm }
1724 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1727 \repeat unfold 15 { d'4 d' d' d' }
1734 This score isolates line- and page-breaking information in a dedicated
1735 voice. This technique of creating a breaks voice will help keep layout
1736 separate from music entry as our example becomes more complicated.
1737 See @ref{Using an extra voice for breaks}.
1739 Explicit @code{\breaks} evenly divide the music into six measures per
1740 line. Vertical spacing results from LilyPond's defaults. To set
1741 the vertical startpoint of each system explicitly, we can set
1742 the @code{Y-offset} pair in the @code{line-break-system-details}
1743 attribute of the @code{NonMusicalPaperColumn} grob:
1746 \header { tagline = ##f }
1747 \paper { left-margin = 0\mm }
1753 \overrideProperty #"Score.NonMusicalPaperColumn"
1754 #'line-break-system-details #'((Y-offset . 0))
1756 \overrideProperty #"Score.NonMusicalPaperColumn"
1757 #'line-break-system-details #'((Y-offset . 40))
1759 \overrideProperty #"Score.NonMusicalPaperColumn"
1760 #'line-break-system-details #'((Y-offset . 80))
1763 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1766 \repeat unfold 15 { d'4 d' d' d' }
1773 Note that @code{line-break-system-details} takes an associative list of
1774 potentially many values, but that we set only one value here. Note,
1775 too, that the @code{Y-offset} property here determines the exact vertical
1776 position on the page at which each new system will render.
1778 Now that we have set the vertical startpoint of each system
1779 explicitly, we can also set the vertical distances between staves
1780 within each system manually. We do this using the @code{alignment-distances}
1781 subproperty of @code{line-break-system-details}.
1784 \header { tagline = ##f }
1785 \paper { left-margin = 0\mm }
1791 \overrideProperty #"Score.NonMusicalPaperColumn"
1792 #'line-break-system-details #'((Y-offset . 20)
1793 (alignment-distances . (15)))
1795 \overrideProperty #"Score.NonMusicalPaperColumn"
1796 #'line-break-system-details #'((Y-offset . 60)
1797 (alignment-distances . (15)))
1799 \overrideProperty #"Score.NonMusicalPaperColumn"
1800 #'line-break-system-details #'((Y-offset . 100)
1801 (alignment-distances . (15)))
1804 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1807 \repeat unfold 15 { d'4 d' d' d' }
1814 Note that here we assign two different values to the
1815 @code{line-break-system-details} attribute of the
1816 @code{NonMusicalPaperColumn} grob. Though the
1817 @code{line-break-system-details} attribute alist accepts many
1818 additional spacing parameters (including, for example, a corresponding
1819 @code{X-offset} pair), we need only set the @code{Y-offset} and
1820 @code{alignment-distances} pairs to control the vertical startpoint of
1821 every system and every staff. Finally, note that @code{alignment-distances}
1822 specifies the vertical positioning of staves but not of staff groups.
1825 \header { tagline = ##f }
1826 \paper { left-margin = 0\mm }
1832 \overrideProperty #"Score.NonMusicalPaperColumn"
1833 #'line-break-system-details #'((Y-offset . 0)
1834 (alignment-distances . (30 10)))
1836 \overrideProperty #"Score.NonMusicalPaperColumn"
1837 #'line-break-system-details #'((Y-offset . 60)
1838 (alignment-distances . (10 10)))
1840 \overrideProperty #"Score.NonMusicalPaperColumn"
1841 #'line-break-system-details #'((Y-offset . 100)
1842 (alignment-distances . (10 30)))
1845 \new Voice { \repeat unfold 15 { c'4 c' c' c' } }
1848 \new Staff { \repeat unfold 15 { d'4 d' d' d' } }
1849 \new Staff { \repeat unfold 15 { e'4 e' e' e' } }
1856 Some points to consider:
1859 @item When using @code{alignment-distances}, lyrics and other non-staff lines
1860 do not count as a staff.
1862 @item The units of the numbers passed to @code{X-offset},
1863 @code{Y-offset} and @code{alignment-distances} are interpreted as multiples
1864 of the distance between adjacent staff lines. Positive values move staves
1865 and lyrics up, negative values move staves and lyrics down.
1867 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
1868 settings given here allow the positioning of staves and systems anywhere
1869 on the page, it is possible to violate paper or margin boundaries or even
1870 to print staves or systems on top of one another. Reasonable values
1871 passed to these different settings will avoid this.
1880 @node Vertical collision avoidance
1881 @subsection Vertical collision avoidance
1883 @funindex outside-staff-priority
1884 @funindex outside-staff-padding
1885 @funindex outside-staff-horizontal-padding
1887 Intuitively, there are some objects in musical notation that belong
1888 to the staff and there are other objects that should be placed outside
1889 the staff. Objects belonging outside the staff include things such as
1890 rehearsal marks, text and dynamic markings (from now on, these will
1891 be called outside-staff objects). LilyPond's rule for the
1892 vertical placement of outside-staff objects is to place them as close
1893 to the staff as possible but not so close that they collide with
1896 LilyPond uses the @code{outside-staff-priority} property to determine
1897 whether a grob is an outside-staff object: if @code{outside-staff-priority}
1898 is a number, the grob is an outside-staff object. In addition,
1899 @code{outside-staff-priority} tells LilyPond in which order the objects
1902 First, LilyPond places all the objects that do not belong outside
1903 the staff. Then it sorts the outside-staff objects according to their
1904 @code{outside-staff-priority} (in increasing order). One by one, LilyPond
1905 takes the outside-staff objects and places them so that they do
1906 not collide with any objects that have already been placed. That
1907 is, if two outside-staff grobs are competing for the same space, the one
1908 with the lower @code{outside-staff-priority} will be placed closer to
1911 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1914 \once \override TextScript #'outside-staff-priority = #1
1915 c4_"Text"\pp % this time the text will be closer to the staff
1917 % by setting outside-staff-priority to a non-number,
1918 % we disable the automatic collision avoidance
1919 \once \override TextScript #'outside-staff-priority = ##f
1920 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
1921 c4_"Text"\pp % now they will collide
1924 The vertical padding between an outside-staff object and the
1925 previously-positioned grobs can be controlled with
1926 @code{outside-staff-padding}.
1928 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1929 \once \override TextScript #'outside-staff-padding = #0
1930 a'^"This text is placed very close to the note"
1931 \once \override TextScript #'outside-staff-padding = #3
1932 c^"This text is padded away from the previous text"
1933 c^"This text is placed close to the previous text"
1937 By default, outside-staff objects are placed only to avoid
1938 a horizontal collision with previously-positioned grobs. This
1939 can lead to situations in which objects are placed very close to each
1940 other horizontally. The vertical spacing between staffs can
1941 also be set so that outside staff objects are interleaved.
1942 Setting @code{outside-staff-horizontal-padding}
1943 causes an object to be offset vertically so that such a situation
1946 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1947 % the markup is too close to the following note
1951 % setting outside-staff-horizontal-padding fixes this
1953 \once \override TextScript #'outside-staff-horizontal-padding = #1
1965 @node Horizontal spacing
1966 @section Horizontal spacing
1968 @cindex horizontal spacing
1969 @cindex spacing, horizontal
1972 * Horizontal spacing overview::
1973 * New spacing area::
1974 * Changing horizontal spacing::
1976 * Proportional notation::
1980 @node Horizontal spacing overview
1981 @subsection Horizontal spacing overview
1983 The spacing engine translates differences in durations into stretchable
1984 distances (@q{springs}) of differing lengths. Longer durations get
1985 more space, shorter durations get less. The shortest durations get a
1986 fixed amount of space (which is controlled by
1987 @code{shortest-duration-space} in the @rinternals{SpacingSpanner}
1988 object). The longer the duration, the more space it gets: doubling a
1989 duration adds a fixed amount (this amount is controlled by
1990 @code{spacing-increment}) of space to the note.
1992 For example, the following piece contains lots of half, quarter, and
1993 8th notes; the eighth note is followed by 1 note head width (NHW).
1994 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
1996 @lilypond[quote,fragment,verbatim,relative=1]
1997 c2 c4. c8 c4. c8 c4. c8 c8
2001 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
2002 approximately the width of a note head, and
2003 @code{shortest-duration-space} is set to 2.0, meaning that the
2004 shortest note gets 2.4 staff space (2.0 times the
2005 @code{spacing-increment}) of horizontal space. This space is counted
2006 from the left edge of the symbol, so the shortest notes are generally
2007 followed by one NHW of space.
2009 If one would follow the above procedure exactly, then adding a single
2010 32nd note to a score that uses 8th and 16th notes, would widen up the
2011 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
2012 thus adding 1 NHW to every note. To prevent this, the shortest
2013 duration for spacing is not the shortest note in the score, but rather
2014 the one which occurs most frequently.
2017 The most common shortest duration is determined as follows: in every
2018 measure, the shortest duration is determined. The most common shortest
2019 duration is taken as the basis for the spacing, with the stipulation
2020 that this shortest duration should always be equal to or shorter than
2021 an 8th note. The shortest duration is printed when you run
2022 @code{lilypond} with the @code{--verbose} option.
2024 These durations may also be customized. If you set the
2025 @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then
2026 this sets the base duration for spacing. The maximum duration for this
2027 base (normally an 8th), is set through @code{base-shortest-duration}.
2029 @funindex common-shortest-duration
2030 @funindex base-shortest-duration
2031 @funindex stem-spacing-correction
2034 Notes that are even shorter than the common shortest note are
2035 followed by a space that is proportional to their duration relative to
2036 the common shortest note. So if we were to add only a few 16th notes
2037 to the example above, they would be followed by half a NHW:
2039 @lilypond[quote,fragment,verbatim,relative=2]
2040 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
2044 In the @emph{Essay on automated music engraving}, it was explained
2045 that stem directions influence spacing (see @ressay{Optical
2046 spacing}). This is controlled with the
2047 @code{stem-spacing-correction} property in the
2048 @rinternals{NoteSpacing}, object. These are generated for every
2049 @rinternals{Voice} context. The @code{StaffSpacing} object
2050 (generated in @rinternals{Staff} context) contains the same
2051 property for controlling the stem/bar line spacing. The following
2052 example shows these corrections, once with default settings, and
2053 once with exaggerated corrections:
2055 @lilypond[quote,ragged-right]
2059 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
2060 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
2066 Proportional notation is supported; see @ref{Proportional notation}.
2073 Internals Reference:
2074 @rinternals{SpacingSpanner},
2075 @rinternals{NoteSpacing},
2076 @rinternals{StaffSpacing},
2077 @rinternals{NonMusicalPaperColumn}.
2082 There is no convenient mechanism to manually override spacing. The
2083 following work-around may be used to insert extra space into a score,
2084 adjusting the padding value as necessary.
2086 \override Score.NonMusicalPaperColumn #'padding = #10
2089 No work-around exists for decreasing the amount of space.
2092 @node New spacing area
2093 @subsection New spacing area
2095 New sections with different spacing parameters can be started with
2096 @code{newSpacingSection}. This is useful when there are
2097 sections with a different notions of long and short notes.
2099 In the following example, the time signature change introduces a new
2100 section, and hence the 16ths notes are spaced wider.
2102 @lilypond[relative,fragment,verbatim,quote]
2105 c8 c c4 c16[ c c8] c4
2111 The @code{\newSpacingSection} command creates a new
2112 @code{SpacingSpanner} object, and hence new @code{\override}s
2113 may be used in that location.
2120 Internals Reference:
2121 @rinternals{SpacingSpanner}.
2124 @node Changing horizontal spacing
2125 @subsection Changing horizontal spacing
2127 Horizontal spacing may be altered with the
2128 @code{base-shortest-duration} property. Here
2129 we compare the same music; once without altering
2130 the property, and then altered. Larger values
2131 of @code{ly:make-moment} will produce smaller
2132 music. Note that @code{ly:make-moment} constructs
2133 a duration, so @code{1 4} is a longer duration
2136 @lilypond[verbatim,line-width=12\cm]
2139 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2140 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2141 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2142 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2147 @lilypond[verbatim,line-width=12\cm]
2150 g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
2151 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2152 d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
2153 g4 e e2 | f4 d d2 | c4 e g g | c,1 |
2158 \override SpacingSpanner
2159 #'base-shortest-duration = #(ly:make-moment 1 16)
2168 By default, spacing in tuplets depends on various non-duration
2169 factors (such as accidentals, clef changes, etc). To disregard
2170 such symbols and force uniform equal-duration spacing, use
2171 @code{Score.SpacingSpanner #'uniform-stretching}. This
2172 property can only be changed at the beginning of a score,
2174 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
2176 \override SpacingSpanner #'uniform-stretching = ##t
2193 When @code{strict-note-spacing} is set, notes are spaced without
2194 regard for clefs, bar lines, and grace notes,
2196 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
2197 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2198 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
2208 @subsection Line length
2211 @cindex breaking pages
2214 @funindex line-width
2215 @funindex ragged-right
2216 @funindex ragged-last
2218 @c Although line-width can be set in \layout, it should be set in paper
2219 @c block, to get page layout right.
2220 @c Setting indent in \paper block makes not much sense, but it works.
2222 @c Bit verbose and vague, use examples?
2223 The most basic settings influencing the spacing are @code{indent} and
2224 @code{line-width}. They are set in the @code{\layout} block. They
2225 control the indentation of the first line of music, and the lengths of
2228 If @code{ragged-right} is set to true in the @code{\layout} block, then
2229 systems ends at their natural horizontal length, instead of being spread
2230 horizontally to fill the whole line. This is useful for
2231 short fragments, and for checking how tight the natural spacing is.
2232 The normal default setting is false, but if the score has only one
2233 system the default value is true.
2236 @cindex vertical spacing
2238 The option @code{ragged-last} is similar to @code{ragged-right}, but
2239 only affects the last line of the piece. No restrictions are put on
2240 that line. The result is similar to formatting text paragraphs. In a
2241 paragraph, the last line simply takes its natural horizontal length.
2242 @c Note that for text there are several options for the last line.
2243 @c While Knuth TeX uses natural length, lead typesetters use the same
2244 @c stretch as the previous line. eTeX uses \lastlinefit to
2245 @c interpolate between both these solutions.
2261 @node Proportional notation
2262 @subsection Proportional notation
2264 LilyPond supports proportional notation, a type of horizontal spacing
2265 in which each note consumes an amount of horizontal space exactly
2266 equivalent to its rhythmic duration. This type of proportional spacing
2267 is comparable to horizontal spacing on top of graph paper. Some late
2268 20th- and early 21st-century scores use proportional notation to
2269 clarify complex rhythmic relationships or to facilitate the placement
2270 of timelines or other graphics directly in the score.
2272 LilyPond supports five different settings for proportional notation,
2273 which may be used together or alone:
2276 @item @code{proportionalNotationDuration}
2277 @item @code{uniform-stretching}
2278 @item @code{strict-note-spacing}
2279 @item @code{\remove Separating_line_group_engraver}
2280 @item @code{\override PaperColumn #'used = ##t}
2283 In the examples that follow, we explore these five different
2284 proportional notation settings and examine how these settings interact.
2286 We start with the following one-measure example, which uses classical
2287 spacing with ragged-right turned on.
2289 @lilypond[quote,verbatim,ragged-right]
2291 \new RhythmicStaff {
2295 c'16 c'16 c'16 c'16 c'16
2301 Notice that the half note which begins the measure takes up far less
2302 than half of the horizontal space of the measure. Likewise, the
2303 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
2304 which end the measure together take up far more than half the
2305 horizontal space of the measure.
2307 In classical engraving, this spacing may be exactly what we want
2308 because we can borrow horizontal space from the half note and conserve
2309 horizontal space across the measure as a whole.
2311 On the other hand, if we want to insert a measured timeline or other
2312 graphic above or below our score, we need proportional notation. We
2313 turn proportional notation on with the proportionalNotationDuration
2316 @lilypond[quote,verbatim,ragged-right]
2318 proportionalNotationDuration = #(ly:make-moment 1 20)
2320 \new RhythmicStaff {
2324 c'16 c'16 c'16 c'16 c'16
2330 The half note at the beginning of the measure and the faster notes in
2331 the second half of the measure now occupy equal amounts of horizontal
2332 space. We could place a measured timeline or graphic above or below
2335 The @code{proportionalNotationDuration} setting is a context setting that
2336 lives in @code{Score}. Recall that context settings appear in one of
2337 three locations in our input file -- in a @code{\with} block, in a
2338 @code{\context} block, or directly in music entry
2339 preceded by the @code{\set} command. As with all
2340 context settings, users can pick which of the three different
2341 locations they would like to set @code{proportionalNotationDuration}.
2343 The @code{proportionalNotationDuration} setting takes a single argument,
2344 which is the reference duration against which all music will be
2345 spaced. The LilyPond Scheme function make-moment takes two arguments
2346 -- a numerator and denominator which together express some fraction of
2347 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces a
2348 reference duration of a twentieth note. The values
2349 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
2350 @code{#(ly:make-moment 3 97)} are all possible as well.
2352 How do we select the right reference duration to pass to
2353 @code{proportionalNotationDuration}? Usually by a process of trial and error,
2354 beginning with a duration close to the fastest (or smallest) duration
2355 in the piece. Smaller reference durations space music loosely; larger
2356 reference durations space music tightly.
2358 @lilypond[quote,verbatim,ragged-right]
2360 proportionalNotationDuration = #(ly:make-moment 1 8)
2362 \new RhythmicStaff {
2366 c'16 c'16 c'16 c'16 c'16
2372 proportionalNotationDuration = #(ly:make-moment 1 16)
2374 \new RhythmicStaff {
2378 c'16 c'16 c'16 c'16 c'16
2384 proportionalNotationDuration = #(ly:make-moment 1 32)
2386 \new RhythmicStaff {
2390 c'16 c'16 c'16 c'16 c'16
2396 Note that too large a reference duration -- such as the eighth note,
2397 above -- spaces music too tightly and can cause note head collisions.
2398 Note also that proportional notation in general takes up more
2399 horizontal space that does classical spacing. Proportional spacing
2400 provides rhythmic clarity at the expense of horizontal space.
2402 Next we examine how to optimally space overlapping tuplets.
2404 We start by examining what happens to our original example, with
2405 classical spacing, when we add a second staff with a different type of
2408 @lilypond[quote,verbatim,ragged-right]
2410 \new RhythmicStaff {
2414 c'16 c'16 c'16 c'16 c'16
2417 \new RhythmicStaff {
2419 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2425 The spacing is bad because the evenly notes of the bottom staff do not
2426 stretch uniformly. Classical engraving includes very few complex
2427 triplets and so classical engraving rules can generate this type of
2428 result. Setting @code{proportionalNotationDuration} remedies this
2429 situation considerably.
2431 @lilypond[quote,verbatim,ragged-right]
2433 proportionalNotationDuration = #(ly:make-moment 1 20)
2435 \new RhythmicStaff {
2439 c'16 c'16 c'16 c'16 c'16
2442 \new RhythmicStaff {
2444 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2450 But if we look very carefully we can see that notes of the second half
2451 of the 9-tuplet space ever so slightly more widely than do the notes
2452 of the first half of the 9-tuplet. To ensure uniform stretching, we
2453 turn on @code{uniform-stretching}, which is a property of
2454 @code{SpacingSpanner}.
2456 @lilypond[quote,verbatim,ragged-right]
2458 proportionalNotationDuration = #(ly:make-moment 1 20)
2459 \override SpacingSpanner #'uniform-stretching = ##t
2461 \new RhythmicStaff {
2465 c'16 c'16 c'16 c'16 c'16
2468 \new RhythmicStaff {
2470 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
2476 Our two-staff example now spaces exactly, our rhythmic
2477 relationships are visually clear, and we can include a measured
2478 timeline or graphic if we want.
2480 Note that the LilyPond's proportional notation package expects
2481 that all proportional scores set the SpacingSpanner's
2482 'uniform-stretching attribute to ##t. Setting
2483 proportionalNotationDuration without also setting the
2484 SpacingSpanner's 'uniform-stretching attribute to ##t will, for
2485 example, cause Skips to consume an incorrect amount of horizontal
2488 The SpacingSpanner is an abstract grob that lives in the Score
2489 context. As with our settings of proportionalNotationDuration,
2490 overrides to the SpacingSpanner can occur in any of three
2491 different places in our input file – in the Score \with block, in
2492 a Score \context block, or in note entry directly.
2494 There is by default only one @code{SpacingSpanner} per @code{Score}. This
2495 means that, by default, @code{uniform-stretching} is either turned on for the
2496 entire score or turned off for the entire score. We can, however,
2497 override this behavior and turn on different spacing features at
2498 different places in the score. We do this with the command
2499 @code{\newSpacingSection}. See @ref{New spacing area}, for more info.
2501 Next we examine the effects of the @code{Separating_line_group_engraver} and
2502 see why proportional scores frequently remove this engraver. The following
2503 example shows that there is a small amount of @qq{preferatory} space
2504 just before the first note in each system.
2506 @lilypond[quote,verbatim,ragged-right]
2519 The amount of this preferatory space is the same whether after a time
2520 signature, a key signature or a clef. @code{Separating_line_group_engraver}
2521 is responsible for this space. Removing @code{Separating_line_group_engraver}
2522 reduces this space to zero.
2524 @lilypond[quote,verbatim,ragged-right]
2530 \remove Separating_line_group_engraver
2538 Nonmusical elements like time signatures, key signatures, clefs and
2539 accidentals are problematic in proportional notation. None of these
2540 elements has rhythmic duration. But all of these elements consume
2541 horizontal space. Different proportional scores approach these
2542 problems differently.
2544 It may be possible to avoid spacing problems with key signatures
2545 simply by not having any. This is a valid option since most
2546 proportional scores are contemporary music. The same may be true
2547 of time signatures, especially for those scores
2548 that include a measured timeline or other graphic. But these scores
2549 are exceptional and most proportional scores include at least some
2550 time signatures. Clefs and accidentals are even more essential.
2552 So what strategies exist for spacing nonmusical elements in a
2553 proportional context? One good option is the @code{strict-note-spacing}
2554 property of @code{SpacingSpanner}. Compare the two scores below:
2556 @lilypond[quote,verbatim,ragged-right]
2558 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
2568 \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
2569 \override Score.SpacingSpanner #'strict-note-spacing = ##t
2579 Both scores are proportional, but the spacing in the first score
2580 is too loose because of the clef change. The spacing of the second
2581 score remains strict, however, because strict-note-spacing is
2582 turned on. Turning on strict-note-spacing causes the width of
2583 time signatures, key signatures, clefs and accidentals to play no
2584 part in the spacing algorithm.
2586 In addition to the settings given here, there are other settings
2587 that frequently appear in proportional scores. These include:
2590 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
2591 @item @code{tupletFullLength = ##t}
2592 @item @code{\override Beam #'breakable = ##t}
2593 @item @code{\override Glissando #'breakable = ##t}
2594 @item @code{\override TextSpanner #'breakable = ##t}
2595 @item @code{\remove Forbid_line_break_engraver in the Voice context}
2598 These settings space grace notes strictly, extend tuplet brackets to
2599 mark both rhythmic start- and stop-points, and allow spanning elements
2600 to break across systems and pages. See the respective parts of the manual
2601 for these related settings.
2606 @ref{New spacing area}.
2612 @node Fitting music onto fewer pages
2613 @section Fitting music onto fewer pages
2615 Sometimes you can end up with one or two staves on a second
2616 (or third, or fourth...) page. This is annoying, especially
2617 if you look at previous pages and it looks like there is plenty
2618 of room left on those.
2620 When investigating layout issues, @code{annotate-spacing} is an
2621 invaluable tool. This command prints the values of various layout
2622 spacing variables; for more details see the following section,
2623 @ref{Displaying spacing}.
2626 * Displaying spacing::
2627 * Changing spacing::
2631 @node Displaying spacing
2632 @subsection Displaying spacing
2634 @funindex annotate-spacing
2635 @cindex spacing, display of layout
2637 To graphically display the dimensions of vertical layout variables
2638 that may be altered for page formatting, set
2639 @code{annotate-spacing} in the @code{\paper} block:
2641 @c need to have \book{} otherwise we get the separate systems. -hwn
2642 @lilypond[verbatim,quote]
2643 #(set-default-paper-size "a6" 'landscape)
2646 \paper { annotate-spacing = ##t }
2652 All layout dimensions are displayed in staff-spaces, regardless
2653 of the units specified in the @code{\paper} or @code{\layout} block.
2654 In the above example, @code{paper-height} has a value of 59.75
2655 @code{staff-spaces}, and the @code{staff-size} is 20 points (the
2656 default value). Note that:
2658 @multitable {1 staff-space} {staff-size)/4 * (25.4/72.27) mm}
2661 @tab = (25.4/72.27) mm
2664 @tab = (@code{staff-size})/4 pts
2666 @tab = (@code{staff-size})/4 * (25.4/72.27) mm
2671 In this case, one @code{staff-space} is approximately equal to
2672 1.757mm. Thus the @code{paper-height} measurement of 59.75
2673 @code{staff-spaces} is equivalent to 105 millimeters, the height
2674 of @code{a6} paper in landscape orientation. The pairs
2675 (@var{a},@var{b}) are intervals, where @var{a} is the lower
2676 edge and @var{b} the upper edge of the interval.
2681 @ref{Setting the staff size}.
2687 @node Changing spacing
2688 @subsection Changing spacing
2690 The output of @code{annotate-spacing} reveals vertical dimensions
2691 in great detail. For details about modifying margins and other
2692 layout variables, see @ref{Page formatting}.
2694 Other than margins, there are a few other options to save space:
2698 Force systems to move as close together as possible (to fit as
2699 many systems as possible onto a page) while being spaced so that
2700 there is no blank space at the bottom of the page.
2704 between-system-spacing = #'((padding . 0) (space . 0.1))
2705 ragged-last-bottom = ##f
2711 Force the number of systems. This can help in two ways. Just
2712 setting a value, even the same value as the number of systems
2713 being typeset by default, will sometimes cause more systems to
2714 be fitted onto each page, as an estimation step is then bypassed,
2715 giving a more accurate fit to each page. Also, forcing an actual
2716 reduction in the number of systems may save a further page. For
2717 example, if the default layout has 11 systems, the following
2718 assignment will force a layout with 10 systems.
2727 Avoid (or reduce) objects that increase the vertical size of a
2728 system. For example, volta repeats (or alternate repeats) require
2729 extra space. If these repeats are spread over two systems, they
2730 will take up more space than one system with the volta repeats and
2731 another system without. For example, dynamics that @q{stick out} of
2732 a system can be moved closer to the staff:
2734 @lilypond[verbatim,quote,relative=1]
2736 \override DynamicText #'extra-offset = #'( -2.2 . 2.0)
2741 Alter the horizontal spacing via @code{SpacingSpanner}. For more
2742 details, see @ref{Changing horizontal spacing}. The following
2743 example illustrates the default spacing:
2745 @lilypond[verbatim,quote]
2758 The next example modifies @code{common-shortest-duration} from a
2759 value of @code{1/4} to @code{1/2}. The quarter note is the most
2760 common and shortest duration in this example, so by making this
2761 duration longer, a @q{squeezing} effect occurs:
2763 @lilypond[verbatim,quote]
2775 \override SpacingSpanner
2776 #'common-shortest-duration = #(ly:make-moment 1 2)
2783 The @code{common-shortest-duration} property cannot be modified
2784 dynamically, so it must always be placed in a @code{\context}
2785 block so that it applies to the whole score.
2792 @ref{Page formatting},
2793 @ref{Changing horizontal spacing}.