]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/editorial.itely
lilypond-book robustness: ensure EOL at the end of @verbatim
[lilypond.git] / Documentation / user / editorial.itely
index 939d28293b9b41c0b0e4b9c602618fe64e500ead..eec43dd741bcd24dada7446df197e6d452cecd9b 100644 (file)
@@ -6,50 +6,69 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
-@c \version "2.11.38"
+@c \version "2.12.0"
 
 @node Editorial annotations
 @section Editorial annotations
 
 @lilypondfile[quote]{editorial-headword.ly}
 
-This section discusses the various ways to change the appearance of 
+This section discusses the various ways to change the appearance of
 notes and add analysis or educational emphasis.
 
 @menu
-* Inside the staff::            
-* Outside the staff::           
+* Inside the staff::
+* Outside the staff::
 @end menu
 
 
 @node Inside the staff
 @subsection Inside the staff
 
-This section discusses how to add emphasis to elements that are 
+This section discusses how to add emphasis to elements that are
 inside the staff.
 
 @menu
-* Selecting notation font size::  
-* Fingering instructions::      
-* Hidden notes::                
-* Coloring objects::            
-* Parentheses::                 
-* Stems::                       
+* Selecting notation font size::
+* Fingering instructions::
+* Hidden notes::
+* Coloring objects::
+* Parentheses::
+* Stems::
 @end menu
 
 @node Selecting notation font size
 @unnumberedsubsubsec Selecting notation font size
 
+@cindex font size (notation) scaling
 @cindex font size (notation)
 @cindex selecting font size (notation)
+@cindex notation font size
+@cindex note heads
+
+@funindex fontSize
+@funindex font-size
+@funindex magstep
+@funindex \huge
+@funindex \large
+@funindex \normalsize
+@funindex \small
+@funindex \tiny
+@funindex \teeny
+@funindex huge
+@funindex large
+@funindex normalsize
+@funindex small
+@funindex tiny
+@funindex teeny
 
 The font size of notation elements may be altered.  It does not
 change the size of variable symbols, such as beams or slurs.
 
 @warning{For font sizes of text, see
-@ref{Common markup commands}.}
+@ref{Selecting font and font size}.}
 
-@lilypond[quote,fragment,relative=2,verbatim,ragged-right]
+@lilypond[verbatim,quote,relative=2]
 \huge
 c4.-> d8---3
 \large
@@ -64,8 +83,6 @@ c4.-> d8---3
 c4.-> d8---3
 @end lilypond
 
-@cindex font size (notation) scaling
-
 Internally, this sets the @code{fontSize} property.  This in turn
 causes the @code{font-size} property to be set in all layout
 objects.  The value of @code{font-size} is a number indicating the
@@ -76,7 +93,7 @@ Six steps is exactly a factor of two.  The Scheme function
 factor.  The @code{font-size} property can also be set directly,
 so that only certain layout objects are affected.
 
-@lilypond[quote,fragment,relative=2,verbatim,ragged-right]
+@lilypond[verbatim,quote,relative=2]
 \set fontSize = #3
 c4.-> d8---3
 \override NoteHead #'font-size = #-4
@@ -90,6 +107,9 @@ c4.-> d8---3
 @cindex standard font size (notation)
 @cindex font size (notation), standard
 
+@funindex font-interface
+@funindex font-size
+
 Font size changes are achieved by scaling the design size that is
 closest to the desired size.  The standard font size (for
 @w{@code{font-size = #0}}) depends on the standard staff height.
@@ -99,29 +119,22 @@ 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.
 
-@predefined
 
-@funindex \teeny
+@predefined
 @code{\teeny},
-@funindex \tiny
 @code{\tiny},
-@funindex \small
 @code{\small},
-@funindex \normalsize
 @code{\normalsize},
-@funindex \large
 @code{\large},
-@funindex \huge
 @code{\huge}.
+@endpredefined
 
-@seealso
 
+@seealso
 Snippets:
 @rlsr{Editorial annotations}.
 
 Internals Reference:
-@rinternals{fontSize},
-@rinternals{font-size},
 @rinternals{font-interface}.
 
 
@@ -131,51 +144,63 @@ Internals Reference:
 @cindex fingering
 @cindex finger change
 
+@funindex \finger
+@funindex finger
+
 Fingering instructions can be entered using
 @var{note}-@var{digit}:
 
-@lilypond[quote,verbatim,ragged-right,fragment,relative=2]
+@lilypond[verbatim,quote,relative=2]
 c4-1 d-2 f-4 e-3
 @end lilypond
 
-Markup texts may be used for finger changes. 
+Markup texts may be used for finger changes.
 
-@lilypond[quote,verbatim,ragged-right,fragment,relative=2]
+@lilypond[verbatim,quote,relative=2]
 c4-1 d-2 f-4 c^\markup { \finger "2 - 3" }
 @end lilypond
 
 @cindex thumb-script
 
+@funindex \thumb
+@funindex thumb
+
 A thumb-script can be added (e.g., in cello music) to indicate
-that a note should be played with the thumb. 
+that a note should be played with the thumb.
 
-@lilypond[quote,verbatim,ragged-right,fragment,relative=2]
+@lilypond[verbatim,quote,relative=2]
 <a_\thumb a'-3>2 <b_\thumb b'-3>
 @end lilypond
 
 @cindex fingering chords
+@cindex fingering instructions for chords
 @cindex chords, fingering
 
 Fingerings for chords can also be added to individual notes of the
 chord by adding them after the pitches.
 
-@lilypond[quote,verbatim,ragged-right,fragment,relative=2]
+@lilypond[verbatim,quote,relative=2]
 <c-1 e-2 g-3 b-5>2 <d-1 f-2 a-3 c-5>
 @end lilypond
 
 Fingering instructions may be manually placed above or below the
-staff, see @ref{Controlling direction and placement}.
+staff, see @ref{Direction and placement}.
 
 @snippets
 
 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {controlling-the-placement-of-chord-fingerings.ly}
 
+@lilypondfile[verbatim,lilyquote,texidoc,doctitle]
+{allowing-fingerings-to-be-printed-inside-the-staff.ly}
 
-@seealso
+@lilypondfile[verbatim,lilyquote,texidoc,doctitle]
+{avoiding-collisions-with-chord-fingerings.ly}
 
+
+@seealso
 Notation Reference:
-@ref{Controlling direction and placement}
+@ref{Direction and placement}
 
 Snippets:
 @rlsr{Editorial annotations}.
@@ -194,19 +219,25 @@ Internals Reference:
 @cindex hidden notes
 @cindex invisible notes
 @cindex transparent notes
+@cindex notes, hidden
+@cindex notes, invisible
+@cindex notes, transparent
+
 @funindex \hideNotes
+@funindex hideNotes
 @funindex \unHideNotes
+@funindex unHideNotes
 
 Hidden (or invisible or transparent) notes can be useful in
 preparing theory or composition exercises.
 
-@lilypond[quote,ragged-right,verbatim,relative=2,fragment]
+@lilypond[verbatim,quote,relative=2]
 c4 d
 \hideNotes
 e4 f
 \unHideNotes
 g a
-\hideNotes 
+\hideNotes
 b
 \unHideNotes
 c
@@ -215,7 +246,7 @@ c
 Notation objects which are attached to invisible notes are still
 visible.
 
-@lilypond[quote,ragged-right,verbatim,relative=2,fragment]
+@lilypond[verbatim,quote,relative=2]
 c4( d)
 \hideNotes
 e4(\p f)--
@@ -223,13 +254,12 @@ e4(\p f)--
 
 
 @predefined
+@code{\hideNotes},
+@code{\unHideNotes}.
+@endpredefined
 
-@funindex \hideNotes
-@funindex \unHideNotes
-@code{\hideNotes}, @code{\unHideNotes}
 
 @seealso
-
 Snippets:
 @rlsr{Editorial annotations}.
 
@@ -242,16 +272,25 @@ Internals Reference:
 @unnumberedsubsubsec Coloring objects
 
 @cindex colored objects
+@cindex objects, colored
 @cindex colors
 @cindex coloring objects
 @cindex colored notes
 @cindex coloring notes
 @cindex notes, colored
+@cindex x11 color
+@cindex x11-color
+@cindex with-color
+
+@funindex color
+@funindex \with-color
+@funindex with-color
+@funindex x11-color
 
 Individual objects may be assigned colors.  Valid color names
 are listed in the @ref{List of colors}.
 
-@lilypond[quote,ragged-right,verbatim,fragment,relative=2]
+@lilypond[verbatim,quote,relative=2]
 \override NoteHead #'color = #red
 c4 c
 \override NoteHead #'color = #(x11-color 'LimeGreen)
@@ -260,7 +299,6 @@ d
 e
 @end lilypond
 
-@cindex x11-color
 
 The full range of colors defined for X11 can be accessed by using
 the Scheme function @code{x11-color}.  The function takes one
@@ -270,9 +308,9 @@ 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.
 
 If @code{x11-color} cannot make sense of the parameter then the
-color returned defaults to black. 
+color returned defaults to black.
 
-@lilypond[quote,ragged-right,verbatim,fragment,relative=2]
+@lilypond[verbatim,quote,relative=2]
 \override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2)
 \set Staff.instrumentName = \markup {
   \with-color #(x11-color 'navy) "Clarinet"
@@ -290,35 +328,49 @@ gis a
 b2 cis
 @end lilypond
 
+@cindex rgb-color
+@cindex color, rgb
+@cindex rgb color
+
+@funindex rgb-color
+
 Exact RGB colors can be specified using the Scheme function
 @code{rgb-color}.
 
-@lilypond[quote,ragged-right,verbatim,fragment,relative=2]
+@lilypond[verbatim,quote,relative=2]
 \override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2)
 \set Staff.instrumentName = \markup {
   \with-color #(x11-color 'navy) "Clarinet"
 }
-  
+
 \override Stem #'color = #(rgb-color 0 0 0)
 gis8 a
 \override Stem #'color = #(rgb-color 1 1 1)
 gis8 a
-\override Stem #'color = #(rgb-color 0 0 0.5) 
+\override Stem #'color = #(rgb-color 0 0 0.5)
 gis4 a
 @end lilypond
 
-@seealso
 
+@seealso
 Notation Reference:
-@ref{List of colors}, @ref{Objects connected to
-the input}.
+@ref{List of colors}, @ref{The
+tweak command}.
 
 Snippets:
 @rlsr{Editorial annotations}.
 
+
+@cindex x11 color
+@cindex colored notes in chords
+@cindex notes, colored in chords
+@cindex color in chords
+
+@funindex x11-color
+
 @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 @code{'LimeGreen}
@@ -327,7 +379,7 @@ and @code{'ForestGreen}.  For web use normal colors are recommended
 
 
 Notes in a chord cannot be colored with @code{\override}; use
-@code{\tweak} instead, see @ref{Objects connected to the input}.
+@code{\tweak} instead, see @ref{The tweak command}.
 
 
 @node Parentheses
@@ -338,25 +390,29 @@ Notes in a chord cannot be colored with @code{\override}; use
 @cindex notes, parenthesized
 @cindex parentheses
 
+@funindex \parenthesize
+@funindex parenthesize
+
 Objects may be parenthesized by prefixing @code{\parenthesize} to
 the music event.  When prefixed to a chord, it parenthesizes every
 note.  Individual notes inside a chord may also be parenthesized.
 
-@lilypond[quote,relative=2,fragment,verbatim,ragged-right]
+@lilypond[verbatim,quote,relative=2]
 c2 \parenthesize d
 c2 \parenthesize <c e g>
 c2 <c \parenthesize e g>
 @end lilypond
 
-Non-note objects may be parenthesized as well.
+Non-note objects may be parenthesized as well. For articulations, 
+a hyphen is needed before the @code{\parenthesize} command.
 
-@lilypond[quote,relative=2,fragment,verbatim,ragged-right]
+@lilypond[verbatim,quote,relative=2]
 c2-\parenthesize -. d
 c2 \parenthesize r
 @end lilypond
 
-@seealso
 
+@seealso
 Snippets:
 @rlsr{Editorial annotations}.
 
@@ -365,6 +421,7 @@ Internals Reference:
 @rinternals{ParenthesesItem},
 @rinternals{parentheses-interface}.
 
+
 @knownissues
 
 Parenthesizing a chord prints parentheses around each individual
@@ -376,34 +433,44 @@ chord.
 @unnumberedsubsubsec Stems
 
 @cindex stem
+@cindex stem, invisible
+@cindex invisible stem
+
+@funindex \stemUp
+@funindex stemUp
+@funindex \stemDown
+@funindex stemDown
+@funindex \stemNeutral
+@funindex stemNeutral
+@cindex stem, direction
+@cindex stem, up
+@cindex stem, down
+@cindex stem, neutral
 
 Whenever a note is found, a @code{Stem} object is created
 automatically.  For whole notes and rests, they are also created but
 made invisible.
 
-@predefined
+Stems may be manually placed to point up or down; see
+@ref{Direction and placement}.
 
-@funindex \stemUp
+
+@predefined
 @code{\stemUp},
-@funindex \stemDown
 @code{\stemDown},
-@funindex \stemNeutral
 @code{\stemNeutral}.
+@endpredefined
 
 
 @snippets
 
-@cindex stem, direction
-@cindex stem, up
-@cindex stem, down
-@cindex stem, neutral
-
 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {default-direction-of-stems-on-the-center-line-of-the-staff.ly}
 
+
 @seealso
 Notation Reference:
-@ref{Controlling direction and placement}.
+@ref{Direction and placement}.
 
 Snippets:
 @rlsr{Editorial annotations}.
@@ -417,35 +484,48 @@ Internals Reference:
 @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. 
+This section discusses how to add emphasis to elements in the staff
+from outside of the staff.
 
 @menu
-* Balloon help::                
-* Grid lines::                  
-* Analysis brackets::           
+* Balloon help::
+* Grid lines::
+* Analysis brackets::
 @end menu
 
 @node Balloon help
 @unnumberedsubsubsec Balloon help
 
+@cindex balloon
+@cindex notation, explaining
+@cindex balloon help
+@cindex help, balloon
+
+@funindex \balloonGrobText
+@funindex \balloonText
+@funindex Balloon_engraver
+@funindex balloonGrobText
+@funindex balloonText
+@funindex \balloonLengthOn
+@funindex balloonLengthOn
+@funindex \balloonLengthOff
+@funindex balloonLengthOff
+
 Elements of notation can be marked and named with the help of a
 square balloon.  The primary purpose of this feature is to explain
 notation.
 
-@lilypond[quote,verbatim,fragment,ragged-right,relative=2]
+@lilypond[verbatim,quote,relative=2]
 \new Voice \with { \consists "Balloon_engraver" }
 {
   \balloonGrobText #'Stem #'(3 . 4) \markup { "I'm a Stem" }
-  a8 
+  a8
   \balloonGrobText #'Rest #'(-4 . -4) \markup { "I'm a rest" }
   r
-  <c, g'-\balloonText #'(-2 . -2) \markup { "I'm a note head" } c>2. 
+  <c, g'-\balloonText #'(-2 . -2) \markup { "I'm a note head" } c>2.
 }
 @end lilypond
 
-@cindex balloon
-@cindex notation, explaining
 
 There are two music functions, @code{balloonGrobText} and
 @code{balloonText};  the former is used like
@@ -456,28 +536,27 @@ attach text to an individual note.
 Balloon text normally influences note spacing, but this can be
 altered:
 
-@lilypond[quote,verbatim,fragment,ragged-right,relative=2]
+@lilypond[verbatim,quote,relative=2]
 \new Voice \with { \consists "Balloon_engraver" }
 {
   \balloonLengthOff
   \balloonGrobText #'Stem #'(3 . 4) \markup { "I'm a Stem" }
-  a8 
+  a8
   \balloonGrobText #'Rest #'(-4 . -4) \markup { "I'm a rest" }
   r
   \balloonLengthOn
-  <c, g'-\balloonText #'(-2 . -2) \markup { "I'm a note head" } c>2. 
+  <c, g'-\balloonText #'(-2 . -2) \markup { "I'm a note head" } c>2.
 }
 @end lilypond
 
 
 @predefined
+@code{\balloonLengthOn},
+@code{\balloonLengthOff}.
+@endpredefined
 
-@funindex balloonLengthOn
-@funindex balloonLengthOff
-@code{\balloonLengthOn}, @code{\balloonLengthOff}
 
 @seealso
-
 Snippets:
 @rlsr{Editorial annotations}.
 
@@ -490,6 +569,15 @@ Internals Reference:
 @node Grid lines
 @unnumberedsubsubsec Grid lines
 
+@cindex grid lines
+@cindex lines, grid
+@cindex vertical lines between staves
+@cindex lines, vertical between staves
+
+@funindex Grid_point_engraver
+@funindex Grid_line_span_engraver
+@funindex gridInterval
+
 Vertical lines can be drawn between staves synchronized with the
 notes.
 
@@ -501,11 +589,11 @@ Grid lines extend from the middle lines of each staff.  The
 @code{gridInterval} must specify the duration between the grid
 lines.
 
-@lilypond[quote,verbatim,ragged-right]
+@lilypond[verbatim,quote]
 \layout {
   \context {
     \Staff
-    \consists "Grid_point_engraver" 
+    \consists "Grid_point_engraver"
     gridInterval = #(ly:make-moment 1 4)
   }
   \context {
@@ -536,7 +624,6 @@ lines.
 
 
 @seealso
-
 Snippets:
 @rlsr{Editorial annotations}.
 
@@ -553,14 +640,24 @@ Internals Reference:
 @unnumberedsubsubsec Analysis brackets
 
 @cindex brackets
-@cindex phrasing brackets
+@cindex bracket, phrasing
+@cindex phrasing bracket
 @cindex musicological analysis
+@cindex analysis, musicological
 @cindex note grouping bracket
+@cindex horizontal bracket
+@cindex bracket, horizontal
+
+@funindex Horizontal_bracket_engraver
+@funindex \startGroup
+@funindex startGroup
+@funindex \stopGroup
+@funindex stopGroup
 
 Brackets are used in musical analysis to indicate structure in musical
 pieces.  Simple horizontal brackets are supported.
 
-@lilypond[quote,verbatim,ragged-right]
+@lilypond[verbatim,quote]
 \layout {
   \context {
     \Voice
@@ -575,7 +672,7 @@ pieces.  Simple horizontal brackets are supported.
 
 Analysis brackets may be nested.
 
-@lilypond[quote,verbatim,ragged-right]
+@lilypond[verbatim,quote]
 \layout {
   \context {
     \Voice
@@ -590,8 +687,8 @@ Analysis brackets may be nested.
 }
 @end lilypond
 
-@seealso
 
+@seealso
 Snippets:
 @rlsr{Editorial annotations}.