]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/editorial.itely
Merge branch 'master' of ssh://kainhofer@git.sv.gnu.org/srv/git/lilypond into kainhofer
[lilypond.git] / Documentation / user / editorial.itely
index 2e9ce00601dda5adf7f35160e919b33971425a65..c13a4fbac0cf5d628ea3503830076aa4e489438c 100644 (file)
@@ -9,8 +9,10 @@
 @node Editorial annotations
 @section Editorial annotations
 
-@lilypondfile[ragged-right,line-width=16\cm,staffsize=16,quote]
-{editorial-headword.ly}
+@lilypondfile[quote]{editorial-headword.ly}
+
+This section discusses the various ways to change the appearance of 
+notes and add analysis or educational emphasis.
 
 @menu
 * Inside the staff::            
@@ -21,6 +23,8 @@
 @node Inside the staff
 @subsection Inside the staff
 
+This section discusses how to add emphasis to elements that are 
+inside the staff.
 
 @menu
 * Selecting notation font size::  
@@ -85,7 +89,7 @@ The @code{font-size} property can only be set on layout objects that
 use fonts.  These are the ones supporting the @code{font-interface}
 layout interface.
 
-@refcommands
+@predefined
 
 The following commands set @code{fontSize} for the current voice:
 
@@ -112,6 +116,9 @@ Internals Reference: @internalsref{font-interface}.
 Fingering instructions can be entered using
 @var{note}-@var{digit}:
 
+Fingering instructions may be manually placed above or below the
+staff, see @ref{Controlling direction and placement}.
+
 @lilypond[quote,verbatim,ragged-right,fragment,relative=2]
 c4-1 d-2 f-4 e-3
 @end lilypond
@@ -128,7 +135,7 @@ You can use the thumb-script (e.g., in cello music)to indicate that a
 note should be played with the thumb. 
 
 @lilypond[quote,verbatim,ragged-right,fragment,relative=2]
-<a_\thumb a'-3>8 <b_\thumb b'-3>
+<a_\thumb a'-3>2 <b_\thumb b'-3>
 @end lilypond
 
 @cindex fingering chords
@@ -142,7 +149,7 @@ chord by adding them after the pitches.
 @end lilypond
 
 
-@commonprop
+@snippets
 
 @code{fingeringOrientations} are used to control where the fingering
 numbers are placed.
@@ -182,17 +189,21 @@ Hidden (or invisible or transparent) notes can be useful in
 preparing theory or composition exercises.
 
 @lilypond[quote,ragged-right,verbatim,relative=2,fragment]
-c4 d4
+c4 d
 \hideNotes
-e4 f4
+e4 f
 \unHideNotes
-g4 a
+g a
 \hideNotes 
 b
 \unHideNotes
 c
 @end lilypond
 
+@predefined
+
+@code{\hideNotes}, @code{\unHideNotes}
+
 @seealso
 
 Snippets: @lsrdir{Editorial,Editorial-annotations}.
@@ -223,72 +234,54 @@ e
 @cindex x11-color
 
 The full range of colors defined for X11 can be accessed by using
-the Scheme function x11-color.  The function takes one argument
-that can be a symbol
+the Scheme function @code{x11-color}.  The function takes one
+argument; this can be a symbol in the form @var{'FooBar} or a
+string in the form @var{"FooBar"}.  The first form is quicker to
+write and is more efficient.  However, using the second form it is
+possible to access X11 colors by the multi-word form of its name.
 
-@example
-\override Beam #'color = #(x11-color 'MediumTurquoise)
-@end example
+If @code{x11-color} cannot make sense of the parameter then the
+color returned defaults to black. 
 
-or a string
-
-@example
-\override Beam #'color = #(x11-color "MediumTurquoise")
-@end example
+@lilypond[quote,ragged-right,verbatim,fragment,relative=2]
 
-The first form is quicker to write and is more efficient.
-However, using the second form it is possible to access X11 colors
-by the multi-word form of its name
+\override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2)
+\set Staff.instrumentName = \markup {
+  \with-color #(x11-color 'navy) "Clarinet"
+}
 
-@example
+gis8 a
 \override Beam #'color = #(x11-color "medium turquoise")
-@end example
-
-If x11-color cannot make sense of the parameter then the color
-returned defaults to black.  It should be obvious from the final
-score that something is wrong.
+gis a
+\override Accidental #'color = #(x11-color 'DarkRed)
+gis a
+\override NoteHead #'color = #(x11-color "LimeGreen")
+gis a
+% this is deliberate nonsense; note that the stems remain black
+\override Stem #'color = #(x11-color 'Boggle)
+b2 cis
 
-This example illustrates the use of x11-color.  Notice that the
-stem color remains black after being set to (x11-color 'Boggle),
-which is deliberate nonsense.
-
-@lilypond[quote,ragged-right,verbatim]
-{
-  \override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2)
-  \set Staff.instrumentName = \markup {
-    \with-color #(x11-color 'navy) "Clarinet"
-  }
-  \time 2/4
-  gis''8 a''
-  \override Beam #'color = #(x11-color "medium turquoise")
-  gis'' a''
-  \override NoteHead #'color = #(x11-color "LimeGreen")
-  gis'' a''
-  \override Stem #'color = #(x11-color 'Boggle)
-  gis'' a''
-}
 @end lilypond
 
 You can get exact RGB colors by specifying the rgb-color number.
 
-@lilypond[quote,ragged-right,verbatim]
-{
+@lilypond[quote,ragged-right,verbatim,fragment,relative=2]
+
   \override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2)
   \set Staff.instrumentName = \markup {
     \with-color #(x11-color 'navy) "Clarinet"
   }
-  \time 4/4
-
+  
   %black
   \override Stem #'color = #(rgb-color 0 0 0)
-  c4
+  gis8 a
   % white
   \override Stem #'color = #(rgb-color 1 1 1)
-  d
+  gis8 a
   % dark blue
   \override Stem #'color = #(rgb-color 0 0 0.5) 
-  e
-}
+  gis4 a
+
 @end lilypond
 
 @seealso
@@ -298,15 +291,17 @@ the input}.
 
 Snippets: @lsrdir{Editorial,Editorial-annotations}.
 
-@refbugs
-Not all x11 colors are distinguishable in a web browser i.e. a web browser might not display a difference between 'LimeGreen and 'ForestGreen.  For web use normal colors are recommended. (#blue, #green, #red) TODOgp
-
+@knownissues
 An x11 color is not necessarily exactly the same shade as a
-similarly named normal color.
+similarly named normal color.  
+
+Not all x11 colors are distinguishable in a web browser i.e. a web browser
+might not display a difference between 'LimeGreen and 'ForestGreen.  For 
+web use normal colors are recommended (i.e. #blue, #green, #red).
+
 
 Notes in a chord cannot be colored with @code{\override}; use
-@code{\tweak} instead.  See @ref{Objects connected to the input},
-for details.
+@code{\tweak} instead, see @ref{Objects connected to the input}.
 
 
 @node Parentheses
@@ -318,32 +313,18 @@ for details.
 @cindex parentheses
 
 Objects may be parenthesized by prefixing @code{\parenthesize} to
-the music event,
+the music event.  This only functions inside chords; to
+parenthesize a single note it must be enclosed with @code{<>} as
+if it is a chord.
 
 @lilypond[relative=2,fragment,verbatim,ragged-right]
-<
-  c
-  \parenthesize d
-  g
->4-\parenthesize -.
-d g 
-< c
-\parenthesize fis
->
+c2 < \parenthesize d>
 @end lilypond
 
-This only functions inside chords, to parenthesize a single note it 
-must be enclosed with @code{<>} as if it is a chord.
-
-@example
-< \parenthesize NOTE>
-@end example
+Non-note objects may be parenthesized as well.
 
 @lilypond[relative=2,fragment,verbatim,ragged-right]
-c4
-<\parenthesize d>
-g
-<\parenthesize d>
+< c d g >2-\parenthesize -. d
 @end lilypond
 
 @seealso
@@ -360,7 +341,7 @@ Whenever a note is found, a @code{Stem} object is created
 automatically.  For whole notes and rests, they are also created but
 made invisible.
 
-@refcommands
+@predefined
 
 @funindex \stemUp
 @code{\stemUp},
@@ -370,7 +351,7 @@ made invisible.
 @code{\stemNeutral}.
 
 
-@commonprop
+@snippets
 
 @cindex stem, direction
 @cindex stem, up
@@ -395,6 +376,8 @@ Snippets: @lsrdir{Editorial,Editorial-annotations}.
 @node Outside the staff
 @subsection Outside the staff
 
+This section discusses how to add emphasis to elements in the staff 
+from outside of the staff. 
 
 @menu
 * Balloon help::                
@@ -413,16 +396,20 @@ The following example demonstrates its use.
 
 @lilypond[quote,verbatim,fragment,ragged-right,relative=2]
 \new Voice \with { \consists "Balloon_engraver" }
-{
-  \balloonGrobText #'Stem #'(3 . 4) \markup { "I'm a Stem" }
-  <f-\balloonText #'(-2 . -2) \markup { "I'm a note head" }  >8
-}
+     {
+      \time 2/4
+       \balloonGrobText #'Stem #'(3 . 4) \markup { "I'm a Stem" }
+       a8
+       <c, g'-\balloonText #'(-2 . -2) \markup { "I'm a note head" } 
+c>4. 
+     }
+
 @end lilypond
 
 There are two music functions, @code{balloonGrobText} and
-@code{balloonText}; the former takes the name of the grob to adorn,
-while the latter may be used as an articulation on a note.  The other
-arguments are the offset and the text of the label.
+@code{balloonText};  The former is used like \once \override to 
+attach text to any grob, and the latter is used like \tweak, 
+typically within chords, to attach text to an individual note.
 
 @cindex balloon
 @cindex notation, explaining
@@ -444,15 +431,55 @@ notes.
 \layout {
   \context {
     \Staff
-    \consists "Grid_point_engraver" %% sets of grid
+    \consists "Grid_point_engraver" 
+    % sets up grids
     gridInterval = #(ly:make-moment 1 4)
+    % this sets the grid interval to 1 quarternote (crotchet)
+  }
+}
+
+\new Score \with {
+  \consists "Grid_line_span_engraver"
+  %% by default this centers grid lines horizontally below and to the 
+  % left side of the notehead, the grid lines extend from 
+  % the middle lines of each staff
+}
+
+\new ChoirStaff <<
+  \new Staff {
+    \stemUp
+    \relative {
+      c'4. d8 e8 f g4
+    }
+  }
+  \new Staff {
+    \stemDown
+    \clef bass
+    \relative c {
+      c4  g'  f  e
+    }
+  }
+>>
+@end lilypond
+
+To change the grid lines use \override.
+
+
+@lilypond[ragged-right,quote,verbatim]
+\layout {
+  \context {
+    \Staff
+    \consists "Grid_point_engraver" 
+    % sets up grids
+       gridInterval = #(ly:make-moment 1 4)
+       % this sets the grid interval to 1 quarternote (crotchet)
   }
 }
 
 \new Score \with {
   \consists "Grid_line_span_engraver"
-  %% centers grid lines  horizontally below note heads
   \override NoteColumn #'X-offset = #-0.5
+  % this moves them to the right half a staff space
 }
 
 \new ChoirStaff <<
@@ -463,8 +490,8 @@ notes.
     }
   }
   \new Staff {
-    %% centers grid lines  vertically
     \override Score.GridLine #'extra-offset = #'( 0.0 . 1.0 )
+    % this moves them up one staff space from the default position
     \stemDown
     \clef bass
     \relative c {
@@ -506,7 +533,9 @@ the @code{Staff} context.  A bracket is started with
   \layout {
     \context {
       \Staff \consists "Horizontal_bracket_engraver"
-}}}
+    }
+  }
+}
 @end lilypond
 
 @seealso