From: Mark Polesky <markpolesky@yahoo.com>
Date: Wed, 8 Dec 2010 10:03:23 +0000 (-0800)
Subject: Doc: NR 4, 5.3.6: Consistent key order for spacing alists.
X-Git-Tag: release/2.13.42-1~3
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=dcbb8d09d9fd38a10e8d7c5aee809ca8c19d86ab;p=lilypond.git

Doc: NR 4, 5.3.6: Consistent key order for spacing alists.
---

diff --git a/Documentation/notation/changing-defaults.itely b/Documentation/notation/changing-defaults.itely
index 39555b46fd..69d6fe3741 100644
--- a/Documentation/notation/changing-defaults.itely
+++ b/Documentation/notation/changing-defaults.itely
@@ -1999,9 +1999,9 @@ can be modified individually without affecting other keys.
 For example, to reduce the space between adjacent staves in a
 staff-group, use the @code{staff-staff-spacing} property of the
 @code{StaffGrouper} grob.  The property is an alist with four
-keys: @code{padding}, @code{basic-distance},
-@code{minimum-distance}, and @code{stretchability}.  Three of the
-four keys have initialized default values; these are listed in the
+keys: @code{basic-distance}, @code{minimum-distance},
+@code{padding}, and @code{stretchability}.  Three of the four keys
+have initialized default values; these are listed in the
 @qq{Backend} section of the Internals Reference (see
 @rinternals{StaffGrouper}):
 
@@ -2044,9 +2044,9 @@ completely re-defined with one declaration, as an alist:
 @lilypond[quote,verbatim]
 \new PianoStaff \with {
   \override StaffGrouper #'staff-staff-spacing =
-    #'((padding . 0)
-       (basic-distance . 0)
+    #'((basic-distance . 0)
        (minimum-distance . 0)
+       (padding . 0)
        (stretchability . 0))
 } <<
   \new Staff { \clef treble c''1 }
@@ -2066,9 +2066,9 @@ declarations are equivalent:
   #'((basic-distance . 7))
 
 \override StaffGrouper #'staff-staff-spacing =
-  #'((padding . 0)
-     (basic-distance . 7)
+  #'((basic-distance . 7)
      (minimum-distance . 0)
+     (padding . 0)
      (stretchability . 7))
 @end example
 
diff --git a/Documentation/notation/spacing.itely b/Documentation/notation/spacing.itely
index 46b466e841..8a9f1d61d6 100644
--- a/Documentation/notation/spacing.itely
+++ b/Documentation/notation/spacing.itely
@@ -402,13 +402,6 @@ an alist (association list) containing four @emph{keys}:
 
 @itemize
 
-@item
-@code{padding} -- the minimum required amount of unobstructed
-vertical whitespace between two items, measured in staff-spaces.
-This can be thought of as the minimum height of an unobstructed
-(invisible) rectangle that extends from the leftmost to the
-rightmost point of the combined items.
-
 @item
 @code{basic-distance} -- the vertical distance, measured in
 staff-spaces, between the @emph{reference points} of the two
@@ -430,6 +423,13 @@ of the two items, when compressing is in effect.  Values for
 meaningful, since the resulting distance will never be less than
 @code{padding.}
 
+@item
+@code{padding} -- the minimum required amount of unobstructed
+vertical whitespace between two items, measured in staff-spaces.
+This can be thought of as the minimum height of an unobstructed
+(invisible) rectangle that extends from the leftmost to the
+rightmost point of the combined items.
+
 @item
 @code{stretchability} -- a unitless measure of the dimension's
 relative propensity to stretch.  If zero, the distance will not
@@ -475,9 +475,9 @@ redefines the variable:
 \paper @{
   system-system-spacing #'basic-distance = #8
   score-system-spacing =
-    #'((padding . 1)
-       (basic-distance . 12)
+    #'((basic-distance . 12)
        (minimum-distance . 6)
+       (padding . 1)
        (stretchability . 12))
 @}
 @end example
@@ -1879,9 +1879,9 @@ individually, and the second completely re-defines the property:
 
 \new Staff \with @{
   \override VerticalAxisGroup #'staff-staff-spacing =
-    #'((padding . 1)
-       (basic-distance . 10)
+    #'((basic-distance . 10)
        (minimum-distance . 9)
+       (padding . 1)
        (stretchability . 10))
 @} @{ @dots{} @}
 @end example
@@ -2035,9 +2035,9 @@ property can affect the spacing of ungrouped staves:
   \context {
     \Staff
     \override VerticalAxisGroup #'staff-staff-spacing =
-      #'((padding . 1)
-         (basic-distance . 8)
-         (minimum-distance . 7))
+      #'((basic-distance . 8)
+         (minimum-distance . 7)
+         (padding . 1))
   }
 }
 
@@ -2057,8 +2057,8 @@ property can affect the spacing of ungrouped staves:
   % collide.  The lowest acceptable value for 'basic-distance is 0.
   \new Staff \with {
     \override VerticalAxisGroup #'staff-staff-spacing =
-      #'((padding . -10)
-         (basic-distance . 3.5))
+      #'((basic-distance . 3.5)
+         (padding . -10))
   } { \clef bass g2 r | }
   \new Staff { \clef bass g2 r | }
 >>
@@ -3320,7 +3320,7 @@ there is no blank space at the bottom of the page.
 
 @example
 \paper @{
-  system-system-spacing = #'((padding . 0) (basic-distance . 0.1))
+  system-system-spacing = #'((basic-distance . 0.1) (padding . 0))
   ragged-last-bottom = ##f
   ragged-bottom = ##f
 @}