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
  53
  54
  55
  56 \mudelafile{grace.ly}
  57
  58
  59 \section{Beams, slurs and other spanners}
  60
  61 Beaming is generated automatically. Beams may cross bar lines. In that
  62 case, line breaks are forbidden.  Yet clef and key signatures are
  63 hidden just as with breakable bar lines.
  64
  65 \mudelafile{beaming.ly}
  66
  67 %Beams should not interfere with various items on the staff (amongst
  68 %others repeat signs)
  69 %
  70 % \mud elafile{beam-repeat.ly}
  71
  72 Beams can be typeset over fixed distance aligned staffs, beam
  73 beautification doesn't really work, but knees do. Beams should be
  74 behave well, wherever the switching point is.
  75
  76 \mudelafile{beam-interstaff.ly}
  77
  78 The same goes for slurs. They behave decently when broken across
  79 linebreak.
  80
  81 \mudelafile{slur-interstaff.ly}
  82
  83 Tuplets are indicated by a bracket with a number.  There should be no
  84 bracket if there is one beam that matches  the length of the tuplet.
  85 The bracket does not interfere with the stafflines, and the number is
  86 centered in the gap in the bracket.
  87
  88 \mudelafile{tup.ly}
  89
  90 \section{Repeats}
  91
  92 LilyPond has three modes for repeats: folded, unfolded and
  93 semi-unfolded.  Unfolded repeats are fully written out. Semi unfolded
  94 repeats have the body written and all alternatives sequentially.
  95 Folded repeats have the body written and all alternatives
  96 simultaneously.  If the number of alternatives is larger than the
  97 repeat count, the excess alternatives are ignored.  If the number of
  98 alternatives is smaller, the first alternative is multiplied to get to
  99 the number of repeats.
 100
 101 Unfolded behavior:
 102
 103 \mudelafile{repeat-unfold.ly}
 104
 105 Semi (un)folded behavior.  Voltas can start on non-barline moments.
 106
 107 \mudelafile{repeat-semifold.ly}
 108
 109 Folded.  This doesn't make sense without alternatives, but it works.
 110
 111 \mudelafile{repeat-fold.ly}
 112
 113 \section{Multiple notes}
 114
 115 Rests should not collide with beams, stems and noteheads.  Rests may
 116 be under beams.  Rests should be move by integral number of spaces
 117 inside the staff, and by half spaces outside.  Notice that the half
 118 and whole rests just outside the staff get ledger lines in different
 119 cases.
 120
 121 \mudelafile{rest-collision.ly}
 122
 123 Normal collisions. We have support for four voice polyphony, where the
 124 middle voices are horizontally shifted in a limited number of cases.
 125
 126 \mudelafile{collisions.ly}
 127
 128 The number of stafflines of a staff can be set with the property
 129 numberOfStaffLines.  Ledger lines both on note heads and rests are
 130 adjusted.  Barlines also are adjusted.
 131
 132
 133 \mudelafile{number-staff-lines.fly}
 134
 135 \section{Spacing}
 136
 137 In a limited number of cases, LilyPond corrects for optical spacing
 138 effects.  In this example, space for opposite pointed stems is adjusted
 139
 140 \mudelafile{stem-spacing.sly}
 141
 142 \section{Global stuff}
 143
 144 Markings that are attached to (invisible) barlines are
 145 delicate: the are attached to the rest of the score without the score
 146 knowing it.  Consequently, they fall over  often.
 147
 148 \mudelafile{bar-scripts.ly}
 149
 150 Staff margins are also markings attached to barlines.  They should be
 151 left otf the staff, and be centered vertically wrt the staff.  They
 152 may be on normal staffs, but also on compound staffs, like the
 153 PianoStaff
 154
 155 \mudelafile{staff-margin.ly}
 156
 157 Breathing signs, also used for phrasing, do normally not influence
 158 global spacing -- only if space gets tight, notes are shifted to make
 159 room for the breathing sign. Breathing signs break beams running
 160 through their voice. In the following example, the notes in the first
 161 two measures all have the same distance from each other:
 162
 163 \mudelafile{breathing-sign.ly}
 164
 165
 166 \section{Clefs and Time Signatures}
 167
 168 The transparent clef should not occupy any space and with style
 169 \texttt{fullSizeChanges}, the changing clef should be typeset in full
 170 size. For octaviated clefs, the ``8'' should appear closely above or
 171 below the clef respectively.  The ``8'' is processed in a rather
 172 convoluted way, so this is fragile as well.
 173
 174 \mudelafile{clefs.ly}
 175
 176 By default, time signatures are written with two numbers. With style
 177 ``C'', 4/4 and 2/2 are written with their corresponding symbols and
 178 with style ``old'', 2/2, 3/2, 3/4, 4/4, 6/4, 9/4, 6/8 and 9/8 are
 179 typeset with symbols, all other signatures retain the default layout.
 180 The style ``1'', gives single number signatures for all signatures.
 181
 182 \mudelafile{time.fly}
 183
 184 \end{document}