Add doctitle fragment option in docs, including policy update

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

diff --git a/Documentation/user/rhythms.itely b/Documentation/user/rhythms.itely
index 4b82d8bbdb2804f4c9992fe38d7e10a25f9a2bb8..b6a4dd4d9f09511afd634ca052ae06909ea263f3 100644 (file)
--- a/Documentation/user/rhythms.itely
+++ b/Documentation/user/rhythms.itely
@@ -8,6 +8,33 @@
 
 @c \version "2.11.38"
 
+@ignore
+GDP TODO list
+
+\compressMusic -> \scaleDurations.
+approved by Han-Wen; just needs somebody to kick up a fuss about
+it.
+
+1.2.3.1 Time signature
+Needs an example of beatLength, which is broken (see my recent
+mail
+to -bug).  What to do?  For now I've left a paragraph of text
+which really
+needs to be inserted with an example in a snippet.
+
+1.2.3.4 Polymetric notation
+Quite extensive changes. Could you please check through.  Divided
+into three
+sections.  Necessarily uses tweaks.  I've also left an @lsr under
+@seealso
+Snippets - is this permitted or is @lsr now verboten?  This
+snippet is too
+long to include, but seems relevant.
+A snippet "grouping beats" hasn't yet appeared (only sent to vv a
+couple of
+days ago).  Text left in Snippets: with TODO.
+@end ignore
+
 @node Rhythms
 @section Rhythms
 
@@ -144,11 +171,11 @@ Notation Reference:
 @ref{Proportional notation}.
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 Internals Reference:
-@internalsref{Dots},
-@internalsref{DotColumn}.
+@rinternals{Dots},
+@rinternals{DotColumn}.
 
 
 @knownissues
@@ -222,15 +249,15 @@ see @ref{Scaling durations}.
 @funindex tupletNumberFormatFunction
 @funindex tupletSpannerDuration
 
-@lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {entering-several-tuplets-using-only-one--times-command.ly}
 
 @funindex TupletNumber
 
-@lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {changing-the-tuplet-number.ly}
 
-@lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {permitting-line-breaks-within-beamed-tuplets.ly}
 
 @seealso
@@ -249,12 +276,12 @@ Notation Reference:
 @ref{Polymetric notation}.
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 Internals Reference:
-@internalsref{TupletBracket},
-@internalsref{TupletNumber},
-@internalsref{TimeScaledMusic}.
+@rinternals{TupletBracket},
+@rinternals{TupletNumber},
+@rinternals{TimeScaledMusic}.
 
 @knownissues
 @cindex grace notes within tuplet brackets
@@ -345,7 +372,7 @@ Notation Reference:
 @ref{Polymetric notation}.
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 
 @node Ties
@@ -460,10 +487,10 @@ commands.
 
 @snippets
 
-@lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {using-ties-with-arpeggios.ly}
 
-@lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {engraving-ties-manually.ly}
 
 
@@ -476,13 +503,13 @@ Music Glossary:
 Notation Reference: @ref{Automatic note splitting}.
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 Internals Reference:
-@internalsref{LaissezVibrerTie},
-@internalsref{LaissezVibrerTieColumn},
-@internalsref{TieColumn},
-@internalsref{Tie}.
+@rinternals{LaissezVibrerTie},
+@rinternals{LaissezVibrerTieColumn},
+@rinternals{TieColumn},
+@rinternals{Tie}.
 
 
 @knownissues
@@ -556,7 +583,7 @@ a4\rest d4\rest
 
 @snippets
 
-@lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {rest-styles.ly}
 
 
@@ -565,9 +592,9 @@ a4\rest d4\rest
 Notation Reference: @ref{Full measure rests}
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
-Internals Reference: @internalsref{Rest}
+Internals Reference: @rinternals{Rest}
 
 
 @knownissues
@@ -638,9 +665,9 @@ empty page:
 @seealso
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
-Internals Reference: @internalsref{SkipMusic}
+Internals Reference: @rinternals{SkipMusic}
 
 
 @node Full measure rests
@@ -790,13 +817,13 @@ alongside and to the left of the measure count numeral.
 @cindex rest, church
 @cindex kirchenpausen
 
-@lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {changing-form-of-multi--measure-rests.ly}
 
 @cindex multi-measure rests, positioning
 @cindex positioning multi-measure rests
 
-@lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {positioning-multi--measure-rests.ly}
 
 @seealso
@@ -812,12 +839,12 @@ Notation Reference:
 @ref{Text scripts}.
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 Internals Reference:
-@internalsref{MultiMeasureRest},
-@internalsref{MultiMeasureRestNumber},
-@internalsref{MultiMeasureRestText}.
+@rinternals{MultiMeasureRest},
+@rinternals{MultiMeasureRestNumber},
+@rinternals{MultiMeasureRestText}.
 
 
 @knownissues
@@ -938,8 +965,8 @@ Options to group beats within a bar are available through the
 Scheme function @code{set-time-signature}, which takes three
 arguments: the number of beats, the beat length, and the internal
 grouping of beats in the measure.  If the
-@internalsref{Measure_grouping_engraver} is included, the function
-will also create @internalsref{MeasureGrouping} signs.  Such signs
+@rinternals{Measure_grouping_engraver} is included, the function
+will also create @rinternals{MeasureGrouping} signs.  Such signs
 ease reading rhythmically complex modern music.  In the example,
 the 9/8 measure is subdivided in 2, 2, 2 and 3.  This is passed to
 @code{set-time-signature} as the third argument: @code{'(2 2 2 3)}:
@@ -965,7 +992,7 @@ the 9/8 measure is subdivided in 2, 2, 2 and 3.  This is passed to
 @cindex compound time signatures
 @cindex time signature, compound
 
-@lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
+@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
 {compound-time-signatures.ly}
 
 
@@ -975,15 +1002,15 @@ Music Glossary:
 @rglos{time signature}
 
 Notation Reference:
-@ruser{Ancient time signatures},
-@ruser{Time administration}.
+@ref{Ancient time signatures},
+@ref{Time administration}.
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 Internals Reference:
-@internalsref{TimeSignature},
-@internalsref{Timing_translator}.
+@rinternals{TimeSignature},
+@rinternals{Timing_translator}.
 
 
 @knownissues
@@ -1040,9 +1067,9 @@ Music Glossary: @rglos{anacrusis}
 Notation Reference: @ref{Grace notes}
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
-Internal Reference: @internalsref{Timing_translator}
+Internal Reference: @rinternals{Timing_translator}
 
 @knownissues
 
@@ -1114,7 +1141,7 @@ Music Glossary: @rglos{cadenza}
 Notation Reference: @ref{Controlling visibility of objects}
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 @knownissues
 
@@ -1259,14 +1286,14 @@ Music Glossary:
 Notation Reference: @ref{Scaling durations}
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 @c Is this still permitted?
 @c @lsr{contemporary,compound-time-signature}
 
 Internals Reference:
-@internalsref{TimeSignature},
-@internalsref{Timing-translator},
-@internalsref{Staff}.
+@rinternals{TimeSignature},
+@rinternals{Timing-translator},
+@rinternals{Staff}.
 
 @knownissues
 
@@ -1314,12 +1341,12 @@ Learning Manual:
 @rlearning{Adding and removing engravers}.
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 Internals Reference:
-@internalsref{Note_heads_engraver},
-@internalsref{Completion_heads_engraver},
-@internalsref{Forbid_line_break_engraver}.
+@rinternals{Note_heads_engraver},
+@rinternals{Completion_heads_engraver},
+@rinternals{Forbid_line_break_engraver}.
 
 
 @knownissues
@@ -1472,9 +1499,9 @@ f8 f''8 f8 f''8
 Notation Reference: @ref{Manual beams}, @ref{Setting automatic beam behavior}.
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
-Internals Reference: @internalsref{Beam}.
+Internals Reference: @rinternals{Beam}.
 
 
 @knownissues
@@ -1672,7 +1699,7 @@ automatic beam is still accepting notes, it is not typeset.
 @seealso
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 
 @node Manual beams
@@ -1784,7 +1811,7 @@ music snippets, and when numbers in the fraction are small.
 @seealso
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 
 
@@ -1941,11 +1968,11 @@ Notation Reference: @ref{Line breaking}, @ref{Repeats},
 @c @ref{System start delimiters}.
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
-Internals Reference: @internalsref{BarLine} (created at
-@internalsref{Staff} level), @internalsref{SpanBar} (across
-staves), @internalsref{Timing_translator} (for Timing
+Internals Reference: @rinternals{BarLine} (created at
+@rinternals{Staff} level), @rinternals{SpanBar} (across
+staves), @rinternals{Timing_translator} (for Timing
 properties).
 
 
@@ -2084,16 +2111,16 @@ Bar numbers can be removed entirely by removing the
 @seealso
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
-Internals Reference: @internalsref{BarNumber}.
+Internals Reference: @rinternals{BarNumber}.
 
 
 @knownissues
 
 Bar numbers may collide with the top of the
-@internalsref{StaffGroup} bracket, if there is one.  To solve
-this, the @code{padding} property of @internalsref{BarNumber} can
+@rinternals{StaffGroup} bracket, if there is one.  To solve
+this, the @code{padding} property of @rinternals{BarNumber} can
 be used to position the number correctly.
 
 Bar numbers may only be printed at bar lines; to print a bar
@@ -2182,7 +2209,7 @@ when it is processed.
 @seealso
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 
 @node Rehearsal marks
@@ -2289,11 +2316,11 @@ For common tweaks to the positioning of rehearsal marks, see
 @seealso
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 This manual: @ref{The Feta font}, @ref{Formatting text}.
 
-Internals Reference: @internalsref{RehearsalMark}.
+Internals Reference: @rinternals{RehearsalMark}.
 
 Init files: @file{scm/@/translation@/-functions@/.scm} contains
 the definition of @code{format-mark-numbers} and
@@ -2478,9 +2505,9 @@ Music Glossary:
 @rglos{appoggiatura}
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
-Internals Reference: @internalsref{GraceMusic}.
+Internals Reference: @rinternals{GraceMusic}.
 
 
 @knownissues
@@ -2549,7 +2576,7 @@ cadenza = \relative c' {
 @seealso
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
+@rlsr{Rhythms}.
 
 
 @node Time administration
@@ -2629,22 +2656,8 @@ notes.
 This manual: @ref{Bar numbers}, @ref{Unmetered music}
 
 Snippets:
-@lsrdir{Rhythms,Rhythms}
-
-Internals Reference: @internalsref{Timing_translator},
-@internalsref{Score}
-
-
-
-
-
-
-
-
-
-
-
-
-
+@rlsr{Rhythms}.
 
+Internals Reference: @rinternals{Timing_translator},
+@rinternals{Score}