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