From: Heikki Junes Date: Thu, 26 Feb 2004 00:48:57 +0000 (+0000) Subject: * input/test/[a-b]*.ly: refresh descriptions -- avoid referring X-Git-Tag: release/2.1.28~29 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=2db32dd2dbced74d03b5a1ae19f2d004ab257548;p=lilypond.git * input/test/[a-b]*.ly: refresh descriptions -- avoid referring to a file in printed documentation, instead, refer either to a syntax or to an output. --- diff --git a/ChangeLog b/ChangeLog index 8e2eac573d..18e310e61b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2004-02-26 Heikki Junes + + * input/test/[a-b]*.ly: refresh descriptions -- avoid referring + to a file in printed documentation, instead, refer either to a + syntax or to an output. + 2004-02-26 Jan Nieuwenhuizen * input/regression/beam-center-slope.ly: Add test. diff --git a/input/test/add-staccato.ly b/input/test/add-staccato.ly index 62c2c3e0b9..fa8379fbc9 100644 --- a/input/test/add-staccato.ly +++ b/input/test/add-staccato.ly @@ -4,9 +4,9 @@ \header { texidoc= "@cindex Add Stacato -Using make-music, you can add various stuff to notes. Here -is an example how to add staccato dots. Note: for this simple case -one would not use scm constructs. See separate-staccato.ly first. +Using @code{make-music}, you can add various stuff to notes. In this +example staccato dots are added to the notes. For this simple case, +it is not necessary to use scm constructs (see @code{separate-staccato.ly}). " } diff --git a/input/test/add-text-script.ly b/input/test/add-text-script.ly index d964ed7cf8..4df05478a4 100644 --- a/input/test/add-text-script.ly +++ b/input/test/add-text-script.ly @@ -2,11 +2,11 @@ \header { texidoc= "@cindex make-music Fingering -You can add various stuff to notes using make-music. -Here is an example of how to add an extra fingering. +You can add various stuff to notes using @code{make-music}. +In this example, an extra fingering is attached to a note. -In general, first do a display of the music you want to -create, then write a function that will build the structure for you. +In general, first do a @code{display} of the music you want to +create, then write a function that will structure the music for you. " } diff --git a/input/test/ambitus-mixed.ly b/input/test/ambitus-mixed.ly index 9c2439fc0f..06fe96e356 100644 --- a/input/test/ambitus-mixed.ly +++ b/input/test/ambitus-mixed.ly @@ -1,15 +1,15 @@ \header { -texidoc = "Ambituses can be switched off or translated by using -applyoutput. +texidoc = "The showing of ambituses can be switched off or they can be +shifted horizontally by using @code{applyoutput}. If you want to mix per-voice and per-staff ambituses, then you have to -define you have to declare a new context type derived from the -@code{Voice} context or @code{Staff} context. The derived context -must consist of the @code{Ambitus_engraver} and it must be accepted by -a proper parent context, in the below example the @code{Staff} context -or @code{Score} context, respectively. The original context and the -derived context can then be used in parallel in the same score. (this is not demonstrated in this file). +define new context type derived from the @code{Voice} or @code{Staff} +context. The derived context must contain the @code{Ambitus_engraver} +and it must be accepted by a proper parent context, which are respectively +the @code{Staff} context or @code{Score} context in the example below. +The original context and the derived context can then be used in parallel +in the same score (not demonstrated in this file). " } diff --git a/input/test/ancient-accidentals.ly b/input/test/ancient-accidentals.ly index 560e7273a4..1a9218865a 100644 --- a/input/test/ancient-accidentals.ly +++ b/input/test/ancient-accidentals.ly @@ -1,8 +1,8 @@ \header { texidoc = "@cindex Ancient Accidentals -Accidentals are available in different ancient styles. This -file lists all of them. +Accidentals are available in different ancient styles, which all +are collected here. " } diff --git a/input/test/ancient-font.ly b/input/test/ancient-font.ly index 46f8a0695d..e808a50b63 100644 --- a/input/test/ancient-font.ly +++ b/input/test/ancient-font.ly @@ -3,7 +3,7 @@ % different locations. \header { texidoc = "@cindex Ancient Font -Here is a display of many (all?) symbols that are +Here are shown many (all?) of the symbols that are included in LilyPond's support of ancient notation. " } diff --git a/input/test/ancient-time.ly b/input/test/ancient-time.ly index b7fdbb02a5..6d98689174 100644 --- a/input/test/ancient-time.ly +++ b/input/test/ancient-time.ly @@ -3,7 +3,7 @@ % for ancient-font.ly \header { texidoc="@cindex Ancient Time Signatures -Should use old style. +Time signatures may also be engraved in an old style. " } diff --git a/input/test/bagpipe.ly b/input/test/bagpipe.ly index 2c6bdd52cd..bca0ab956d 100644 --- a/input/test/bagpipe.ly +++ b/input/test/bagpipe.ly @@ -2,7 +2,7 @@ \header { texidoc = "@cindex Bagpipe Music -Here's an example of bagpipe music. +Bagpipe music may contain a lot of grace notes. " } diff --git a/input/test/bar-always.ly b/input/test/bar-always.ly index 3833007c5a..60abb3a25d 100644 --- a/input/test/bar-always.ly +++ b/input/test/bar-always.ly @@ -4,7 +4,7 @@ texidoc = "@cindex Bars Always -By setting @code{barAlways} and @code{defaultBarType,} you can automatically insert barlines everywhere." +By setting @code{barAlways} and @code{defaultBarType}, barlines may be inserted automatically everywhere." } diff --git a/input/test/bar-lines-lyric-only.ly b/input/test/bar-lines-lyric-only.ly index 6929c724d6..1c791feb7d 100644 --- a/input/test/bar-lines-lyric-only.ly +++ b/input/test/bar-lines-lyric-only.ly @@ -1,7 +1,8 @@ \version "2.1.26" \header { texidoc = "@cindex Bar line lyric only -You can move around @code{Bar_engraver} and -@code{Span_bar_engraver} if you want bar lines on lyrics. " +You can move @code{Bar_engraver} and @code{Span_bar_engraver} to +a different engraving context, if you want, for example, bar lines +on lyrics. " } \score { diff --git a/input/test/bar-lines.ly b/input/test/bar-lines.ly index 984db18334..ad59e74f2d 100644 --- a/input/test/bar-lines.ly +++ b/input/test/bar-lines.ly @@ -2,7 +2,7 @@ \version "2.1.26" \header { texidoc = "@cindex Bar Lines -Different types of bar lines demonstrated. +There a many types of bar lines available. " } % TODO: dashed "|", HJJ \score diff --git a/input/test/bar-number-every-five-reset.ly b/input/test/bar-number-every-five-reset.ly index 853c91e257..ea229dd788 100644 --- a/input/test/bar-number-every-five-reset.ly +++ b/input/test/bar-number-every-five-reset.ly @@ -3,10 +3,11 @@ \header { texidoc = "@cindex Bar Number Every Fifth Reset If you would like the bar numbers to appear at regular intervals, but -not starting from measure zero, you can use the context function, -@code{set-bar-number-visibility}, to automatically set -@code{barNumberVisibility} so that the bar numbers appear at regular -intervals, starting from the @code{\applycontext}. +not starting from measure zero, you can use a context function, +@code{set-bar-number-visibility}, to set automatically +@code{barNumberVisibility}, so that the bar numbers appear at regular +intervals, starting from the measure in which +@code{set-bar-number-visibility} is set using @code{\applycontext}. " } diff --git a/input/test/bar-number-regular-interval.ly b/input/test/bar-number-regular-interval.ly index d7eef805cb..a801421301 100644 --- a/input/test/bar-number-regular-interval.ly +++ b/input/test/bar-number-regular-interval.ly @@ -1,7 +1,7 @@ \header { texidoc = " -Bar numbers can also be printed at regular intervals. +Bar numbers can also be printed inside boxes. " } diff --git a/input/test/bar-number-show-all.ly b/input/test/bar-number-show-all.ly index e247d8f251..bf06bafdb6 100644 --- a/input/test/bar-number-show-all.ly +++ b/input/test/bar-number-show-all.ly @@ -2,7 +2,8 @@ \version "2.1.26" \header{ texidoc="@cindex Bar Number Show All -Second line has bar numbers on start of every measure. +By default, bar numbers are printed only in the first measure. This +setting can be overridden, so that bar numbers on start of every measure. " } \score{ diff --git a/input/test/beam-alternate.ly b/input/test/beam-alternate.ly index 41682a3672..4002e75165 100644 --- a/input/test/beam-alternate.ly +++ b/input/test/beam-alternate.ly @@ -1,9 +1,10 @@ \header { - texidoc = "Meshing eighths beams, connected by ties. This occurs - in (for example) in the cello suites. See also - @file{tie-cross-voice.ly}." + texidoc = "The eighth notes may be seemingly attached to different + beams, and the corresponding notes connected by ties (see also + @file{tie-cross-voice.ly}). + Such a situation may occur, for example, in the cello suites." } diff --git a/input/test/beam-auto-4-8.ly b/input/test/beam-auto-4-8.ly index 8c1ce62cc6..19e050da12 100644 --- a/input/test/beam-auto-4-8.ly +++ b/input/test/beam-auto-4-8.ly @@ -3,7 +3,7 @@ % keep for now, although merging into beam-auto-override is a possibility. \header { texidoc = "@cindex Auto Beaming 4/8 -You can override LilyPond's automatic beaming. +You can override the automatic beaming settings. " } diff --git a/input/test/beam-auto-override.ly b/input/test/beam-auto-override.ly index fbaf2034d2..c9a6394f9e 100644 --- a/input/test/beam-auto-override.ly +++ b/input/test/beam-auto-override.ly @@ -4,18 +4,17 @@ texidoc = "@cindex Auto Beaming Override -This shows how auto-beaming settings can be overridden. - -The auto-beamer will only engrave beams that end when: +The auto-beamer, which can be overridden, will only engrave beams +that end before encountering of @itemize @bullet -@item a rest is encountered +@item a rest, @item - another beam (entered manually) is encountered + an other, manually entered beam, or @item - there's a 'gap' in the beam note's durations + a bar line. @end itemize -The beam will be ended also when now % beamAutoEnd = 0. +The @code{autoBeaming} can also be turned off. " diff --git a/input/test/beam-auto.ly b/input/test/beam-auto.ly index 98bce46685..16ed23e92f 100644 --- a/input/test/beam-auto.ly +++ b/input/test/beam-auto.ly @@ -2,7 +2,8 @@ \version "2.1.26" \header{ texidoc = "@cindex Beaming Presets -The auto-beam engraver has presets for common time signatures. " } +There are presets for the @code{auto-beam} engraver in the case of common +time signatures. " } \score{ \notes \relative c''{ diff --git a/input/test/beam-control.ly b/input/test/beam-control.ly index 21efde49c3..2f10efafbb 100644 --- a/input/test/beam-control.ly +++ b/input/test/beam-control.ly @@ -3,7 +3,7 @@ \header{ texidoc="@cindex Beam Position Control -Beam positions may be controlled manually, by setting @code{positions} in the @code{Beam} grob. +Beam positions may be controlled manually, by overriding the @code{positions} setting of the @code{Beam} grob. " } \score { diff --git a/input/test/beam-count.ly b/input/test/beam-count.ly index c61b5577e9..ee8f7ed7eb 100644 --- a/input/test/beam-count.ly +++ b/input/test/beam-count.ly @@ -3,8 +3,8 @@ \header{ texidoc="@cindex Beam Count -You can alter the number of stems in a beam. Here we see -two sets of four 32nds joined as if they were 8th notes. +You can alter the number of stems in a beam. In this example, +two sets of four 32nds are joined, as if they were 8th notes. " } @@ -12,10 +12,10 @@ fragment = \notes { #(override-auto-beam-setting '(end * * * *) 1 4) f32 g a b b a g f - f32 g a b + f32 g a \set stemRightBeamCount = #1 b - \set stemLeftBeamCount = #1 a - g f + \set stemLeftBeamCount = #1 b + a g f } diff --git a/input/test/beam-dir-functions.ly b/input/test/beam-dir-functions.ly index 9223bbfb15..177d926ccc 100644 --- a/input/test/beam-dir-functions.ly +++ b/input/test/beam-dir-functions.ly @@ -3,21 +3,21 @@ \header { texidoc = "@cindex Beam Dir Functions -There are several ways to calculate the direction of a beam: +The direction of a beam may be calculated in several ways. As shown in +the example, the beam are be below the notes if: @table @code @item majority -number count of up or down notes +of (individual) notes would have down stems, @item mean -mean center distance of all notes +of note pitches is on the center line or below it, or @item median -mean centre distance weighted per note +of note pithes (i.e. the centermost element of ordered pitches) is +on the center line or below it. @end table -You can spot the differences of these settings from these simple -examples: - -These beam direction functions are defined in @file{scm/beam.scm}. If -your favourite algorithm isn't one of these, you can hook up your own. +If your favourite algorithm is not one of these, you can hook up your +own one. +(These beam direction functions are defined in @file{scm/beam.scm}.) " } diff --git a/input/test/beam-isknee.ly b/input/test/beam-isknee.ly index abab8e01c0..e5844385ed 100644 --- a/input/test/beam-isknee.ly +++ b/input/test/beam-isknee.ly @@ -2,7 +2,7 @@ \version "2.1.26" \header{ texidoc="@cindex Beam Isknee -LilyPond can beam across a Piano Staff. +Beams can be placed across a \code{PianoStaff}. " } \score{ \context PianoStaff << diff --git a/input/test/beam-neutral-direction.ly b/input/test/beam-neutral-direction.ly index d8efd4d2c5..a4b13d1949 100644 --- a/input/test/beam-neutral-direction.ly +++ b/input/test/beam-neutral-direction.ly @@ -2,9 +2,8 @@ \version "2.1.26" \header{ texidoc="@cindex Beam Neutral Direction -When a beam falls in the middle of the staff, LilyPond normally -prints the beam pointing down. However, this behaviour can be -altered if desired. +When a beam falls in the middle of the staff, the beams point normally +down. However, this behaviour can be altered, if desired. " } fragment = \notes { diff --git a/input/test/beam-rest.ly b/input/test/beam-rest.ly index 2c2a1ea914..7a975ba21d 100644 --- a/input/test/beam-rest.ly +++ b/input/test/beam-rest.ly @@ -3,7 +3,7 @@ \header{ texidoc="@cindex Beam Over Rests -Beams over rests. +Beams may be forced to be over rests. " } \score{ diff --git a/input/test/blank-notes.ly b/input/test/blank-notes.ly index ad90f7252d..89cb23b0c1 100644 --- a/input/test/blank-notes.ly +++ b/input/test/blank-notes.ly @@ -7,10 +7,8 @@ \header { texidoc = "@cindex Invisible Notes @cindex Blank Notes -You can suppress printing of LilyPond output. This example shows you how to -print invisible (or blank) notes. This can be very useful when you want to -do wierd tricks with LilyPond (especially with slurs, since you can't attach -a slur to a rest or spacer rest). +Invisible (or transparent) can be useful, when wierd tricks are needed; +especially, a slur cannot be attach to a rest or spacer rest. " } blanknotes = { \override NoteHead #'transparent = ##t diff --git a/input/test/blank-paper-tab.ly b/input/test/blank-paper-tab.ly index f77a339d41..2d16dc9044 100644 --- a/input/test/blank-paper-tab.ly +++ b/input/test/blank-paper-tab.ly @@ -2,8 +2,9 @@ \header { texidoc = "@cindex Blank Paper Tab -Blank music paper, another example: empty staffs and a -tablature staff. " } +A blank music paper can be produced by using spacer rests, and removing +@code{Bar_number_engraver}. Here is an empty staff with a tablature staff. +" } emptymusic = \notes { \repeat unfold 4 { s1\break } \bar "|." } diff --git a/input/test/blank-paper.ly b/input/test/blank-paper.ly index 5c522f8a3c..aa836b0f05 100644 --- a/input/test/blank-paper.ly +++ b/input/test/blank-paper.ly @@ -2,7 +2,8 @@ \header { texidoc="@cindex Blank Paper -Blank music paper with clefs. Change the repeat count to get more staves. +A blank music paper can be produced also by using invisible notes, and removing +@code{Bar_number_engraver}. " } \score { diff --git a/input/test/boxed-molecule.ly b/input/test/boxed-molecule.ly index 057c6b225a..651653de44 100644 --- a/input/test/boxed-molecule.ly +++ b/input/test/boxed-molecule.ly @@ -3,7 +3,8 @@ \header { texidoc = "@cindex Boxed Stencil -You can override the print-function to draw a box around arbitrary grobs. " } +The @code{print-function} can be overridden to draw a box around an arbitrary +grob. " } \score { \notes \relative c'' {