Add some comments to Beam::get_beam_segments.

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

diff --git a/Documentation/user/vocal.itely b/Documentation/user/vocal.itely
index 90ab71fb813bb4ad95fab99f1728a72251dfa117..7f68e263fe211d016cd88f0b3c5569b780a9a3ae 100644 (file)
--- a/Documentation/user/vocal.itely
+++ b/Documentation/user/vocal.itely
@@ -93,10 +93,12 @@ TBC
 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {simple-lead-sheet.ly}
 
+
 @seealso
 Notation Reference:
 @ref{Chord notation}.
 
+
 @node Spoken music
 @unnumberedsubsubsec Spoken music
 @cindex parlato
@@ -126,6 +128,7 @@ TBC
 @c Add "Printing both the ancient and the modern clef in vocal music" snippet,
 @c and "Transcription of Ancient music with incipit" snippet. -vv
 
+
 @seealso
 Notation Reference:
 @ref{Ancient notation}.
@@ -289,7 +292,6 @@ verseOne = \lyricmode @{ Joy to the world the Lord is come @}
 
 
 @seealso
-
 Notation Reference:
 @ref{Fonts}.
 
@@ -297,6 +299,7 @@ Internals Reference:
 @rinternals{LyricText},
 @rinternals{LyricSpace}.
 
+
 @c FIXME: this title has to be changed (possible confusion with LM) -vv
 @node Setting simple songs
 @unnumberedsubsubsec Setting simple songs
@@ -422,8 +425,8 @@ remains empty.
 
 @end ignore
 
-@seealso
 
+@seealso
 @c TODO: document \new Staff << Voice \lyricsto >> bug
 Internals Reference:
 @rinternals{LyricCombineMusic},
@@ -575,8 +578,8 @@ Here is an example demonstrating manual lyric durations,
  } >>
 @end lilypond
 
-@seealso
 
+@seealso
 Internals Reference:
 @rinternals{Lyrics}.
 
@@ -604,8 +607,8 @@ glyph.}.
 \addlyrics { pu- ro~y~ho- nes- to }
 @end lilypond
 
-@seealso
 
+@seealso
 Internals Reference:
 @rinternals{LyricCombineMusic}.
 
@@ -689,15 +692,17 @@ A complete example of a SATB score setup is in section
 
 
 @predefined
-
-@code{\melisma}, @code{\melismaEnd}
-@funindex \melismaEnd
 @funindex \melisma
+@code{\melisma},
+@funindex \melismaEnd
+@code{\melismaEnd}.
+@endpredefined
 
-@seealso
 
+@seealso
 @c @lsr{vocal,lyric@/-combine.ly}.
 
+
 @knownissues
 
 Melismata are not detected automatically, and extender lines must be
@@ -755,12 +760,13 @@ 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
 
+@seealso
 Internals Reference:
 @rinternals{LyricExtender},
 @rinternals{LyricHyphen}
 
+
 @node Lyrics and repeats
 @unnumberedsubsubsec Lyrics and repeats
 
@@ -1090,12 +1096,6 @@ multiple syllables in another one.  One solution is to make the faster
 voice ignore the melisma.  This is done by setting
 @code{ignoreMelismata} in the Lyrics context.
 
-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  TODO: breaks compile
-@c seems to be fixed, does not break compile anymore --FV
 @lilypond[verbatim,ragged-right,quote]
 <<
   \relative c' \new Voice = "lahlah" {
@@ -1109,18 +1109,20 @@ in the text, as shown here,
     more slow -- ly
   }
   \new Lyrics \lyricsto "lahlah" {
-    \set ignoreMelismata = ##t % applies to "fas"
-    go fas -- ter
+    go
+    \set ignoreMelismata = ##t
+    fas -- ter
     \unset ignoreMelismata
     still
   }
 >>
 @end lilypond
 
-
-The @code{ignoreMelismata} applies to the syllable @q{fas}, so it
-should be entered before @q{go}.
-
+@knownissues
+Unlike most @code{\set} commands, @code{\set ignoreMelismata} does
+not work if prefixed with @code{\once}.  It is necessary to use
+@code{\set} and @code{\unset} to bracket the lyrics where melismata
+are to be ignored.
 
 @subsubheading Switching to an alternative melody
 
@@ -1322,7 +1324,6 @@ text = \lyricmode {
 
 
 @seealso
-
 Internals Reference:
 @rinternals{LyricText},
 @rinternals{StanzaNumber}.