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