From 440c270bbe7033dd09345d9e1639375f7201e018 Mon Sep 17 00:00:00 2001 From: Heikki Junes Date: Sat, 28 Feb 2004 15:40:01 +0000 Subject: [PATCH] * input/test/[t-v]*.ly: finish rewriting texidocs. --- ChangeLog | 5 +++++ input/test/tablature-hammer.ly | 2 +- input/test/tablature.ly | 12 ++++++++---- input/test/temporary-stave.ly | 4 ++-- input/test/text-rotate.ly | 6 +++--- input/test/text-spanner.ly | 4 +++- input/test/textscript.ly | 2 +- input/test/tie-cross-voice.ly | 2 +- input/test/tie-sparse.ly | 5 +++-- input/test/time-signature-double.ly | 4 ++-- input/test/time.ly | 2 +- input/test/timing.ly | 2 +- input/test/title.ly | 3 ++- input/test/to-xml.ly | 2 +- input/test/transposition.ly | 8 ++++---- input/test/trill.ly | 5 ++--- input/test/trills.ly | 3 ++- input/test/unfold-all-repeats.ly | 4 ++-- input/test/version-output.ly | 7 ++++--- input/test/vertical-extent.ly | 7 +++---- 20 files changed, 51 insertions(+), 38 deletions(-) diff --git a/ChangeLog b/ChangeLog index e8d4e4cbb7..680335dfea 100644 --- a/ChangeLog +++ b/ChangeLog @@ -17,6 +17,11 @@ 2004-02-28 Heikki Junes + * input/test/[t-v]*.ly: finish rewriting texidocs. + + * input/test/vaticana.ly: remove. + * input/test/ligature-vaticana.ly: new, renamed file name. + * input/test/stem-centered.ly: remove. * input/test/mensural-note-heads.ly: new file. take content from removed file stem-centered.ly. diff --git a/input/test/tablature-hammer.ly b/input/test/tablature-hammer.ly index d96f594a24..674bd535b4 100644 --- a/input/test/tablature-hammer.ly +++ b/input/test/tablature-hammer.ly @@ -1,7 +1,7 @@ \version "2.1.26" \header {texidoc = "@cindex Tablature hammer -You can fake a hammer in tablature with slurs. " +A hammer in tablature can be faked with slurs. " } \score{ diff --git a/input/test/tablature.ly b/input/test/tablature.ly index a74a5cea25..062c966612 100644 --- a/input/test/tablature.ly +++ b/input/test/tablature.ly @@ -1,11 +1,15 @@ \version "2.1.26" \header{ texidoc = "@cindex Tabulature -A sample tablature, with both normal staff and tab. +Tablature is internally done by overriding the note-head formatting function +and let it act on a 6-line staff. A special engraver takes then care of +choosing the fret and converting the pitch to a number. -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. " +Thus, by providing the fret numbers, the same music can be generated both +for a normal and tabulature staffs. By default, the fret is the smallest +possible, according to @code{minimumFret}. + +" } partition = \notes { diff --git a/input/test/temporary-stave.ly b/input/test/temporary-stave.ly index 74a5d66f0b..72f7514f70 100644 --- a/input/test/temporary-stave.ly +++ b/input/test/temporary-stave.ly @@ -5,8 +5,8 @@ texidoc= " An additional stave can be typeset in the middle of a score line. -A new context type is created to avoid printing time and key -signatures and clef at the beginning of the temporary stave. +A new context type is created for the temporary staff to avoid printing +time and key signatures and clef at the beginning of the extra stave. " } diff --git a/input/test/text-rotate.ly b/input/test/text-rotate.ly index d0c8ad4052..a8d2707746 100644 --- a/input/test/text-rotate.ly +++ b/input/test/text-rotate.ly @@ -5,9 +5,9 @@ @cindex rotated text @cindex choir, rotated text -Rotated text may be faked using inline TeX (or inline -postscript). To see the result, this files must be processed with -the lilypond.py script, and a line must be uncommented. +Inline TeX (or PostScript) may be used, for example, to rotate text. +To see the result, use the @code{lilypond.py} script to generate the +output for printing of the source of this example (commenting one line). " diff --git a/input/test/text-spanner.ly b/input/test/text-spanner.ly index 0ac414db1f..1d7ae2ddea 100644 --- a/input/test/text-spanner.ly +++ b/input/test/text-spanner.ly @@ -2,7 +2,9 @@ \version "2.1.26" \header { texidoc = "@cindex text spanner -You can make LilyPond print text spanners. " +Text spanners can be used in the similar manner than markings for pedals +or octavation. +" } \score{ diff --git a/input/test/textscript.ly b/input/test/textscript.ly index b1ab154893..bb07993620 100644 --- a/input/test/textscript.ly +++ b/input/test/textscript.ly @@ -2,7 +2,7 @@ \version "2.1.26" \header { texidoc = "@cindex Textscript -Test font selection and scm text markup. " +There are different fonts and glyphs to be used with @code{\markup} command. " } \score{ diff --git a/input/test/tie-cross-voice.ly b/input/test/tie-cross-voice.ly index e904dd16c0..f12662e188 100644 --- a/input/test/tie-cross-voice.ly +++ b/input/test/tie-cross-voice.ly @@ -3,7 +3,7 @@ \header { - texidoc = "Cross voice ties can be faked by blanking noteheads." + texidoc = "Cross voice ties can be faked by using transparent noteheads." } diff --git a/input/test/tie-sparse.ly b/input/test/tie-sparse.ly index 89d50e358a..75f160ebce 100644 --- a/input/test/tie-sparse.ly +++ b/input/test/tie-sparse.ly @@ -2,9 +2,10 @@ \version "2.1.26" \header { texidoc = "@cindex Tie Sparse -Setting sparseTies causes only one tie to be -generated per chord pair. " +Setting @code{sparseTies} generated only one tie per chord pair. " } + +% seem not to work -HJJ \score { \context Voice \notes\relative c { diff --git a/input/test/time-signature-double.ly b/input/test/time-signature-double.ly index ba8d0db2f2..e8693b0d42 100644 --- a/input/test/time-signature-double.ly +++ b/input/test/time-signature-double.ly @@ -9,8 +9,8 @@ Double time -signatures are not supported explicitly, but can be faked with markups -and overriding formatting routines. " } +signatures are not supported explicitly, but they can be faked with +markups and overriding formatting routines. " } tsMarkup = \markup { diff --git a/input/test/time.ly b/input/test/time.ly index e01def09c9..22a56fd6fa 100644 --- a/input/test/time.ly +++ b/input/test/time.ly @@ -4,7 +4,7 @@ \header { texidoc = "@cindex Time -Old time signatures. For further information, consult the file. +The different styles for time signatures are shown in this file. " } diff --git a/input/test/timing.ly b/input/test/timing.ly index a4b55bfdd2..56e7df7f36 100644 --- a/input/test/timing.ly +++ b/input/test/timing.ly @@ -4,7 +4,7 @@ \header{ texidoc = "@cindex Bar Length -You can alter the length of bars by setting +You can alter the length of bars by setting explicitly @code{measureLength} or by resetting @code{measurePosition}. " } diff --git a/input/test/title.ly b/input/test/title.ly index 83fac2abec..32bbf81328 100644 --- a/input/test/title.ly +++ b/input/test/title.ly @@ -17,7 +17,8 @@ enteredby = "jcn" source = "urtext" - texidoc ="This test lilypond titling. process with lilypond, not lilypond-book." + texidoc ="This example tests titling. By processing with @code{lilypond} + (not @code{lilypond-book}), you will see all the titles." } \score { diff --git a/input/test/to-xml.ly b/input/test/to-xml.ly index 274462d170..f6bdc3dd3e 100644 --- a/input/test/to-xml.ly +++ b/input/test/to-xml.ly @@ -10,7 +10,7 @@ fooBar = \notes { << c''4 \\ g'4 >> } \header { texidoc = "@cindex To XML" texidoc = #(string-append - "The input representation is very generic. It + "The input representation is very generic. Therefore, it should not be hard to convert it to XML or a similar format:\n\n" "@example\n" diff --git a/input/test/transposition.ly b/input/test/transposition.ly index bc5ed65326..e9cee118cb 100644 --- a/input/test/transposition.ly +++ b/input/test/transposition.ly @@ -2,13 +2,13 @@ \version "2.1.26" \header{ texidoc = "@cindex Transposition -Transposition test file." +Transposing has also an effect key signature, if it is given using +@code{\key}. If @code{keySignature} is set explicitly instead, +the key signature is not transposed." - -% huh what's this supposed to test? } - +% should the explicitly set key signature transpose also? -HJJ vOne = \notes \relative c''{ \clef"violin" diff --git a/input/test/trill.ly b/input/test/trill.ly index f49ee75757..9fd74b62c7 100644 --- a/input/test/trill.ly +++ b/input/test/trill.ly @@ -1,9 +1,8 @@ \version "2.1.26" \header { texidoc="@cindex Trill -Show trill line type. - -The extended trill is a TextSpanner in @code{trill} style. +The extended trill may be produced using @code{TextSpanner} with @code{trill} +spanner style. " } diff --git a/input/test/trills.ly b/input/test/trills.ly index 4faa73e90a..f1ea5af9f2 100644 --- a/input/test/trills.ly +++ b/input/test/trills.ly @@ -2,7 +2,8 @@ \header { texidoc="@cindex Trills -Document trills, pralls and turns." +Trills, pralls and turns may also be written out in full. Here the +D'Anglebert system (1689) is shown." } diff --git a/input/test/unfold-all-repeats.ly b/input/test/unfold-all-repeats.ly index e9ee7f6a27..20826832e2 100644 --- a/input/test/unfold-all-repeats.ly +++ b/input/test/unfold-all-repeats.ly @@ -2,8 +2,8 @@ % regression. -gp \header { -texidoc = "The standard function unfold-repeats will recursively unfold -all repeats for correct MIDI output. Thanks to Rune Zedeler." +texidoc = "Applying the standard function @code{unfold-repeats} unfolds +recursively all repeats for a correct MIDI output." } diff --git a/input/test/version-output.ly b/input/test/version-output.ly index 46ac4727dc..48994a4968 100644 --- a/input/test/version-output.ly +++ b/input/test/version-output.ly @@ -4,9 +4,10 @@ texidoc = #(string-append "By putting the output of - @code{lilypond-version} into a lyric, we can print the version - number in a score, or a lilypond-book document. Another option is - to append the version to the doc-string, like this: " + @code{lilypond-version} into a lyric, it is possible to print the + version number of LilyPond in a score, or in a document generated + with @code{lilypond-book}. Another possibility is to append the + version number to the doc-string, in this manner: " (lilypond-version) ) diff --git a/input/test/vertical-extent.ly b/input/test/vertical-extent.ly index 9d48ace821..21d989a969 100644 --- a/input/test/vertical-extent.ly +++ b/input/test/vertical-extent.ly @@ -2,10 +2,9 @@ % TODO: huh? what's this file about? -gp \header { texidoc = " -Vertical extents may be overriden by -minimumVerticalExtent, extraVerticalExtent, and verticalExtent. These are -normal property values, and are written into the grob when the -associated context finishes, so using it in \property works. +Vertical extents may increased by setting @code{minimumVerticalExtent}, +@code{extraVerticalExtent}, and @code{verticalExtent}. In this example, +@code{verticalExtent} is increased. " } \score { -- 2.39.2