]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/vocal.itely
Policy updates.
[lilypond.git] / Documentation / user / vocal.itely
index e0e936c436d165c57b7c32857196e539e8ba3148..9ee8c8710ff89a01676a519354030b9d4296dbed 100644 (file)
@@ -12,7 +12,7 @@
 Since LilyPond input files are text, there are two issues to
 consider when working with vocal music:
 
-@itemize @bullet
+@itemize
 @item
 Song texts must be entered as text, not notes.  For example, the
 input@tie{}@code{d} should be interpreted as a one letter syllable, not the
@@ -26,11 +26,15 @@ There are a few different ways to define lyrics; we shall begin
 by examining the simplest method, and gradually increase complexity.
 
 @menu
-* TODO subsection vocal music::  
+* Simple lyrics::               
+* Aligning lyrics to a melody::  
+* Vocals and variables::        
+* Flexibility in placement::    
+* Spacing vocals::              
+* More about stanzas::          
 @end menu
 
-
-@commonprop
+@snippets
 
 Checking to make sure that text scripts and lyrics are within the margins is
 a relatively large computational task.  To speed up processing, lilypond does
@@ -40,7 +44,8 @@ not perform such calculations by default; to enable it, use
 \override Score.PaperColumn #'keep-inside-line = ##t
 @end example
 
-To make lyrics avoid barlines as well, use
+To make lyrics avoid bar lines as well, use
+
 @example
 \layout @{
   \context @{
@@ -53,31 +58,16 @@ To make lyrics avoid barlines as well, use
 @end example
 
 
-@node TODO subsection vocal music
-@subsection TODO subsection vocal music
+@node Simple lyrics
+@subsection Simple lyrics
 
 @menu
 * Setting simple songs::        
 * Entering lyrics::             
-* Aligning lyrics to a melody::  
-* Automatic syllable durations::  
-* Another way of entering lyrics::  
-* Assigning more than one syllable to a single note::  
-* More than one note on a single syllable::  
-* Extenders and hyphens::       
-* Working with lyrics and identifiers::  
-* Flexibility in placement::    
-* Lyrics to multiple notes of a melisma::  
-* Divisi lyrics::               
-* Switching the melody associated with a lyrics line::  
-* Lyrics independent of notes::  
-* Spacing lyrics::              
-* More about stanzas::          
-* Other vocal issues::          
 @end menu
 
 @node Setting simple songs
-@unnumberedsubsubsec Setting simple songs
+@subsubsection Setting simple songs
 
 @cindex \addlyrics
 
@@ -114,7 +104,7 @@ introduced in @ref{Entering lyrics}.
 
 
 @node Entering lyrics
-@unnumberedsubsubsec Entering lyrics
+@subsubsection Entering lyrics
 
 @cindex lyrics
 @funindex \lyricmode
@@ -204,9 +194,11 @@ accented and special characters (such as the heart symbol or slanted quotes),
 simply insert the characters directly into the input file and save
 it with utf-8 encoding.  See @ref{Text encoding}, for more info.
 
+FIXME: quotes.
+
 @lilypond[quote,ragged-right,fragment,verbatim]
 \relative { e4 f e d e f e2 }
-\addlyrics { He said: â\80\9cLet my peo ple goâ\80\9d. }
+\addlyrics { He said: Ã¢â\82¬Å\93Let my peo ple goââ\82¬Â\9d. }
 @end lilypond
 
 To use normal quotes in lyrics, add a backslash before the
@@ -227,7 +219,7 @@ any 8-bit character with ASCII code over 127, or a two-character
 combination of a backslash followed by one of @code{`}, @code{'},
 @code{"}, or @code{^}.
 
-To define identifiers containing lyrics, the function @code{lyricmode}
+To define variables containing lyrics, the function @code{lyricmode}
 must be used.
 
 @example
@@ -247,12 +239,11 @@ verseOne = \lyricmode @{ Joy to the world the Lord is come @}
 
 @seealso
 
-Program reference: @internalsref{LyricText}, @internalsref{LyricSpace}.
-
+Internals Reference: @internalsref{LyricText}, @internalsref{LyricSpace}.
 
 
 @node Aligning lyrics to a melody
-@unnumberedsubsubsec Aligning lyrics to a melody
+@subsection Aligning lyrics to a melody
 
 @funindex \lyricmode
 @funindex \addlyrics
@@ -269,7 +260,7 @@ Lyrics are printed by interpreting them in the context called
 There are two main methods to specify the horizontal placement
 of the syllables:
 
-@itemize @bullet
+@itemize
 @item
 by automatically aligning
 the lyrics to a melody or other voice of music, using @code{\addlyrics}
@@ -289,7 +280,7 @@ explicitly, using @code{\lyricmode}
 @end menu
 
 @node Automatic syllable durations
-@unnumberedsubsubsec Automatic syllable durations
+@subsubsection Automatic syllable durations
 
 @cindex automatic syllable durations
 @cindex lyrics and melodies
@@ -345,12 +336,12 @@ is the same as
 @end example
 
 @node Another way of entering lyrics
-@unnumberedsubsubsec Another way of entering lyrics
+@subsubsection Another way of entering lyrics
 
 Lyrics can also be entered without @code{\addlyrics} or
 @code{\lyricsto}.  In this case,
 syllables are entered like notes -- but with pitches replaced by text -- and the
-duration of each syllable must be entered explicitly. For example:
+duration of each syllable must be entered explicitly.  For example:
  
 @example
 play2 the4 game2.
@@ -384,11 +375,11 @@ Here is an example demonstrating manual lyric durations,
 
 @seealso
  
-Program reference: @internalsref{Lyrics}.
+Internals Reference: @internalsref{Lyrics}.
 
 
 @node Assigning more than one syllable to a single note
-@unnumberedsubsubsec Assigning more than one syllable to a single note
+@subsubsection Assigning more than one syllable to a single note
 
 
 @funindex _
@@ -412,14 +403,14 @@ glyph.}.
 
 @seealso
 
-Program reference: @internalsref{LyricCombineMusic}.
+Internals Reference: @internalsref{LyricCombineMusic}.
 
 @c Here come the section which used to be "Melismata"
 @c the new title might be more self-explanatory
 
 
 @node More than one note on a single syllable
-@unnumberedsubsubsec More than one note on a single syllable
+@subsubsection More than one note on a single syllable
 
 @cindex melisma
 @cindex melismata
@@ -482,7 +473,7 @@ A complete example of a SATB score setup is in section
 @rlearning{Vocal ensembles}.
 
 
-@refcommands
+@predefined
 
 @code{\melisma}, @code{\melismaEnd}
 @funindex \melismaEnd
@@ -490,21 +481,22 @@ A complete example of a SATB score setup is in section
 
 @seealso
 
-Program reference: @internalsref{Melisma_translator}.
+Internals Reference: @internalsref{Melisma_translator}.
 
-@lsr{vocal,lyric@/-combine.ly}.
+@c @lsr{vocal,lyric@/-combine.ly}.
 
-@refbugs
+@knownissues
 
 Melismata are not detected automatically, and extender lines must be
 inserted by hand.
 
 @node Extenders and hyphens
-@unnumberedsubsubsec Extenders and hyphens
+@subsubsection Extenders and hyphens
 
 @cindex melisma
 @cindex extender
 
+@c leave this as samp. -gp
 Melismata are indicated with a horizontal line centered between a syllable
 and the next one.  Such a line is called an extender line, and it is entered
 as @samp{ __ } (note the spaces before and after the two underscore
@@ -512,30 +504,39 @@ characters).
 
 @cindex hyphens
 
+@c leave this as samp. -gp
 Centered hyphens are entered as @samp{ -- } between syllables of a same word
 (note the spaces before and after the two hyphen characters).  The hyphen
 will be centered between the syllables, and its length will be adjusted
 depending on the space between the syllables.
 
-In tighly engraved music, hyphens can be removed.  Whether this
+In tightly engraved music, hyphens can be removed.  Whether this
 happens can be controlled with the @code{minimum-distance} (minimum
 distance between two syllables) and the @code{minimum-length}
 (threshold below which hyphens are removed).
 
 @seealso
 
-Program reference: @internalsref{LyricExtender},
+Internals Reference: @internalsref{LyricExtender},
 @internalsref{LyricHyphen}
 
 
-@node Working with lyrics and identifiers
-@unnumberedsubsubsec Working with lyrics and identifiers
-@cindex lyrics, identifiers
+@node Vocals and variables
+@subsection Vocals and variables
 
-To define identifiers containing lyrics, the function @code{\lyricmode}
-must be used. You do not have to enter durations though, if you add
+@menu
+* Working with lyrics and variables::  
+@end menu
+
+@node Working with lyrics and variables
+@subsubsection Working with lyrics and variables
+
+@cindex lyrics, variables
+
+To define variables containing lyrics, the function @code{\lyricmode}
+must be used.  You do not have to enter durations though, if you add
 @code{\addlyrics} or @code{\lyricsto}
-when invoking your identifier.
+when invoking your variable.
  
 @example
 verseOne = \lyricmode @{ Joy to the world the Lord is come @}
@@ -584,12 +585,12 @@ The final input would resemble
 @seealso
  
 @c TODO: document \new Staff << Voice \lyricsto >> bug
-Program reference: @internalsref{LyricCombineMusic},
+Internals Reference: @internalsref{LyricCombineMusic},
 @internalsref{Lyrics}.  
 
 
 @node Flexibility in placement
-@unnumberedsubsubsec Flexibility in placement
+@subsection Flexibility in placement
 
 Often, different stanzas of one song are put to one melody in slightly
 differing ways.  Such variations can still be captured with
@@ -604,7 +605,7 @@ differing ways.  Such variations can still be captured with
 
 
 @node Lyrics to multiple notes of a melisma
-@unnumberedsubsubsec Lyrics to multiple notes of a melisma
+@subsubsection Lyrics to multiple notes of a melisma
 
 One possibility is that the text has a melisma in one stanza, but
 multiple syllables in another one.  One solution is to make the faster
@@ -615,7 +616,7 @@ There is one tricky aspect: the setting for @code{ignoreMelismata}
 must be set one syllable @emph{before} the non-melismatic syllable
 in the text, as shown here,
 
-@c  FIXME: breaks compile
+@c  TODO: breaks compile
 @lilypond[verbatim,ragged-right,quote]
 %{
 <<
@@ -658,7 +659,7 @@ For example,
 
 
 @node Divisi lyrics
-@unnumberedsubsubsec Divisi lyrics
+@subsubsection Divisi lyrics
 
 You can display alternate (or divisi) lyrics by naming voice
 contexts and attaching lyrics to those specific contexts.
@@ -704,7 +705,7 @@ section.
 
 
 @node Switching the melody associated with a lyrics line
-@unnumberedsubsubsec Switching the melody associated with a lyrics line
+@subsubsection Switching the melody associated with a lyrics line
 
 More complex variations in text underlay are possible.  It is possible
 to switch the melody for a line of lyrics during the text.  This is
@@ -787,7 +788,7 @@ The underlay is switched back to the starting situation by assigning
 
 
 @node Lyrics independent of notes
-@unnumberedsubsubsec Lyrics independent of notes
+@subsubsection Lyrics independent of notes
 
 In some complex vocal music, it may be desirable to place
 lyrics completely independently of notes.  Music defined
@@ -815,8 +816,15 @@ lyr = \lyricmode { I like my cat! }
 @end lilypond
 
 
+@node Spacing vocals
+@subsection Spacing vocals
+
+@menu
+* Spacing lyrics::              
+@end menu
+
 @node Spacing lyrics
-@unnumberedsubsubsec Spacing lyrics
+@subsubsection Spacing lyrics
 
 @cindex Spacing lyrics
 @cindex Lyrics, increasing space between
@@ -860,10 +868,21 @@ layout.
 
 
 @node More about stanzas
-@unnumberedsubsubsec More about stanzas
+@subsection More about stanzas
+
+@menu
+* Adding stanza numbers ::      
+* Adding dynamics marks::       
+* Adding singer names::         
+* Printing stanzas at the end ::  
+* Printing stanzas at the end in multiple columns ::  
+@end menu
+
+
+@node Adding stanza numbers 
+@subsubsection Adding stanza numbers 
 
 @cindex stanza number
-@unnumberedsubsubsec Adding stanza numbers 
 
 Stanza numbers can be added by setting @code{stanza}, e.g.,
 
@@ -875,7 +894,7 @@ Stanza numbers can be added by setting @code{stanza}, e.g.,
   Hi, my name is Bert.
 } \addlyrics {
   \set stanza = "2. "
-  Oh, ché -- ri, je t'aime
+  Oh, chÃ\83© -- ri, je t'aime
 }
 @end lilypond
 
@@ -883,10 +902,11 @@ Stanza numbers can be added by setting @code{stanza}, e.g.,
 These numbers are put just before the start of the first syllable.
 
 
-@unnumberedsubsubsec Adding dynamics marks
+@node Adding dynamics marks
+@subsubsection Adding dynamics marks
 
 Stanzas differing in loudness may be indicated by putting a
-dynamics mark before each stanza.  In Lilypond, everthing coming in
+dynamics mark before each stanza.  In Lilypond, everything coming in
 front of a stanza goes into the @code{StanzaNumber} object; dynamics marks
 are no different.  For technical reasons, you have to set the stanza
 outside @code{\lyricmode}:
@@ -908,9 +928,11 @@ text = {
 >>
 @end lilypond
 
+@node Adding singer names
+@subsubsection Adding singer names
+
 @cindex singer name
 @cindex name of singer
-@unnumberedsubsubsec Adding singer names
 
 Names of singers can also be added.  They are printed at the start of
 the line, just like instrument names.  They are created by setting
@@ -929,7 +951,8 @@ the line, just like instrument names.  They are created by setting
 @end lilypond
 
 
-@unnumberedsubsubsec Printing stanzas at the end 
+@node Printing stanzas at the end 
+@subsubsection Printing stanzas at the end 
 
 Sometimes it is appropriate to have one stanza set
 to the music, and the rest added in verse form at
@@ -973,11 +996,12 @@ its fleece was white as snow.
 @end lilypond
 
 
-@unnumberedsubsubsec Printing stanzas at the end in multiple columns 
+@node Printing stanzas at the end in multiple columns 
+@subsubsection Printing stanzas at the end in multiple columns 
 
 When a piece of music has many verses, they are often printed in
-multiple columns across the page. An outdented verse number often
-introduces each verse. The following example shows how to produce such
+multiple columns across the page.  An outdented verse number often
+introduces each verse.  The following example shows how to produce such
 output in Lilypond.
 
 @lilypond[ragged-right,quote,verbatim]
@@ -1043,15 +1067,14 @@ text = \lyricmode {
 
 @seealso
 
-Program reference: @internalsref{LyricText}, @internalsref{StanzaNumber},
+Internals Reference: @internalsref{LyricText}, @internalsref{StanzaNumber},
 @internalsref{VocalName}.
 
-
-
-@node Other vocal issues
-@unnumberedsubsubsec Other vocal issues
-
+@c TODO: stick elsewhere
 @ignore
+@n ode Other vocal issues
+@s ubsection Other vocal issues
+
 yeah, I'm giving up somewhat by stuffing a bunch of things in
 here.  But at least they're in the manual now; it's easier to
 move them around in the manual once they're already here.
@@ -1059,11 +1082,12 @@ move them around in the manual once they're already here.
 Besides, if users complain about everything stuffed in here, I
 can ask them for specific instructions about where to move these
 examples, and that might get them more involved in the docs.  -gp
-@end ignore
+
 
 @q{Parlato} is spoken without pitch but still with rhythm; it is
-notated by cross noteheads.  This is demonstrated in
-@ref{Special noteheads}.
+notated by cross note heads.  This is demonstrated in
+@ref{Special note heads}.
+@end ignore