]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: Update for staff.itely
authorPatrick McCarty <pnorcks@gmail.com>
Mon, 25 Aug 2008 01:18:12 +0000 (18:18 -0700)
committerNeil Puttock <n.puttock@gmail.com>
Thu, 28 Aug 2008 07:08:18 +0000 (08:08 +0100)
* Hiding staves: general revision

* Instrument names: general revision

* Formatting cue notes: description of \transposedCueDuring syntax.

Signed-off-by: Patrick McCarty <pnorcks@gmail.com>
Documentation/user/staff.itely

index 87149b49763600f6872ad294c2511f92f436395c..e5ae60afc22671ff2660adf55407ec129c352447 100644 (file)
@@ -379,16 +379,15 @@ staff.  For an explanation, refer to the snippet section in
 @ref{Clef}.
 
 @lilypond[verbatim,quote,relative=2]
-\new Staff {
-  \override Staff.StaffSymbol #'line-count = #3
-  d4 d d d
+\new Staff \with {
+  \override StaffSymbol #'line-count = #3
 }
+{ d4 d d d }
 @end lilypond
 
 The vertical position of staff lines and the number of staff lines
 can be defined at the same time.  As the following example shows,
-note positions are not influenced by the position of the staff
-lines.
+note positions are not influenced by the staff line positions.
 
 @warning{The @code{'line-positions} property overrides the
 @code{'line-count} property.  The number of staff lines is
@@ -413,8 +412,8 @@ thickness.
 { e4 d c b }
 @end lilypond
 
-The thickness of ledger lines can be set independently of staff
-line thickness.
+Ledger line thickness can be set independently of staff line
+thickness.
 
 @lilypond[verbatim,quote,relative=1]
 \new Staff \with {
@@ -423,7 +422,7 @@ line thickness.
 { e4 d c b }
 @end lilypond
 
-The distance between staff lines can be changed.  The setting has
+The distance between staff lines can be changed.  This setting has
 influence on ledger lines as well.
 
 @lilypond[verbatim,quote,relative=1]
@@ -433,7 +432,7 @@ influence on ledger lines as well.
 { a4 b c d }
 @end lilypond
 
-The width of a staff can be adjusted.  The unit is one staff
+The width of a staff can be modified.  The unit is one staff
 space.  The spacing of objects inside the staff is not influenced
 by this setting.
 
@@ -444,8 +443,11 @@ by this setting.
 { a4 e' f b | d1 }
 @end lilypond
 
-Further details about the properties of @code{StaffSymbol} listed
-above can be found here: @rinternals{staff-symbol-interface}.
+Further details about the properties of @code{StaffSymbol} can be
+found here: @rinternals{staff-symbol-interface}.
+
+@funindex \startStaff
+@funindex \stopStaff
 
 Modifications to staff properties in the middle of a score can be
 placed between @code{\stopStaff} and @code{\startStaff}:
@@ -465,9 +467,7 @@ a2 a
 
 @predefined
 
-@funindex \startStaff
 @code{\startStaff},
-@funindex \stopStaff
 @code{\stopStaff}.
 
 
@@ -497,9 +497,9 @@ Internals Reference:
 
 @knownissues
 
-When setting staff lines manually, bar lines are always drawn
-centered on the position 0, so the maximum distance of the bar
-lines in either direction must be equal.
+When setting vertical staff line positions manually, bar lines are
+always centered on position 0, so the maximum distance between the
+outermost bar lines in either direction must be equal.
 
 
 @node Ossia staves
@@ -709,22 +709,34 @@ Internals Reference:
 @node Hiding staves
 @unnumberedsubsubsec Hiding staves
 
-@cindex Frenched scores
+@cindex Frenched score
+@cindex Frenched staff
 @cindex staff, hiding
 @cindex staff, empty
 @cindex hiding of staves
 @cindex empty staves
-@cindex Frenched staves
 
-In orchestral scores, staff lines that only have rests are usually
-removed in order to save some space.  This style is called
-@q{French Score}.  For the @code{Lyrics}, @code{ChordNames}, and
-@code{FiguredBass} contexts, this is switched on by default.
+Staff lines can be hidden by removing the
+@code{Staff_symbol_engraver} from the @code{Staff} context.  As an
+alternative, @code{\stopStaff} may be used.
+
+@lilypond[verbatim,quote]
+\new Staff \with {
+  \remove "Staff_symbol_engraver"
+}
+\relative c''' { a8 f e16 d c b a2 }
+@end lilypond
+
+@funindex \RemoveEmptyStaffContext
+
+Empty staves can be hidden by setting the
+@code{\RemoveEmptyStaffContext} command in the @code{\layout}
+block.  In orchestral scores, this style is known as @q{Frenched
+Score}.  By default, this command hides all empty staves in a
+score except for those in the first system.
 
-For other staff contexts, this behavior is set with the
-@code{\RemoveEmptyStaffContext} command.  It is set in the
-@code{\layout} block.  As a result, empty staves or staves
-containing multi-measure rests are removed after a line break.
+@warning{An empty staff may only include multi-measure rests,
+skips, spacer rests, or a combination of these.}
 
 @lilypond[verbatim,quote,ragged-right]
 \layout {
@@ -732,54 +744,54 @@ containing multi-measure rests are removed after a line break.
     \RemoveEmptyStaffContext
   }
 }
-\relative c'' {
-  <<
-    \new Staff { e4 f g a \break c1 }
-    \new Staff { c4 d e f \break R1 }
-  >>
-}
+\relative c' <<
+  \new Staff {
+    e4 f g a \break
+    b1 \break
+    a4 b c2
+  }
+  \new Staff {
+    c,4 d e f \break
+    R1 \break
+    f4 g c,2
+  }
+>>
 @end lilypond
 
-To remove other types of contexts, use
-@code{\AncientRemoveEmptyStaffContext} or
-@code{\RemoveEmptyRhythmicStaffContext}.
-
 @cindex ossia
 
-Another application of @code{\RemoveEmptyStaffContext} is to make
-ossia sections, i.e., alternative melodies on a separate piece of
-staff, with help of a Frenched staff.  For details, see
-@ref{Ossia staves}.
-
-Staff lines can be made invisible by removing the
-@code{Staff_symbol_engraver} from the @code{Staff} context:
+@code{\RemoveEmptyStaffContext} can also be used to create ossia
+sections for a staff.  For details, see @ref{Ossia staves}.
 
-@lilypond[verbatim,quote]
-\new Staff \with {
-  \remove "Staff_symbol_engraver"
-}
-\relative c'' { c8 c c16 c c c c2 }
-@end lilypond
-
-
-@snippets
+@cindex hiding ancient staves
+@cindex hiding rhythmic staves
+@funindex \AncientRemoveEmptyStaffContext
+@funindex \RemoveEmptyRhythmicStaffContext
 
-@lilypondfile[verbatim,lilyquote,texidoc,doctitle]
-{removing-the-first-empty-line.ly}
+The @code{\AncientRemoveEmptyStaffContext} command may be used to
+hide empty staves in ancient music contexts.  Similarly,
+@code{\RemoveEmptyRhythmicStaffContext} may be used to hide empty
+@code{RhythmicStaff} contexts.
 
 
 @predefined
 
-@funindex \RemoveEmptyStaffContext
 @code{\RemoveEmptyStaffContext},
-@funindex \AncientRemoveEmptyStaffContext
 @code{\AncientRemoveEmptyStaffContext},
-@funindex \RemoveEmptyRhythmicStaffContext
 @code{\RemoveEmptyRhythmicStaffContext}.
 
 
+@snippets
+
+@lilypondfile[verbatim,lilyquote,texidoc,doctitle]
+{removing-the-first-empty-line.ly}
+
+
 @seealso
 
+Music Glossary:
+@rglos{Frenched staff}.
+
 Notation Reference:
 @ref{Staff symbol},
 @ref{Ossia staves}.
@@ -923,9 +935,9 @@ of @code{shortInstrumentName} is used for all succeeding staves.
 @lilypond[verbatim,quote,ragged-right,relative=1]
 \set Staff.instrumentName = "Violin "
 \set Staff.shortInstrumentName = "Vln "
-c1
+c4.. g'16 c4.. g'16
 \break
-c''1
+c1
 @end lilypond
 
 Markup mode can be used to create more complicated instrument
@@ -935,7 +947,7 @@ names:
 \set Staff.instrumentName = \markup {
   \column { "Clarinetti"
             \line { "in B" \smaller \flat } } }
-c1
+c4 c,16 d e f g2
 @end lilypond
 
 @cindex instrument names, centering
@@ -947,16 +959,16 @@ default.  To center multi-line instrument names,
 
 @lilypond[verbatim,quote,relative=2]
 <<
+  \new Staff {
+    \set Staff.instrumentName = "Flute"
+    f2 g4 f
+  }
   \new Staff {
     \set Staff.instrumentName = \markup \center-column {
       Clarinetti
       \line { "in B" \smaller \flat }
     }
-    c1
-  }
-  \new Staff {
-    \set Staff.instrumentName = "Vibraphone"
-    c1
+    c4 b c2
   }
 >>
 @end lilypond
@@ -964,28 +976,33 @@ default.  To center multi-line instrument names,
 @cindex indent
 @cindex short-indent
 
-The @code{indent} and @code{short-indent} settings specify the
-level of indentation for the first system and all succeeding
-systems, respectively.  They can be modified in the @code{\layout}
-block.  For instrument names or short instrument names that are
-longer, it may be useful to increase the @code{indent} and
-@code{short-indent} settings:
-
-@lilypond[verbatim,quote]
-\relative c' <<
-  \new Staff \with {
-    instrumentName = "Oboe"
-  }
-  { c2 d }
-  \new Staff \with {
-    instrumentName = "Glockenspiel"
-  }
-  { c'2 d }
->>
+However, if the instrument names are longer, the instrument names
+in a staff group may not be centered unless the @code{indent} and
+@code{short-indent} settings are increased.  The @code{indent} and
+@code{short-indent} settings are modified in the @code{\layout}
+block and specify the level of indentation for the first system
+and all succeeding systems, respectively.
 
+@lilypond[verbatim,quote,ragged-right]
 \layout {
   indent = 2.5\cm
+  short-indent = 1.5\cm
 }
+
+\relative c'' <<
+  \new Staff {
+    \set Staff.instrumentName = "Flute"
+    \set Staff.shortInstrumentName = "Fl."
+    f2 g4 f \break
+    g4 f g2
+  }
+  \new Staff {
+    \set Staff.instrumentName = "Clarinet"
+    \set Staff.shortInstrumentName = "Clar."
+    c,4 b c2 \break
+    c2 b4 c
+  }
+>>
 @end lilypond
 
 To add instrument names to other contexts (such as
@@ -1009,12 +1026,6 @@ c1 c c c \break
 @end lilypond
 
 
-@snippets
-
-@lilypondfile[verbatim,lilyquote,texidoc,doctitle]
-{aligning-and-centering-instrument-names.ly}
-
-
 @seealso
 
 Notation Reference:
@@ -1178,8 +1189,8 @@ into a @code{CueVoice} context.  The @code{CueVoice} is created
 implicitly, and occurs simultaneously with @var{music}, which
 creates a polyphonic situation.  The @var{voice} argument
 determines whether the cue notes should be notated as a first or
-second voice; @code{DOWN} corresponds to the first voice, and
-@code{UP} corresponds to the second.
+second voice; @code{UP} corresponds to the first voice, and
+@code{DOWN} corresponds to the second.
 
 @lilypond[verbatim,quote]
 oboe = \relative c'' {
@@ -1253,11 +1264,12 @@ clef, the original clef should be stated once again.
 
 @end itemize
 
-@c FIXME explain syntax of \transposedCueDuring
-
 The @code{\transposedCueDuring} command is useful to add cues for
-instruments in a completely different register.  Having piccolo
-cues within a contrabassoon part is a good example.
+instruments in a completely different register.  The syntax is
+similar to @code{\cueDuring}, but it requires one more argument to
+specify the transposition of the cued instrument.  For more
+information about transposition, see
+@ref{Instrument transpositions}.
 
 @lilypond[verbatim,quote]
 piccolo = \relative c''' {
@@ -1284,6 +1296,9 @@ cbassoon = \relative c, {
 
 @seealso
 
+Notation Reference:
+@ref{Instrument transpositions}.
+
 Snippets:
 @rlsr{Staff notation}.