Rerun scripts/auxiliar/update-with-convert-ly.sh

[lilypond.git] / Documentation / notation / staff.itely

diff --git a/Documentation/notation/staff.itely b/Documentation/notation/staff.itely
index a8111bd7c47a7a1a096521fb9b4c5fe5b0727537..b1558e72dfef9f3fae3886e528f9020a4385690b 100644 (file)
--- a/Documentation/notation/staff.itely
+++ b/Documentation/notation/staff.itely
@@ -7,12 +7,14 @@
     Guide, node Updating translation committishes..
 @end ignore
 
     Guide, node Updating translation committishes..
 @end ignore
 

-@c \version "2.14.0"
+@c \version "2.17.6"

 
 @node Staff notation
 @section Staff notation
 
 
 @node Staff notation
 @section Staff notation
 

-@lilypondfile[quote]{staff-headword.ly}
+@c The line width is a bit of a hack to allow space for the
+@c  instrument names.
+@lilypondfile[quote,ragged-right,line-width=14.5\cm,staffsize=16]{staff-headword.ly}

 
 This section explains how to influence the appearance of staves,
 how to print scores with more than one staff, and how to add tempo
 
 This section explains how to influence the appearance of staves,
 how to print scores with more than one staff, and how to add tempo


@@ -437,11 +439,11 @@ The number of staff lines can be altered,
 
 @lilypond[verbatim,quote,relative=2]
 f4 d \stopStaff
 
 @lilypond[verbatim,quote,relative=2]
 f4 d \stopStaff

-\override Staff.StaffSymbol #'line-count = #2
+\override Staff.StaffSymbol.line-count = #2

 \startStaff g, e |
 
 f'4 d \stopStaff
 \startStaff g, e |
 
 f'4 d \stopStaff

-\revert Staff.StaffSymbol #'line-count
+\revert Staff.StaffSymbol.line-count

 \startStaff g, e |
 @end lilypond
 
 \startStaff g, e |
 @end lilypond
 


@@ -453,10 +455,10 @@ position in the staff, can be changed with a single override.
 
 @lilypond[verbatim,quote,relative=2]
 f4 d \stopStaff
 
 @lilypond[verbatim,quote,relative=2]
 f4 d \stopStaff

-\override Staff.StaffSymbol #'line-positions = #'(1 3 5 -1 -3)
+\override Staff.StaffSymbol.line-positions = #'(1 3 5 -1 -3)

 \startStaff g, e |
 f'4 d \stopStaff
 \startStaff g, e |
 f'4 d \stopStaff

-\override Staff.StaffSymbol #'line-positions = #'(8 6.5 -6 -8 -0.5)
+\override Staff.StaffSymbol.line-positions = #'(8 6.5 -6 -8 -0.5)

 \startStaff g, e
 @end lilypond
 
 \startStaff g, e
 @end lilypond
 


@@ -468,7 +470,7 @@ default, are also affected.
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {

-  \override StaffSymbol #'thickness = #3
+  \override StaffSymbol.thickness = #3

 }
 { f4 d g, e }
 @end lilypond
 }
 { f4 d g, e }
 @end lilypond


@@ -480,8 +482,8 @@ ledger line thickness.
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {

-  \override StaffSymbol #'thickness = #2
-  \override StaffSymbol #'ledger-line-thickness = #'(0.5 . 0.4)
+  \override StaffSymbol.thickness = #2
+  \override StaffSymbol.ledger-line-thickness = #'(0.5 . 0.4)

 }
 { f'4 a, a,, f }
 @end lilypond
 }
 { f'4 a, a,, f }
 @end lilypond


@@ -490,7 +492,7 @@ The vertical positions of ledger lines can be altered,
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {

-  \override StaffSymbol #'ledger-positions = #'(-3 -2 -1 2 5 6)
+  \override StaffSymbol.ledger-positions = #'(-3 -2 -1 2 5 6)

 }
 { f'4 a, a,, f }
 @end lilypond
 }
 { f'4 a, a,, f }
 @end lilypond


@@ -501,7 +503,7 @@ also have their own ledger lines.
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {

-  \override StaffSymbol #'ledger-extra = #4
+  \override StaffSymbol.ledger-extra = #4

 }
 { f'4 a, d, f, }
 @end lilypond
 }
 { f'4 a, d, f, }
 @end lilypond


@@ -513,11 +515,11 @@ The @code{stopStaff} is needed in the example to revert the
 @code{\override} for the whole @code{StaffSymbol}.
 
 @lilypond[fragment,quote,relative=1]
 @code{\override} for the whole @code{StaffSymbol}.
 
 @lilypond[fragment,quote,relative=1]

-\override Staff.StaffSymbol #'line-positions =   #'(-8 0 2 4)
+\override Staff.StaffSymbol.line-positions =   #'(-8 0 2 4)

 d4 e f g
 \stopStaff
 \startStaff
 d4 e f g
 \stopStaff
 \startStaff

-\override Staff.StaffSymbol #'ledger-positions = #'(-8 -6 (-4 -2) 0)
+\override Staff.StaffSymbol.ledger-positions = #'(-8 -6 (-4 -2) 0)

 d4 e f g
 @end lilypond
 
 d4 e f g
 @end lilypond
 


@@ -526,7 +528,7 @@ line spacing as well.
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {
 
 @lilypond[verbatim,quote,relative=2]
 \new Staff \with {

-  \override StaffSymbol #'staff-space = #1.5
+  \override StaffSymbol.staff-space = #1.5

 }
 { f'4 d, g, e, }
 @end lilypond
 }
 { f'4 d, g, e, }
 @end lilypond


@@ -602,8 +604,8 @@ only a few ossia staves are needed.
       \remove "Time_signature_engraver"
       alignAboveContext = #"main"
       fontSize = #-3
       \remove "Time_signature_engraver"
       alignAboveContext = #"main"
       fontSize = #-3

-      \override StaffSymbol #'staff-space = #(magstep -3)
-      \override StaffSymbol #'thickness = #(magstep -3)
+      \override StaffSymbol.staff-space = #(magstep -3)
+      \override StaffSymbol.thickness = #(magstep -3)

       firstClef = ##f
     }
     { e4 d f e }
       firstClef = ##f
     }
     { e4 d f e }


@@ -624,10 +626,10 @@ example.
 <<
   \new Staff = ossia \with {
     \remove "Time_signature_engraver"
 <<
   \new Staff = ossia \with {
     \remove "Time_signature_engraver"

-    \override Clef #'transparent = ##t
+    \override Clef.transparent = ##t

     fontSize = #-3
     fontSize = #-3

-    \override StaffSymbol #'staff-space = #(magstep -3)
-    \override StaffSymbol #'thickness = #(magstep -3)
+    \override StaffSymbol.staff-space = #(magstep -3)
+    \override StaffSymbol.thickness = #(magstep -3)

   }
   { \stopStaff s1*6 }
 
   }
   { \stopStaff s1*6 }
 


@@ -663,10 +665,10 @@ break.  For more information about
 <<
   \new Staff = ossia \with {
     \remove "Time_signature_engraver"
 <<
   \new Staff = ossia \with {
     \remove "Time_signature_engraver"

-    \override Clef #'transparent = ##t
+    \override Clef.transparent = ##t

     fontSize = #-3
     fontSize = #-3

-    \override StaffSymbol #'staff-space = #(magstep -3)
-    \override StaffSymbol #'thickness = #(magstep -3)
+    \override StaffSymbol.staff-space = #(magstep -3)
+    \override StaffSymbol.thickness = #(magstep -3)

   } \relative c'' {
     R1*3
     c4 e8 d c2
   } \relative c'' {
     R1*3
     c4 e8 d c2


@@ -684,7 +686,7 @@ break.  For more information about
 \layout {
   \context {
     \Staff \RemoveEmptyStaves
 \layout {
   \context {
     \Staff \RemoveEmptyStaves

-    \override VerticalAxisGroup #'remove-first = ##t
+    \override VerticalAxisGroup.remove-first = ##t

   }
 }
 @end lilypond
   }
 }
 @end lilypond


@@ -837,8 +839,8 @@ this case, use the following overrides instead of removing the
 engraver:
 
 @example
 engraver:
 
 @example

-\override StaffSymbol #'stencil = ##f
-\override NoteHead #'no-ledgers = ##t
+\override StaffSymbol.stencil = ##f
+\override NoteHead.no-ledgers = ##t

 @end example
 
 For the Known issues and warnings associated with
 @end example
 
 For the Known issues and warnings associated with


@@ -908,8 +910,9 @@ multi-line instrument names, @code{\center-column} must be used:
   { f2 g4 f }
   \new Staff \with {
     instrumentName = \markup {
   { f2 g4 f }
   \new Staff \with {
     instrumentName = \markup {

-      \center-column { "Clarinet" }
-      \line { "in B" \smaller \flat }
+      \center-column { "Clarinet"
+        \line { "in B" \smaller \flat }
+      }

     }
   }
   { c4 b c2 }
     }
   }
   { c4 b c2 }


@@ -1298,7 +1301,7 @@ fluteNotes = \relative c'' {
 
 oboeNotes = \relative c'' {
   R1
 
 oboeNotes = \relative c'' {
   R1

-  s1*0^\markup { \tiny "flute" }
+  \new CueVoice { \set instrumentCueName = "flute" }

   \cueDuring #"flute" #UP { R1 }
   g2 c,
 }
   \cueDuring #"flute" #UP { R1 }
   g2 c,
 }


@@ -1341,10 +1344,13 @@ oboeNotes = \relative c'' {
 }
 @end lilypond
 
 }
 @end lilypond
 

-Markup can be used to show the name of the quoted instrument.  Also,
-if the cue notes require a change in clef, this can be done manually but
-the original clef should also be restored manually at the end of the cue
-notes.
+The name of the instrument playing the cue can be printed by setting
+the @code{instrumentCueName} property in a temporary @code{CueVoice}
+context.  The placement and style of the @code{instrumentCueName} is
+controlled by the @code{\instrumentSwitch} object, see
+@ref{Instrument names}.  If the cue notes require a change in clef,
+this can be done manually but the original clef should also be
+restored manually at the end of the cue notes.

 
 @lilypond[verbatim,quote]
 fluteNotes = \relative c'' {
 
 @lilypond[verbatim,quote]
 fluteNotes = \relative c'' {


@@ -1355,7 +1361,7 @@ bassoonNotes = \relative c {
   \clef bass
   R1
   \clef treble
   \clef bass
   R1
   \clef treble

-  s1*0^\markup { \tiny "flute" }
+  \new CueVoice { \set instrumentCueName = "flute" }

   \cueDuring #"flute" #UP { R1 }
   \clef bass
   g4. b8 d2
   \cueDuring #"flute" #UP { R1 }
   \clef bass
   g4. b8 d2


@@ -1381,7 +1387,7 @@ fluteNotes = \relative c'' {
 bassoonNotes = \relative c {
   \clef bass
   R1
 bassoonNotes = \relative c {
   \clef bass
   R1

-  s1*0^\markup { \tiny "flute" }
+  \new CueVoice { \set instrumentCueName = "flute" }

   \cueDuringWithClef #"flute" #UP #"treble" { R1 }
   g4. b8 d2
 }
   \cueDuringWithClef #"flute" #UP #"treble" { R1 }
   g4. b8 d2
 }


@@ -1457,7 +1463,7 @@ bassoonNotes = \relative c {
   R1
   \tag #'part {
     \clef treble
   R1
   \tag #'part {
     \clef treble

-    s1*0^\markup { \tiny "flute" }
+    \new CueVoice { \set instrumentCueName = "flute" }

   }
   \cueDuring #"flute" #UP { R1 }
   \tag #'part \clef bass
   }
   \cueDuring #"flute" #UP { R1 }
   \tag #'part \clef bass