* lily/ various: Introduce stream events of types Prepare,

[lilypond.git] / Documentation / user / advanced-notation.itely

diff --git a/Documentation/user/advanced-notation.itely b/Documentation/user/advanced-notation.itely
index 62116e26081fa387d2225b599ed7854292da008c..f446039c5c397acecf61dd1d3533424642264e0f 100644 (file)
--- a/Documentation/user/advanced-notation.itely
+++ b/Documentation/user/advanced-notation.itely
@@ -75,9 +75,9 @@ The @code{\markup} is described in more detail in
 
 @refcommands
 
 
 @refcommands
 

-@findex \fatText
+@funindex \fatText

 @code{\fatText},
 @code{\fatText},

-@findex \emptyText
+@funindex \emptyText

 @code{\emptyText}.
 
 
 @code{\emptyText}.
 
 


@@ -157,13 +157,14 @@ Examples: @inputfileref{input/@/regression,text@/-spanner@/.ly}.
 @cindex segno on bar line
 @cindex fermata on bar line
 @cindex bar lines, symbols on
 @cindex segno on bar line
 @cindex fermata on bar line
 @cindex bar lines, symbols on

-@findex \mark
+@funindex \mark

 
 The @code{\mark} command is primarily used for
 @ref{Rehearsal marks},
 but it can also be used to put signs like coda,
 segno, and fermata on a bar line.  Use @code{\markup} to
 
 The @code{\mark} command is primarily used for
 @ref{Rehearsal marks},
 but it can also be used to put signs like coda,
 segno, and fermata on a bar line.  Use @code{\markup} to

-access the appropriate symbol
+access the appropriate symbol (symbols are listed in
+@ref{The Feta font})

 
 @lilypond[fragment,quote,ragged-right,verbatim,relative=2]
 c1 \mark \markup { \musicglyph #"scripts.ufermata" }
 
 @lilypond[fragment,quote,ragged-right,verbatim,relative=2]
 c1 \mark \markup { \musicglyph #"scripts.ufermata" }


@@ -304,7 +305,7 @@ but it can also be used anywhere text is called in lilypond
 
 Text can also be placed on its own, away from any @code{\score}
 block.  This is primarily used in a @code{\book} (see
 
 Text can also be placed on its own, away from any @code{\score}
 block.  This is primarily used in a @code{\book} (see

-@ref{Multiple movements}).
+@ref{Multiple scores in a book}).

 
 @lilypond[quote,ragged-right,verbatim]
 \markup{ Here is some text. }
 
 @lilypond[quote,ragged-right,verbatim]
 \markup{ Here is some text. }


@@ -450,7 +451,7 @@ The following commands can all be used inside @code{\markup @{ @}}.
 
 @cindex font selection
 @cindex font magnification
 
 @cindex font selection
 @cindex font magnification

-@findex font-interface
+@funindex font-interface

 
 By setting the object properties described below, you can select a
 font from the preconfigured font families.  LilyPond has default
 
 By setting the object properties described below, you can select a
 font from the preconfigured font families.  LilyPond has default


@@ -492,12 +493,12 @@ then set the
 
 @lilypond[fragment,verbatim]
 {
 
 @lilypond[fragment,verbatim]
 {

-  \override Staff.TimeSignature #'font-name = #"Charter"
-  \override Staff.TimeSignature #'font-size = #2
+%  \override Staff.TimeSignature #'font-name = #"Charter"
+%  \override Staff.TimeSignature #'font-size = #2

   \time 3/4
   c'1_\markup {
   \time 3/4
   c'1_\markup {

-    \override #'(font-name . "Vera Bold")
-      { This text is in Vera Bold }
+%    \override #'(font-name . "Vera Bold")
+%      { This text is in Vera Bold }

   }
 }
 @end lilypond
   }
 }
 @end lilypond


@@ -613,7 +614,7 @@ individual parts.
 @cindex Rests, multi measure
 @cindex Rests, full measure
 @cindex whole rests for a full measure
 @cindex Rests, multi measure
 @cindex Rests, full measure
 @cindex whole rests for a full measure

-@findex R
+@funindex R

 
 Rests for one full measure (or many bars) are entered using `@code{R}'.  It
 is specifically meant for full bar rests and for entering parts: the rest
 
 Rests for one full measure (or many bars) are entered using `@code{R}'.  It
 is specifically meant for full bar rests and for entering parts: the rest


@@ -735,7 +736,7 @@ Metronome settings can be entered as follows
 
 In the MIDI output, they are interpreted as a tempo change.  In the
 layout output, a metronome marking is printed
 
 In the MIDI output, they are interpreted as a tempo change.  In the
 layout output, a metronome marking is printed

-@findex \tempo
+@funindex \tempo

 @lilypond[quote,ragged-right,verbatim,fragment]
 \tempo 8.=120 c''1
 @end lilypond
 @lilypond[quote,ragged-right,verbatim,fragment]
 \tempo 8.=120 c''1
 @end lilypond


@@ -785,7 +786,7 @@ further away from the staff.
 @subsection Rehearsal marks
 
 @cindex Rehearsal marks
 @subsection Rehearsal marks
 
 @cindex Rehearsal marks

-@findex \mark
+@funindex \mark

 
 To print a rehearsal mark, use the @code{\mark} command
 
 
 To print a rehearsal mark, use the @code{\mark} command
 


@@ -898,7 +899,7 @@ Examples: @inputfileref{input/@/regression,rehearsal@/-mark@/-letter@/.ly},
 
 @cindex Bar numbers
 @cindex measure numbers
 
 @cindex Bar numbers
 @cindex measure numbers

-@findex currentBarNumber
+@funindex currentBarNumber

 
 Bar numbers are printed by default at the start of the line.  The
 number itself is stored in the @code{currentBarNumber} property, which
 
 Bar numbers are printed by default at the start of the line.  The
 number itself is stored in the @code{currentBarNumber} property, which


@@ -1154,7 +1155,7 @@ during an octavation bracket.
 @node Different editions from one source
 @subsection Different editions from one source
 
 @node Different editions from one source
 @subsection Different editions from one source
 

-@findex \tag
+@funindex \tag

 @cindex tag
 
 The @code{\tag} command marks music expressions with a name.  These
 @cindex tag
 
 The @code{\tag} command marks music expressions with a name.  These


@@ -1618,15 +1619,6 @@ that fits into traditional notation categories, such as
 microtones, nested tuplet beams, and unusual fermatas, please
 see those sections of the documentation.
 
 microtones, nested tuplet beams, and unusual fermatas, please
 see those sections of the documentation.
 

-
-@c I don't think we should discourage modern composers who might
-@c want to sponsor new features.  :)
-@c  In general, the use of new, innovative notation makes a piece
-@c harder to understand and perform and its use should therefore be
-@c avoided.  For this reason, support for contemporary notation in
-@c LilyPond is limited.
-
-

 @menu
 * Polymetric notation::         
 * Time administration::         
 @menu
 * Polymetric notation::         
 * Time administration::         


@@ -1635,6 +1627,7 @@ see those sections of the documentation.
 * Special noteheads::           
 * Feathered beams::             
 * Improvisation::               
 * Special noteheads::           
 * Feathered beams::             
 * Improvisation::               

+* Selecting notation font size::  

 @end menu
 
 
 @end menu
 
 


@@ -1896,6 +1889,8 @@ accurately.  Use @code{<g a>8 <e a>8} instead.
 @node Special noteheads
 @subsection Special noteheads
 
 @node Special noteheads
 @subsection Special noteheads
 

+@cindex note heads, special
+

 Different noteheads are used by various instruments for various
 meanings -- crosses are used for ``parlato'' with vocalists, stopped
 notes on guitar; diamonds are used for harmonics on string instruments,
 Different noteheads are used by various instruments for various
 meanings -- crosses are used for ``parlato'' with vocalists, stopped
 notes on guitar; diamonds are used for harmonics on string instruments,


@@ -1976,6 +1971,62 @@ the following example
 @end lilypond
 
 
 @end lilypond
 
 

+@node Selecting notation font size
+@subsection Selecting notation font size
+
+The easiest method of setting the font size of any context is by
+setting the @code{fontSize} property.
+
+@lilypond[quote,fragment,relative=1,verbatim]
+c8
+\set fontSize = #-4
+c f
+\set fontSize = #3
+g
+@end lilypond
+
+@noindent
+It does not change the size of variable symbols, such as beams or
+slurs.
+
+Internally, the @code{fontSize} context property will cause the
+@code{font-size} property to be set in all layout objects.  The value
+of @code{font-size} is a number indicating the size relative to the
+standard size for the current staff height.  Each step up is an
+increase of approximately 12% of the font size.  Six steps is exactly a
+factor two.  The Scheme function @code{magstep} converts a
+@code{font-size} number to a scaling factor.
+
+@lilypond[quote,fragment,relative=1,verbatim]
+c8
+\override NoteHead #'font-size = #-4
+c f
+\override NoteHead #'font-size = #3
+g
+@end lilypond
+
+Font size changes are achieved by scaling the design size that is
+closest to the desired size.  The standard font size (for
+@code{font-size} equals 0), depends on the standard staff height.  For
+a 20pt staff, a 10pt font is selected.
+
+The @code{font-size} property can only be set on layout objects that
+use fonts. These are the ones supporting the
+@internalsref{font-interface} layout interface.
+
+@refcommands
+
+The following commands set @code{fontSize} for the current voice:
+
+@funindex \tiny
+@code{\tiny},
+@funindex \small
+@code{\small},
+@funindex \normalsize
+@code{\normalsize}.
+
+
+

 @node Educational use
 @section Educational use
 
 @node Educational use
 @section Educational use
 


@@ -2060,8 +2111,8 @@ emptymusic = {
 @cindex Invisible notes
 @cindex Transparent notes
 
 @cindex Invisible notes
 @cindex Transparent notes
 

-@findex \hideNotes
-@findex \unHideNotes
+@funindex \hideNotes
+@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.
 


@@ -2077,6 +2128,8 @@ g4 a
 @node Shape note heads
 @subsection Shape note heads
 
 @node Shape note heads
 @subsection Shape note heads
 

+@cindex note heads, shape
+

 In shape note head notation, the shape of the note head corresponds
 to the harmonic function of a note in the scale.  This notation was
 popular in the 19th century American song books.
 In shape note head notation, the shape of the note head corresponds
 to the harmonic function of a note in the scale.  This notation was
 popular in the 19th century American song books.


@@ -2094,10 +2147,10 @@ Shape note heads can be produced by setting @code{\aikenHeads} or
 Shapes are determined on the step in the scale, where the base of the
 scale is determined by  the @code{\key} command
 
 Shapes are determined on the step in the scale, where the base of the
 scale is determined by  the @code{\key} command
 

-@findex \key
-@findex shapeNoteStyles
-@findex \aikenHeads
-@findex \sacredHarpHeads
+@funindex \key
+@funindex shapeNoteStyles
+@funindex \aikenHeads
+@funindex \sacredHarpHeads

 
 Shape note heads are implemented through the @code{shapeNoteStyles}
 property.  Its value is a vector of symbols.  The k-th element indicates
 
 Shape note heads are implemented through the @code{shapeNoteStyles}
 property.  Its value is a vector of symbols.  The k-th element indicates


@@ -2113,6 +2166,8 @@ combinations are possible, e.g.
 @node Easy Notation note heads
 @subsection Easy Notation note heads
 
 @node Easy Notation note heads
 @subsection Easy Notation note heads
 

+@cindex note heads, practice
+@cindex note heads, easy notation

 @cindex easy notation
 @cindex Hal Leonard
 
 @cindex easy notation
 @cindex Hal Leonard
 


@@ -2131,7 +2186,7 @@ to be printed in a large font size.  To print with a larger font, see
 
 @refcommands
 
 
 @refcommands
 

-@findex \setEasyHeads
+@funindex \setEasyHeads

 @code{\setEasyHeads}
 
 
 @code{\setEasyHeads}
 
 


@@ -2185,7 +2240,7 @@ e
 @end lilypond
 
 The full range of colors defined for X11 can be accessed by using the
 @end lilypond
 
 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
+Scheme function x11-color.  The function takes one argument that can be a

 symbol
 
 @example
 symbol
 
 @example