From 06cdf796c67baca6a1fe1796971e4229329991d0 Mon Sep 17 00:00:00 2001
From: Graham Percival <graham@percival-music.ca>
Date: Thu, 19 Jun 2003 23:11:18 +0000
Subject: [PATCH] Add texidoc index and a few comments.

---
 ChangeLog                          |  2 ++
 input/test/coda-kludge.ly          |  2 +-
 input/test/part-combine-moments.ly |  9 ++++++++-
 input/test/part-combine-staff.ly   |  4 +++-
 input/test/part-combine.ly         |  7 +++----
 input/test/partial-blank.ly        | 13 +++++++------
 input/test/pedal.ly                | 14 +++-----------
 input/test/perform-grace.ly        |  2 ++
 input/test/perform-tie.ly          |  2 ++
 input/test/phrasing-slur-height.ly | 10 ++++------
 input/test/poly-metric.ly          | 16 ++++++++--------
 input/test/preset-extent.ly        |  8 +++-----
 input/test/repeat-manual.ly        |  7 +++++--
 input/test/repeat.ly               |  5 +++++
 input/test/rest-dot-positions.ly   |  4 ++++
 input/test/rests.ly                |  3 ++-
 input/test/reverse-music.ly        |  8 +++-----
 input/test/rhythm-excercise.ly     | 12 +++++-------
 input/test/rhythmic-staff.ly       |  4 ++--
 19 files changed, 72 insertions(+), 60 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index f1be3b3218..5478bd8944 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -21,6 +21,8 @@
 
 	* input/test/hymn.ly: change comments.
 
+	* input/test/[p-r]*.ly: add texidoc index.
+
 2003-06-19  Han-Wen Nienhuys  <hanwen@cs.uu.nl>
 
 	* input/mutopia/J.S.Bach/Petites-Preludes/*.ly (opus): update
diff --git a/input/test/coda-kludge.ly b/input/test/coda-kludge.ly
index a51a16a5d1..23ef59615a 100644
--- a/input/test/coda-kludge.ly
+++ b/input/test/coda-kludge.ly
@@ -1,6 +1,6 @@
 \version "1.7.18"
 % TODO: rethink name and whole file -- possible delete or major
-% changes.
+% changes.  See repeat-manual.ly
 \header{
 	texidoc="@cindex Coda Kludge"
 }
diff --git a/input/test/part-combine-moments.ly b/input/test/part-combine-moments.ly
index 43d0a7f67e..949417181e 100644
--- a/input/test/part-combine-moments.ly
+++ b/input/test/part-combine-moments.ly
@@ -1,4 +1,11 @@
 \version "1.7.19"
+% TODO: this example has a ton of text for very little output.
+% Is it all needed?  -gp
+% should this go to regression or be delete'd?   -gp
+\header{ texidoc="@cindex Part Combine Moments
+When you combine two voices with the same notes, you should
+only have one stem. "
+}
 
 \score{
 	\context PianoStaff <
@@ -17,7 +24,7 @@
 				}
 		>
 	\paper {
-
+		raggedright= ##t
 		textheight = 295.0\mm
 		linewidth = 180.0\mm
 
diff --git a/input/test/part-combine-staff.ly b/input/test/part-combine-staff.ly
index 02ec43a466..5be11d47c9 100644
--- a/input/test/part-combine-staff.ly
+++ b/input/test/part-combine-staff.ly
@@ -1,4 +1,7 @@
 \version "1.7.19"
+\header { texidoc = "@cindex Part Combine Staff
+You can combine parts on two staffs, as well as two voices. "
+}
 
 \score{
 	\context PianoStaff <
@@ -27,7 +30,6 @@
 				}
 		>
 	\paper {
-
 		textheight = 295.0\mm
 		linewidth = 180.0\mm
 
diff --git a/input/test/part-combine.ly b/input/test/part-combine.ly
index 4d59c8e00e..35333cdf63 100644
--- a/input/test/part-combine.ly
+++ b/input/test/part-combine.ly
@@ -1,12 +1,10 @@
 \version "1.7.18"
 
-\header{
-texidoc="
+\header{ texidoc="@cindex Part Combine
 In orchestral scores and hymns, voices are traditionally combined onto
 one staff.  LilyPond has a part combiner, that combines or separates two
 voices according to actual rhythm and pitch.  User-defined texts such as
-``solo'' and ``@`a2'' are typeset automagically, as appropriate.
-"
+``solo'' and ``@`a2'' are typeset automagically, as appropriate. "
 }
 
 \score{
@@ -25,6 +23,7 @@ voices according to actual rhythm and pitch.  User-defined texts such as
     }
   >
   \paper{
+	raggedright = ##t
     linewidth = 80 * \staffspace
     \translator{
       \ThreadContext
diff --git a/input/test/partial-blank.ly b/input/test/partial-blank.ly
index 4b1c7a145a..a8f0b88d6b 100644
--- a/input/test/partial-blank.ly
+++ b/input/test/partial-blank.ly
@@ -1,10 +1,11 @@
 \version "1.7.18"
-
-%{  When entering half music (I.e. for students to complete by hand)
-    you need the spacing to correspond to the timing - all measures same length, etc.
-    This thing implements it by adding invisible staff with lots of fast notes.
-%}
-
+% check with invisible-notes or blank-notes.  possible rename. -gp
+\header{ texidoc = "@cindex Partial Blank
+When entering half music (i.e. for students to complete by hand)
+you need the spacing to correspond to the timing -- all measures
+same length, etc.  This thing implements it by adding invisible
+staff with lots of fast notes. "
+}
 
 quickmeasure = \notes {[\repeat unfold 16 c''16]}
 mel = \notes \relative c' {c16 d16 e8 a4 g2 e8 d c2. g'1 e4 d c2}
diff --git a/input/test/pedal.ly b/input/test/pedal.ly
index 3d31007bc0..7a45e19067 100644
--- a/input/test/pedal.ly
+++ b/input/test/pedal.ly
@@ -1,12 +1,10 @@
 \version "1.7.18"
-\header{
-    texidoc = "Piano pedal symbols merge stop and start.  The strings are configurable. 
+
+\header{ texidoc = "@cindex Pedal
+Piano pedal symbols merge stop and start.  The strings are configurable. 
 Text style, bracket style, and a mixture of both are supported.  "
 }
 
-
-
-
 \score{
     \context Staff \notes\relative c'{
 
@@ -29,12 +27,6 @@ Text style, bracket style, and a mixture of both are supported.  "
 	c4 d \unaCorda e f g
 	b \treCorde c
 
-
-    }
-    \paper{
-    }
-    \midi{
-	\tempo 4 = 60
     }
 }
 %% new-chords-done %%
diff --git a/input/test/perform-grace.ly b/input/test/perform-grace.ly
index feb4b80edd..d741b6136f 100644
--- a/input/test/perform-grace.ly
+++ b/input/test/perform-grace.ly
@@ -1,4 +1,6 @@
 \version "1.7.18"
+% regression or delete.  -gp
+\header{ texidoc = "" }
 
 \score { 
   \context Voice \notes\relative c {
diff --git a/input/test/perform-tie.ly b/input/test/perform-tie.ly
index 894854bd8a..2c9902a414 100644
--- a/input/test/perform-tie.ly
+++ b/input/test/perform-tie.ly
@@ -1,4 +1,6 @@
 \version "1.7.18"
+% regression or delete. -gp
+\header { texidoc= "" }
 
 \score { 
   \context Voice \notes\relative c {
diff --git a/input/test/phrasing-slur-height.ly b/input/test/phrasing-slur-height.ly
index 893b83bfe3..c863f37790 100644
--- a/input/test/phrasing-slur-height.ly
+++ b/input/test/phrasing-slur-height.ly
@@ -1,8 +1,7 @@
-\header{
-    texidoc="Make PhrasingSlur higher, to avoid colission from other slurs"
-    }
-
 \version "1.7.18"
+\header{ texidoc="@cindex Phrasing Slur Height
+Make PhrasingSlur higher, to avoid colission from other slurs. "
+}
 
 \score {
     \context Staff = melody \notes\relative c''{
@@ -10,7 +9,6 @@
 	c8 \( (d e f-) g ( a b c-)
 	| c ( b a g-) f ( e d c-)-\)
     }
-    \paper {
-    }
+    \paper { raggedright = ##t }
 }
 %% new-chords-done %%
diff --git a/input/test/poly-metric.ly b/input/test/poly-metric.ly
index dd937ea2f0..2ba8a559da 100644
--- a/input/test/poly-metric.ly
+++ b/input/test/poly-metric.ly
@@ -1,7 +1,7 @@
 \version "1.7.18"
-\header {
-    texidoc = "Polymetric music with aligned note values can be written
- by moving the timing engraver to staff context."
+\header { texidoc = "@cindex Poly Metric
+Polymetric music with aligned note values can be written
+by moving the timing engraver to staff context. "
 }
 
 \score {
@@ -24,11 +24,11 @@
 
     \paper{
     \translator{ \ScoreContext
-    \remove "Timing_engraver" }
+	    \remove "Timing_engraver" }
     \translator{ \StaffContext
-    \consists "Timing_engraver"
-    \alias Timing
-}
-}
+	    \consists "Timing_engraver"
+	    \alias Timing }
+	raggedright= ##t
+	}
 }
 %% new-chords-done %%
diff --git a/input/test/preset-extent.ly b/input/test/preset-extent.ly
index 28f20fdca5..38d3437b33 100644
--- a/input/test/preset-extent.ly
+++ b/input/test/preset-extent.ly
@@ -1,9 +1,7 @@
 \version "1.7.18"
-\header {
-
-texidoc = "Grob extents may be hard coded using grob
-    properties.  This requires Grob::preset_extent () function.
-" 
+\header { texidoc = "@cindex Preset Extent
+Grob extents may be hard coded using grob properties.  This
+requires Grob::preset_extent () function. " 
 }
 
 \score {
diff --git a/input/test/repeat-manual.ly b/input/test/repeat-manual.ly
index 89b4281e58..3c2809ccfd 100644
--- a/input/test/repeat-manual.ly
+++ b/input/test/repeat-manual.ly
@@ -1,6 +1,8 @@
-
 \version "1.7.18"
-
+\header { texidoc = "@cindex Repeat Manual
+You can manually control repeat signs and numbers to produce
+unusual output. "
+}
 
 \score { \notes {
 % First a normal looking repeat:
@@ -17,5 +19,6 @@
     \property Score.repeatCommands = #'((volta #f))
  c c
 }
+	\paper{raggedright=##t}
 }
 %% new-chords-done %%
diff --git a/input/test/repeat.ly b/input/test/repeat.ly
index cb6366e298..ae6e17eea6 100644
--- a/input/test/repeat.ly
+++ b/input/test/repeat.ly
@@ -1,4 +1,8 @@
 \version "1.7.18"
+% possible rename to lyric-repeat or repeat-lyric.
+\header{ texidoc = "@cindex Repeat Lyrics
+You can use alternate lyrics as well as alternate notes for repeats. "
+}
 
 \score{
 	<
@@ -17,5 +21,6 @@
 			  en dan nog dit er ach- ter aan
 		  }
 	>
+	\paper{raggedright=##t}
 }
 %% new-chords-done %%
diff --git a/input/test/rest-dot-positions.ly b/input/test/rest-dot-positions.ly
index 2ce48b361a..a9d822d39e 100644
--- a/input/test/rest-dot-positions.ly
+++ b/input/test/rest-dot-positions.ly
@@ -1,4 +1,7 @@
 \version "1.7.18"
+% candidate for regression.  -gp
+\header { texidoc = "@cindex Rest Dot Positions
+This file tests dotted rests. " }
 
 muz = \notes \relative c'' {
     \time 6/1
@@ -50,5 +53,6 @@ muz = \notes \relative c'' {
 	  \context Voice=two { \voiceTwo \muz }
       >
   }
+	\paper{}
 }
 %% new-chords-done %%
diff --git a/input/test/rests.ly b/input/test/rests.ly
index b2211b9c34..42b60dc71e 100644
--- a/input/test/rests.ly
+++ b/input/test/rests.ly
@@ -1,6 +1,7 @@
 \version "1.7.18"
 \header {
-    texidoc = "rests in various styles."
+    texidoc = "@cindex Rests
+Rests in various styles."
 }
 
 % FIXME: Currently, this file produces "warning: flag `d-3' not found"
diff --git a/input/test/reverse-music.ly b/input/test/reverse-music.ly
index e7da3e765a..5195a5d849 100644
--- a/input/test/reverse-music.ly
+++ b/input/test/reverse-music.ly
@@ -1,9 +1,7 @@
 \version "1.7.18"
-
-\header {
-texidoc="
-Simple customised music apply.
-"
+% possible rename to scheme-something.
+\header { texidoc="@cindex Scheme Reverse Music
+Simple customised music apply. "
 }
 
 music = \notes \relative c'' { c4 d4( e4 f4 }
diff --git a/input/test/rhythm-excercise.ly b/input/test/rhythm-excercise.ly
index 24d1918db5..cd53b36a0a 100644
--- a/input/test/rhythm-excercise.ly
+++ b/input/test/rhythm-excercise.ly
@@ -1,10 +1,7 @@
 \version "1.7.18"
-\header {
-
-    texidoc = " a way to generate rhythm exercises with lilypond
-    (e.g. no staff but retaining the barlines"
-
-
+\header { texidoc = "@cindex Rhythm Exercise
+This example shows a way to generate rhythm exercises with
+Lilypond (e.g. no staff but retaining the barlines. "
 }
 
 \score { \notes { c4 c4 [ c8 c8 ] }
@@ -16,5 +13,6 @@
 			   \remove Clef_engraver
 		       }
 	 }
-     }
+	\paper{raggedright= ##t}
+}
 %% new-chords-done %%
diff --git a/input/test/rhythmic-staff.ly b/input/test/rhythmic-staff.ly
index 109d7b58e3..48e095e311 100644
--- a/input/test/rhythmic-staff.ly
+++ b/input/test/rhythmic-staff.ly
@@ -1,6 +1,6 @@
 \version "1.7.18"
-
-
+% covered by refman, I think.  delete or regression.  -gp
+\header { texidoc = ""}
 \score{
   \context RhythmicStaff {
     \notes\relative c''{ 
-- 
2.39.2