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).
  12
  13 \section{Notes and rests}
  14
  15 Rests.  Note that the dot of 8th, 16th and 32nd rests rest should be
  16 next to the top of the rest.  All rests except the whole rest are
  17 centered on the middle staff line.
  18
  19 \mudelafile{rest.fly}
  20
  21 Note head shapes are settable.  The stem endings should be adjusted
  22 per note head.  If you want different note head styles on one stem,
  23 you must create a special context called Thread.
  24
  25 \mudelafile{noteheadstyle.ly}
  26
  27 Multiple measure rests do not collide with barlines and clefs.  They
  28 are not expanded when you set \verb+Score.SkipBars+.  Although the
  29 multi-measure-rest is a Spanner, minimum distances are set to keep it
  30 colliding from barlines.
  31
  32 \mudelafile{multi-measure-rest.ly}
  33
  34 \section{Stems}
  35
  36 Stem tremolos (official naming?) or rolls are tremolo signs that look
  37 like beam segments crossing stems.  If the stem is in a beam, the
  38 tremolo must be parallel to the beam.  If the stem is invisible
  39 (eg. on a whole note), the tremolo must be centered on the note.
  40
  41 \mudelafile{stem-tremolo.ly}
  42
  43 Beams, stems and noteheads often have communication troubles, since
  44 the two systems for y dimensions (1 unit = staffspace, 1 unit = 1
  45 point) are mixed.
  46
  47 \section{Grace notes}
  48
  49 Grace notes are typeset as an encapsulated piece of music. You can
  50 have beams, notes, chords, stems etc. within a \verb|\grace|
  51 section. Slurs that start within a grace section, but aren't ended are
  52 attached to the next normal note.  Grace notes have zero duration.  If
  53 there are tuplets, the grace notes won't be under the brace.
  54
  55
  56
  57 \mudelafile{grace.ly}
  58
  59
  60 \section{Beams, slurs and other spanners}
  61
  62 Beaming is generated automatically. Beams may cross bar lines. In that
  63 case, line breaks are forbidden.  Yet clef and key signatures are
  64 hidden just as with breakable bar lines.
  65
  66 \mudelafile{beaming.ly}
  67
  68 %Beams should not interfere with various items on the staff (amongst
  69 %others repeat signs)
  70 %
  71 % \mud elafile{beam-repeat.ly}
  72
  73 Beams should behave reasonably well, even under extreme circumstances.
  74 Stems may be short, but noteheads should never touch the beam.
  75
  76 \mudelafile{beam-extreme.ly}
  77
  78 Slurs should look nice and symmetric.  The curvature may increase
  79 only to avoid noteheads, and as little as possible.
  80
  81 \mudelafile{slur-symmetry.ly}
  82 \mudelafile{slur-symmetry-1.ly}
  83
  84 Ties are strictly horizontal.  They are placed in between note heads.
  85 The horizontal middle should not overlap with a staffline.
  86
  87 \mudelafile{tie.ly}
  88
  89 Beams can be typeset over fixed distance aligned staffs, beam
  90 beautification doesn't really work, but knees do. Beams should be
  91 behave well, wherever the switching point is.
  92
  93 \mudelafile{beam-interstaff.ly}
  94
  95 The same goes for slurs. They behave decently when broken across
  96 linebreak.
  97
  98 \mudelafile{slur-interstaff.ly}
  99
 100 Tuplets are indicated by a bracket with a number.  There should be no
 101 bracket if there is one beam that matches  the length of the tuplet.
 102 The bracket does not interfere with the stafflines, and the number is
 103 centered in the gap in the bracket.
 104
 105 \mudelafile{tup.ly}
 106
 107 \section{Repeats}
 108
 109 LilyPond has three modes for repeats: folded, unfolded and
 110 semi-unfolded.  Unfolded repeats are fully written out. Semi unfolded
 111 repeats have the body written and all alternatives sequentially.
 112 Folded repeats have the body written and all alternatives
 113 simultaneously.  If the number of alternatives is larger than the
 114 repeat count, the excess alternatives are ignored.  If the number of
 115 alternatives is smaller, the first alternative is multiplied to get to
 116 the number of repeats.
 117
 118 Unfolded behavior:
 119
 120 \mudelafile{repeat-unfold.ly}
 121
 122 Semi (un)folded behavior.  Voltas can start on non-barline moments.
 123
 124 \mudelafile{repeat-semifold.ly}
 125
 126 Folded.  This doesn't make sense without alternatives, but it works.
 127
 128 \mudelafile{repeat-fold.ly}
 129
 130 \section{Multiple notes}
 131
 132 Rests should not collide with beams, stems and noteheads.  Rests may
 133 be under beams.  Rests should be move by integral number of spaces
 134 inside the staff, and by half spaces outside.  Notice that the half
 135 and whole rests just outside the staff get ledger lines in different
 136 cases.
 137
 138 \mudelafile{rest-collision.ly}
 139
 140 Normal collisions. We have support for four voice polyphony, where the
 141 middle voices are horizontally shifted in a limited number of cases.
 142
 143 \mudelafile{collisions.ly}
 144
 145 The number of stafflines of a staff can be set with the property
 146 numberOfStaffLines.  Ledger lines both on note heads and rests are
 147 adjusted.  Barlines also are adjusted.
 148
 149
 150 \mudelafile{number-staff-lines.fly}
 151
 152 \section{Spacing}
 153
 154 In a limited number of cases, LilyPond corrects for optical spacing
 155 effects.  In this example, space for opposite pointed stems is adjusted
 156
 157 \mudelafile{stem-spacing.sly}
 158
 159 \section{Global stuff}
 160
 161 Markings that are attached to (invisible) barlines are
 162 delicate: the are attached to the rest of the score without the score
 163 knowing it.  Consequently, they fall over  often.
 164
 165 \mudelafile{bar-scripts.ly}
 166
 167 Staff margins are also markings attached to barlines.  They should be
 168 left otf the staff, and be centered vertically wrt the staff.  They
 169 may be on normal staffs, but also on compound staffs, like the
 170 PianoStaff
 171
 172 \mudelafile{staff-margin.ly}
 173
 174 Breathing signs, also used for phrasing, do normally not influence
 175 global spacing -- only if space gets tight, notes are shifted to make
 176 room for the breathing sign. Breathing signs break beams running
 177 through their voice. In the following example, the notes in the first
 178 two measures all have the same distance from each other:
 179
 180 \mudelafile{breathing-sign.ly}
 181
 182
 183 \section{Clefs and Time Signatures}
 184
 185 The transparent clef should not occupy any space and with style
 186 \texttt{fullSizeChanges}, the changing clef should be typeset in full
 187 size. For octaviated clefs, the ``8'' should appear closely above or
 188 below the clef respectively.  The ``8'' is processed in a rather
 189 convoluted way, so this is fragile as well.
 190
 191 \mudelafile{clefs.ly}
 192
 193 By default, time signatures are written with two numbers. With style
 194 ``C'', 4/4 and 2/2 are written with their corresponding symbols and
 195 with style ``old'', 2/2, 3/2, 3/4, 4/4, 6/4, 9/4, 6/8 and 9/8 are
 196 typeset with symbols, all other signatures retain the default layout.
 197 The style ``1'', gives single number signatures for all signatures.
 198
 199 \mudelafile{time.fly}
 200
 201 \end{document}