Documentation/tex/lilypond-regtest.doc

   1 % -*-LaTeX-*-
   2 \documentclass{article}
   3
   4 \title{LilyPond feature test}
   5 \author{Han-Wen Nienhuys}
   6 \begin{document}
   7 \maketitle
   8
   9 This document tries give an brief overview of LilyPond features.  When
  10 the text correspond with the shown notation, we consider LilyPond
  11 Officially BugFree (tm).  This document is intended for finding bugs,
  12 and documenting bugfixes.
  13
  14 \section{Notes and rests}
  15
  16 Rests.  Note that the dot of 8th, 16th and 32nd rests rest should be
  17 next to the top of the rest.  All rests except the whole rest are
  18 centered on the middle staff line.
  19
  20 \mudelafile{rest.fly}
  21
  22 Note head shapes are settable.  The stem endings should be adjusted
  23 per note head.  If you want different note head styles on one stem,
  24 you must create a special context called Thread.
  25
  26 \mudelafile{noteheadstyle.ly}
  27
  28 Noteheads can have dots, and ---although this is bad style in duple
  29 meters--- rests can too.  Augmentation dots should never be printed on
  30 a staff line, but rather be shifted: down stem notes shift dots down,
  31 up stem up.  In case of chords, all dots should be in a column.  The
  32 dots go along as rests are shifted to avoid collisions.
  33
  34 \mudelafile{dots.fly}
  35
  36 Multiple measure rests do not collide with barlines and clefs.  They
  37 are not expanded when you set \verb+Score.SkipBars+.  Although the
  38 multi-measure-rest is a Spanner, minimum distances are set to keep it
  39 colliding from barlines.
  40
  41 \mudelafile{multi-measure-rest.ly}
  42
  43 \section{Stems}
  44
  45 Stem tremolos (official naming?) or rolls are tremolo signs that look
  46 like beam segments crossing stems.  If the stem is in a beam, the
  47 tremolo must be parallel to the beam.  If the stem is invisible
  48 (eg. on a whole note), the tremolo must be centered on the note.
  49
  50 \mudelafile{stem-tremolo.ly}
  51
  52 Beams, stems and noteheads often have communication troubles, since
  53 the two systems for y dimensions (1 unit = staffspace, 1 unit = 1
  54 point) are mixed.
  55
  56 Stems, beams, ties and slurs should behave similarly, when placed
  57 on the middle staff line. Of course stem-direction is down for high
  58 notes, and up for low notes.
  59
  60 \mudelafile{stem-direction.sly}
  61
  62 \section{Grace notes}
  63
  64 Grace notes are typeset as an encapsulated piece of music. You can
  65 have beams, notes, chords, stems etc. within a \verb|\grace| section.
  66 Slurs that start within a grace section, but aren't ended are attached
  67 to the next normal note.  Grace notes have zero duration.  If there
  68 are tuplets, the grace notes won't be under the brace.  Grace notes
  69 can have accidentals, but they are (currently) spaced at a fixed
  70 distance.  Grace notes (of course) come before the accidentals of the
  71 main note.  Grace notes can also be positioned after the main note.
  72
  73 \mudelafile{grace.ly}
  74
  75
  76 \section{Beams, slurs and other spanners}
  77
  78 Beaming is generated automatically. Beams may cross bar lines. In that
  79 case, line breaks are forbidden.  Yet clef and key signatures are
  80 hidden just as with breakable bar lines.
  81
  82 \mudelafile{beaming.ly}
  83
  84 %Beams should not interfere with various items on the staff (amongst
  85 %others repeat signs)
  86 %
  87 % \mud elafile{beam-repeat.ly}
  88
  89 Beams should behave reasonably well, even under extreme circumstances.
  90 Stems may be short, but noteheads should never touch the beam.
  91
  92 \mudelafile{beam-extreme.ly}
  93
  94 Beams should always reach the middle staff line, the second beam
  95 counting from the note head side, should never be lower than the
  96 second staff line.  This does not hold for grace note beams.
  97
  98 \mudelafile{beam-position.sly}
  99
 100 Slurs should look nice and symmetric.  The curvature may increase
 101 only to avoid noteheads, and as little as possible.
 102
 103 \mudelafile{slur-symmetry.ly}
 104 \mudelafile{slur-symmetry-1.ly}
 105
 106 Ties are strictly horizontal.  They are placed in between note heads.
 107 The horizontal middle should not overlap with a staffline.
 108
 109 \mudelafile{tie.ly}
 110
 111 Beams can be typeset over fixed distance aligned staffs, beam
 112 beautification doesn't really work, but knees do. Beams should be
 113 behave well, wherever the switching point is.
 114
 115 \mudelafile{beam-interstaff.ly}
 116
 117 The same goes for slurs. They behave decently when broken across
 118 linebreak.
 119
 120 \mudelafile{slur-interstaff.ly}
 121
 122 Tuplets are indicated by a bracket with a number.  There should be no
 123 bracket if there is one beam that matches  the length of the tuplet.
 124 The bracket does not interfere with the stafflines, and the number is
 125 centered in the gap in the bracket.
 126
 127 \mudelafile{tup.ly}
 128
 129 \section{Repeats}
 130
 131 LilyPond has three modes for repeats: folded, unfolded and
 132 semi-unfolded.  Unfolded repeats are fully written out. Semi unfolded
 133 repeats have the body written and all alternatives sequentially.
 134 Folded repeats have the body written and all alternatives
 135 simultaneously.  If the number of alternatives is larger than the
 136 repeat count, the excess alternatives are ignored.  If the number of
 137 alternatives is smaller, the first alternative is multiplied to get to
 138 the number of repeats.
 139
 140 Unfolded behavior:
 141
 142 \mudelafile{repeat-unfold.ly}
 143
 144 Semi (un)folded behavior.  Voltas can start on non-barline moments.
 145 If they don't barlines should still be shown.
 146
 147 \mudelafile{repeat-semifold.ly}
 148
 149 Folded.  This doesn't make sense without alternatives, but it works.
 150
 151 \mudelafile{repeat-fold.ly}
 152
 153 \section{Lyrics}
 154
 155 Lyrics can be set to a melody automatically.  Excess lyrics will be
 156 dumped.  Lyrics will not be set over rests.  You can have melismata by
 157 setting a property melismaBusy.  If you want a different order than
 158 first Music, then Lyrics, you must precook a chord of staffs/lyrics
 159 and label those.  Of course \verb+\rhythm+ ignores any other rhythms
 160 in the piece.  Hyphens and extenders do not assume anything about
 161 lyric lengths, so they continue to work.
 162
 163 \mudelafile{lyric-combine.ly}
 164
 165 \section{Multiple notes}
 166
 167 Rests should not collide with beams, stems and noteheads.  Rests may
 168 be under beams.  Rests should be move by integral number of spaces
 169 inside the staff, and by half spaces outside.  Notice that the half
 170 and whole rests just outside the staff get ledger lines in different
 171 cases.
 172
 173 \mudelafile{rest-collision.ly}
 174
 175 Normal collisions. We have support for four voice polyphony, where the
 176 middle voices are horizontally shifted in a limited number of cases.
 177
 178 \mudelafile{collisions.ly}
 179
 180 The number of stafflines of a staff can be set with the property
 181 numberOfStaffLines.  Ledger lines both on note heads and rests are
 182 adjusted.  Barlines also are adjusted.
 183
 184
 185 \mudelafile{number-staff-lines.fly}
 186
 187 \section{Spacing}
 188
 189 In a limited number of cases, LilyPond corrects for optical spacing
 190 effects.  In this example, space for opposite pointed stems is adjusted
 191
 192 \mudelafile{stem-spacing.sly}
 193
 194 Even if a line is very tightly spaced, there will still be room
 195 between prefatory matter and the following notes.  The space after the
 196 prefatory is very rigid.  In contrast, the space before the barline
 197 must stretch like the space within the measure.
 198
 199 Tight:
 200
 201 \mudelafile{spacing-tight.ly}
 202
 203 Natural:
 204
 205 \mudelafile{spacing-natural.ly}
 206
 207 Loose:
 208
 209 \mudelafile{spacing-loose.ly}
 210
 211
 212 \section{Global stuff}
 213
 214 Markings that are attached to (invisible) barlines are
 215 delicate: the are attached to the rest of the score without the score
 216 knowing it.  Consequently, they fall over  often.
 217
 218 \mudelafile{bar-scripts.ly}
 219
 220 Staff margins are also markings attached to barlines.  They should be
 221 left of the staff, and be centered vertically wrt the staff.  They may
 222 be on normal staffs, but also on compound staffs, like the PianoStaff
 223
 224 \mudelafile{staff-margin.ly}
 225
 226 Breathing signs, also used for phrasing, do normally not influence
 227 global spacing -- only if space gets tight, notes are shifted to make
 228 room for the breathing sign. Breathing signs break beams running
 229 through their voice. In the following example, the notes in the first
 230 two measures all have the same distance from each other:
 231
 232 \mudelafile{breathing-sign.ly}
 233
 234 Fonts are  available in a default set of sizes: 11, 13, 16, 20, 23 and
 235 26pt staffheight.  Sizes of the text fonts and symbol fonts are made
 236 to match the staff dimensions.
 237
 238 \mudelafile{size11.ly}
 239
 240 \mudelafile{size13.ly}
 241
 242 \mudelafile{size16.ly}
 243
 244 \mudelafile{size20.ly}
 245
 246 \mudelafile{size23.ly}
 247
 248 \mudelafile{size26.ly}
 249
 250
 251 \section{Clefs and Time Signatures}
 252
 253 The transparent clef should not occupy any space and with style
 254 \texttt{fullSizeChanges}, the changing clef should be typeset in full
 255 size. For octaviated clefs, the ``8'' should appear closely above or
 256 below the clef respectively.  The ``8'' is processed in a convoluted
 257 way, so this is fragile as well.
 258
 259 \mudelafile{clefs.ly}
 260
 261 \def\bla#1{%the input file is too long and does not test for specific bugs
 262 By default, time signatures are written with two numbers. With style
 263 ``C'', 4/4 and 2/2 are written with their corresponding symbols and
 264 with style ``old'', 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8 and
 265 9/8 are typeset with symbols, all other signatures retain the default
 266 layout. The style ``1'', gives single number signatures for all
 267 signatures.
 268 %
 269 \mu delafile{time.fly}
 270 }
 271 \end{document}