]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/repeats.itely
GDP: NR 3.1 and 3.2.1 first pass
[lilypond.git] / Documentation / user / repeats.itely
index 31f1e87fcc98d262ac32dd8db06e72a839236213..f862ec53097afb3e27dc7404945afb6ee6e3476b 100644 (file)
@@ -6,6 +6,8 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
+@c \version "2.11.38"
+
 @node Repeats
 @section Repeats
 
 {repeats-headword.ly}
 
 Repetition is a central concept in music, and multiple notations
-exist for repetitions.
+exist for repetitions. LilyPond supports the following kinds of repeats:
+
+
+@table @code
+@item volta
+The repeated music is not written out but enclosed between repeat bar
+lines.  If the repeat is at the beginning of a piece, a repeat bar
+line is only printed at the end. Alternative endings (volte) are
+printed left to right with brackets.  This is the standard notation
+for repeats with alternatives.
+
+@item unfold
+The repeated music is fully written out, as many times as
+specified by @var{repeatcount}.  This is useful when
+entering repetitious music. 
+
+@item percent
+These are beat or measure repeats.  They look like single slashes or
+percent signs.
+
+@item tremolo
+This is used to write tremolo beams.
+
+@end table
+
 
 @menu
-* Writing repeats::             
-* Other repeats::               
+* Long repeats::                
+* Short repeats::               
 @end menu
 
-@node Writing repeats
-@subsection Writing repeats
+@node Long repeats
+@subsection Long repeats
 
-Blah blah
+This section discusses how to input long (usually multi-measure)
+repeats.  The repeats can take two forms: repeats enclosed between
+repeat signs; or written out repeats, used to input repetitious music.
+Repeat signs can also be controlled manually.
 
 @menu
 * Normal repeats::              
-* Repeat syntax::               
-* Manual repeat commands::      
+* Manual repeat marks::         
+* Written-out repeats::  
 @end menu
 
-@node Normal repeats
-@unnumberedsubsubsec Normal repeats
-
 @cindex volta
 @cindex prima volta
 @cindex seconda volta
+@cindex volta, prima
+@cindex volta, seconda
 @funindex \repeat
 
-Normal repeats, with or without alternate repeats, may be printed:
+@node Normal repeats
+@subsubsection Normal repeats
+
+The syntax for a normal repeat is
+
+@example
+\repeat volta @var{repeatcount} @var{musicexpr}
+@end example
+
+where @var{musicexpr} is a music expression.  Alternate endings can
+be produced using @code{\alternative}.
+
+Normal repeats without alternate endings:
 
 @lilypond[quote,ragged-right,fragment,verbatim,relative=2]
 \repeat volta 2 { c4 d e f }
-\repeat volta 2 { g f e d }
+c2 d
+\repeat volta 2 { d4 e f g }
+@end lilypond
+
+Normal repeats with alternate endings:
+
+@lilypond[quote,ragged-right,fragment,verbatim,relative=2]
+\repeat volta 2 { g4 f e d }
   \alternative {
     { cis2 g' }
     { cis,2 b }
@@ -51,13 +98,18 @@ Normal repeats, with or without alternate repeats, may be printed:
 c1
 @end lilypond
 
-Repeats with upbeats may be created.
+
+Repeats with upbeats can be entered in two ways:
 
 @lilypond[quote,ragged-right,fragment,verbatim,relative=2]
 \new Staff {
-  \partial 4 e |
-  \repeat volta 4 { c2 d2 | e2 f2 | }
-  \alternative { { g4 g g e } { a a a a | b2. } }
+  \partial 4
+  e |
+  \repeat volta 4 { c2 d | e2 f | }
+  \alternative {
+    { g4 g g e }
+    { a4 a a a | b2. }
+  }
 }
 @end lilypond
 
@@ -67,66 +119,63 @@ or
 @lilypond[quote,ragged-right,fragment,verbatim,relative=2]
 \new Staff {
   \partial 4 
-  \repeat volta 4 { e | c2 d2 | e2 f2 | }
-  \alternative { { \partial 4*3 g4 g g } { a a a a | b2. } }
+  \repeat volta 4 { e4 | c2 d | e2 f | }
+  \alternative {
+    { \partial 4*3 g4 g g }
+    { a4 a a a | b2. }
+  }
 }
 @end lilypond
 
 
 @funindex \repeatTie
 
-Ties may be added to a second ending,
+Ties may be added to a second ending:
 
 @lilypond[quote,ragged-right,fragment,verbatim,relative=2]
 c1
 \repeat volta 2 {c4 d e f ~ }
-\alternative { {f2 d} {f\repeatTie f,} }
-@end lilypond
-
-It is possible to shorten volta brackets by setting
-@code{voltaSpannerDuration}.  In the next example, the bracket
-only lasts one measure, which is a duration of 3/4.
-
-@lilypond[verbatim,ragged-right,quote]
-\relative c''{
-  \time 3/4
-  c c c
-  \set Score.voltaSpannerDuration = #(ly:make-moment 3 4)
-  \repeat volta 5 { d d d }
-  \alternative { { e e e f f f }
-  { g g g } }
+\alternative {
+  {f2 d}
+  {f2\repeatTie f,}
 }
 @end lilypond
 
-If you want to start a repeat at the beginning of a line and have
-a double bar at the end of the previous line, use
+@snippets
 
-@example
-@dots{} \bar "||:" \break 
-\repeat volta 2 @{ @dots{} 
-@end example
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
+{shortening-volta-brackets.ly}
 
-see @ref{Bar lines} for more information.
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
+{adding-volta-brackets-to-additional-staves.ly}
 
-@seealso
 
-Snippets: @lsrdir{repeats}
+@c Is there a way to have a final bar ("|.") at the end of the
+@c previous line? Doesn't seem to be.
+If you want to start a repeat at the beginning of a line and have a
+double bar at the end of the previous line, use @code{\bar}. For more
+information, see @ref{Bar lines}.
 
-Internals Reference: @internalsref{VoltaBracket},
-@internalsref{RepeatedMusic},
-@internalsref{VoltaRepeatedMusic}, and
-@internalsref{UnfoldedRepeatedMusic}.
+@lilypond[quote,ragged-right,fragment,verbatim,relative=2]
+c4 c c c
+\bar "||:" \break 
+\repeat volta 2 { c4 d e f }   
+@end lilypond
 
-Examples:
 
-Brackets for the repeat are normally only printed over the topmost
-staff.  This can be adjusted by moving @code{Volta_engraver} to
-the Staff context where you want the brackets to appear; see
-@ref{Modifying context plug-ins} and
-@lsr{repeats,volta@/-multi@/-staff@/.ly}.
+@seealso
 
+Music Glossary: @rglos{repeat}, @rglos{volta}.
 
-@refbugs
+Notation Reference: @ref{Bar lines}, @ref{Modifying context plug-ins}.
+
+Snippets: @rlsr{Repeats}.
+
+Internals Reference: @rinternals{VoltaBracket},
+@rinternals{RepeatedMusic}, @rinternals{VoltaRepeatedMusic},
+@rinternals{UnfoldedRepeatedMusic}.
+
+@knownissues
 
 @cindex repeat, ambiguous
 
@@ -144,74 +193,23 @@ is ambiguous, since it is is not clear to which @code{\repeat} the
 having the @code{\alternative} belong to the inner @code{\repeat}.
 For clarity, it is advisable to use braces in such situations.
 
-Timing information is not remembered at the start of an
-alternative, so after a repeat timing information must be reset by
-hand; for example, by setting @code{Score.measurePosition} or
-entering @code{\partial}.  Similarly, slurs or ties are also not
-repeated.
-
-
-
-@node Repeat syntax
-@unnumberedsubsubsec Repeat syntax
-
-@cindex repeats
-
-LilyPond has one syntactic construct for specifying different
-types of repeats.  The syntax is
-
-@example
-\repeat @var{variant} @var{repeatcount} @var{repeatbody}
-@end example
-
-If you have alternative endings, you may add
-@funindex \alternative
-@example
-\alternative @{
-  @var{alternative1}
-  @var{alternative2}
-  @var{alternative3}
-  @dots{}
-@}
-@end example
-
-@noindent
-where each @var{alternative} is a music expression.  If you do not
-give enough alternatives for all of the repeats, the first
-alternative is assumed to be played more than once.
+Timing information is not remembered at the start of an alternative,
+so after a repeat timing information must be reset by hand; for
+example, by setting @code{Score.measurePosition} or entering
+@code{\partial}.  Similarly, slurs are also not repeated.
 
-The following types of repetition are supported
 
-@table @code
-@item unfold
-Repeated music is fully written (played) out.  This is useful when
-entering repetitious music.  This is the only kind of repeat that
-is included in MIDI output.
-
-@item volta
-Repeats are not written out, but alternative endings (volte) are
-printed, left to right with brackets.  This is the standard
-notation for repeats with alternatives.  These are not played in
-MIDI output by default.
 
-
-@item tremolo
-Make tremolo beams.  These are not played in MIDI output by
-default.
-
-@item percent
-Make beat or measure repeats.  These look like percent signs.
-These are not played in MIDI output by default.  Percent repeats
-must be declared within a @code{Voice} context.
-
-@end table
-
-
-@node Manual repeat commands
-@unnumberedsubsubsec Manual repeat commands
+@node Manual repeat marks
+@subsubsection Manual repeat marks
 
 @funindex repeatCommands
 
+@c FIXME: Markup does not work in the "text" field
+@c And how does one change the font?
+@c On the whole, this section needs better documentation (why the
+@c double parentheses around the volta expressions?)
+
 The property @code{repeatCommands} can be used to control the
 layout of repeats.  Its value is a Scheme list of repeat commands.
 
@@ -223,10 +221,11 @@ Print a @code{|:} bar line.
 Print a @code{:|} bar line.
 
 @item @code{(volta @var{text})}
-Print a volta bracket saying @var{text}: The text can be specified
-as a text string or as a markup text, see @ref{Text markup}.  Do
-not forget to change the font, as the default number font does not
-contain alphabetic characters;
+Print a volta bracket saying @var{text}.  The text can be specified as
+a text string or as a markup text, see @ref{Formatting text}.  Do not
+forget to change the font, as the default number font does not contain
+alphabetic characters;
+
 
 @item @code{(volta #f)}
 Stop a running volta bracket.
@@ -234,154 +233,212 @@ Stop a running volta bracket.
 
 @lilypond[quote,ragged-right,verbatim,fragment,relative=2]
 c4
-  \set Score.repeatCommands = #'((volta "93") end-repeat)
-c4 c4
-  \set Score.repeatCommands = #'((volta #f))
-c4 c4
+\set Score.repeatCommands = #'((volta "93") end-repeat)
+c4 b
+\set Score.repeatCommands = #'((volta #f))
+d4 e
 @end lilypond
 
+@c FIXME: improve visibility of bar lines link?
 
 @seealso
 
-Snippets: @lsrdir{repeats}
+Notation Reference: @ref{Bar lines}, @ref{Formatting text}.
 
-Internals Reference: @internalsref{VoltaBracket},
-@internalsref{RepeatedMusic}, @internalsref{VoltaRepeatedMusic},
-and @internalsref{UnfoldedRepeatedMusic}.
+Snippets: @rlsr{Repeats}.
 
+Internals Reference: @rinternals{VoltaBracket},
+@rinternals{RepeatedMusic}, @rinternals{VoltaRepeatedMusic}.
 
-@node Other repeats
-@subsection Other repeats
 
-@menu
-* Tremolo repeats::             
-* Tremolo subdivisions::        
-* Measure repeats::             
-@end menu
+@node Written-out repeats
+@subsubsection Written-out repeats
 
-@node Tremolo repeats
-@unnumberedsubsubsec Tremolo repeats
+@cindex written-out repeats
+@cindex repetitious music
+@cindex repeats, written-out
 
-@cindex tremolo beams
+By using the @code{unfold} command, repeats can be used to simplify
+the writing out of repetitious music.  The syntax is
 
-To place tremolo marks between notes, use @code{\repeat} with
-tremolo style
+@example
+\repeat unfold @var{repeatcount} @var{musicexpr}
+@end example
 
-@lilypond[quote,verbatim,ragged-right]
-\new Voice \relative c' {
-  \repeat tremolo 8 { c16 d16 }
-  \repeat tremolo 4 { c16 d16 }
-  \repeat tremolo 2 { c16 d16 }
-}
+where @var{musicexpr} is a music expression.  Unfold repeats can be
+made with or without alternate endings.  Unfold repeats without
+alternate endings:
+
+@lilypond[quote,ragged-right,verbatim,fragment,relative=2]
+c1
+\repeat unfold 2 { c4 d e f }
+c1
 @end lilypond
 
-Tremolo marks can also be put on a single note.  In this case, the
-note should not be surrounded by braces.
+Unfold repeats with alternate endings:
 
-@lilypond[quote,verbatim,ragged-right]
-\repeat tremolo 4 c'16
+@lilypond[quote,ragged-right,verbatim,fragment,relative=2]
+c1
+\repeat unfold 2 { g4 f e d }
+  \alternative {
+    { cis2 g' }
+    { cis,2 b }
+  }
+c1
 @end lilypond
 
-Similar output is obtained using the tremolo subdivision,
-described in @ref{Tremolo subdivisions}.
+@seealso
+
+Snippets: @rlsr{Repeats}.
 
+Internals Reference: @rinternals{RepeatedMusic},
+@rinternals{UnfoldedRepeatedMusic}.
 
-@seealso
+@node Short repeats
+@subsection Short repeats
 
-Notation Reference: @ref{Tremolo subdivisions}, @ref{Repeats}.
+This section discusses how to input short repeats.  Short repeats can
+take two basic forms: repeats of a single note to two measures,
+represented by slashes or percent signs; and tremolos.
 
-Snippets: @lsrdir{repeats}
+@menu
+* Percent repeats::             
+* Tremolo repeats::             
+@end menu
 
-Internals Reference: @internalsref{Beam},
-@internalsref{StemTremolo}.
+@node Percent repeats
+@subsubsection Percent repeats
 
+@cindex percent repeats
+@cindex measure repeats
 
-@node Tremolo subdivisions
-@unnumberedsubsubsec Tremolo subdivisions
+Repeated short patterns of notes are supported.  The music is printed
+once, and the pattern is replaced with a special sign.  Patterns that
+are shorter than one measure are replaced by slashes, and patterns of
+one or two measures are replaced by percent-like signs.  The syntax is
 
-@cindex tremolo marks
-@funindex tremoloFlags
+@example
+@code{\repeat percent @var{number} @var{musicexpr}}
+@end example
 
-Tremolo marks can be printed on a single note by adding
-@q{@code{:}[@var{number}]} after the note.  The number indicates
-the duration of the subdivision, and it must be at least 8.  A
-@var{length} value of 8 gives one line across the note stem.  If
-the length is omitted, the last value (stored in
-@code{tremoloFlags}) is used
+where @var{musicexpr} is a music expression. 
 
-@lilypond[quote,ragged-right,verbatim,fragment]
-c'2:8 c':32 | c': c': |
+@lilypond[quote,verbatim,ragged-right]
+\relative c' {
+  \repeat percent 4 { c4 }
+  \repeat percent 2 { b'4 a g f }
+  \repeat percent 2 { c2 es | f4 fis g c | }
+}
 @end lilypond
 
+Measure repeats of more than two repeats get a counter if you switch
+on the @code{countPercentRepeats} property:
 
-@refbugs
+@lilypond[relative=2,fragment,quote,verbatim,ragged-right]
+\relative c' {
+  \set countPercentRepeats = ##t
+  \repeat percent 4 { c1 }
+}
+@end lilypond
 
-Tremolos entered in this way do not carry over into the MIDI
-output.
 
+Isolated percents can also be printed.  This is done by entering a
+multi-measure rest with a different print function:
 
-@seealso
+@lilypond[fragment,verbatim,quote]
+\override MultiMeasureRest #'stencil
+  = #ly:multi-measure-rest::percent
+R1
+@end lilypond
 
-Notation Reference: @ref{Tremolo repeats}.
 
-Snippets: @lsrdir{repeats}
+@knownissues
 
-Elsewhere: @internalsref{StemTremolo}.
+Only three kinds of percent repeats are supported: a single slash
+representing a single beat (regardless of the duration of the repeated
+notes); a single slash with dots representing one full measure; and
+two slashes with dots crossing a bar line representing two full
+measures.  Neither multiple slashes representing single beat repeats
+consisting of sixteenth or shorter notes, nor two slashes with dots
+representing single beat repeats consisting of notes of varying
+durations, are supported.
 
 
-@node Measure repeats
-@unnumberedsubsubsec Measure repeats
+@seealso
 
-@cindex percent repeats
-@cindex measure repeats
+Music Glossary: @rglos{percent repeat}, @rglos{simile}.
 
-In the @code{percent} style, a note pattern can be repeated.  It
-is printed once, and then the pattern is replaced with a special
-sign.  Patterns of one and two measures are replaced by
-percent-like signs, patterns that divide the measure length are
-replaced by slashes.  Percent repeats must be declared within a
-@code{Voice} context.
+Snippets: @rlsr{Repeats}.
 
-@lilypond[quote,verbatim,ragged-right]
-\new Voice \relative c' {
-  \repeat percent 4 { c4 }
-  \repeat percent 2 { c2 es2 f4 fis4 g4 c4 }
-}
-@end lilypond
+Internals Reference: @rinternals{RepeatSlash},
+@rinternals{PercentRepeat}, @rinternals{DoublePercentRepeat},
+@rinternals{DoublePercentRepeatCounter},
+@rinternals{PercentRepeatCounter}, @rinternals{PercentRepeatedMusic}.
 
-Measure repeats of more than 2 measures get a counter, if you
-switch on the @code{countPercentRepeats} property,
+@node Tremolo repeats
+@subsubsection Tremolo repeats
 
-@lilypond[relative=2,fragment,quote,verbatim,ragged-right]
-\new Voice {
-\set countPercentRepeats = ##t
-  \repeat percent 4 { c1 }
+Tremolos can take two forms: alternation between two chords or two
+notes, and rapid repetition of a single
+note or chord. Tremolos consisting of an alternation are indicated by
+adding beams between the notes or chords being alternated, while
+tremolos consisting of the rapid repetition of a single note are
+indicated by adding beams or slashes to a single note.
+
+@cindex tremolo beams
+
+To place tremolo marks between notes, use @code{\repeat} with
+tremolo style:
+
+@lilypond[quote,verbatim,ragged-right]
+\relative c' {
+  \repeat tremolo 8 { c16 d }
+  \repeat tremolo 4 { c16 d }
+  \repeat tremolo 2 { c16 d }
 }
 @end lilypond
 
+The @code{\repeat tremolo} syntax expects exactly two notes within
+the braces, and the number of repetitions must correspond to a
+note value that can be expressed with plain or dotted notes.  Thus,
+@code{\repeat tremolo 7} is valid and produces a double dotted
+note, but @code{\repeat tremolo 9} is not.
 
+The duration of the tremolo equals the duration of the
+braced expression multiplied by the number of repeats:
+@code{\repeat tremolo 8 @{ c16 d16 @}} gives a whole note tremolo,
+notated as two whole notes joined by tremolo beams. 
 
-Isolated percents can also be printed.  This is done by putting a
-multi-measure rest with a different print function,
+There are two ways to put tremolo marks on a single note.  The
+@code{\repeat tremolo} syntax is also used here, in which case
+the note should not be surrounded by braces:
 
-@lilypond[fragment,verbatim,quote]
-\override MultiMeasureRest #'stencil
-  = #ly:multi-measure-rest::percent
-R1
+@lilypond[quote,verbatim,ragged-right]
+\repeat tremolo 4 c'16
 @end lilypond
 
+@cindex tremolo marks
+@funindex tremoloFlags
 
+The same output can be obtained by adding
+@q{@code{:}[@var{number}]} after the note.  The number indicates
+the duration of the subdivision, and it must be at least 8.  A
+@var{number} value of 8 gives one line across the note stem.  If
+the length is omitted, the last value (stored in
+@code{tremoloFlags}) is used
 
+@lilypond[quote,ragged-right,verbatim,fragment]
+c'2:8 c':32 | c': c': |
+@end lilypond
 
-@seealso
 
-Snippets: @lsrdir{repeats}
+@knownissues
 
-Internals Reference: @internalsref{RepeatSlash},
-@internalsref{PercentRepeat}, @internalsref{DoublePercentRepeat},
-@internalsref{DoublePercentRepeatCounter},
-@internalsref{PercentRepeatCounter},
-@internalsref{PercentRepeatedMusic}.
 
+Tremolos entered with @q{@code{:}[@var{number}]} do not carry over
+into the MIDI output.
 
 
+@seealso
+
+@c Notation Reference: @re