]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/user/spacing.itely
Refine check-translation error message
[lilypond.git] / Documentation / user / spacing.itely
1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @c This file is part of lilypond.tely
3 @ignore
4     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
5
6     When revising a translation, copy the HEAD committish of the
7     version that you are working on.  See TRANSLATION for details.
8 @end ignore
9
10 @c A menu is needed before every deeper *section nesting of @node's; run
11 @c     M-x texinfo-all-menus-update
12 @c to automatically fill in these menus before saving changes
13
14 @node Spacing issues
15 @chapter Spacing issues
16
17 The global paper layout is determined by three factors: the page layout, the
18 line breaks, and the spacing.  These all influence each other.  The
19 choice of spacing determines how densely each system of music is set.
20 This influences where line breaks are chosen, and thus ultimately, how
21 many pages a piece of music takes.
22
23 Globally speaking, this procedure happens in four steps: first,
24 flexible distances (@q{springs}) are chosen, based on durations.  All
25 possible line breaking combinations are tried, and a @q{badness} score
26 is calculated for each. Then the height of each possible system is
27 estimated. Finally, a page breaking and line breaking combination is chosen
28 so that neither the horizontal nor the vertical spacing is too cramped
29 or stretched.
30
31 @menu
32 * Paper and pages::             
33 * Music layout::                
34 * Displaying spacing::          
35 * Breaks::                      
36 * Vertical spacing::            
37 * Horizontal spacing::          
38 @end menu
39
40
41 @node Paper and pages
42 @section Paper and pages
43
44 This section deals with the boundaries that define the area
45 that music can be printed inside.
46
47 @menu
48 * Paper size::                  
49 * Page formatting::             
50 @end menu
51
52
53 @node Paper size
54 @subsection Paper size
55
56 @cindex paper size
57 @cindex page size
58 @funindex papersize
59
60 To change the paper size, there are two commands,
61 @example
62 #(set-default-paper-size "a4")
63 \paper @{
64   #(set-paper-size "a4")
65 @}
66 @end example
67
68 The first command sets the size of all pages.  The second command sets the
69 size
70 of the pages that the @code{\paper} block applies to -- if the @code{\paper}
71 block is at the top of the file, then it will apply to all pages.  If the
72 @code{\paper} block is inside a @code{\book}, then the paper size will only
73 apply to that book.
74
75 Support for the following paper sizes are included by default,
76 @code{a6}, @code{a5}, @code{a4}, @code{a3}, @code{legal}, @code{letter},
77 @code{11x17} (also known as tabloid).
78
79 Extra sizes may be added by editing the definition for
80 @code{paper-alist} in the initialization file @file{scm/paper.scm}.
81
82 @cindex orientation
83 @cindex landscape
84
85 If the symbol @code{landscape} is supplied as an argument to
86 @code{set-default-paper-size}, the pages will be rotated by 90 degrees,
87 and wider line widths will be set correspondingly.
88
89 @example
90 #(set-default-paper-size "a6" 'landscape)
91 @end example
92
93 Setting the paper size will adjust a number of @code{\paper} variables
94 (such as margins).  To use a particular paper size with altered
95 @code{\paper} variables, set the paper size before setting the variables.
96
97
98 @node Page formatting
99 @subsection Page formatting
100
101 @cindex page formatting
102 @cindex margins
103 @cindex header, page
104 @cindex footer, page
105
106 LilyPond will do page layout, set margins, and add headers and
107 footers to each page.
108
109 The default layout responds to the following settings in the
110 @code{\paper} block.
111
112 @funindex \paper
113
114 @quotation
115 @table @code
116 @funindex first-page-number
117 @item first-page-number
118 The value of the page number of the first page.  Default is@tie{}1.
119
120 @funindex print-first-page-number
121 @item print-first-page-number
122 If set to true, will print the page number in the first page.  Default is
123 false.
124
125 @funindex print-page-number
126 @item print-page-number
127 If set to false, page numbers will not be printed. Default is true.
128
129 @funindex paper-width
130 @item paper-width
131 The width of the page. The default is taken from the current paper size,
132 see @ref{Paper size}. 
133
134 @funindex paper-height
135 @item paper-height
136 The height of the page. The default is taken from the current paper size,
137 see @ref{Paper size}. 
138
139 @funindex top-margin
140 @item top-margin
141 Margin between header and top of the page. Default is@tie{}5mm.
142
143 @funindex bottom-margin
144 @item bottom-margin
145 Margin between footer and bottom of the page. Default is@tie{}6mm.
146
147 @funindex left-margin
148 @item left-margin
149 Margin between the left side of the page and the beginning of the
150 music. Unset by default, which means that the margins is determined
151 based on the @code{paper-width} and @code{line-width} to center the
152 score on the paper. 
153
154 @funindex line-width
155 @item line-width
156 The length of the systems. Default is @code{paper-width} minus @tie{}20mm.
157
158 @funindex head-separation
159 @item head-separation
160 Distance between the top-most music system and the page header. Default
161 is@tie{}4mm. 
162
163 @funindex foot-separation
164 @item foot-separation
165 Distance between the bottom-most music system and the page
166 footer. Default is@tie{}4mm.
167
168 @funindex page-top-space
169 @item page-top-space
170 Distance from the top of the printable area to the center of the first
171 staff. This only works for staves which are vertically small. Big staves
172 are set with the top of their bounding box aligned to the top of the
173 printable area. Default is@tie{}12mm.
174
175 @funindex ragged-bottom
176 @item ragged-bottom
177 If set to true, systems will not be spread vertically across the page.  This
178 does not affect the last page. Default is false.
179
180 This should be set to true for pieces that have only two or three
181 systems per page, for example orchestral scores.
182
183 @funindex ragged-last-bottom
184 @item ragged-last-bottom
185 If set to false, systems will be spread vertically to fill the last
186 page. Default is true.
187
188 Pieces that amply fill two pages or more should have this set to
189 true.
190
191 @funindex system-count
192 @item system-count
193 This variable, if set, specifies into how many lines a score should be
194 broken. Unset by default.
195
196 @funindex between-system-space
197 @item between-system-space
198 This dimensions determines the distance between systems.  It is the
199 ideal distance between the center of the bottom staff of one system
200 and the center of the top staff of the next system. Default is@tie{}20mm.
201
202 Increasing this will provide a more even appearance of the page at the
203 cost of using more vertical space.
204
205 @funindex between-system-padding
206 @item between-system-padding
207 This dimension is the minimum amount of white space that will always
208 be present between the bottom-most symbol of one system, and the
209 top-most of the next system. Default is@tie{}4mm.
210
211 Increasing this will put systems whose bounding boxes almost touch
212 farther apart.
213
214 @funindex page-breaking-between-system-padding
215 @item page-breaking-between-system-padding
216 This variable tricks the page breaker into thinking that
217 @code{between-system-padding} is set to something different than it
218 really is. For example, if this variable is set to something substantially
219 larger than @code{between-system-padding}, then the page-breaker will put
220 fewer systems on each page.
221
222 @funindex horizontal-shift
223 @item horizontal-shift
224 All systems (including titles and system separators) are shifted by
225 this amount to the right. Page markup, such as headers and footers are
226 not affected by this. The purpose of this variable is to make space
227 for instrument names at the left. Default is@tie{}0.
228
229 @funindex after-title-space
230 @item after-title-space
231 Amount of space between the title and the first system. Default is@tie{}5mm.
232
233 @funindex before-title-space
234 @item before-title-space
235 Amount of space between the last system of the previous piece and the
236 title of the next. Default is@tie{}10mm.
237
238 @funindex between-title-space
239 @item between-title-space
240 Amount of space between consecutive titles (e.g., the title of the
241 book and the title of a piece). Default is@tie{}2mm.
242
243 @funindex printallheaders
244 @item printallheaders
245 Setting this to #t will print all headers for each \score in the
246 output.  Normally only the piece and opus \headers are printed.
247
248 @funindex systemSeparatorMarkup
249 @item systemSeparatorMarkup
250 This contains a markup object, which will be inserted between
251 systems.  This is often used for orchestral scores. Unset by default.
252
253 The markup command @code{\slashSeparator} is provided as a sensible
254 default,  for example
255
256 @lilypond[ragged-right]
257 #(set-default-paper-size "a6" 'landscape)
258 \book {
259   \score {
260     \relative { c1 \break c1 }
261   }
262   \paper {
263     systemSeparatorMarkup = \slashSeparator
264   }
265 }
266 @end lilypond
267
268 @funindex blank-page-force
269 @item blank-page-force
270 The penalty for having a blank page in the middle of a
271 score. This is not used by @code{ly:optimal-breaking} since it will
272 never consider blank pages in the middle of a score. Default value
273 is 10.
274
275 @funindex blank-last-page-force
276 @item blank-last-page-force
277 The penalty for ending the score on an odd-numbered page.
278 Default value is 0.
279
280 @funindex page-spacing-weight
281 @item page-spacing-weight
282 The relative importance of page (vertical) spacing and line (horizontal)
283 spacing. High values will make page spacing more important. Default
284 value is 10.
285
286 @funindex auto-first-page-number
287 @item auto-first-page-number
288 The page breaking algorithm is affected by the first page number being
289 odd or even.  If this variable is set to #t, the page breaking algorithm
290 will decide whether to start with an odd or even number.  This will 
291 result in the first page number remaining as is or being increased by one.
292
293 @end table
294 @end quotation
295
296
297 @commonprop
298
299 The header and footer are created by the functions make-footer and
300 make-header, defined in \paper. The default implementations are in
301 ly/paper-defaults.ly and ly/titling-init.ly.
302
303 The page layout itself is done by two functions in the \paper block,
304 page-music-height and page-make-stencil. The former tells the
305 line-breaking algorithm how much space can be spent on a page, the
306 latter creates the actual page given the system to put on it.
307
308 You can define paper block values in Scheme. In that case mm, in, pt,
309 and cm are variables defined in paper-defaults.ly with values in
310 millimeters. That is why the value 2 cm must be multiplied in the
311 example
312
313 @example
314 \paper @{
315  #(define bottom-margin (* 2 cm))
316 @}
317 @end example
318
319
320 Example:
321
322 @example
323 \paper@{
324   paper-width = 2\cm
325   top-margin = 3\cm
326   bottom-margin = 3\cm
327   ragged-last-bottom = ##t
328 @}
329 @end example
330
331 This second example centers page numbers at the bottom of every page. 
332
333 @example
334 \paper @{
335   print-page-number = ##t
336   print-first-page-number = ##t
337   oddHeaderMarkup = \markup \fill-line @{ " " @}
338   evenHeaderMarkup = \markup \fill-line @{ " " @}
339   oddFooterMarkup = \markup @{ \fill-line @{
340      \bold \fontsize #3 \on-the-fly #print-page-number-check-first
341      \fromproperty #'page:page-number-string @} @}
342   evenFooterMarkup = \markup @{ \fill-line @{
343      \bold \fontsize #3 \on-the-fly #print-page-number-check-first
344      \fromproperty #'page:page-number-string @} @}
345 @} 
346 @end example
347
348 You can also define these values in Scheme.  In that case @code{mm},
349 @code{in}, @code{pt}, and @code{cm} are variables defined in
350 @file{paper-defaults.ly} with values in millimeters.  That is why the
351 value must be multiplied in the example
352
353 @example
354 \paper @{
355   #(define bottom-margin (* 2 cm))
356 @}
357 @end example
358
359 The header and footer are created by the functions @code{make-footer}
360 and @code{make-header}, defined in @code{\paper}.  The default
361 implementations are in @file{ly/@/paper@/-defaults@/.ly} and
362 @file{ly/@/titling@/-init@/.ly}.
363
364 The page layout itself is done by two functions in the
365 @code{\paper} block, @code{page-music-height} and
366 @code{page-make-stencil}.  The former tells the line-breaking algorithm
367 how much space can be spent on a page, the latter creates the actual
368 page given the system to put on it.
369
370
371 @refbugs
372
373 The option right-margin is defined but doesn't set the right margin
374 yet.  The value for the right margin has to be defined adjusting the
375 values of @code{left-margin} and @code{line-width}.
376
377 The default page header puts the page number and the @code{instrument}
378 field from the @code{\header} block on a line.
379
380 The titles (from the @code{\header@{@}} section) are treated as a
381 system, so @code{ragged-bottom} and @code{ragged-last-bottom} will
382 add space between the titles and the first system of the score.
383
384
385 @node Music layout
386 @section Music layout
387
388 @menu
389 * Setting the staff size::      
390 * Score layout::                
391 @end menu
392
393
394 @node Setting the staff size
395 @subsection Setting the staff size
396
397 @cindex font size, setting
398 @cindex staff size, setting
399 @funindex layout file
400
401 To set the staff size globally for all scores in a file (or
402 in a @code{book} block, to be precise), use @code{set-global-staff-size}.
403
404 @example
405 #(set-global-staff-size 14)
406 @end example
407
408 @noindent
409 This sets the global default size to 14pt staff height and scales all
410 fonts accordingly.
411
412 To set the staff size individually for each score, use 
413 @example
414 \score@{
415   ...
416   \layout@{
417   #(layout-set-staff-size 15)
418   @}
419 @}
420 @end example
421
422 The Feta font provides musical symbols at eight different
423 sizes.  Each font is tuned for a different staff size: at a smaller size
424 the font becomes heavier, to match the relatively heavier staff lines.
425 The recommended font sizes are listed in the following table:
426
427 @quotation
428 @multitable @columnfractions .15 .2 .22 .2
429
430 @item @b{font name}
431 @tab @b{staff height (pt)}
432 @tab @b{staff height (mm)}
433 @tab @b{use}
434
435 @item feta11
436 @tab 11.22
437 @tab 3.9
438 @tab pocket scores
439
440 @item feta13
441 @tab 12.60
442 @tab 4.4
443 @tab
444
445 @item feta14
446 @tab 14.14
447 @tab 5.0
448 @tab
449
450 @item feta16
451 @tab 15.87
452 @tab 5.6
453 @tab
454
455 @item feta18
456 @tab 17.82
457 @tab 6.3
458 @tab song books
459
460 @item feta20
461 @tab 20
462 @tab 7.0
463 @tab standard parts
464
465 @item feta23
466 @tab 22.45
467 @tab 7.9
468 @tab
469
470 @item feta26
471 @tab 25.2
472 @tab 8.9
473 @tab
474 @c modern rental material?
475
476 @end multitable
477 @end quotation
478
479 These fonts are available in any sizes.  The context property
480 @code{fontSize} and the layout property @code{staff-space} (in
481 @internalsref{StaffSymbol}) can be used to tune the size for individual
482 staves.  The sizes of individual staves are relative to the global size.
483
484 @example
485
486 @end example
487
488 @seealso
489
490 This manual: @ref{Selecting notation font size}.
491
492
493 @node Score layout
494 @subsection Score layout
495
496 @funindex \layout
497
498 While @code{\paper} contains settings that relate to the page formatting
499 of the whole document, @code{\layout} contains settings for score-specific
500 layout.
501
502 @example
503 \layout @{
504   indent = 2.0\cm
505   \context @{ \Staff
506     \override VerticalAxisGroup #'minimum-Y-extent = #'(-6 . 6)
507   @}
508   \context @{ \Voice
509     \override TextScript #'padding = #1.0
510     \override Glissando #'thickness = #3
511   @}
512 @}
513 @end example
514
515
516 @seealso
517
518 This manual: @ref{Changing context default settings}.
519
520
521 @node Displaying spacing
522 @section Displaying spacing
523
524 @funindex annotate-spacing
525 @cindex Spacing, display of properties
526
527 To graphically display the dimensions of vertical properties that may
528 be altered for page formatting, set @code{annotate-spacing} in the
529 @code{\paper} block, like this
530
531
532 @lilypond[verbatim]
533 #(set-default-paper-size "a6" 'landscape)
534
535 \book {
536   \score { { c4 } }
537   \paper { annotate-spacing = ##t }
538 }
539 @end lilypond
540
541 @c need to have \book{} otherwise we get  the separate systems. -hwn
542
543 @noindent
544 @c  FIXME: really bad vagueness due to bug in annotate-spacing.  -gp
545 Some unit dimensions are measured in staff spaces, while others
546 are measured in millimeters.
547 The pairs
548 (@var{a},@var{b}) are intervals, where @var{a} is the lower edge and
549 @var{b} the upper edge of the interval.
550
551
552 @node Breaks
553 @section Breaks
554
555 @menu
556 * Line breaking::               
557 * Page breaking::               
558 * Optimal page breaking::       
559 * Optimal page turning::        
560 * Minimal page breaking::        
561 * Explicit breaks::             
562 * Using an extra voice for breaks::  
563 @end menu
564
565 @node Line breaking
566 @subsection Line breaking
567
568 @cindex line breaks
569 @cindex breaking lines
570
571 Line breaks are normally computed automatically.  They are chosen so
572 that lines look neither cramped nor loose, and that consecutive lines
573 have similar density.
574
575 Occasionally you might want to override the automatic breaks; you can
576 do this by specifying @code{\break}.  This will force a line break at
577 this point.  Line breaks can only occur at places where there are bar
578 lines.  If you want to have a line break where there is no bar line,
579 you can force an invisible bar line by entering @code{\bar
580 ""}.  Similarly, @code{\noBreak} forbids a line break at a
581 point.
582
583
584 @cindex regular line breaks
585 @cindex four bar music.
586
587 For line breaks at regular intervals use @code{\break} separated by
588 skips and repeated with @code{\repeat}:
589 @example
590 << \repeat unfold 7 @{
591          s1 \noBreak s1 \noBreak
592          s1 \noBreak s1 \break @}
593    @emph{the real music}
594 >>
595 @end example
596
597 @noindent
598 This makes the following 28 measures (assuming 4/4 time) be broken every
599 4 measures, and only there.
600
601 @refcommands
602
603 @code{\break}, and @code{\noBreak}.
604 @funindex \break
605 @funindex \noBreak
606
607 @seealso
608
609 Internals: @internalsref{LineBreakEvent}.
610
611 A linebreaking configuration can be saved as a @code{.ly} file
612 automatically.  This allows vertical alignments to be stretched to
613 fit pages in a second formatting run.  This is fairly new and
614 complicated.  More details are available in
615 @lsrdir{spacing}
616
617 @refbugs
618
619 Line breaks can only occur if there is a @q{proper} bar line.  A note
620 which is hanging over a bar line is not proper, such as
621
622 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
623 c4 c2 c2 \break   % this does nothing
624 c2 c4 |           % a break here would work
625 c4 c2 c4 ~ \break % as does this break
626 c4 c2 c4
627 @end lilypond
628
629 This can be avoided by removing the @code{Forbid_line_break_engraver}
630 and adding the line breaks in another voice:
631
632 @lilypond[quote,ragged-right,verbatim]
633 \new Staff <<
634   \new Voice \with {
635     \remove Forbid_line_break_engraver
636   } {
637     c'4 c'2 c'2 c'2 c'4
638   }
639   \new Voice {
640     s1 \break s1
641   }
642 >>
643 @end lilypond
644
645
646 @node Page breaking
647 @subsection Page breaking
648
649 The default page breaking may be overriden by inserting
650 @code{\pageBreak} or @code{\noPageBreak} commands.  These commands are
651 analogous to @code{\break} and @code{\noBreak}.  They should be
652 inserted at a bar line.  These commands force and forbid a page-break
653 from happening.  Of course, the @code{\pageBreak} command also forces
654 a line break.
655
656 The @code{\pageBreak} and @code{\noPageBreak} commands may also be
657 inserted at top-level, between scores and top-level markups.
658
659 Page breaks are computed by the @code{page-breaking} function.  LilyPond
660 provides three algorithms for computing page breaks,
661 @code{ly:optimal-breaking}, @code{ly:page-turn-breaking} and
662 @code{ly:minimal-breaking}. The default is @code{ly:optimal-breaking},
663 but the value can be changed in the @code{\paper} block:
664
665 @example
666 \paper@{
667   #(define page-breaking ly:page-turn-breaking)
668 @}
669 @end example
670
671 The old page breaking algorithm is called
672 @code{optimal-page-breaks}. If you are having trouble with the new page
673 breakers, you can enable the old one as a workaround.
674
675 @refcommands
676
677 @funindex \pageBreak
678 @code{\pageBreak}
679 @funindex \noPageBreak
680 @code{\noPageBreak}
681
682
683 @node Optimal page breaking
684 @subsection Optimal page breaking
685
686 @funindex ly:optimal-breaking
687
688 The @code{ly:optimal-breaking} function is LilyPond's default method of
689 determining page breaks. It attempts to find a page breaking that minimizes
690 cramping and stretching, both horizontally and vertically. Unlike
691 @code{ly:page-turn-breaking}, it has no concept of page turns.
692
693
694 @node Optimal page turning
695 @subsection Optimal page turning
696
697 @funindex ly:page-turn-breaking
698
699 Often it is necessary to find a page breaking configuration so that there is
700 a rest at the end of every second page. This way, the musician can turn the
701 page without having to miss notes. The @code{ly:page-turn-breaking} function
702 attempts to find a page breaking minimizing cramping and stretching, but with
703 the additional restriction that it is only allowed to introduce page turns
704 in specified places.
705
706 There are two steps to using this page breaking function. First, you
707 must enable it in the @code{\paper} block, as explained in @ref{Page
708 breaking}. Then you must tell the function where you would like to allow
709 page breaks.
710
711 There are two ways to achieve the second step. First, you can specify each
712 potential page turn manually, by inserting @code{\allowPageTurn} into your
713 input file at the appropriate places.
714
715 If this is too tedious, you can add a @code{Page_turn_engraver} to a Staff or
716 Voice context. The @code{Page_turn_engraver} will scan the context for
717 sections without notes (note that it does not scan for rests; it scans for
718 the absence of notes. This is so that single-staff polyphony with rests in one
719 of the parts does not throw off the @code{Page_turn_engraver}). When it finds
720 a sufficiently long section without notes, the @code{Page_turn_engraver} will
721 insert an @code{\allowPageTurn} at the final barline in that section, unless
722 there is a @q{special} barline (such as a double bar), in which case the
723 @code{\allowPageTurn} will be inserted at the final @q{special} barline in
724 the section.
725
726 @funindex minimumPageTurnLength
727 The @code{Page_turn_engraver} reads the context property
728 @code{minimumPageTurnLength} to determine how long a note-free section must
729 be before a page turn is considered. The default value for
730 @code{minimumPageTurnLength} is @code{#(ly:make-moment 1 1)}. If you want
731 to disable page turns, you can set it to something very large.
732
733 @example
734 \new Staff \with @{ \consists "Page_turn_engraver" @}
735 @{
736   a4 b c d |
737   R1 | % a page turn will be allowed here
738   a4 b c d |
739   \set Staff.minimumPageTurnLength = #(ly:make-moment 5 2)
740   R1 | % a page turn will not be allowed here
741   a4 b r2 |
742   R1*2 | % a page turn will be allowed here
743   a1
744 @}
745 @end example
746
747 @funindex minimumRepeatLengthForPageTurn
748 The @code{Page_turn_engraver} detects volta repeats. It will only allow a page
749 turn during the repeat if there is enough time at the beginning and end of the
750 repeat to turn the page back. The @code{Page_turn_engraver} can also disable
751 page turns if the repeat is very short. If you set the context property
752 @code{minimumRepeatLengthForPageTurn} then the @code{Page_turn_engraver} will
753 only allow turns in repeats whose duration is longer than this value.
754
755 The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and
756 @code{\allowPageTurn}, may also be used at top-level, between scores and
757 top-level markups.
758
759 @refcommands
760
761 @funindex \pageTurn
762 @code{\pageTurn}
763 @funindex \noPageTurn
764 @code{\noPageTurn}
765 @funindex \allowPageTurn
766 @code{\allowPageTurn}
767
768 @refbugs
769
770 There should only be one @code{Page_turn_engraver} in a score. If there is more
771 than one, they will interfere with each other.
772
773 @node Minimal page breaking
774 @subsection Minimal page breaking
775
776 @funindex ly:minimal-breaking
777
778 The @code{ly:minimal-breaking} function performs minimal computations to
779 calculate the page breaking: it fills a page with as many systems as
780 possible before moving to the next one.  Thus, it may be prefered for
781 scores with many pages, where the other page breaking functions could be
782 too slow or memory demanding, or a lot of texts.  It is enabled using:
783
784 @example
785 \paper @{
786   #(define page-breaking ly:minimal-breaking)
787 @}
788 @end example
789
790 @node Explicit breaks
791 @subsection Explicit breaks
792
793 Lily sometimes rejects explicit @code{\break} and @code{\pageBreak}
794 commands.  There are two commands to override this behavior:
795
796 @example
797 \override NonMusicalPaperColumn #'line-break-permission = ##f
798 \override NonMusicalPaperColumn #'page-break-permission = ##f
799 @end example
800
801 When @code{line-break-permission} is overriden to false, Lily will insert
802 line breaks at explicit @code{\break} commands and nowhere else.  When
803 @code{page-break-permission} is overriden to false, Lily will insert
804 page breaks at explicit @code{\pageBreak} commands and nowhere else.
805
806 @lilypond[quote,verbatim]
807 \paper {
808   indent = #0
809   ragged-right = ##t
810   ragged-bottom = ##t
811 }
812
813 \score {
814   \new Score \with {
815     \override NonMusicalPaperColumn #'line-break-permission = ##f
816     \override NonMusicalPaperColumn #'page-break-permission = ##f
817   } {
818     \new Staff {
819       \repeat unfold 2 { c'8 c'8 c'8 c'8 } \break
820       \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
821       \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
822       \repeat unfold 8 { c'8 c'8 c'8 c'8 } \pageBreak
823       \repeat unfold 8 { c'8 c'8 c'8 c'8 } \break
824       \repeat unfold 6 { c'8 c'8 c'8 c'8 } \break
825       \repeat unfold 4 { c'8 c'8 c'8 c'8 } \break
826       \repeat unfold 2 { c'8 c'8 c'8 c'8 }
827     }
828   }
829 }
830 @end lilypond
831
832
833 @node Using an extra voice for breaks
834 @subsection Using an extra voice for breaks
835
836 Line- and page-breaking information usually appears within note entry directly.
837
838 @example
839 \new Score @{
840   \new Staff @{
841     \repeat unfold 2 @{ c'4 c'4 c'4 c'4 @}
842     \break
843     \repeat unfold 3 @{ c'4 c'4 c'4 c'4 @}
844   @}
845 @}
846 @end example
847
848 This makes @code{\break} and @code{\pageBreak} commands easy to enter but mixes
849 music entry with information that specifies how music should lay out
850 on the page.  You can keep music entry and line- and page-breaking
851 information in two separate places by introducing an extra voice to 
852 contain the  breaks.  This extra voice
853 contains only skips together with @code{\break}, @code{pageBreak} and other
854 breaking layout information.
855
856 @lilypond[quote,verbatim]
857 \new Score {
858   \new Staff <<
859      \new Voice {
860         s1 * 2 \break
861         s1 * 3 \break
862         s1 * 6 \break
863         s1 * 5 \break
864      }
865      \new Voice {
866         \repeat unfold 2 { c'4 c'4 c'4 c'4 }
867         \repeat unfold 3 { c'4 c'4 c'4 c'4 }
868         \repeat unfold 6 { c'4 c'4 c'4 c'4 }
869         \repeat unfold 5 { c'4 c'4 c'4 c'4 }
870      }
871   >>
872 }
873 @end lilypond
874
875 This pattern becomes especially helpful when overriding
876 @code{line-break-system-details} and the other useful but long properties of
877 @code{NonMusicalPaperColumnGrob}, as explained in @ref{Vertical spacing}.
878
879 @lilypond[quote,verbatim]
880 \new Score {
881   \new Staff <<
882      \new Voice {
883
884         \overrideProperty "Score.NonMusicalPaperColumn"
885         #'line-break-system-details #'((Y-offset . 0))
886         s1 * 2 \break
887
888         \overrideProperty "Score.NonMusicalPaperColumn"
889         #'line-break-system-details #'((Y-offset . 35))
890         s1 * 3 \break
891
892         \overrideProperty "Score.NonMusicalPaperColumn"
893         #'line-break-system-details #'((Y-offset . 70))
894         s1 * 6 \break
895
896         \overrideProperty "Score.NonMusicalPaperColumn"
897         #'line-break-system-details #'((Y-offset . 105))
898         s1 * 5 \break
899      }
900      \new Voice {
901         \repeat unfold 2 { c'4 c'4 c'4 c'4 }
902         \repeat unfold 3 { c'4 c'4 c'4 c'4 }
903         \repeat unfold 6 { c'4 c'4 c'4 c'4 }
904         \repeat unfold 5 { c'4 c'4 c'4 c'4 }
905      }
906   >>
907 }
908 @end lilypond
909
910
911 @node Vertical spacing
912 @section Vertical spacing
913
914 @cindex vertical spacing
915 @cindex spacing, vertical
916
917 Vertical spacing is controlled by three things: the amount of
918 space available (i.e., paper size and margins), the amount of
919 space between systems, and the amount of space between
920 staves inside a system.
921
922 @menu
923 * Vertical spacing inside a system::  
924 * Vertical spacing between systems::  
925 * Explicit staff and system positioning::  
926 * Two-pass vertical spacing::   
927 * Vertical collision avoidance::  
928 @end menu
929
930
931 @node Vertical spacing inside a system
932 @subsection Vertical spacing inside a system
933
934 @cindex distance between staves
935 @cindex staff distance
936 @cindex space between staves
937 @cindex space inside systems
938
939 The height of each system is determined automatically.  To prevent
940 staves from bumping into each other, some minimum distances are set.
941 By changing these, you can put staves closer together.  This
942 reduces the amount of space each system requires, and may result
943 in having more systems per page.
944
945 Normally staves are stacked vertically.  To make staves maintain a
946 distance, their vertical size is padded.  This is done with the
947 property @code{minimum-Y-extent}.  When applied to a
948 @internalsref{VerticalAxisGroup}, it controls the size of a horizontal
949 line, such as a staff or a line of lyrics.  @code{minimum-Y-extent}
950 takes a pair of numbers, so
951 if you want to make it smaller than its default @code{#'(-4 . 4)}
952 then you could set
953
954 @example
955 \override Staff.VerticalAxisGroup #'minimum-Y-extent = #'(-3 . 3)
956 @end example
957
958 @noindent
959 This sets the vertical size of the current staff to 3 staff spaces on
960 either side of the center staff line.  The value @code{(-3 . 3)} is
961 interpreted as an interval, where the center line is the 0, so the
962 first number is generally negative.  The numbers need not match;
963 for example, the staff can be made larger at the bottom by setting
964 it to @code{(-6 . 4)}.
965
966 After page breaks are determined, the vertical spacing within each
967 system is reevaluated in order to fill the page more evenly; if a page
968 has space left over, systems are stretched in order to fill that space.
969 The amount of stretching can be configured though the @code{max-stretch}
970 property of the @internalsref{VerticalAlignment} grob. To disable this
971 stretching entirely, set @code{max-stretch} to zero.
972
973 In some situations, you may want to stretch most of a system while
974 leaving some parts fixed. For example, if a piano part occurs in the
975 middle of an orchestral score, you may want to leave the piano staves
976 close to each other while stretching the rest of the score. The
977 @code{keep-fixed-while-stretching} property of
978 @internalsref{VerticalAxisGroup} can be used to achieve this. When set
979 to @code{##t}, this property keeps its staff (or line of lyrics) from
980 moving relative to the one directly above it. In the example above,
981 you would override @code{keep-fixed-while-stretching} to @code{##t} in
982 the second piano staff:
983
984 @lilypond[verbatim]
985 #(set-default-paper-size "a6")
986 #(set-global-staff-size 14.0)
987
988 \book {
989 \paper {
990   ragged-last-bottom = ##f
991 }
992
993 \score {
994 \new GrandStaff
995 <<
996   \new StaffGroup
997   <<
998     \new Staff {c' d' e' f'}
999     \new Staff {c' d' e' f'}
1000     \new Staff {c' d' e' f'}
1001   >>
1002
1003   \new PianoStaff
1004   <<
1005     \new Staff {c' d' e' f'}
1006     \new Staff \with {
1007       \override VerticalAxisGroup #'keep-fixed-while-stretching = ##t
1008     }
1009     {c' d' e' f'}
1010   >>
1011
1012   \new StaffGroup
1013   <<
1014     \new Staff {c' d' e' f'}
1015     \new Staff {c' d' e' f'}
1016   >>
1017 >>
1018 }
1019 }
1020 @end lilypond
1021
1022 @seealso
1023
1024 Internals: Vertical alignment of staves is handled by the
1025 @internalsref{VerticalAlignment} object. The context parameters
1026 specifying the vertical extent are described in connection with
1027 the @internalsref{Axis_group_engraver}.
1028
1029 Example files: @lsr{spacing,page-spacing.ly},
1030 @lsr{spacing,alignment-vertical-spacing.ly}.
1031
1032
1033 @node Vertical spacing between systems
1034 @subsection Vertical spacing between systems
1035
1036 Space between systems are controlled by four @code{\paper} variables,
1037
1038 @example
1039 \paper @{
1040   between-system-space = 1.5\cm
1041   between-system-padding = #1
1042   ragged-bottom=##f
1043   ragged-last-bottom=##f
1044 @}
1045 @end example
1046
1047 When only a couple of flat systems are placed on a page, the resulting
1048 vertical spacing may be non-eleguant: one system at the top of the page,
1049 and the other at the bottom, with a huge gap between them. To avoid this
1050 situation, the space added between the systems can be limited. This
1051 feature is activated by setting to @code{#t} the
1052 @code{page-limit-inter-system-space} variable in the @code{\paper}
1053 block. The paper variable @code{page-limit-inter-system-space-factor}
1054 determines how much the space can be increased: for instance, the value
1055 @code{1.3} means that the space can be 30% larger than what it would be
1056 on a ragged-bottom page.
1057
1058 In the following example, if the inter system space were not limited,
1059 the second system of page 1 would be placed at the page bottom. By
1060 activating the space limitation, the second system is placed closer to
1061 the first one. By setting @code{page-limit-inter-system-space-factor} to
1062 @code{1}, the spacing would the same as on a ragged-bottom page, like
1063 the last one.
1064
1065 @lilypond[verbatim]
1066 #(set-default-paper-size "a6")
1067 \book {
1068   \paper {
1069     page-limit-inter-system-space = ##t
1070     page-limit-inter-system-space-factor = 1.3
1071
1072     oddFooterMarkup = \markup "page bottom"
1073     evenFooterMarkup = \markup "page bottom"
1074     oddHeaderMarkup = \markup \fill-line {
1075       "page top" \fromproperty #'page:page-number-string }
1076     evenHeaderMarkup = \markup \fill-line {
1077       "page top" \fromproperty #'page:page-number-string }
1078   }
1079   \new Staff << \repeat unfold 4 { g'4 g' g' g' \break }
1080                 { s1*2 \pageBreak } >>
1081 }
1082 @end lilypond
1083
1084 @node Explicit staff and system positioning
1085 @subsection Explicit staff and system positioning
1086
1087 One way to understand the @code{VerticalAxisGroup} and @code{\paper}
1088 settings explained in the previous two sections is as a collection of
1089 different settings that primarily concern the amount of vertical padding
1090 different staves and systems running down the page.
1091
1092 It is possible to approach vertical spacing in a different way using
1093 @code{NonMusicalPaperColumn #'line-break-system-details}.  Where
1094 @code{VerticalAxisGroup} and @code{\paper} settings specify vertical padding,
1095 @code{NonMusicalPaperColumn #'line-break-system-details} specifies exact
1096 vertical positions on the page.
1097
1098 @code{NonMusicalPaperColumn #'line-break-system-details} accepts an associative
1099 list of five different settings:
1100
1101 @itemize 
1102 @item @code{X-offset}
1103 @item @code{Y-offset}
1104 @item @code{alignment-offsets}
1105 @item @code{alignment-extra-space}
1106 @item @code{fixed-alignment-extra-space}
1107 @end itemize
1108
1109 Grob overrides, including the overrides for @code{NonMusicalPaperColumn}
1110 below, can occur in any of three different places in an input file:
1111
1112 @itemize
1113 @item in the middle of note entry directly
1114 @item in a @code{\context} block
1115 @item in the @code{\with} block
1116 @end itemize
1117
1118 When we override @code{NonMusicalPaperColumn}, we use the usual
1119 @code{\override} command in @code{\context} blocks and in the
1120 @code{\with} block.  On the other hand, when we override
1121 @code{NonMusicalPaperColumn} in the middle of note entry,
1122 use the special @code{\overrideProperty} command.  Here are some
1123 example @code{NonMusicalPaperColumn} overrides with the special
1124 @code{\overrideProperty} command:
1125
1126 @example
1127 \overrideProperty NonMusicalPaperColumn
1128   #'line-break-system-details #'((X-offset . 20))
1129
1130 \overrideProperty NonMusicalPaperColumn
1131   #'line-break-system-details #'((Y-offset . 40))
1132
1133 \overrideProperty NonMusicalPaperColumn
1134   #'line-break-system-details #'((X-offset . 20) (Y-offset . 40))
1135
1136 \override NonMusicalPaperColumn
1137   #'line-break-system-details #'((alignment-offsets . (0 -15)))
1138
1139 \override NonMusicalPaperColumn
1140   #'line-break-system-details #'((X-offset . 20) (Y-offset . 40)
1141                                  (alignment-offsets . (0 -15)))
1142 @end example
1143
1144 To understand how each of these different settings work, we begin
1145 by looking at an example that includes no overrides at all.
1146
1147 @lilypond[quote,ragged-right]
1148 \new Score <<
1149   \new Staff <<
1150     \new Voice {
1151       s1 * 6 \break
1152       s1 * 6 \break
1153       s1 * 6 \break
1154     }
1155     \new Voice { \repeat unfold 18 { c'4 c'4 c'4 c'4 } }
1156   >>
1157   \new Staff {
1158     \repeat unfold 18 { d'4 d'4 d'4 d'4 }
1159   }
1160 >>
1161 @end lilypond
1162
1163 This score isolates line- and page-breaking information in a dedicated
1164 voice. This technique of creating a breaks voice will help keep layout
1165 separate from music entry as our example becomes more complicated.
1166 See @ref{Using an extra voice for breaks}.
1167
1168 Explicit @code{\breaks} evenly divide the music into six measures per
1169 line.  Vertical spacing results from LilyPond's defaults.  To set
1170 the vertical startpoint of each system explicitly, we can set
1171 the @code{Y-offset} pair in the @code{line-break-system-details}
1172 attribute of the @code{NonMusicalPaperColumn} grob:
1173
1174 @lilypond[quote,ragged-right]
1175 \new Score <<
1176   \new Staff <<
1177     \new Voice {
1178       \overrideProperty #"Score.NonMusicalPaperColumn"
1179         #'line-break-system-details #'((Y-offset . 0))
1180       s1 * 6 \break
1181       \overrideProperty #"Score.NonMusicalPaperColumn"
1182         #'line-break-system-details #'((Y-offset . 40))
1183       s1 * 6 \break
1184       \overrideProperty #"Score.NonMusicalPaperColumn"
1185         #'line-break-system-details #'((Y-offset . 80))
1186       s1 * 6 \break
1187     }
1188     \new Voice { \repeat unfold 18 { c'4 c'4 c'4 c'4 } }
1189   >>
1190   \new Staff {
1191     \repeat unfold 18 { d'4 d'4 d'4 d'4 }
1192   }
1193 >>
1194 @end lilypond
1195
1196 Note that @code{line-break-system-details} takes an associative list of
1197 potentially many values, but that we set only one value here.  Note,
1198 too, that the @code{Y-offset} property here determines the exact vertical
1199 position on the page at which each new system will render.
1200
1201 Now that we have set the vertical startpoint of each system
1202 explicitly, we can also set the vertical startpoint of each staff
1203 within each system manually.  We do this using the @code{alignment-offsets}
1204 subproperty of @code{line-break-system-details}.
1205
1206 @lilypond[quote,ragged-right]
1207 \new Score <<
1208   \new Staff <<
1209     \new Voice {
1210       \overrideProperty #"Score.NonMusicalPaperColumn"
1211         #'line-break-system-details #'((Y-offset . 20)
1212           (alignment-offsets . (0 -15)))
1213       s1 * 6 \break
1214       \overrideProperty #"Score.NonMusicalPaperColumn"
1215         #'line-break-system-details #'((Y-offset . 60)
1216           (alignment-offsets . (0 -15)))
1217       s1 * 6 \break
1218       \overrideProperty #"Score.NonMusicalPaperColumn"
1219         #'line-break-system-details #'((Y-offset . 100)
1220           (alignment-offsets . (0 -15)))
1221       s1 * 6 \break
1222     }
1223     \new Voice { \repeat unfold 18 { c'4 c'4 c'4 c'4 } }
1224   >>
1225   \new Staff {
1226     \repeat unfold 18 { d'4 d'4 d'4 d'4 }
1227   }
1228 >>
1229 @end lilypond
1230
1231 Note that here we assign two different values to the
1232 @code{line-break-system-details} attribute of the
1233 @code{NonMusicalPaperColumn} grob.  Though the
1234 @code{line-break-system-details} attribute alist accepts many
1235 additional spacing parameters (including, for example, a corresponding
1236 @code{X-offset} pair), we need only set the @code{Y-offset} and
1237 @code{alignment-offsets} pairs to control the vertical startpoint of
1238 every system and every staff.  Finally, note that @code{alignment-offsets}
1239 specifies the vertical positioning of staves but not of staff groups.
1240
1241 @lilypond[quote,ragged-right]
1242 \new Score <<
1243   \new Staff <<
1244     \new Voice {
1245       \overrideProperty #"Score.NonMusicalPaperColumn"
1246       #'line-break-system-details #'((Y-offset . 0)
1247         (alignment-offsets . (0 -30 -40)))
1248       s1 * 6 \break
1249       \overrideProperty #"Score.NonMusicalPaperColumn"
1250       #'line-break-system-details #'((Y-offset . 60)
1251         (alignment-offsets . (0 -10 -20)))
1252       s1 * 6 \break
1253       \overrideProperty #"Score.NonMusicalPaperColumn"
1254       #'line-break-system-details #'((Y-offset . 100)
1255         (alignment-offsets . (0 -10, -40)))
1256       s1 * 6 \break
1257     }
1258     \new Voice { \repeat unfold 18 { c'4 c'4 c'4 c'4 } }
1259   >>
1260   \new StaffGroup <<
1261     \new Staff {
1262       \repeat unfold 18 { d'4 d'4 d'4 d'4 }
1263     }
1264     \new Staff {
1265       \repeat unfold 18 { e'4 e'4 e'4 e'4 }
1266     }
1267   >>
1268 >>
1269 @end lilypond
1270
1271 Some points to consider:
1272
1273 @itemize
1274 @item When using @code{alignment-offsets}, lyrics count as a staff.
1275
1276 @item The units of the numbers passed to @code{X-offset},
1277 @code{Y-offset} and @code{alignment-offsets} are interpreted as multiples
1278 of the distance between adjacent staff lines.  Positive values move staves
1279 and lyrics up, negative values move staves and lyrics down.
1280
1281 @item Because the @code{NonMusicalPaperColumn #'line-break-system-details}
1282 settings given here allow the positioning of staves and systems anywhere
1283 on the page, it is possible to violate paper or margin boundaries or even
1284 to print staves or systems on top of one another.  Reasonable values
1285 passed to these different settings will avoid this.
1286 @end itemize
1287
1288
1289 @node Two-pass vertical spacing
1290 @subsection Two-pass vertical spacing
1291
1292 Warning: two-pass vertical spacing is deprecated and will be removed in
1293 a future version of LilyPond. Systems are now stretched automatically
1294 in a single pass. See @ref{Vertical spacing inside a system}.
1295
1296 In order to automatically stretch systems so that they should fill the
1297 space left on a page, a two-pass technique can be used:
1298
1299 @enumerate
1300 @item In the first pass, the amount of vertical space used to increase
1301 the height of each system is computed and dumped to a file.
1302 @item In the second pass, spacing inside the systems are
1303 stretched according to the data in the page layout file.
1304 @end enumerate
1305
1306 The @code{ragged-bottom} property adds space between systems, while
1307 the two-pass technique adds space between staves inside a system.
1308
1309 To allow this behaviour, a @code{tweak-key} variable has to be set in
1310 each score @code{\layout} block, and the tweaks included in each score
1311 music, using the @code{\scoreTweak} music function.
1312
1313 @quotation
1314 @verbatim
1315 %% include the generated page layout file:
1316 \includePageLayoutFile
1317
1318 \score {
1319   \new StaffGroup <<
1320     \new Staff <<
1321       %% Include this score tweaks:
1322       \scoreTweak "scoreA"
1323       { \clef french c''1 \break c''1 }
1324     >>
1325     \new Staff { \clef soprano g'1 g'1 }
1326     \new Staff { \clef mezzosoprano e'1 e'1 }
1327     \new Staff { \clef alto g1 g1 }
1328     \new Staff { \clef bass c1 c1 }
1329   >>
1330   \header {
1331     piece = "Score with tweaks"
1332   }
1333   %% Define how to name the tweaks for this score:
1334   \layout { #(define tweak-key "scoreA") }
1335 }
1336 @end verbatim
1337 @end quotation
1338
1339 For the first pass, the @code{dump-tweaks} option should be set to
1340 generate the page layout file.
1341
1342 @example
1343 lilypond -dbackend=null -d dump-tweaks <file>.ly
1344 lilypond <file>.ly
1345 @end example
1346
1347
1348 @node Vertical collision avoidance
1349 @subsection Vertical collision avoidance
1350
1351 @funindex outside-staff-priority
1352 @funindex outside-staff-padding
1353 @funindex outside-staff-horizontal-padding
1354
1355 Intuitively, there are some objects in musical notation that belong
1356 to the staff and there are other objects that should be placed outside
1357 the staff.  Objects belonging outside the staff include things such as
1358 rehearsal marks, text and dynamic markings (from now on, these will
1359 be called outside-staff objects).  LilyPond's rule for the
1360 vertical placement of outside-staff objects is to place them as close
1361 to the staff as possible but not so close that they collide with
1362 another object.
1363
1364 LilyPond uses the @code{outside-staff-priority} property to determine
1365 whether a grob is an outside-staff object: if @code{outside-staff-priority}
1366 is a number, the grob is an outside-staff object.  In addition,
1367 @code{outside-staff-priority} tells LilyPond in which order the objects
1368 should be placed.
1369
1370 First, LilyPond places all the objects that do not belong outside
1371 the staff.  Then it sorts the outside-staff objects according to their
1372 @code{outside-staff-priority} (in increasing order).  One by one, LilyPond
1373 takes the outside-staff objects and places them so that they do
1374 not collide with any objects that have already been placed.  That
1375 is, if two outside-staff grobs are competing for the same space, the one
1376 with the lower @code{outside-staff-priority} will be placed closer to
1377 the staff.
1378
1379 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1380 c4_"Text"\pp
1381 r2.
1382 \once \override TextScript #'outside-staff-priority = #1
1383 c4_"Text"\pp % this time the text will be closer to the staff
1384 r2.
1385 % by setting outside-staff-priority to a non-number, we
1386 % disable the automatic collision avoidance
1387 \once \override TextScript #'outside-staff-priority = ##f
1388 \once \override DynamicLineSpanner #'outside-staff-priority = ##f
1389 c4_"Text"\pp % now they will collide
1390 @end lilypond
1391
1392 The vertical padding between an outside-staff object and the
1393 previously-positioned grobs can be controlled with
1394 @code{outside-staff-padding}.
1395
1396 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1397 \once \override TextScript #'outside-staff-padding = #0
1398 a'^"This text is placed very close to the note"
1399 \once \override TextScript #'outside-staff-padding = #3
1400 c^"This text is padded away from the previous text"
1401 c^"This text is placed close to the previous text"
1402 @end lilypond
1403
1404 By default, outside-staff objects are placed without regard to
1405 their horizontal distance from the previously-posititioned grobs.  This
1406 can lead to situations in which objects are placed very close to each
1407 other horizontally.  Setting @code{outside-staff-horizontal-padding}
1408 causes an object to be offset vertically so that such a situation
1409 doesn't occur.
1410
1411 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1412 % the markup is too close to the following note
1413 c2^"Text"
1414 c''2
1415 % setting outside-staff-horizontal-padding fixes this
1416 R1
1417 \once \override TextScript #'outside-staff-horizontal-padding = #1
1418 c,,2^"Text"
1419 c''2
1420 @end lilypond
1421
1422
1423
1424 @node Horizontal spacing
1425 @section Horizontal Spacing
1426
1427 @cindex horizontal spacing
1428 @cindex spacing, horizontal
1429
1430 @menu
1431 * Horizontal spacing overview::  
1432 * New spacing area::            
1433 * Changing horizontal spacing::  
1434 * Line length::                 
1435 * Proportional notation::       
1436 @end menu
1437
1438
1439 @node Horizontal spacing overview
1440 @subsection Horizontal spacing overview
1441
1442 The spacing engine translates differences in durations into stretchable
1443 distances (@q{springs}) of differring lengths.  Longer durations get
1444 more space, shorter durations get less.  The shortest durations get a
1445 fixed amount of space (which is controlled by
1446 @code{shortest-duration-space} in the @internalsref{SpacingSpanner}
1447 object).  The longer the duration, the more space it gets: doubling a
1448 duration adds a fixed amount (this amount is controlled by
1449 @code{spacing-increment}) of space to the note.
1450
1451 For example, the following piece contains lots of half, quarter, and
1452 8th notes; the eighth note is followed by 1 note head width (NHW).
1453 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
1454
1455 @lilypond[quote,fragment,verbatim,relative=1]
1456 c2 c4. c8 c4. c8 c4. c8 c8
1457 c8 c4 c4 c4
1458 @end lilypond
1459
1460 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
1461 approximately the width of a note head, and
1462 @code{shortest-duration-space} is set to 2.0, meaning that the
1463 shortest note gets 2.4 staff space (2.0 times the
1464 @code{spacing-increment}) of horizontal space.  This space is counted
1465 from the left edge of the symbol, so the shortest notes are generally
1466 followed by one NHW of space.
1467
1468 If one would follow the above procedure exactly, then adding a single
1469 32nd note to a score that uses 8th and 16th notes, would widen up the
1470 entire score a lot.  The shortest note is no longer a 16th, but a 32nd,
1471 thus adding 1 NHW to every note.  To prevent this, the shortest
1472 duration for spacing is not the shortest note in the score, but rather
1473 the one which occurs most frequently.
1474
1475
1476 The most common shortest duration is determined as follows: in every
1477 measure, the shortest duration is determined.  The most common shortest
1478 duration is taken as the basis for the spacing, with the stipulation
1479 that this shortest duration should always be equal to or shorter than
1480 an 8th note.  The shortest duration is printed when you run
1481 @code{lilypond} with the @code{--verbose} option.
1482
1483 These durations may also be customized.  If you set the
1484 @code{common-shortest-duration} in @internalsref{SpacingSpanner}, then
1485 this sets the base duration for spacing.  The maximum duration for this
1486 base (normally an 8th), is set through @code{base-shortest-duration}.
1487
1488 @funindex common-shortest-duration
1489 @funindex base-shortest-duration
1490 @funindex stem-spacing-correction
1491 @funindex spacing
1492
1493 Notes that are even shorter than the common shortest note are
1494 followed by a space that is proportional to their duration relative to
1495 the common shortest note.  So if we were to add only a few 16th notes
1496 to the example above, they would be followed by half a NHW:
1497
1498 @lilypond[quote,fragment,verbatim,relative=2]
1499 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
1500 @end lilypond
1501
1502
1503 In the introduction (see @ref{Engraving}), it was explained that stem
1504 directions influence spacing.  This is controlled with the
1505 @code{stem-spacing-correction} property in the
1506 @internalsref{NoteSpacing}, object.  These are generated for every
1507 @internalsref{Voice} context.  The @code{StaffSpacing} object
1508 (generated in @internalsref{Staff} context) contains the same property
1509 for controlling the stem/bar line spacing.  The following example shows
1510 these corrections, once with default settings, and once with
1511 exaggerated corrections:
1512
1513 @lilypond[quote,ragged-right]
1514 {
1515   c'4 e''4 e'4 b'4 |
1516   b'4 e''4 b'4 e''4|
1517   \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
1518   \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
1519   c'4 e''4 e'4 b'4 |
1520   b'4 e''4 b'4 e''4|
1521 }
1522 @end lilypond
1523
1524 Proportional notation is supported; see @ref{Proportional notation}.
1525
1526
1527 @seealso
1528
1529 Internals: @internalsref{SpacingSpanner}, @internalsref{NoteSpacing},
1530 @internalsref{StaffSpacing}, @internalsref{SeparationItem}, and
1531 @internalsref{SeparatingGroupSpanner}.
1532
1533
1534 @refbugs
1535
1536 There is no convenient mechanism to manually override spacing.  The
1537 following work-around may be used to insert extra space into a score.
1538 @example
1539  \once \override Score.SeparationItem #'padding = #1
1540 @end example
1541
1542 No work-around exists for decreasing the amount of space.
1543
1544
1545 @node New spacing area
1546 @subsection New spacing area
1547
1548 New sections with different spacing parameters can be started with
1549 @code{newSpacingSection}.  This is useful when there are  
1550 sections with a different notions of long and short notes.
1551
1552 In the following example, the time signature change introduces a new
1553 section, and hence the 16ths notes are spaced wider.
1554
1555 @lilypond[relative,fragment,verbatim,quote]
1556 \time 2/4
1557 c4 c8 c 
1558 c8 c c4 c16[ c c8] c4
1559 \newSpacingSection
1560 \time 4/16
1561 c16[ c c8]
1562 @end lilypond
1563
1564
1565 The @code{\newSpacingSection} command creates a new
1566 @internalsref{SpacingSpanner} object, and hence new @code{\override}s
1567 may be used in that location.
1568
1569
1570 @node Changing horizontal spacing
1571 @subsection Changing horizontal spacing
1572
1573 Horizontal spacing may be altered with the
1574 @code{base-shortest-duration} property.  Here
1575 we compare the same music; once without altering
1576 the property, and then altered.  Larger values
1577 of @code{ly:make-moment} will produce smaller
1578 music.  Note that @code{ly:make-moment} constructs
1579 a duration, so @code{1 4} is a longer duration
1580 than @code{1 16}.
1581
1582 @lilypond[relative,verbatim,line-width=12\cm]
1583 \score {
1584   \relative c'' {
1585     g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
1586     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
1587     d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
1588     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
1589   }
1590 }
1591 @end lilypond
1592
1593 @lilypond[relative,verbatim,line-width=12\cm]
1594 \score {
1595   \relative c'' {
1596     g4 e e2 | f4 d d2 | c4 d e f | g4 g g2 |
1597     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
1598     d4 d d d | d4 e f2 | e4 e e e | e4 f g2 |
1599     g4 e e2 | f4 d d2 | c4 e g g | c,1 |
1600   }
1601   \layout {
1602     \context {
1603       \Score
1604       \override SpacingSpanner
1605                 #'base-shortest-duration = #(ly:make-moment 1 16)
1606     }
1607   }
1608 }
1609 @end lilypond
1610
1611
1612 @commonprop
1613
1614 By default, spacing in tuplets depends on various non-duration
1615 factors (such as accidentals, clef changes, etc).  To disregard
1616 such symbols and force uniform equal-duration spacing, use
1617 @code{Score.SpacingSpanner #'uniform-stretching}.  This
1618 property can only be changed at the beginning of a score,
1619
1620 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1621 \new Score \with {
1622   \override SpacingSpanner #'uniform-stretching = ##t
1623 } <<
1624   \new Staff{
1625     \times 4/5 {
1626       c8 c8 c8 c8 c8
1627     }
1628     c8 c8 c8 c8
1629   }
1630   \new Staff{
1631     c8 c8 c8 c8
1632     \times 4/5 {
1633       c8 c8 c8 c8 c8
1634     }
1635   }
1636 >>
1637 @end lilypond
1638
1639
1640 When @code{strict-note-spacing} is set, notes are spaced without
1641 regard for clefs, bar lines, and grace notes,
1642
1643 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1644 \override Score.SpacingSpanner #'strict-note-spacing = ##t
1645 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c]  c32[ c32] }
1646 @end lilypond
1647
1648
1649 @node Line length
1650 @subsection Line length
1651
1652 @cindex page breaks
1653 @cindex breaking pages
1654
1655 @funindex indent
1656 @funindex line-width
1657 @funindex ragged-right
1658 @funindex ragged-last
1659
1660 @c Although line-width can be set in \layout, it should be set in paper
1661 @c block, to get page layout right.
1662 @c Setting indent in \paper block makes not much sense, but it works.
1663
1664 @c Bit verbose and vague, use examples?
1665 The most basic settings influencing the spacing are @code{indent} and
1666 @code{line-width}.  They are set in the @code{\layout} block.  They
1667 control the indentation of the first line of music, and the lengths of
1668 the lines.
1669
1670 If @code{ragged-right} is set to true in the @code{\layout} block, then
1671 systems ends at their natural horizontal length, instead of being spread
1672 horizontally to fill the whole line.  This is useful for
1673 short fragments, and for checking how tight the natural spacing is.
1674
1675 @cindex page layout
1676 @cindex vertical spacing
1677
1678 The option @code{ragged-last} is similar to @code{ragged-right}, but
1679 only affects the last line of the piece.  No restrictions are put on
1680 that line.  The result is similar to formatting text paragraphs.  In a
1681 paragraph, the last line simply takes its natural horizontal length.
1682 @c Note that for text there are several options for the last line.
1683 @c While Knuth TeX uses natural length, lead typesetters use the same
1684 @c stretch as the previous line.  eTeX uses \lastlinefit to
1685 @c interpolate between both these solutions.
1686
1687 @example
1688 \layout @{
1689   indent = #0
1690   line-width = #150
1691   ragged-last = ##t
1692 @}
1693 @end example
1694
1695
1696 @node Proportional notation
1697 @subsection Proportional notation
1698
1699 LilyPond supports proportional notation, a type of horizontal spacing
1700 in which each note consumes an amount of horizontal space exactly
1701 equivalent to its rhythmic duration. This type of proportional spacing
1702 is comparable to horizontal spacing on top of graph paper. Some late
1703 20th- and early 21st-century scores use proportional notation to
1704 clarify complex rhythmic relationships or to faciliate the placement
1705 of timelines or other graphics directly in the score.
1706
1707 LilyPond supports five different settings for proportional notation,
1708 which may be used together or alone:
1709
1710 @itemize
1711 @item @code{proportionalNotationDuration}
1712 @item @code{uniform-stretching}
1713 @item @code{strict-note-spacing}
1714 @item @code{\remove Separating_line_group_engraver}
1715 @item @code{\override PaperColumn #'used = ##t}
1716 @end itemize
1717
1718 In the examples that follow, we explore these five different
1719 proportional notation settings and examine how these settings interact.
1720
1721 We start with the following one-measure example, which uses classical
1722 spacing with ragged-right turned on.
1723
1724 @lilypond[quote,verbatim,ragged-right]
1725 \new Score <<
1726   \new RhythmicStaff {
1727     c'2
1728     c'16 c'16 c'16 c'16
1729     \times 4/5 {
1730       c'16 c'16 c'16 c'16 c'16
1731     }
1732   }
1733 >>
1734 @end lilypond
1735
1736 Notice that the half note which begins the measure takes up far less
1737 than half of the horizontal space of the measure.  Likewise, the
1738 sixteenth notes and sixteenth-note quintuplets (or twentieth notes)
1739 which end the measure together take up far more than half the
1740 horizontal space of the measure.
1741
1742 In classical engraving, this spacing may be exactly what we want
1743 because we can borrow horizontal space from the half note and conserve
1744 horizontal space across the measure as a whole.
1745
1746 On the other hand, if we want to insert a measured timeline or other
1747 graphic above or below our score, we need proportional notation.  We
1748 turn proportional notation on with the proportionalNotationDuration
1749 setting.
1750
1751 @lilypond[quote,verbatim,ragged-right]
1752 \new Score \with {
1753   proportionalNotationDuration = #(ly:make-moment 1 20)
1754 } <<
1755   \new RhythmicStaff {
1756     c'2
1757     c'16 c'16 c'16 c'16
1758     \times 4/5 {
1759       c'16 c'16 c'16 c'16 c'16
1760     }
1761   }
1762 >>
1763 @end lilypond
1764
1765 The half note at the beginning of the measure and the faster notes in
1766 the second half of the measure now occupy equal amounts of horizontal
1767 space.  We could place a measured timeline or graphic above or below
1768 this example.
1769
1770 The @code{proportionalNotationDuration} setting is a context setting that
1771 lives in @context{Score}.  Recall that context settings appear in one of
1772 three locations in our input file -- in a @code{\with} block, in a
1773 @code{\context} block, or directly in music entry
1774 preceeded by the @code{\set} command.  As with all
1775 context settings, users can pick which of the three different
1776 locations they would like to set @code{proportionalNotationDuration}.
1777
1778 The @code{proportionalNotationDuration} setting takes a single argument,
1779 which is the reference duration against which all music will be
1780 spaced.  The LilyPond Scheme function make-moment takes two arguments
1781 -- a numerator and denominator which together express some fraction of
1782 a whole note. The call @code{#(ly:make-moment 1 20)} therefore produces a
1783 reference duration of a twentieth note. The values
1784 @code{#(ly:make-moment 1 16)}, @code{#(ly:make-moment 1 8)}, and
1785 @code{#(ly:make-moment 3 97)} are all possible as well.
1786
1787 How do we select the right reference duration to pass to
1788 @code{proportionalNotationDuration}?  Usually by a process of trial and error,
1789 beginning with a duration close to the fastest (or smallest) duration
1790 in the piece.  Smaller reference durations space music loosely; larger
1791 reference durations space music tightly.
1792
1793 @lilypond[quote,verbatim,ragged-right]
1794 \new Score \with {
1795   proportionalNotationDuration = #(ly:make-moment 1 8)
1796 } <<
1797   \new RhythmicStaff {
1798     c'2
1799     c'16 c'16 c'16 c'16
1800     \times 4/5 {
1801       c'16 c'16 c'16 c'16 c'16
1802     }
1803   }
1804 >>
1805
1806 \new Score \with {
1807   proportionalNotationDuration = #(ly:make-moment 1 16)
1808 } <<
1809   \new RhythmicStaff {
1810     c'2
1811     c'16 c'16 c'16 c'16
1812     \times 4/5 {
1813       c'16 c'16 c'16 c'16 c'16
1814     }
1815   }
1816 >>
1817
1818 \new Score \with {
1819   proportionalNotationDuration = #(ly:make-moment 1 32)
1820 } <<
1821   \new RhythmicStaff {
1822     c'2
1823     c'16 c'16 c'16 c'16
1824     \times 4/5 {
1825       c'16 c'16 c'16 c'16 c'16
1826     }
1827   }
1828 >>
1829 @end lilypond
1830
1831 Note that too large a reference duration -- such as the eighth note,
1832 above -- spaces music too tightly and can cause notehead collisions.
1833 Note also that proportional notation in general takes up more
1834 horizontal space that does classical spacing.  Proportional spacing
1835 provides rhythmic clarity at the expense of horizontal space.
1836
1837 Next we examine how to optimally space overlapping tuplets.
1838
1839 We start by examining what happens to our original example, with
1840 classical spacing, when we add a second staff with a different type of
1841 tuplet.
1842
1843 @lilypond[quote,verbatim,ragged-right]
1844 \new Score <<
1845   \new RhythmicStaff {
1846     c'2
1847     c'16 c'16 c'16 c'16
1848     \times 4/5 {
1849       c'16 c'16 c'16 c'16 c'16
1850     }
1851   }
1852   \new RhythmicStaff {
1853     \times 8/9 {
1854       c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
1855     }
1856   }
1857 >>
1858 @end lilypond
1859
1860 The spacing is bad because the evenly notes of the bottom staff do not
1861 stretch uniformly.  Classical engraving includes very few complex
1862 triplets and so classical engraving rules can generate this type of
1863 result.  Setting @code{proportionalNotationDuration} remedies this
1864 situation considerably.
1865
1866 @lilypond[quote,verbatim,ragged-right]
1867 \new Score \with {
1868   proportionalNotationDuration = #(ly:make-moment 1 20)
1869 } <<
1870   \new RhythmicStaff {
1871     c'2
1872     c'16 c'16 c'16 c'16
1873     \times 4/5 {
1874       c'16 c'16 c'16 c'16 c'16
1875     }
1876   }
1877   \new RhythmicStaff {
1878     \times 8/9 {
1879       c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
1880     }
1881   }
1882 >>
1883 @end lilypond
1884
1885 But if we look very carefully we can see that notes of the second half
1886 of the 9-tuplet space ever so slightly more widely than do the notes
1887 of the first half of the 9-tuplet.  To ensure uniform stretching, we
1888 turn on @code{uniform-stretching}, which is a property of
1889 @code{SpacingSpanner}.
1890
1891 @lilypond[quote,verbatim,ragged-right]
1892 \new Score \with {
1893   proportionalNotationDuration = #(ly:make-moment 1 20)
1894   \override SpacingSpanner #'uniform-stretching = ##t
1895 } <<
1896   \new RhythmicStaff {
1897     c'2
1898     c'16 c'16 c'16 c'16
1899     \times 4/5 {
1900       c'16 c'16 c'16 c'16 c'16
1901     }
1902   }
1903   \new RhythmicStaff {
1904     \times 8/9 {
1905       c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8 c'8
1906     }
1907   }
1908 >>
1909 @end lilypond
1910
1911 Our two-staff example now spaces exactly, our rhythmic relationships
1912 are visually clear, and we can include a measured timeline or graphic
1913 if we want.
1914
1915 The @code{SpacingSpanner} is an abstract grob that lives in the
1916 @context{Score} context.  As with our settings of
1917 @code{proportionalNotationDuration},
1918 overrides to the @code{SpacingSpanner} can occur in any of three different
1919 places in our input file -- in the Score @code{\with} block, in a
1920 Score @code{\context} block, or in note entry directly.
1921
1922 There is by default only one @code{SpacingSpanner} per @code{Score}.  This
1923 means that, by default, @code{uniform-stretching} is either turned on for the
1924 entire score or turned off for the entire score.  We can, however,
1925 override this behavior and turn on different spacing features at
1926 different places in the score.  We do this with the command
1927 @code{\newSpacingSection}.  See @ref{New spacing area}, for more info.
1928
1929 Next we examine the effects of the @code{Separating_line_group_engraver} and
1930 see why proportional scores frequently remove this engraver.  The following
1931 example shows that there is a small amount of @qq{preferatory} space
1932 just before the first note in each system.
1933
1934 @lilypond[quote,verbatim,ragged-right]
1935 \paper {
1936   indent = #0
1937 }
1938
1939 \new Staff {
1940   c'1
1941   \break
1942   c'1
1943 }
1944 @end lilypond
1945
1946
1947 The amount of this preferatory space is the same whether after a time
1948 signature, a key signature or a clef.  @code{Separating_line_group_engraver}
1949 is responsible for this space.  Removing @code{Separating_line_group_engraver}
1950 reduces this space to zero.
1951
1952 @lilypond[quote,verbatim,ragged-right]
1953 \paper {
1954   indent = #0
1955 }
1956
1957 \new Staff \with {
1958   \remove Separating_line_group_engraver
1959 } {
1960   c'1
1961   \break
1962   c'1
1963 }
1964 @end lilypond
1965
1966 Nonmusical elements like time signatures, key signatures, clefs and
1967 accidentals are problemmatic in proportional notation.  None of these
1968 elements has rhythmic duration.  But all of these elements consume
1969 horizontal space.  Different proportional scores approach these
1970 problems differently.
1971
1972 It may be possible to avoid spacing problems with key signatures
1973 simply by not having any.  This is a valid option since most
1974 proportional scores are contemporary music.  The same may be true
1975 of time signatures, especially for those scores
1976 that include a measured timeline or other graphic.  But these scores
1977 are exceptional and most proportional scores include at least some
1978 time signatures.  Clefs and accidentals are even more essential.
1979
1980 So what strategies exist for spacing nonmusical elements in a
1981 proportional context?  One good option is the @code{strict-note-spacing}
1982 property of @code{SpacingSpanner}.  Compare the two scores below:
1983
1984 @lilypond[quote,verbatim,ragged-right]
1985 \new Staff {
1986   \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
1987   c''8
1988   c''8
1989   c''8
1990   \clef alto
1991   d'8
1992   d'2
1993 }
1994
1995 \new Staff {
1996   \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
1997   \override Score.SpacingSpanner #'strict-note-spacing = ##t
1998   c''8
1999   c''8
2000   c''8
2001   \clef alto
2002   d'8
2003   d'2
2004 }
2005 @end lilypond
2006
2007 Both scores are proportional, but the spacing in the first score is
2008 too loose because of the clef change.  The spacing of the second score
2009 remains strict, however, because @code{strict-note-spacing} is turned
2010 on.  Turning on @code{strict-note-spacing} causes the width of time
2011 signatures, key signatures and clefs to play no part in the spacing
2012 algorithm.  Accidentals are a different matter, however.  By default, all
2013 accidentals consume a little extra space, as the following pair of
2014 scores shows.
2015
2016 @lilypond[quote,verbatim,ragged-right]
2017 \new Staff {
2018   \set Score.proportionalNotationDuration = #(ly:make-moment 1 32)
2019   c'16
2020   c'16
2021   c'16
2022   c'16
2023   c'16
2024   c'16
2025   c'16
2026   c'16
2027 }
2028
2029 \new Staff {
2030   \set Score.proportionalNotationDuration = #(ly:make-moment 1 32)
2031   c'16
2032   cis'16
2033   c'16
2034   c'16
2035   c'16
2036   c'16
2037   c'16
2038   c'16
2039 }
2040 @end lilypond
2041
2042 Both scores are proportional but the second score exhibits spacing
2043 irregularities due to accidentals.  Turning on @code{strict-note-spacing}
2044 does not work for accidentals.  Instead,
2045 we override the @code{X-extent} of all accidentals to zero and then move the
2046 accidentals to the left of the notes they modify.
2047
2048 @lilypond[quote,verbatim,ragged-right]
2049 \new Staff {
2050   \set Score.proportionalNotationDuration = #(ly:make-moment 1 32)
2051   \override Accidental #'X-extent = #'(0 . 0)
2052   \override Accidental #'extra-offset = #'(-1 . 0)
2053   c'16
2054   cis'16
2055   c'16
2056   c'16
2057   c'16
2058   c'16
2059   c'16
2060   c'16
2061 }
2062 @end lilypond
2063
2064 In addition to the settings given here, there are other settings that
2065 frequently appear in proportional scores.  These include:
2066
2067 @itemize
2068 @item @code{\override SpacingSpanner #'strict-grace-spacing = ##t}
2069 @item @code{tupletFullLength = ##t}
2070 @item @code{\override Beam #'breakable = ##t}
2071 @item @code{\override Glissando #'breakable = ##t}
2072 @item @code{\override TextSpanner #'breakable = ##t}
2073 @item @code{\remove Forbid_line_break_engraver in the Voice context}
2074 @end itemize
2075
2076 These settings space grace notes strictly, extend tuplet brackets to
2077 mark both rhythmic start- and stop-points, and allow spanning elements
2078 to break across systems and pages.  See the respective parts of the manual
2079 for these related settings.
2080
2081