From: Heikki Junes <heikki.junes@hut.fi>
Date: Sat, 28 Feb 2004 12:58:35 +0000 (+0000)
Subject: reformulate texidocs.
X-Git-Tag: release/2.1.28~7
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=ace92555320752430e289c541172c21f6da9dee5;p=lilypond.git

reformulate texidocs.
---

diff --git a/ChangeLog b/ChangeLog
index 7ab737f280..e8d4e4cbb7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -17,6 +17,14 @@
 	
 2004-02-28  Heikki Junes <hjunes@cc.hut.fi>
 
+	* input/test/stem-centered.ly: remove.
+	* input/test/mensural-note-heads.ly: new file. take content from
+	removed file stem-centered.ly.
+
+	* input/test/scales-greek.ly: simplify.
+
+	* input/test/s*.ly: reformulate texidocs.
+	
 	* input/test/[p-r]*.ly: use more verbose texidocs. add comments
 	of missing features.
 
diff --git a/input/test/scales-greek.ly b/input/test/scales-greek.ly
index dfa50cccb8..669b33428e 100644
--- a/input/test/scales-greek.ly
+++ b/input/test/scales-greek.ly
@@ -2,31 +2,28 @@
 \header {
   texidoc = "
 
-Show different greek scales. All these scales are in the key of C
-(major, ionian, phrygian, etc.)
+In addition to major and minor keys, the key can be given also in terms 
+of greek, modal scales: ionian (= major), dorian, phrygian, lydian, mixolydian,
+aeolian (= minor), and locrian. All these scales are in the key of C.
 
 "
 }
 
 \score  { \notes {
 
-\key c \major c'8 -"major" d'8 e'8 f'8 g'8 a'8 b'8 c''8
+\key c \ionian c'8 -"C ionian, major" d'8 e'8 f'8 g'8 a'8 b'8 c''8
 
-\key c \ionian c'8 -"ionian" d'8 e'8 f'8 g'8 a'8 b'8 c''8
+\transpose d c { \key d \dorian d'8 -"C dorian" e'8 f'8 g'8 a'8 b'8 c''8 d''8}
 
-\transpose d c { \key d \dorian c'8 -"dorian" d'8 e'8 f'8 g'8 a'8 b'8 c''8 }
+\transpose e c { \key e \phrygian e'8 -"C phrygian" f'8 g'8 a'8 b'8 c''8 d''8 e''8}
 
-\transpose e c { \key e \phrygian c'8 -"phrygian" d'8 e'8 f'8 g'8 a'8 b'8 c''8 }
+\transpose f c { \key f \lydian f'8 -"C lydian" g'8 a'8 b'8 c''8 d''8 e''8 f''8}
 
-\transpose f c { \key f \lydian c'8 -"lydian" d'8 e'8 f'8 g'8 a'8 b'8 c''8 }
+\transpose g c  { \key g \mixolydian g'8 -"C mixolydian" a'8 b'8 c''8 d''8 e''8 f''8 g''8}
 
-\transpose g c  { \key g \mixolydian c'8 -"mixolydian" d'8 e'8 f'8 g'8 a'8 b'8 c''8 }
+\transpose a c' { \key a \aeolian a8 -"C aeolian, minor" b8 c'8 d'8 e'8 f'8 g'8 a'8 }
 
-\transpose a c' { \key a \minor c'8 -"minor" d'8 e'8 f'8 g'8 a'8 b'8 c''8 }
-
-\transpose a c' { \key a \aeolian c'8 -"aeolian" d'8 e'8 f'8 g'8 a'8 b'8 c''8 }
-
-\transpose b c' { \key b \locrian c'8 -"locrian" d'8 e'8 f'8 g'8 a'8 b'8 c''8 }
+\transpose b c' { \key b \locrian b8 -"C locrian" c'8 d'8 e'8 f'8 g'8 a'8 b'8 }
 
 }
 	  
diff --git a/input/test/scheme-interactions.ly b/input/test/scheme-interactions.ly
index 2cebce260d..7d34a8974b 100644
--- a/input/test/scheme-interactions.ly
+++ b/input/test/scheme-interactions.ly
@@ -1,11 +1,10 @@
 \version "2.1.26"
 \header { texidoc = "@cindex Scheme Interactions
-With @code{ly:export}, you can pass of the result of
-Scheme expressions as lilypond input.  Within a Scheme expression,
-you can use, define or change lilypond variables.
-
-In this example, the E-s and D-s are generated using scheme functions,
-and woven together with manually entered C-s.
+Using @code{ly:export}, the result of Scheme expressions can be passed
+as LilyPond input.  Within a Scheme expression, you can use, define or 
+change the corresponding variables. In this example, the D-s and E-s are 
+generated using scheme functions, and between there are manually 
+(without Scheme) entered C-s.
 
 " }
 
diff --git a/input/test/script-abbreviations.ly b/input/test/script-abbreviations.ly
index 8401ef46a8..c4ca5aabea 100644
--- a/input/test/script-abbreviations.ly
+++ b/input/test/script-abbreviations.ly
@@ -4,7 +4,7 @@
 \version "2.1.26"
 \header { texidoc = "@cindex Script Abbreviations
 
-Some scripts may be entered using an abbreviation.
+Some articulations may be entered using an abbreviation.
 
 "
 	  
diff --git a/input/test/script-chart.ly b/input/test/script-chart.ly
index 7dafa32e5e..8849a27c80 100644
--- a/input/test/script-chart.ly
+++ b/input/test/script-chart.ly
@@ -5,7 +5,7 @@
 \header {
     texidoc ="@cindex Feta scripts
 
-A chart showing all feta scripts.
+This chart shows all articulations, or scripts, that feta font contains.
 
 "
 }
diff --git a/input/test/script-priority.ly b/input/test/script-priority.ly
index 6843df8b8a..cab389290e 100644
--- a/input/test/script-priority.ly
+++ b/input/test/script-priority.ly
@@ -3,7 +3,7 @@
 
 \header { texidoc = "@cindex Script Priority
 Relative placements of different script types can be controlled
-by overriding script-priority. "
+by overriding @code{script-priority}. "
 }
 
 
diff --git a/input/test/script-stack.ly b/input/test/script-stack.ly
index a1878d86c6..d66dd97bbb 100644
--- a/input/test/script-stack.ly
+++ b/input/test/script-stack.ly
@@ -2,7 +2,7 @@
 \version "2.1.26"
 
 \header { texidoc = "@cindex Stacked Text Articulation
-You can stack text and articulations. "
+Text and articulations may be stacked on top of each other. "
 }
 
 \score {
diff --git a/input/test/slur-attachment-override.ly b/input/test/slur-attachment-override.ly
index e24aadaed5..fb6684ab98 100644
--- a/input/test/slur-attachment-override.ly
+++ b/input/test/slur-attachment-override.ly
@@ -3,7 +3,8 @@
 
 \header{
 texidoc="@cindex Slur Attachment Override
-In some cases you may want to set slur attachments by hand. "
+In some cases, you may want to control the attachment points of a slur 
+by hand. "
 }
 
 
diff --git a/input/test/slur-beautiful.ly b/input/test/slur-beautiful.ly
index 1b934515a9..1ba9dda021 100644
--- a/input/test/slur-beautiful.ly
+++ b/input/test/slur-beautiful.ly
@@ -1,16 +1,14 @@
 
 \version "2.1.26"
-% TODO bit too wordy; edit a bit to cut stuff.  -gp
+
 \header { texidoc ="@cindex Slur Beautiful
-Similarly, the curvature of a slur is adjusted to stay clear of note
-heads and stems.  When that would increase the curvature too much, the
-slur is reverted to its default shape.  The threshold for this
-decision is in Slur's object property @code{beautiful}.
-It is loosely related to the enclosed area between the slur and the
-notes.  Usually, the default setting works well, but in some cases you
-may prefer a curved slur when LilyPond decides for a vertically moved
-one.  You can indicate this preference by increasing the
-@code{beautiful} value."
+The curvature of a slur is adjusted to stay away from note heads and 
+stems. When the curvature would increase much, the slur is reverted 
+to its default shape.  The Slur's property @code{beautiful} (which is 
+loosely related to the enclosed area between the slur and the notes)
+controls the transition point, and by increasing that value you may
+keep slurs more curved.
+"
 }
 
 \score { \notes {\relative c' {
diff --git a/input/test/slur-dash.ly b/input/test/slur-dash.ly
index cf512cb6be..fd597de28d 100644
--- a/input/test/slur-dash.ly
+++ b/input/test/slur-dash.ly
@@ -1,6 +1,7 @@
 \version "2.1.26"
 \header {texidoc = "@cindex Slur, dotted
-You can print different kinds of slurs (dotted, dashed, etc). "
+The appearance of slurs may be changed from solid to dotted or dashed.
+"
 } 
 \score{
 	\notes{
diff --git a/input/test/slur-manual.ly b/input/test/slur-manual.ly
index 50f4f79e1e..098f4a550d 100644
--- a/input/test/slur-manual.ly
+++ b/input/test/slur-manual.ly
@@ -2,14 +2,17 @@
 \header {
 
 
-    texidoc = "In extreme cases, you can resort to setting slur
-    control-points manually. This involves a lot of trial and error,
-    though. Be sure to force line breaks at both sides, since
+    texidoc = "In extreme cases, you can resort to setting the 
+    @code{control-points} of a slur manually, althout it involves 
+    a lot of trial and error. Be sure to force line breaks at both sides, since
     different horizontal spacing will require rearrangement of the
     slur."
  
     }
 
+%% This slur does not look good. Looks like there have not been a line 
+%% break at some point, it is then added, but the slur does not break 
+%% in the case of a line break. -HJJ
 
 \score {\notes \new PianoStaff  <<
     \context Staff = up { \clef bass s1 * 6 } 
diff --git a/input/test/slur-minimum-length.ly b/input/test/slur-minimum-length.ly
index 1aabd0c6f8..045520ec7a 100644
--- a/input/test/slur-minimum-length.ly
+++ b/input/test/slur-minimum-length.ly
@@ -2,7 +2,7 @@
 \version "2.1.26"
 
 \header { texidoc = "@cindex Slur Minimum Length
-You can set the minimum length of a slur. " 
+By setting the minimum length of a slur, notes are more separated. " 
 }
 
 \score{
diff --git a/input/test/slur-ugly.ly b/input/test/slur-ugly.ly
index a1e2854fdb..2af89ea74a 100644
--- a/input/test/slur-ugly.ly
+++ b/input/test/slur-ugly.ly
@@ -2,7 +2,7 @@
 \version "2.1.26"
 
 \header { texidoc="@cindex Slur Ugly
-You can get ugly slurs, if you want. "
+Strange slurs can be produced by setting properties by hand. "
 }
 
 baseWalk = \notes \relative c {
diff --git a/input/test/smart-transpose.ly b/input/test/smart-transpose.ly
index 2cad844129..612df905c8 100644
--- a/input/test/smart-transpose.ly
+++ b/input/test/smart-transpose.ly
@@ -3,22 +3,22 @@
 
 \header {
 texidoc="@cindex Smart Transpose
-@example
-	Here's a copy of my feature request :
-@quotation
-        Your task, if you accept it is to implement a \smarttranspose
-        command>> that would translate such oddities into more natural
-        notations. Double accidentals should be removed, as well as E-sharp
-        (-> F), bC (-> B), bF (-> E), B-sharp (-> C).
-@end quotation
-
-You mean like this. (Sorry 'bout the nuked indentation.)
-
-Modified to use the standard transpose mechanism. The question is
-how useful these enharmonic modifications are. Mats B.
-@end example
+
+There is a way to enforce enharmonic modifications for notes in order
+to have the minimum number of accidentals. In that case, ``Double 
+accidentals should be removed, as well as E-sharp (-> F), bC (-> B),
+bF (-> E), B-sharp (-> C).'', as proposed by a request for a new feature.
+In this example, the double accidentals are removed after transposing
+C scale to Ais.
+
 "
 }
+%
+% Modified to use the standard transpose mechanism. The question is
+% how useful these enharmonic modifications are. Mats B.
+% 
+% Why not to have a function that minimizes the number of accidentals? -HJJ
+i%
 
 #(define  (unhair-pitch p)
   (let* ((o (ly:pitch-octave p))
diff --git a/input/test/spacing-2.ly b/input/test/spacing-2.ly
index 71aed66966..7a504e5ae0 100644
--- a/input/test/spacing-2.ly
+++ b/input/test/spacing-2.ly
@@ -3,9 +3,8 @@
 % more yummy regression goodness.  -gp
 \header {
 texidoc = "
-1. Upon stretching every note should stretch according to duration.
-
-2. 8th notes should be spaced equidistantly.
+When stretching notes, every note should stretch according to its duration.
+Eighth notes should be spaced equidistantly.
 "
 }
 
diff --git a/input/test/spanner-after-break-tweak.ly b/input/test/spanner-after-break-tweak.ly
index 9f933cc1bd..a87d80c31c 100644
--- a/input/test/spanner-after-break-tweak.ly
+++ b/input/test/spanner-after-break-tweak.ly
@@ -3,9 +3,9 @@
 
 \header { texidoc = "@cindex Spanner after break
 
-To selectively tweak spanners after the linebreaking
-process, Scheme code must be used.  In this simple example, the tie
-after the line break is moved around. "
+In order to selectively change the properties of spanners after 
+a line break, Scheme code must be used.  In thas manner, the tie
+after the line break in this example is moved around. "
 
       }
 
diff --git a/input/test/staff-bracket.ly b/input/test/staff-bracket.ly
index cd7d6d62f2..cf6ea6596c 100644
--- a/input/test/staff-bracket.ly
+++ b/input/test/staff-bracket.ly
@@ -1,7 +1,8 @@
 \version "2.1.26"
 
 \header{texidoc = "@cindex Staff Bracket
-Here's an example of staff brackets. "
+In a music with piano accompaniment, staff brackets, like the one in 
+this example can be used. "
 }
 
 \score
diff --git a/input/test/staff-container.ly b/input/test/staff-container.ly
index fdcedab240..93b51a4398 100644
--- a/input/test/staff-container.ly
+++ b/input/test/staff-container.ly
@@ -4,13 +4,14 @@
 
     texidoc = "
 
-Container by splitting the grouping (Axis_group_engraver) and creation
-functionality into separate contexts, you can override interesting
-things.
-
-Notation like this is used in modern scores. Note that LilyPond is not
-especially prepared for it: the clefs and time-signatures don't do
-what you would expect.
+In this preliminary test of a modern score, the staff lines are washed
+out temporarily. This is done by making a tuned @code{StaffContainer},
+which @code{\skip}s some notes without printing lines either and
+creates a @code{\new Staff} then in order to create the lines again.
+(Be careful if you use this; it has been done by splitting the
+grouping @code{Axis_group_engraver} and creating functionality into 
+separate contexts, but the clefs and time signatures may not do
+what you would expect.)
 
     "
 
diff --git a/input/test/staff-lines.ly b/input/test/staff-lines.ly
index 54b9890d6e..0a68b641eb 100644
--- a/input/test/staff-lines.ly
+++ b/input/test/staff-lines.ly
@@ -3,8 +3,10 @@
 
 \header {
 
-    texidoc="@cindex Staff Lines Staff symbol properties may also be
- set with @code{\\property}. "
+    texidoc="@cindex Staff Lines 
+The number of lines in a staff may changed by overriding @code{line-count}
+in the properties of @code{StaffSymbol}.
+"
 	  
 }
 
diff --git a/input/test/staff-size.ly b/input/test/staff-size.ly
index 75a3c2d723..22cc273c85 100644
--- a/input/test/staff-size.ly
+++ b/input/test/staff-size.ly
@@ -2,8 +2,8 @@
 
 \header { texidoc = "@cindex Staff Size
 
-For setting staff sizes, both @code{staff-space} and @code{fontSize}
-must be set."
+In order to change staff sizes, both @code{staff-space} and @code{fontSize}
+must be scaled."
 
 }
 
diff --git a/input/test/staff-space.ly b/input/test/staff-space.ly
index 183dd427fc..4c4dfb88c6 100644
--- a/input/test/staff-space.ly
+++ b/input/test/staff-space.ly
@@ -1,7 +1,8 @@
 \version "2.1.26"
 
 \header{ texidoc ="@cindex Staff Space
-Setting staff space on a staff. "
+By just increasing @code{staff-space} on a staff, you may produce strange
+results. "
 }
 
 \score { 
diff --git a/input/test/stem-cross-staff.ly b/input/test/stem-cross-staff.ly
index 7c57e1ba86..dcc7c59bc0 100644
--- a/input/test/stem-cross-staff.ly
+++ b/input/test/stem-cross-staff.ly
@@ -1,9 +1,9 @@
 \version "2.1.26"
 
 \header { texidoc = "@cindex Stem Cross Staff
-There is no support for putting chords across staves.
-You can get this result by increasing the length of the stem in the
-lower stave so it reaches the stem in the upper stave, or vice versa. "
+The chords which exceptionally cross staves may be produced by increasing 
+the length of the stem in the lower stave, so it reaches the stem in the 
+upper stave, or vice versa. "
 }
 
 stemExtend = \once \override Stem  #'length = #22
diff --git a/input/test/stem-extend.ly b/input/test/stem-extend.ly
index edfdc986e8..62c4b12d79 100644
--- a/input/test/stem-extend.ly
+++ b/input/test/stem-extend.ly
@@ -1,7 +1,8 @@
 \version "2.1.26"
 
 \header { texidoc = "@cindex Stem Extend
-You can stop LilyPond from extending stems to the center line. "
+Extending stems to the center line may be prevented using @code{no-stem-extend}.
+"
 }
 
 \score { 
diff --git a/input/test/stem-length.ly b/input/test/stem-length.ly
index ff6e34e81f..4729a6c0e0 100644
--- a/input/test/stem-length.ly
+++ b/input/test/stem-length.ly
@@ -2,7 +2,7 @@
 \version "2.1.26"
 
 \header{ texidoc = "@cindex Stem Length
-You can alter the length of stems. "
+The length of stems can be altered. "
 }
 
 \score {