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