Docs: add snippet to illustrate use of whiteout

diff --git a/Documentation/snippets/editorial-annotations.snippet-list b/Documentation/snippets/editorial-annotations.snippet-list
index ab07d9cd3736936997c5a1911aa69750788c7c88..de40435fbb5631fd6a57ff57cc044f4e46d346fd 100644 (file)
--- a/Documentation/snippets/editorial-annotations.snippet-list
+++ b/Documentation/snippets/editorial-annotations.snippet-list
@@ -24,3 +24,4 @@ positioning-text-markups-inside-slurs.ly
 printing-text-from-right-to-left.ly
 string-number-extender-lines.ly
 using-postscript-to-generate-special-note-head-shapes.ly
+using-the-whiteout-property.ly

diff --git a/Documentation/snippets/expressive-marks.snippet-list b/Documentation/snippets/expressive-marks.snippet-list
index 83e6631a78d0f460d70de89ff88aa3e648729baf..b56614aedcbbdd5df63460695ceae31f72fb7792 100644 (file)
--- a/Documentation/snippets/expressive-marks.snippet-list
+++ b/Documentation/snippets/expressive-marks.snippet-list
@@ -40,5 +40,6 @@ setting-the-minimum-length-of-hairpins.ly
 showing-the-same-articulation-above-and-below-a-note-or-chord.ly
 snap-pizzicato-bartok-pizzicato.ly
 using-double-slurs-for-legato-chords.ly
+using-the-whiteout-property.ly
 vertical-line-as-a-baroque-articulation-mark.ly
 vertically-aligning-dynamics-across-multiple-notes.ly

diff --git a/Documentation/snippets/new/using-the-whiteout-property.ly b/Documentation/snippets/new/using-the-whiteout-property.ly
new file mode 100644 (file)
index 0000000..46a5d57
--- /dev/null
+++ b/Documentation/snippets/new/using-the-whiteout-property.ly
@@ -0,0 +1,30 @@
+\version "2.13.10"
+
+\header {
+  lsrtags = "expressive-marks, editorial-annotations"
+  texidoc = "
+Any graphical object can be printed over a white backgound to
+mask parts of objects that lie beneath.  This can be useful to
+improve the appearance of collisions in complex situations when
+repositioning objects is impractical.  It is necessary to explicitly
+set the @code{layer} property to control which objects are masked
+by the white 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} 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 is not masked.
+"
+  doctitle = "Using the whiteout property"
+}
+
+{
+  \override Score.StaffSymbol #'layer = #4
+  \override Staff.TimeSignature #'layer = #3
+  b'2 b'~
+  \once \override Staff.TimeSignature #'whiteout = ##t
+  \time 3/4
+  b' r4
+}

diff --git a/Documentation/snippets/simple-lead-sheet.ly b/Documentation/snippets/simple-lead-sheet.ly
index c6fc7affb3da42fa162ffb145a4ccceb3be9d315..912d1f94d4887435001555c987f3e705eccc1f20 100644 (file)
--- a/Documentation/snippets/simple-lead-sheet.ly
+++ b/Documentation/snippets/simple-lead-sheet.ly
@@ -4,6 +4,14 @@
 \version "2.13.10"
 
 \header {
+%% Translation of GIT committish: 
+  texidocfr = "
+Pour obtenir la partition d'un chanson, il suffit d'assembler
+des noms d'accords, une mélodie et des paroles :
+
+"
+  doctitlefr = "Chanson simple"
+
   lsrtags = "chords"
 
 %% Translation of GIT committish: b2d4318d6c53df8469dfa4da09b27c15a374d0ca

diff --git a/Documentation/snippets/using-the-whiteout-property.ly b/Documentation/snippets/using-the-whiteout-property.ly
new file mode 100644 (file)
index 0000000..8109189
--- /dev/null
+++ b/Documentation/snippets/using-the-whiteout-property.ly
@@ -0,0 +1,35 @@
+% Do not edit this file; it is automatically
+% generated from Documentation/snippets/new
+% This file is in the public domain.
+%% Note: this file works from version 2.13.10
+\version "2.13.10"
+
+\header {
+  lsrtags = "expressive-marks, editorial-annotations"
+  texidoc = "
+Any graphical object can be printed over a white backgound to
+mask parts of objects that lie beneath.  This can be useful to
+improve the appearance of collisions in complex situations when
+repositioning objects is impractical.  It is necessary to explicitly
+set the @code{layer} property to control which objects are masked
+by the white 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} 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 is not masked.
+"
+  doctitle = "Using the whiteout property"
+} % begin verbatim
+
+
+{
+  \override Score.StaffSymbol #'layer = #4
+  \override Staff.TimeSignature #'layer = #3
+  b'2 b'~
+  \once \override Staff.TimeSignature #'whiteout = ##t
+  \time 3/4
+  b' r4
+}