From b7e7f17aa49c824cf8516d2928b0bee793159089 Mon Sep 17 00:00:00 2001
From: Graham Percival <graham@percival-music.ca>
Date: Fri, 20 Jun 2003 03:40:04 +0000
Subject: [PATCH] Added texidoc index and comments.

---
 ChangeLog                             |  2 +-
 input/test/tablature-hammer.ly        |  1 +
 input/test/tablature.ly               |  8 +++-----
 input/test/text-spanner.ly            |  8 +++++---
 input/test/textscript.ly              |  6 ++++--
 input/test/thumb.ly                   |  6 ++++--
 input/test/tie-broken.ly              |  1 +
 input/test/tie-sparse.ly              | 13 ++++---------
 input/test/time-signature-double.ly   | 16 ++++++----------
 input/test/time.ly                    |  6 +++---
 input/test/timing.ly                  |  8 ++++++--
 input/test/title.ly                   |  1 +
 input/test/to-xml.ly                  |  5 ++---
 input/test/transposing.ly             |  9 +++++----
 input/test/transposition.ly           | 13 +++++++------
 input/test/trill.ly                   |  7 +++----
 input/test/trills.ly                  | 16 ++++++++--------
 input/test/tuplet-rest.ly             |  3 +--
 input/test/tuplet-spanner-duration.ly |  2 +-
 input/test/two-key.ly                 |  4 ++--
 input/test/two-slurs.ly               |  7 +++++--
 input/test/unfold-all-repeats.ly      |  1 +
 input/test/uniform-breaking.ly        |  3 +++
 input/test/vaticana.ly                | 10 +++++++---
 input/test/vertical-align.ly          |  3 +--
 input/test/vertical-extent.ly         | 11 ++++++-----
 input/test/vertical-text.ly           |  2 ++
 input/test/voice-switch.ly            |  2 ++
 input/test/volta.ly                   |  7 +++----
 29 files changed, 98 insertions(+), 83 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 861f073cab..d0d318b5c7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -10,7 +10,7 @@
 	stem-extend was deleted (it was duplicate example, and not as
 	good).
 
-	* input/test/s*.ly: add texidoc index.
+	* input/test/[s-z]*.ly: add texidoc index.
 
 2003-06-20  Han-Wen Nienhuys  <hanwen@cs.uu.nl>
 
diff --git a/input/test/tablature-hammer.ly b/input/test/tablature-hammer.ly
index 5f3a513a80..0c0807a334 100644
--- a/input/test/tablature-hammer.ly
+++ b/input/test/tablature-hammer.ly
@@ -1,4 +1,5 @@
 \version "1.7.18"
+% delete.  -gp
 \header {
 texidoc = "" 
 }
diff --git a/input/test/tablature.ly b/input/test/tablature.ly
index e509d5a0cb..2a89af2501 100644
--- a/input/test/tablature.ly
+++ b/input/test/tablature.ly
@@ -1,14 +1,12 @@
 \version "1.7.18"
 
-%{
-
+\header{ texidoc = "@cindex Tabulature
 A sample tablature, with both normal staff and tab.
 
 Tablature is done by overriding the note-head formatting function, and
 putting it on a 6-line staff. A special engraver takes care of going
-from string-number + pitch to number.
-
-%}
+from string-number + pitch to number. "
+}
 
 partition = \notes {
     \key e \major
diff --git a/input/test/text-spanner.ly b/input/test/text-spanner.ly
index 74a7dd5889..4cb8863551 100644
--- a/input/test/text-spanner.ly
+++ b/input/test/text-spanner.ly
@@ -1,7 +1,8 @@
 \version "1.7.18"
+% TODO: check about other ottava functions.
 
-\header {
-texidoc = "ottava spanners."
+\header { texidoc = "@cindex Ottava Spanner
+You can make Lilypond print ottava spanners. "
 }
 
 \score{
@@ -32,7 +33,8 @@ texidoc = "ottava spanners."
         a #(ly:export (make-span-event 'TextSpanEvent START))
 	b c 
         a #(ly:export (make-span-event 'TextSpanEvent STOP))
-        \property Staff.centralCPosition = #-6
+        \property Staff.centralCPosition = #-6	
     }
+	\paper{ raggedright = ##t}
 }
 %% new-chords-done %%
diff --git a/input/test/textscript.ly b/input/test/textscript.ly
index 2096557ede..1b7472ab7f 100644
--- a/input/test/textscript.ly
+++ b/input/test/textscript.ly
@@ -1,6 +1,7 @@
 \version "1.7.18"
-\header {
-texidoc = "Test font selection and scm text markup"
+
+\header { texidoc = "@cindex Textscript
+Test font selection and scm text markup. "
 }
 
 \score{
@@ -12,5 +13,6 @@ texidoc = "Test font selection and scm text markup"
     c^\markup { \bold "Dal" " " \raise #0.8 \musicglyph #"scripts-segno" }
     c^\markup \huge "ABCD"
   }
+	\paper{ }
 }
 %% new-chords-done %%
diff --git a/input/test/thumb.ly b/input/test/thumb.ly
index f9397de3f9..106bb470d8 100644
--- a/input/test/thumb.ly
+++ b/input/test/thumb.ly
@@ -1,7 +1,9 @@
 \version "1.7.18"
+% delete; covered in refman.  Trust me, I'm a cellist, and I found
+% this stuff easily in the refman.  :)   -gp
 
-\header{
-texidoc ="the thumb-script is used in cello music to indicate a note that should
+\header{ texidoc = "
+the thumb-script is used in cello music to indicate a note that should
  be played with your thumb."
 
 %% TODO: merge with fingering ?
diff --git a/input/test/tie-broken.ly b/input/test/tie-broken.ly
index 97282c902c..20e1f46e66 100644
--- a/input/test/tie-broken.ly
+++ b/input/test/tie-broken.ly
@@ -1,4 +1,5 @@
 \version "1.7.18"
+% regression stuff.  -gp
 
 \score{
 	\notes \relative c''{
diff --git a/input/test/tie-sparse.ly b/input/test/tie-sparse.ly
index 233463bc30..6ad2d6be80 100644
--- a/input/test/tie-sparse.ly
+++ b/input/test/tie-sparse.ly
@@ -1,20 +1,15 @@
 \version "1.7.18"
-\header {
-
-texidoc = "setting sparseTies causes only one tie to be
-generated per chord pair."
 
+\header { texidoc = "@cindex Tie Sparse
+setting sparseTies causes only one tie to be
+generated per chord pair. "
 }
-
 	
 \score { 
   \context Voice \notes\relative c {
 	\property Voice.sparseTies = ##t
 	c''  <<c e g>> ~ <<c e g>> 
   }
-  \paper {
-    raggedright = ##t
-  }  
-  \midi { }
+  \paper { raggedright = ##t }  
 }
 %% new-chords-done %%
diff --git a/input/test/time-signature-double.ly b/input/test/time-signature-double.ly
index 736e3f3593..890b685345 100644
--- a/input/test/time-signature-double.ly
+++ b/input/test/time-signature-double.ly
@@ -1,12 +1,9 @@
+\version "1.7.18"
 
-\header {
-
-
-texidoc= "Double time signatures are not supported
+\header { texidoc= "@cindex Time Signature Double
+Double time signatures are not supported
 explicitly, but can be faked by overriding formatting routines. "
-
 }
-\version "1.7.18"
 
 
 #(define (brew-double-time-sig grob)
@@ -49,7 +46,6 @@ explicitly, but can be faked by overriding formatting routines. "
 	   \time 3/2
 	   c2 c c 
 	   
-	   }
-
-	  }
-	  
+   }
+	\paper{ raggedright = ##t}
+}	  
diff --git a/input/test/time.ly b/input/test/time.ly
index 13d114f259..f736cc7cf2 100644
--- a/input/test/time.ly
+++ b/input/test/time.ly
@@ -1,7 +1,7 @@
 \version "1.7.18"
-\header
-{
-    texidoc =  "
+% TODO: This file could be old.  Ask about it later.  -gp
+
+\header { texidoc =  "@cindex Time
 IMPORTANT NOTE: The current selection scheme for time signature
 symbols is not flexible enough for future extensions such as various
 flavours of early mensural notation or complex signatures as in
diff --git a/input/test/timing.ly b/input/test/timing.ly
index 300130718e..3771e838aa 100644
--- a/input/test/timing.ly
+++ b/input/test/timing.ly
@@ -1,4 +1,9 @@
 \version "1.7.18"
+% possible rename to bar-something.
+
+\header{ texidoc = "@cindex Bar Length
+You can alter the length of bars in a number of ways. "
+}
 
 \score { 
   \context Voice \notes\relative c {
@@ -20,7 +25,6 @@
 	c4 c1
 	
   }
-  \paper { }  
-  \midi { }
+  \paper { raggedright= ##t}  
 }
 %% new-chords-done %%
diff --git a/input/test/title.ly b/input/test/title.ly
index 1458b2d544..8309c4c700 100644
--- a/input/test/title.ly
+++ b/input/test/title.ly
@@ -1,4 +1,5 @@
 \version "1.7.18"
+% MERGE with ly2dvi-
 \header {
   filename =  "title.ly"
   dedication = "dedication"
diff --git a/input/test/to-xml.ly b/input/test/to-xml.ly
index 38e537e744..62b7919fd1 100644
--- a/input/test/to-xml.ly
+++ b/input/test/to-xml.ly
@@ -8,9 +8,8 @@ fooBar = \notes { < c''4 \\ g'4 > }
 #(music-to-xml fooBar (current-output-port))
 
 \header {
-    texidoc =
-
-    #(string-append
+    texidoc = "@cindex To XML"
+	texidoc = #(string-append
       "The input representation is very generic. It
       should not be hard to convert it to XML or a similar format:\n\n"
 
diff --git a/input/test/transposing.ly b/input/test/transposing.ly
index bc0ea6a4d1..4d4069866d 100644
--- a/input/test/transposing.ly
+++ b/input/test/transposing.ly
@@ -1,8 +1,9 @@
-\header {
-texidoc = " the transposing property leaves output invariant, but has effect on MIDI."
+\version "1.7.18"
+% possible rename to midi-something.
 
+\header { texidoc = "@cindex Transposing
+The transposing property leaves output invariant, but has effect on MIDI. "
 }
-\version "1.7.18"
 
 \score { 
   \context Voice \notes\relative c {
@@ -18,7 +19,7 @@ texidoc = " the transposing property leaves output invariant, but has effect on
 	\property Staff.transposing = #12 c
 	
   }
-  \paper { }  
+  \paper { raggedright = ##t } 
   \midi { }
 }
 %% new-chords-done %%
diff --git a/input/test/transposition.ly b/input/test/transposition.ly
index 7a14b5c0bf..22a7aa59cd 100644
--- a/input/test/transposition.ly
+++ b/input/test/transposition.ly
@@ -1,4 +1,10 @@
 \version "1.7.18"
+
+\header{ texidoc = "@cindex Transposition
+Transposition Test file"
+}
+
+
 %{
 Hi all,
 
@@ -22,11 +28,6 @@ Eric
 %}
 
 
-\header{
-texidoc = 	 "Transposition Test file"
-}
-
-
 
 
 vOne =  \notes \relative c''{
@@ -65,7 +66,7 @@ vFour =  \notes \transpose c d \vThree
          \context Staff=vThree \vThree
          \context Staff=vFour \vFour
   >
-        \paper { linewidth= 130.\mm }
+        \paper { linewidth= 130.\mm raggedright = ##t }
 }
 
 
diff --git a/input/test/trill.ly b/input/test/trill.ly
index afdd4c4f9d..a7551eb015 100644
--- a/input/test/trill.ly
+++ b/input/test/trill.ly
@@ -1,10 +1,9 @@
 \version "1.7.18"
 
-\header {
-texidoc="show trill line type"
+\header { texidoc="@cindex Trill
+Show trill line type. "
 }
 
-\paper { raggedright = ##t} 
 
 \score {
   \context RhythmicStaff \notes {
@@ -22,7 +21,7 @@ texidoc="show trill line type"
      = #(cons (make-musicglyph-markup "scripts-trill")  "")
     a#(ly:export (make-span-event 'TextSpanEvent START)) b c a #(ly:export (make-span-event 'TextSpanEvent STOP))
   }
-  \paper { }  
+	\paper { raggedright = ##t} 
 }
 
 %% new-chords-done %%
diff --git a/input/test/trills.ly b/input/test/trills.ly
index c535dee669..8b0ac8431b 100644
--- a/input/test/trills.ly
+++ b/input/test/trills.ly
@@ -1,14 +1,13 @@
-\paper  {
-  linewidth = 433.619940\pt
-  
-} 
 \version "1.7.18"
+
 \header {
-  texidoc="Document trills, pralls and turns."
+  texidoc="@cindex Trills
+Document trills, pralls and turns."
   
-  title="Marques des agr\\'ements et leur signification"
-  composer="D'Anglebert"
-  year="1689"
+% TODO:  these don't get built, right?  check it, then delete.
+%  title="Marques des agr\\'ements et leur signification"
+%  composer="D'Anglebert"
+%  year="1689"
 }
 
 invisible = \property Voice.NoteHead \override #'transparent = ##t
@@ -107,5 +106,6 @@ endHorizScript = {
       }
     >
   >
+	\paper{ }
 }
 %% new-chords-done %%
diff --git a/input/test/tuplet-rest.ly b/input/test/tuplet-rest.ly
index 8a24cdb2a7..5166a68c31 100644
--- a/input/test/tuplet-rest.ly
+++ b/input/test/tuplet-rest.ly
@@ -1,6 +1,5 @@
 \version "1.7.18"
-
-
+% regression or delete.  -gp
 
 \score {
   \context Voice \notes \relative c'' {
diff --git a/input/test/tuplet-spanner-duration.ly b/input/test/tuplet-spanner-duration.ly
index dfcbd35be8..18ca2f36a1 100644
--- a/input/test/tuplet-spanner-duration.ly
+++ b/input/test/tuplet-spanner-duration.ly
@@ -1,5 +1,5 @@
 \version "1.7.18"
-
+% regression or delete.
 
 \score
 {
diff --git a/input/test/two-key.ly b/input/test/two-key.ly
index 7d83fea44e..6c13918ba6 100644
--- a/input/test/two-key.ly
+++ b/input/test/two-key.ly
@@ -1,7 +1,7 @@
 \version "1.7.18"
-\header {
+% regression
 
-texidoc = "If you specify two different key sigs at one point, a
+\header { texidoc = "If you specify two different key sigs at one point, a
   warning is printed."
 
 }
diff --git a/input/test/two-slurs.ly b/input/test/two-slurs.ly
index 5dc8df00f5..44d91142ec 100644
--- a/input/test/two-slurs.ly
+++ b/input/test/two-slurs.ly
@@ -1,9 +1,12 @@
 \version "1.7.18"
 
-%
+\header{ texidoc = "@cindex Two Slurs
+You can print a slur in each voice. "
+}
+
 % We'd want to combine the stems, but have two slurs too...
 % Looks like the a-due engraver
-%
+
 \score{
 	\context Staff <
 		\context Voice=v \notes\relative c''{
diff --git a/input/test/unfold-all-repeats.ly b/input/test/unfold-all-repeats.ly
index cb3b035305..2be72c3682 100644
--- a/input/test/unfold-all-repeats.ly
+++ b/input/test/unfold-all-repeats.ly
@@ -1,4 +1,5 @@
 \version "1.7.18"
+% regression.  -gp
 
 \header { 
 texidoc = "The standard function unfold-repeats will recursively unfold
diff --git a/input/test/uniform-breaking.ly b/input/test/uniform-breaking.ly
index 9df550dae2..525aeda042 100644
--- a/input/test/uniform-breaking.ly
+++ b/input/test/uniform-breaking.ly
@@ -1,4 +1,7 @@
 \version "1.7.18"
+% definately need to check with Han or Jan for this one.
+% I haven't a clue what it does, but the output doesn't look
+% special.  -gP
 
 %{
 Hmm, ik vraag me af of dit al helemaal koel is.
diff --git a/input/test/vaticana.ly b/input/test/vaticana.ly
index 41bc93a545..c6c80d2794 100644
--- a/input/test/vaticana.ly
+++ b/input/test/vaticana.ly
@@ -1,6 +1,8 @@
 \version "1.7.19"
-\header {
-    texidoc	= "vaticana ligature test"
+% possible rename to ancient-something.
+
+\header { texidoc	= "Ancient Vaticana
+Vaticana ligature test. "
 }
 
 \include "gregorian-init.ly"
@@ -39,12 +41,14 @@ verba = \context Lyrics = verba \lyrics {
     stafflinethickness = \staffspace / 5.0
     linewidth = 15.0 \cm
     indent = 0.0
+	raggedright = ##t
 %
 % FIXME: ragged-right alignment is currently broken
+	% I don't think it is any more.  -gp
 %   width = 12.0 \cm
-%   raggedright = ##t
 %   gourlay_maxmeasures = 30.
 %
+
     \translator {
       \VoiceContext
       \name VaticanaVoice
diff --git a/input/test/vertical-align.ly b/input/test/vertical-align.ly
index 4a00cd2e2d..82d87b738b 100644
--- a/input/test/vertical-align.ly
+++ b/input/test/vertical-align.ly
@@ -1,6 +1,5 @@
 \version "1.7.18"
-
-
+% regression or delete.  -gp
 
 \score {
 \notes <
diff --git a/input/test/vertical-extent.ly b/input/test/vertical-extent.ly
index 3ddbc34c22..42b9e63e2b 100644
--- a/input/test/vertical-extent.ly
+++ b/input/test/vertical-extent.ly
@@ -1,11 +1,12 @@
+\version "1.7.18"
+% TODO: huh?  what's this file about?  -gp
 
-\header { texidoc = "vertical extents may be overriden by
+\header { texidoc = "
+Vertical extents may be overriden by
 verticalExtent, verticalExtent, verticalExtent. These are
-normal property values, and are written itno the grob when the
+normal property values, and are written into the grob when the
 associated context finishes, so using it in \property works.
-
- " }
-\version "1.7.18"
+" }
 
 \score {
   \notes  <
diff --git a/input/test/vertical-text.ly b/input/test/vertical-text.ly
index 09d11a1d65..2c29945486 100644
--- a/input/test/vertical-text.ly
+++ b/input/test/vertical-text.ly
@@ -1,4 +1,6 @@
 \version "1.7.18"
+% TODO: huh?  This text isn't vertical...?
+
 \score{
 	<
 		\context Staff = o \notes\relative c,,, { 
diff --git a/input/test/voice-switch.ly b/input/test/voice-switch.ly
index 5950396ca7..f4fae7cdeb 100644
--- a/input/test/voice-switch.ly
+++ b/input/test/voice-switch.ly
@@ -1,4 +1,6 @@
 \version "1.7.18"
+% delete.  We have other partcombine examples -- if that's
+% what this is.  -gp
 
 \score{
 	\context Staff <
diff --git a/input/test/volta.ly b/input/test/volta.ly
index 7de0d01f68..e4e895be1f 100644
--- a/input/test/volta.ly
+++ b/input/test/volta.ly
@@ -1,8 +1,7 @@
-% DOCUMENTME!
-
 \version "1.7.18"
-
-
+% DOCUMENT ME!
+% I think this is an old example of alternate repeats,
+% but that's covered in refman now.  candidate for delete.
 
 
 voiceE =  \notes {
-- 
2.39.5