From: Paul Morris <paulwmorris@gmail.com>
Date: Tue, 10 Nov 2015 21:44:26 +0000 (-0500)
Subject: Issue 4504/4 edits to tests, docs, and changes.tely
X-Git-Tag: release/2.19.32-1~13^2~4
X-Git-Url: https://git.donarmstrong.com/?p=lilypond.git;a=commitdiff_plain;h=bcd127bc07fc7b53704f9db8a6cf3d53e9d4094a

Issue 4504/4 edits to tests, docs, and changes.tely
---

diff --git a/Documentation/changes.tely b/Documentation/changes.tely
index 5f01072a35..75a5a06f30 100644
--- a/Documentation/changes.tely
+++ b/Documentation/changes.tely
@@ -79,6 +79,34 @@ mus = \relative { c'4 cih d dih }
 >>
 @end lilypond
 
+@item
+A new style of whiteout that approximates the contours of a glyph's
+outline is now available using @code{whiteout-style}.  The shape of the
+white background is produced from multiple displaced copies of the
+glyph.  The @code{thickness} of both the new @code{outline} style and
+the default @code{box} style, as a multiple of staff-line thickness, can
+be customized.
+@lilypond[verbatim,quote]
+\markup {
+  \combine
+    \filled-box #'(-1 . 15) #'(-3 . 4) #1
+    \override #'(thickness . 2)
+    \whiteout whiteout-box
+}
+\markup {
+  \combine
+    \filled-box #'(-1 . 18) #'(-3 . 4) #1
+    \override #'(style . outline)
+    \override #'(thickness . 3)
+    \whiteout whiteout-outline
+}
+\relative {
+  \override Staff.Clef.whiteout-style = #'outline
+  \override Staff.Clef.whiteout = 3
+  g'1
+}
+@end lilypond
+
 @item
 All of @code{\override}, @code{\revert}, @code{\set}, and
 @code{\unset} now work with the @code{\once} prefix for making
@@ -154,18 +182,6 @@ With those particular definitions, LilyPond will try to recognize
 legacy use of @code{parser} and @code{location} arguments,
 providing backwards-compatible semantics for some time.
 
-@item
-The @code{whiteout} grob property and @code{\whiteout} markup command
-now create a white background built from multiple displaced copies of
-the glyph in order to approximate the contours of its outline.
-The previous rounded box white background can be achieved with the
-new @code{whiteout-box} grob property and @code{\whiteout-box} markup
-command.  Setting the @code{whiteout} property to a number now sets
-the thickness of the white outline as a multiple of staff-line
-thickness.  Similarly, overriding the @code{thickness} property of
-the @code{\whiteout} markup command sets the thickness of the white
-outline it produces.
-
 @item
 In the "english" notename language, the long notenames for pitches
 with accidentals now contain a hyphen for better readability.  You
diff --git a/Documentation/fr/notation/rhythms.itely b/Documentation/fr/notation/rhythms.itely
index 7c6db70b9e..958ec1effc 100644
--- a/Documentation/fr/notation/rhythms.itely
+++ b/Documentation/fr/notation/rhythms.itely
@@ -604,7 +604,7 @@ plus amples détails à ce sujet, reportez vous au chapitre
 @ref{Liaisons d'articulation}.
 
 Dans le cas où une liaison est recouverte par d'autres éléments de la
-portée, une adaptation des propriétés @var{whiteout-box} et @var{layer}
+portée, une adaptation des propriétés @var{whiteout} et @var{layer}
 permet d'obtenir une meilleure lisibilité.
 
 @lilypond[verbatim,quote,ragged-right]
diff --git a/Documentation/notation/rhythms.itely b/Documentation/notation/rhythms.itely
index 78e0433690..9f0adb7741 100644
--- a/Documentation/notation/rhythms.itely
+++ b/Documentation/notation/rhythms.itely
@@ -578,7 +578,7 @@ Dash pattern definitions for ties have the same structure as dash
 pattern definitions for slurs. For more information about complex dash
 patterns, see @ref{Slurs}.
 
-Override @var{whiteout-box} and @var{layer} layout properties of objects
+Override @var{whiteout} and @var{layer} layout properties of objects
 that should cause a gap in ties.
 
 @lilypond[verbatim,quote,ragged-right]
diff --git a/Documentation/snippets/new/using-the-whiteout-property.ly b/Documentation/snippets/new/using-the-whiteout-property.ly
index 2c28c13893..07c2b7288b 100644
--- a/Documentation/snippets/new/using-the-whiteout-property.ly
+++ b/Documentation/snippets/new/using-the-whiteout-property.ly
@@ -13,7 +13,7 @@ background.
 
 In this example the collision of the tie with the time signature is
 improved by masking out the part of the tie that crosses the time
-signature by setting the @code{whiteout-box} property of
+signature by setting the @code{whiteout} property of
 @code{TimeSignature}. To do this @code{TimeSignature} is moved to a
 layer above @code{Tie}, which is left in the default layer of 1, and
 @code{StaffSymbol} is moved to a layer above @code{TimeSignature} so it
diff --git a/input/regression/markup-syntax.ly b/input/regression/markup-syntax.ly
index 489c21fc4f..1350a2447c 100644
--- a/input/regression/markup-syntax.ly
+++ b/input/regression/markup-syntax.ly
@@ -41,7 +41,6 @@
       \super "2"
       " "
       \raise #3.0 \whiteout white-out
-      \raise #3.0 \whiteout white-out-box
       \circle \dynamic p
       \with-color #green Green
       \dynamic sfzp
diff --git a/input/regression/whiteout-lower-layers.ly b/input/regression/whiteout-lower-layers.ly
index 1284cee54b..8549cbc783 100644
--- a/input/regression/whiteout-lower-layers.ly
+++ b/input/regression/whiteout-lower-layers.ly
@@ -1,8 +1,7 @@
 \version "2.19.32"
 
 \header { texidoc = "If the 'whiteout property of a
-grob is set to a number or #t, or if the 'whiteout-box
-property is set to #t, that part of all objects
+grob is set to a number or #t, that part of all objects
 in lower layers which falls under the extent of
 the grob's whiteout area is whited out.  Here the
 TimeSignature whites out the Tie but not the StaffSymbol.
@@ -14,7 +13,7 @@ TimeSignature whites out the Tie but not the StaffSymbol.
   \override Staff.StaffSymbol.layer = #4
   \once \override Tie.layer = #2
   b'2.~
-  \once \override Staff.TimeSignature.whiteout = #3
+  \once \override Staff.TimeSignature.whiteout = ##t
   \once \override Staff.TimeSignature.layer = #3
   \time 5/4
   b4
@@ -25,7 +24,8 @@ TimeSignature whites out the Tie but not the StaffSymbol.
   \override Staff.StaffSymbol.layer = #4
   \once \override Tie.layer = #2
   b'2.~
-  \once \override Staff.TimeSignature.whiteout = ##t
+  \once \override Staff.TimeSignature.whiteout-style = #'outline
+  \once \override Staff.TimeSignature.whiteout = #3
   \once \override Staff.TimeSignature.layer = #3
   \time 5/4
   b4
diff --git a/input/regression/whiteout.ly b/input/regression/whiteout.ly
index 1813c8beec..7e10de9727 100644
--- a/input/regression/whiteout.ly
+++ b/input/regression/whiteout.ly
@@ -1,8 +1,9 @@
 \header {
 
   texidoc = "The whiteout command underlays a white background under a
-markup that approximates the outline of the markup.  The whiteout-box
-command underlays a rounded white box under a markup. "
+markup.  The shape is determined by @code{whiteout-style}. The default
+is @code{box} which produces a white rectangle.  @code{outline}
+approximates the outline of the markup."
 
 }
 \version "2.19.32"
@@ -16,5 +17,16 @@ command underlays a rounded white box under a markup. "
   \override TextScript.layer = #'2
   \override TextScript.extra-offset = #'(2 . 4)
   c''4-\markup { \whiteout foo } c
-  c4-\markup { \whiteout \pad-markup #0.5 foo } c
+  c-\markup { \whiteout \pad-markup #0.5 foo } c
+  c-\markup {
+    \override #'(thickness . 2)
+    \whiteout foo
+  }
+  c
+  c-\markup {
+    \override #'(thickness . 3)
+    \override #'(whiteout-style . outline)
+    \whiteout foo
+  }
+  c
 }