]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/notation/spacing.itely
Merge branch 'lilypond/translation' of ssh://jomand@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / Documentation / notation / spacing.itely
index bd844e3ebe5fb7aa81b138ef3e86e5677f7c21b0..7e9b1d66aa232acf386d92db569d1da1e7ae51d4 100644 (file)
@@ -195,43 +195,61 @@ page:
 
 @table @code
 
-@item after-title-space
-@funindex after-title-space
-
-The amount of space between the title and the first system.
-Default: @code{5\mm}.
-
-@item before-title-space
-@funindex before-title-space
+@item after-title-spacing
+@funindex after-title-spacing
+
+Specifies how to calculate the space between a title (or top-level markup)
+and the system that follows it.  This is an associative list with five
+components:
+@itemize @bullet
+@item @var{space} -- the amount of stretchable space between the baseline
+of a title and the center of the staff that follows it;
+@item @var{padding} -- the minimum amount of whitespace that must be
+present between a title and the staff that follows it;
+@item @var{stretchability} -- the ease with which the stretchable
+space increases when a page is stretched.
+If this is zero, the distance to the next staff will not stretch at all;
+@item @var{minimum-distance} -- the minimum distance to place between
+the baseline of a title and the center of the staff that follows it. This differs
+from @var{padding} in that the height of a staff has no effect on
+the application of @var{minimum-distance} (whereas the height of a
+staff is crucial for @var{padding}).
+@end itemize
 
-Amount of space between the last system of the previous piece and the
-title of the next.  Default: @code{10\mm}.
+If a page has a ragged bottom, @var{space} is not stretched. In particular, the
+resulting distance on such a page is the largest of
+@itemize @bullet
+@item @var{space},
+@item @var{minimum-distance}, and
+@item @var{padding} plus the smallest distance necessary to eliminate overlap.
+@end itemize
 
-@item between-system-padding
-@funindex between-system-padding
+@item before-title-spacing
+@funindex before-title-spacing
 
-The minimum amount of white space that will always be present
-between the bottom-most symbol of one system, and the top-most of
-the next system.  Default: @code{4\mm}.
+Specifies the spacing between a system and the title (or top-level markup) that
+follows it.
+The distances are measured from the center of the last staff in the system to
+the baseline of the title that follows it.  See @var{after-title-spacing}.
 
-Increasing this will put systems whose bounding boxes almost touch
-farther apart.
+@item between-scores-system-spacing
+@funindex between-scores-system-spacing
 
-@item between-system-space
-@funindex between-system-space
+Specifies the spacing between two systems if they are in different scores, but
+there is no title between them. See @var{after-title-spacing}.
 
-The distance between systems.  It is the ideal distance between
-the center of the bottom staff of one system and the center of the
-top staff of the next system.  Default: @code{20\mm}.
+@item between-system-spacing
+@funindex between-system-spacing
 
-Increasing this value will provide a more even appearance of the
-page at the cost of using more vertical space.
+Specifies the spacing between the center of the bottom staff of one system
+and the center of the top staff of the following system.  See @var{after-title-spacing}.
 
-@item between-title-space
-@funindex between-title-space
+@item between-title-spacing
+@funindex between-title-spacing
 
-Amount of space between consecutive titles (e.g., the title of the
-book and the title of a piece).  Default: @code{2\mm}.
+Specifies the spacing between two titles (or top-level markups).
+The distances are measured from the baseline of the first title to the baseline
+of the second.  See @var{after-title-spacing}.
 
 @item bottom-margin
 @funindex bottom-margin
@@ -239,25 +257,35 @@ book and the title of a piece).  Default: @code{2\mm}.
 The margin between footer and bottom of the page.  Default:
 @code{6\mm}.
 
+@item bottom-system-spacing
+@funindex bottom-system-spacing
+
+Specifies the spacing from the center of the last staff (or the
+baseline of the last top-level markup) to the bottom of the
+printable area (ie. the top of the bottom margin).
+See @var{after-title-spacing}.
+
 @item foot-separation
 @funindex foot-separation
 
 Distance between the bottom-most music system and the page
 footer.  Default: @code{4\mm}.
 
-@item head-separation
-@funindex head-separation
+@item top-title-spacing
+@funindex top-title-spacing
 
-Distance between the top-most music system and the page header.
-Default: @code{4\mm}.
+Specifies the spacing from the top of the printable area (ie.
+the bottom of the top margin) to the baseline of the title.
+See @var{after-title-spacing}.
 
-@item page-top-space
-@funindex page-top-space
+@item top-system-spacing
+@funindex top-system-spacing
 
-Distance from the top of the printable area to the center of the
-first staff.  This only works for staves that are vertically
-small.  Big staves are set with the top of their bounding box
-aligned to the top of the printable area.  Default: @code{12\mm}.
+Specifies the spacing from the top of the printable area (ie.
+the bottom of the top margin) to the center of the first staff.
+This only takes effect if there is no title at the top of the
+page (in which case @var{top-title-spacing} is used instead).
+See @var{after-title-spacing}.
 
 @item paper-height
 @funindex paper-height
@@ -327,7 +355,7 @@ This second example centers page numbers at the bottom of every page.
 
 You can also define these values in Scheme.  In that case @code{mm},
 @code{in}, @code{pt}, and @code{cm} are variables defined in
-@file{paper-defaults.ly} with values in millimeters.  That is why the
+@file{paper@/-defaults@/.ly} with values in millimeters.  That is why the
 value must be multiplied in the example
 
 @example
@@ -936,11 +964,6 @@ but the value can be changed in the @code{\paper} block:
 @}
 @end example
 
-@c TODO Check this -td
-The old page breaking algorithm is called
-@code{optimal-page-breaks}.  If you are having trouble with the new page
-breakers, you can enable the old one as a workaround.
-
 @funindex \bookpart
 
 When a book has many scores and pages, the page breaking problem may be
@@ -1263,7 +1286,6 @@ staves inside a system.
 * Vertical spacing inside a system::
 * Vertical spacing between systems::
 * Explicit staff and system positioning::
-* Two-pass vertical spacing::
 * Vertical collision avoidance::
 @end menu
 
@@ -1303,6 +1325,9 @@ first number is generally negative.  The numbers need not match;
 for example, the staff can be made larger at the bottom by setting
 it to @code{(-6 . 4)}.
 
+@ignore
+FIXME: update this section
+
 After page breaks are determined, the vertical spacing within each
 system is reevaluated in order to fill the page more evenly; if a page
 has space left over, systems are stretched in order to fill that space.
@@ -1364,6 +1389,7 @@ the second piano staff:
 }
 }
 @end lilypond
+@end ignore
 
 Vertical alignment of staves is handled by the
 @code{VerticalAlignment} object.  The context parameters
@@ -1673,70 +1699,6 @@ Snippets:
 @rlsr{Spacing}.
 
 
-@node Two-pass vertical spacing
-@subsection Two-pass vertical spacing
-
-@warning{Two-pass vertical spacing is deprecated and will be removed in
-a future version of LilyPond.  Systems are now stretched automatically
-in a single pass.  See @ref{Vertical spacing inside a system}.}
-
-In order to automatically stretch systems so that they should fill the
-space left on a page, a two-pass technique can be used:
-
-@enumerate
-@item In the first pass, the amount of vertical space used to increase
-the height of each system is computed and dumped to a file.
-@item In the second pass, spacing inside the systems are
-stretched according to the data in the page layout file.
-@end enumerate
-
-The @code{ragged-bottom} property adds space between systems, while
-the two-pass technique adds space between staves inside a system.
-
-To allow this behavior, a @code{tweak-key} variable has to be set in
-each score @code{\layout} block, and the tweaks included in each score
-music, using the @code{\scoreTweak} music function.
-
-@quotation
-@verbatim
-%% include the generated page layout file:
-\includePageLayoutFile
-
-\score {
-  \new StaffGroup <<
-    \new Staff <<
-      %% Include this score tweaks:
-      \scoreTweak "scoreA"
-      { \clef french c''1 \break c''1 }
-    >>
-    \new Staff { \clef soprano g'1 g'1 }
-    \new Staff { \clef mezzosoprano e'1 e'1 }
-    \new Staff { \clef alto g1 g1 }
-    \new Staff { \clef bass c1 c1 }
-  >>
-  \header {
-    piece = "Score with tweaks"
-  }
-  %% Define how to name the tweaks for this score:
-  \layout { #(define tweak-key "scoreA") }
-}
-@end verbatim
-@end quotation
-
-For the first pass, the @code{dump-tweaks} option should be set to
-generate the page layout file.
-
-@example
-lilypond -dbackend=null -d dump-tweaks <file>.ly
-lilypond <file>.ly
-@end example
-
-
-@seealso
-Snippets:
-@rlsr{Spacing}.
-
-
 @node Vertical collision avoidance
 @subsection Vertical collision avoidance
 
@@ -1901,7 +1863,10 @@ c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
 @end lilypond
 
 
-In the introduction (see @rlearning{Engraving}), it was explained that stem
+In the introduction
+FIXME FIXME FIXME
+@c (see @rlearning{Engraving}), 
+it was explained that stem
 directions influence spacing.  This is controlled with the
 @code{stem-spacing-correction} property in the
 @rinternals{NoteSpacing}, object.  These are generated for every
@@ -2088,6 +2053,8 @@ If @code{ragged-right} is set to true in the @code{\layout} block, then
 systems ends at their natural horizontal length, instead of being spread
 horizontally to fill the whole line.  This is useful for
 short fragments, and for checking how tight the natural spacing is.
+The normal default setting is false, but if the score has only one
+system the default value is true.
 
 @cindex page layout
 @cindex vertical spacing
@@ -2534,7 +2501,9 @@ edge and @var{b} the upper edge of the interval.
 
 
 @seealso
-@ref{Setting the staff size}
+Notation Reference:
+@ref{Setting the staff size}.
+
 Snippets:
 @rlsr{Spacing}.