Merge commit 'origin/dev/jneeman' into systems-per-page

[lilypond.git] / Documentation / user / editorial.itely

diff --git a/Documentation/user/editorial.itely b/Documentation/user/editorial.itely
index 3f04aff558f9347e5836345dc8efe680debd80d3..556db2dc66bfefb0509d60192719ad8d3560e048 100644 (file)
--- a/Documentation/user/editorial.itely
+++ b/Documentation/user/editorial.itely
@@ -6,48 +6,67 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
     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}
 
 
 @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
 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
 
 @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
 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
 
 @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 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
 
 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[verbatim,quote,relative=2]
 \huge
 
 @lilypond[verbatim,quote,relative=2]
 \huge


@@ -64,8 +83,6 @@ c4.-> d8---3
 c4.-> d8---3
 @end lilypond
 
 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
 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


@@ -90,6 +107,9 @@ c4.-> d8---3
 @cindex standard font size (notation)
 @cindex font size (notation), standard
 
 @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.
 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.
 
 that use fonts.  These are the ones supporting the
 @code{font-interface} layout interface.
 

-@predefined

 
 

-@funindex \teeny
+@predefined

 @code{\teeny},
 @code{\teeny},

-@funindex \tiny

 @code{\tiny},
 @code{\tiny},

-@funindex \small

 @code{\small},
 @code{\small},

-@funindex \normalsize

 @code{\normalsize},
 @code{\normalsize},

-@funindex \large

 @code{\large},
 @code{\large},

-@funindex \huge

 @code{\huge}.
 @code{\huge}.

+@endpredefined

 
 

-@seealso

 
 

+@seealso

 Snippets:
 @rlsr{Editorial annotations}.
 
 Internals Reference:
 Snippets:
 @rlsr{Editorial annotations}.
 
 Internals Reference:

-@rinternals{fontSize},
-@rinternals{font-size},

 @rinternals{font-interface}.
 
 
 @rinternals{font-interface}.
 
 


@@ -131,6 +144,9 @@ Internals Reference:
 @cindex fingering
 @cindex finger change
 
 @cindex fingering
 @cindex finger change
 

+@funindex \finger
+@funindex finger
+

 Fingering instructions can be entered using
 @var{note}-@var{digit}:
 
 Fingering instructions can be entered using
 @var{note}-@var{digit}:
 


@@ -138,7 +154,7 @@ Fingering instructions can be entered using
 c4-1 d-2 f-4 e-3
 @end lilypond
 
 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[verbatim,quote,relative=2]
 c4-1 d-2 f-4 c^\markup { \finger "2 - 3" }
 
 @lilypond[verbatim,quote,relative=2]
 c4-1 d-2 f-4 c^\markup { \finger "2 - 3" }


@@ -146,14 +162,18 @@ c4-1 d-2 f-4 c^\markup { \finger "2 - 3" }
 
 @cindex thumb-script
 
 
 @cindex thumb-script
 

+@funindex \thumb
+@funindex thumb
+

 A thumb-script can be added (e.g., in cello music) to indicate
 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[verbatim,quote,relative=2]
 <a_\thumb a'-3>2 <b_\thumb b'-3>
 @end lilypond
 
 @cindex fingering chords
 
 @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
 @cindex chords, fingering
 
 Fingerings for chords can also be added to individual notes of the


@@ -171,9 +191,14 @@ staff, see @ref{Direction and placement}.
 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {controlling-the-placement-of-chord-fingerings.ly}
 
 @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{Direction and placement}
 
 Notation Reference:
 @ref{Direction and placement}
 


@@ -194,8 +219,14 @@ Internals Reference:
 @cindex hidden notes
 @cindex invisible notes
 @cindex transparent notes
 @cindex hidden notes
 @cindex invisible notes
 @cindex transparent notes

+@cindex notes, hidden
+@cindex notes, invisible
+@cindex notes, transparent
+

 @funindex \hideNotes
 @funindex \hideNotes

+@funindex hideNotes

 @funindex \unHideNotes
 @funindex \unHideNotes

+@funindex unHideNotes

 
 Hidden (or invisible or transparent) notes can be useful in
 preparing theory or composition exercises.
 
 Hidden (or invisible or transparent) notes can be useful in
 preparing theory or composition exercises.


@@ -206,7 +237,7 @@ c4 d
 e4 f
 \unHideNotes
 g a
 e4 f
 \unHideNotes
 g a

-\hideNotes 
+\hideNotes

 b
 \unHideNotes
 c
 b
 \unHideNotes
 c


@@ -223,13 +254,12 @@ e4(\p f)--
 
 
 @predefined
 
 
 @predefined

+@code{\hideNotes},
+@code{\unHideNotes}.
+@endpredefined

 
 

-@funindex \hideNotes
-@funindex \unHideNotes
-@code{\hideNotes}, @code{\unHideNotes}

 
 @seealso
 
 @seealso

-

 Snippets:
 @rlsr{Editorial annotations}.
 
 Snippets:
 @rlsr{Editorial annotations}.
 


@@ -242,11 +272,20 @@ Internals Reference:
 @unnumberedsubsubsec Coloring objects
 
 @cindex colored objects
 @unnumberedsubsubsec Coloring objects
 
 @cindex colored objects

+@cindex objects, colored

 @cindex colors
 @cindex coloring objects
 @cindex colored notes
 @cindex coloring notes
 @cindex notes, 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}.
 
 Individual objects may be assigned colors.  Valid color names
 are listed in the @ref{List of colors}.


@@ -260,7 +299,6 @@ d
 e
 @end lilypond
 
 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
 
 The full range of colors defined for X11 can be accessed by using
 the Scheme function @code{x11-color}.  The function takes one


@@ -270,7 +308,7 @@ 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
 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[verbatim,quote,relative=2]
 \override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2)
 
 @lilypond[verbatim,quote,relative=2]
 \override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2)


@@ -290,6 +328,12 @@ gis a
 b2 cis
 @end lilypond
 
 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}.
 
 Exact RGB colors can be specified using the Scheme function
 @code{rgb-color}.
 


@@ -298,27 +342,35 @@ Exact RGB colors can be specified using the Scheme function
 \set Staff.instrumentName = \markup {
   \with-color #(x11-color 'navy) "Clarinet"
 }
 \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)
 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
 
 gis4 a
 @end lilypond
 

-@seealso

 
 

+@seealso

 Notation Reference:
 Notation Reference:

-@ref{List of colors}, @ref{Objects connected to
-the input}.
+@ref{List of colors}, @ref{The
+tweak command}.

 
 Snippets:
 @rlsr{Editorial annotations}.
 
 
 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
 @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}
 
 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
 
 
 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
 
 
 @node Parentheses


@@ -338,6 +390,9 @@ Notes in a chord cannot be colored with @code{\override}; use
 @cindex notes, parenthesized
 @cindex parentheses
 
 @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.
 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.


@@ -348,15 +403,16 @@ c2 \parenthesize <c e g>
 c2 <c \parenthesize e g>
 @end lilypond
 
 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[verbatim,quote,relative=2]
 c2-\parenthesize -. d
 c2 \parenthesize r
 @end lilypond
 
 
 @lilypond[verbatim,quote,relative=2]
 c2-\parenthesize -. d
 c2 \parenthesize r
 @end lilypond
 

-@seealso

 
 

+@seealso

 Snippets:
 @rlsr{Editorial annotations}.
 
 Snippets:
 @rlsr{Editorial annotations}.
 


@@ -365,6 +421,7 @@ Internals Reference:
 @rinternals{ParenthesesItem},
 @rinternals{parentheses-interface}.
 
 @rinternals{ParenthesesItem},
 @rinternals{parentheses-interface}.
 

+

 @knownissues
 
 Parenthesizing a chord prints parentheses around each individual
 @knownissues
 
 Parenthesizing a chord prints parentheses around each individual


@@ -376,31 +433,38 @@ chord.
 @unnumberedsubsubsec Stems
 
 @cindex stem
 @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.
 
 
 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

 
 

-@funindex \stemUp
+@predefined

 @code{\stemUp},
 @code{\stemUp},

-@funindex \stemDown

 @code{\stemDown},
 @code{\stemDown},

-@funindex \stemNeutral

 @code{\stemNeutral}.
 @code{\stemNeutral}.

+@endpredefined

 
 
 @snippets
 
 
 
 @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}
 
 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {default-direction-of-stems-on-the-center-line-of-the-staff.ly}
 

+

 @seealso
 Notation Reference:
 @ref{Direction and placement}.
 @seealso
 Notation Reference:
 @ref{Direction and placement}.


@@ -417,18 +481,33 @@ Internals Reference:
 @node Outside the staff
 @subsection Outside the staff
 
 @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
 
 @menu

-* Balloon help::                
-* Grid lines::                  
-* Analysis brackets::           
+* Balloon help::
+* Grid lines::
+* Analysis brackets::

 @end menu
 
 @node Balloon help
 @unnumberedsubsubsec Balloon help
 
 @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.
 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.


@@ -437,15 +516,13 @@ notation.
 \new Voice \with { \consists "Balloon_engraver" }
 {
   \balloonGrobText #'Stem #'(3 . 4) \markup { "I'm a Stem" }
 \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
   \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
 
 }
 @end lilypond
 

-@cindex balloon
-@cindex notation, explaining

 
 There are two music functions, @code{balloonGrobText} and
 @code{balloonText};  the former is used like
 
 There are two music functions, @code{balloonGrobText} and
 @code{balloonText};  the former is used like


@@ -461,23 +538,22 @@ altered:
 {
   \balloonLengthOff
   \balloonGrobText #'Stem #'(3 . 4) \markup { "I'm a Stem" }
 {
   \balloonLengthOff
   \balloonGrobText #'Stem #'(3 . 4) \markup { "I'm a Stem" }

-  a8 
+  a8

   \balloonGrobText #'Rest #'(-4 . -4) \markup { "I'm a rest" }
   r
   \balloonLengthOn
   \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
 }
 @end lilypond
 
 
 @predefined

+@code{\balloonLengthOn},
+@code{\balloonLengthOff}.
+@endpredefined

 
 

-@funindex balloonLengthOn
-@funindex balloonLengthOff
-@code{\balloonLengthOn}, @code{\balloonLengthOff}

 
 @seealso
 
 @seealso

-

 Snippets:
 @rlsr{Editorial annotations}.
 
 Snippets:
 @rlsr{Editorial annotations}.
 


@@ -490,6 +566,15 @@ Internals Reference:
 @node Grid lines
 @unnumberedsubsubsec Grid lines
 
 @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.
 
 Vertical lines can be drawn between staves synchronized with the
 notes.
 


@@ -505,7 +590,7 @@ lines.
 \layout {
   \context {
     \Staff
 \layout {
   \context {
     \Staff

-    \consists "Grid_point_engraver" 
+    \consists "Grid_point_engraver"

     gridInterval = #(ly:make-moment 1 4)
   }
   \context {
     gridInterval = #(ly:make-moment 1 4)
   }
   \context {


@@ -536,7 +621,6 @@ lines.
 
 
 @seealso
 
 
 @seealso

-

 Snippets:
 @rlsr{Editorial annotations}.
 
 Snippets:
 @rlsr{Editorial annotations}.
 


@@ -553,9 +637,19 @@ Internals Reference:
 @unnumberedsubsubsec Analysis brackets
 
 @cindex brackets
 @unnumberedsubsubsec Analysis brackets
 
 @cindex brackets

-@cindex phrasing brackets
+@cindex bracket, phrasing
+@cindex phrasing bracket

 @cindex musicological analysis
 @cindex musicological analysis

+@cindex analysis, musicological

 @cindex note grouping bracket
 @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.
 
 Brackets are used in musical analysis to indicate structure in musical
 pieces.  Simple horizontal brackets are supported.


@@ -590,8 +684,8 @@ Analysis brackets may be nested.
 }
 @end lilypond
 
 }
 @end lilypond
 

-@seealso

 
 

+@seealso

 Snippets:
 @rlsr{Editorial annotations}.
 
 Snippets:
 @rlsr{Editorial annotations}.