]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/user/refman.itely
fc846f99ceb4ee9523ace4b3a1957249b87a8348
[lilypond.git] / Documentation / user / refman.itely
1 @c Note: -*-texinfo-*-
2 @c
3 @c A menu is needed before every deeper *section nesting of @node's; run
4 @c     M-x texinfo-all-menus-update
5 @c to automagically fill in these menus before saving changes
6 @c
7 @c FIXME: singular vs. plural:  Beams/Beam
8
9
10 @node Reference Manual
11 @chapter Reference Manual
12
13 @html
14 <!--- @@WEB-TITLE@@=Reference Manual --->
15 @end html
16
17
18 This document describes GNU LilyPond and its input format. The last
19 revision of this document was made for LilyPond 1.7.10.  It assumes
20 that you already know a little bit about LilyPond input (how to
21 make an input file, how to create sheet music from that input file,
22 etc).  New users are encouraged to study the tutorial before reading
23 this manual.
24
25 @menu
26 * Note entry::                  
27 * Easier music entry::          
28 * Staff notation::              
29 * Polyphony::                   
30 * Beaming::                     
31 * Accidentals::                 
32 * Expressive marks::            
33 * Ornaments::                   
34 * Repeats::                     
35 * Rhythmic music::              
36 * Piano music::                 
37 * Vocal music::                 
38 * Tablatures::                  
39 * Chords::                      
40 * Writing parts::               
41 * Ancient notation ::           
42 * Contemporary notation::       
43 * Tuning output::               
44 * Global layout::               
45 * Sound::                       
46 @end menu
47
48 @c FIXME: Note entry vs Music entry at top level menu is confusing.
49
50 @node Note entry
51 @section Note entry
52 @cindex Note entry
53
54 Notes constitute the most basic elements of LilyPond input, but they do
55 not form valid input on their own without a @code{\score} block.  However,
56 for the sake of brevity and simplicity we will generally omit
57 @code{\score} blocks and @code{\paper} declarations in this manual.
58
59
60 @menu
61 * Notes::                       
62 * Pitches::                     
63 * Chromatic alterations::       
64 * Rests::                       
65 * Skips::                       
66 * Durations::                   
67 * Ties::                        
68 * Automatic note splitting ::   
69 * Tuplets::                     
70 * Easy Notation note heads ::   
71 @end menu
72
73
74 @node Notes
75 @subsection Notes
76
77
78 A note is printed by specifying its pitch and then its duration.
79 @lilypond[fragment,verbatim]
80   cis'4 d'8 e'16 c'16
81 @end lilypond
82
83
84 @node Pitches
85 @subsection Pitches
86
87 @cindex Pitch names
88 @cindex Note specification
89 @cindex pitches
90 @cindex entering notes
91
92 The verbose syntax for pitch specification is
93
94 @cindex @code{\pitch}
95 @example
96   \pitch @var{scmpitch}
97 @end example
98
99 where @var{scmpitch} is a pitch scheme object.
100
101 In Note and Chord mode, pitches may be designated by names.  The
102 default names are the Dutch note names.  The notes are specified by
103 the letters @code{a} through @code{g}, while the octave is formed with
104 notes ranging from @code{c} to @code{b}.  The pitch @code{c} is an
105 octave below middle C and the letters span the octave above that C.
106
107 @lilypond[fragment,verbatim]
108 \clef bass
109   a,4 b, c d e f g a b c' d' e' \clef treble f' g' a' b' c''
110 @end lilypond
111
112 @cindex note names, Dutch
113
114 In Dutch, a sharp is formed by adding @code{-is} to the end of a pitch
115 name and a flat is formed by adding @code{-es}.  Double sharps and
116 double flats are obtained by adding @code{-isis} or @code{-eses}.
117 @code{aes} is contracted to @code{as} in Dutch, but both forms are
118 accepted. Similarly, both @code{es} and @code{ees} are accepted.
119
120 There are predefined sets of note names for various other languages.
121 To use them,  include the language specific init file.  For
122 example: @code{\include "english.ly"}.  The available language files
123 and the note names they define are:
124
125 @anchor{note name}
126 @anchor{note names}
127 @example 
128                         Note Names               sharp       flat
129 nederlands.ly  c   d   e   f   g   a   bes b   -is         -es
130 english.ly     c   d   e   f   g   a   bf  b   -s/-sharp   -f/-flat
131 deutsch.ly     c   d   e   f   g   a   b   h   -is         -es
132 norsk.ly       c   d   e   f   g   a   b   h   -iss/-is    -ess/-es
133 svenska.ly     c   d   e   f   g   a   b   h   -iss        -ess
134 italiano.ly    do  re  mi  fa  sol la  sib si  -d          -b
135 catalan.ly     do  re  mi  fa  sol la  sib si  -d/-s       -b 
136 espanol.ly     do  re  mi  fa  sol la  sib si  -s          -b 
137
138 @end example 
139
140 @cindex @code{'}
141 @cindex @code{,}
142
143
144
145 The optional octave specification takes the form of a series of
146 single quote (`@code{'}') characters or a series of comma
147 (`@code{,}') characters.  Each @code{'} raises the pitch by one
148 octave; each @code{,} lowers the pitch by an octave.
149
150 @lilypond[fragment,verbatim,center]
151   c' c'' es' g' as' gisis' ais'  
152 @end lilypond
153
154 @node Chromatic alterations
155 @subsection Chromatic alterations
156
157 Normally accidentals are printed automatically, but you may also
158 print them manually.  A reminder accidental
159 @cindex reminder accidental
160 @cindex @code{?}
161 can be forced by adding an exclamation mark @code{!}
162 after the pitch.  A cautionary accidental
163 @cindex cautionary accidental
164 @cindex parenthesized accidental
165 (an accidental within parentheses) can be obtained by adding the
166 question mark `@code{?}' after the pitch.
167
168 @lilypond[fragment,verbatim]
169   cis' cis' cis'! cis'?
170 @end lilypond
171
172
173 The automatic production of accidentals can be tuned in many
174 ways. For more information, refer to @ref{Accidentals}.
175
176
177 @node  Rests
178 @subsection Rests
179 @cindex Rests
180
181 Rests are entered like notes, with the note name @code{r}.
182
183 @lilypond[singleline,verbatim]
184 r1 r2 r4 r8
185 @end lilypond
186
187 Whole bar rests, centered in middle of the bar, are specified using
188 @code{R} (capital R); see @ref{Multi measure rests}.  See also
189 @seeinternals{Rest}.
190
191 For some music, you may wish to explicitly specify the rest's vertical
192 position.  This can be achieved by entering a note with the @code{\rest}
193 keyword appended. Rest collision testing will leave these rests alone.
194
195 @lilypond[singleline,verbatim]
196 a'4\rest d'4\rest
197 @end lilypond
198
199
200
201 @c FIXME: naming.
202 @node Skips
203 @subsection Skips
204 @cindex Skip
205 @cindex Invisible rest
206 @cindex Space note
207
208 An invisible rest (also called a `skip') can be entered like a note
209 with note name `@code{s}' or with @code{\skip @var{duration}}:
210
211 @lilypond[singleline,verbatim]
212 a2 s4 a4 \skip 1 a4 
213 @end lilypond
214
215  The @code{s} syntax is only available in Note mode and Chord
216 mode.  In other situations, you should use the @code{\skip} command,
217 which will work outside of those two modes:
218
219 @lilypond[singleline,verbatim]
220 \score {
221   \context Staff <
222     { \time 4/8 \skip 2 \time 4/4 } 
223     \notes\relative c'' { a2 a1 }
224   >
225 }
226 @end lilypond
227
228 The skip command is merely an empty musical placeholder.  It does not
229 produce any output, not even transparent output.
230
231
232
233
234 @node Durations
235 @subsection Durations
236
237
238 @cindex duration
239 @cindex @code{\duration}
240
241
242 In Note, Chord, and Lyrics mode, durations are designated by numbers
243 and dots: durations are entered as their reciprocal values.  For example,
244 a quarter note is entered using a @code{4} (since it is a 1/4 note), while
245 a half note is entered using a @code{2} (since it is a 1/2 note).  For notes
246 longer than a whole you must use identifiers.
247 @c FIXME: what is an identifier?  I do not think it's been introduced yet.
248 @c and if it has, I obviously skipped that part.     - Graham
249
250 @example 
251 c'\breve  
252 c'1 c'2 c'4 c'8 c'16 c'32 c'64 c'64 
253 r\longa r\breve  
254 r1 r2 r4 r8 r16 r32 r64 r64 
255 @end example 
256
257 @lilypond[noindent]
258 \score {
259   \notes \relative c'' {
260     a\breve  \autoBeamOff
261     a1 a2 a4 a8 a16 a32 a64 a64 
262     r\longa r\breve  
263     r1 r2 r4 r8 r16 r32 r64 r64 
264   }
265   \paper {
266     \translator {
267       \StaffContext
268         \remove "Clef_engraver"
269         \remove "Staff_symbol_engraver"
270         \remove "Time_signature_engraver"
271         \consists "Pitch_squash_engraver"
272     }
273   }
274 }
275 @end lilypond
276
277
278 If the duration is omitted then it is set to the previously entered
279 duration. Default for the first note is a quarter note.  The duration
280 can be followed by dots (`@code{.}') in order to obtain dotted note
281 lengths:
282 @cindex @code{.}
283
284 @lilypond[fragment,verbatim,center]
285   a' b' c''8 b' a'4 a'4. b'4.. c'8.
286 @end lilypond
287 @cindex @code{r}
288 @cindex @code{s}
289
290 You can alter the length of duration by a fraction @var{N/M}
291 appending `@code{*}@var{N/M}' (or `@code{*}@var{N}' if @var{M=1}). This
292 will not affect the appearance of the notes or rests produced.
293
294 @lilypond[fragment,verbatim]
295   a'2*2 b'4*2 a'8*4 a'4*3/2 gis'4*3/2 a'4*3/2 a'4
296 @end lilypond
297
298 Durations can also be produced through GUILE extension mechanism. 
299 @lilypond[verbatim,fragment]
300  c'\duration #(ly:make-duration 2 1)
301 @end lilypond
302
303
304 @refbugs
305
306 Dot placement for chords is not perfect.  In some cases, dots overlap:
307 @lilypond[]
308  <<f, c'' d e f>>4.
309 @end lilypond
310
311
312 @node Ties
313 @subsection Ties
314
315 @cindex Tie
316 @cindex ties
317 @cindex @code{~}
318
319 A tie connects two adjacent note heads of the same pitch.  The tie in
320 effect extends the length of a note.  Ties should not be confused with
321 slurs, which indicate articulation, or phrasing slurs, which indicate
322 musical phrasing.  A tie is entered using the tilde symbol `@code{~}'.
323
324 @lilypond[fragment,verbatim,center]
325   e' ~ e' <<c' e' g'>> ~ <<c' e' g'>>
326 @end lilypond
327
328 When a tie is applied to a chord, all note heads (whose pitches match) are
329 connected.  If you try to tie together chords that have no common pitches,
330 no ties will be created.
331
332 In its meaning a tie is just a way of extending a note duration, similar
333 to the augmentation dot: the following example are two ways of notating
334 exactly the same concept.
335 @c
336 @lilypond[fragment, singleline,quote]
337 \time 3/4 c'2. c'2 ~ c'4
338 @end lilypond
339 If you need to tie notes over bars, it may be easier to use automatic
340 note splitting (See @ref{Automatic note splitting}).
341
342
343 @seealso 
344
345 @seeinternals{Tie}, @ref{Automatic note splitting}. If you want less
346 ties created for a chord, see @inputfileref{input/test/,tie-sparse.ly}.
347
348 @refbugs
349
350 Tieing only a subset of the note heads of a pair of chords is not
351 supported in a simple way.  It can be achieved by moving the
352 tie-engraver into the @internalsref{Thread} context and turning on and
353 off ties per @internalsref{Thread}.
354
355 Switching staves when a tie is active, will produce a horizontal tie
356 on the first note.
357
358
359 Formatting of ties is a difficult subject. LilyPond often does not
360 give optimal results.
361
362
363
364 @node Automatic note splitting 
365 @subsection Automatic note splitting
366 @c FIXME: This subsection does not belong in @ref{Note entry}.
367
368 LilyPond can automatically converting long notes to tied notes.  This
369 is done by replacing the @code{Note_heads_engraver} by the
370 @code{Completion_heads_engraver}. 
371
372 @lilypond[verbatim,noindent]
373 \score{
374   \notes\relative c'{ \time 2/4
375   c2. c8 d4 e f g a b c8 c2 b4 a g16 f4 e d c8. c2 
376   }
377   \paper{ \translator{
378       \ThreadContext
379       \remove "Note_heads_engraver"
380       \consists "Completion_heads_engraver"
381   } } }
382 @end lilypond
383
384 This engraver splits all running notes at the bar line, and inserts
385 ties.  One of its uses is to debug complex scores: if the measures are
386 not entirely filled, then the ties exactly show how much each measure
387 is off.
388
389 @refbugs
390
391 Not all durations (especially those containing tuplets) can be
392 represented exactly; the engraver will not insert tuplets. 
393
394 @node Tuplets
395 @subsection Tuplets
396
397 @cindex tuplets
398 @cindex triplets
399 @cindex @code{\times}
400
401 Tuplets are made out of a music expression by multiplying all durations
402 with a fraction.
403
404 @cindex @code{\times}
405 @example
406   \times @var{fraction} @var{musicexpr}
407 @end example
408
409 The duration of @var{musicexpr} will be multiplied by the fraction. 
410 In the sheet music, the fraction's denominator will be printed over
411 the notes, optionally with a bracket.  The most common tuplet is the
412 triplet in which 3 notes have the length of 2, so the notes are 2/3
413 of their written length:
414
415 @lilypond[fragment,verbatim,center]
416   g'4 \times 2/3 {c'4 c' c'} d'4 d'4
417 @end lilypond
418
419 The property @code{tupletSpannerDuration} specifies how long each bracket
420 should last.  With this, you can make lots of tuplets while typing
421 @code{\times} only once, saving you lots of typing.
422
423 @lilypond[fragment,  relative, singleline, verbatim]
424 \property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
425 \times 2/3 { c'8 c c c c c }
426 @end lilypond
427
428 The format of the number is determined by the property
429 @code{tupletNumberFormatFunction}.  The default prints only the
430 denominator, but if you set it to the Scheme function
431 @code{fraction-tuplet-formatter}, Lilypond will print @var{num}:@var{den}
432 instead.
433
434
435 @cindex @code{tupletNumberFormatFunction}
436 @cindex tuplet formatting 
437
438 See also @seeinternals{TupletBracket}.
439
440 @refbugs
441
442 Nested tuplets are not formatted automatically.  In this case, outer
443 tuplet brackets should be moved manually.
444
445 @node Easy Notation note heads 
446 @subsection Easy Notation note heads
447
448 @cindex easy notation
449 @cindex Hal Leonard
450
451 The "easyplay" note head includes a note name inside the head.  It is
452 used in music aimed at beginners.
453
454 @lilypond[singleline,verbatim,26pt]
455 \score {
456   \notes { c'2 e'4 f' | g'1 }
457   \paper { \translator { \EasyNotation } } 
458 }
459 @end lilypond
460
461 The @code{EasyNotation} identifier overrides a @internalsref{Score}
462 context.  You probably will want to print it with magnification or a
463 large font size to make it more readable.  To print with
464 magnification, you must create a DVI file (with @file{ly2dvi}) and
465 then enlarge it with something like @file{dvips -x 2000 file.dvi}.
466 See @file{man dvips} for details.  To print with a larger font, see
467 @ref{Font Size}.
468
469
470 @cindex Xdvi
471 @cindex ghostscript
472
473 If you view the result with Xdvi, then staff lines will show through
474 the letters.  Printing the PostScript file obtained with ly2dvi does
475 produce the correct result.
476
477
478 @node Easier music entry
479 @section Easier music entry
480 @cindex Music entry
481 @menu
482 * Relative octaves::            
483 * Bar check::                   
484 * Skipping corrected music::    
485 @end menu
486
487 When entering music with LilyPond, it is easy to introduce
488 errors. This section deals with tricks and features that help you
489 enter music, and find and correct mistakes.  It is also possible to
490 use external programs to enter or edit music. Refer to the website for
491 more information.
492
493
494
495 @node Relative octaves
496 @subsection Relative octaves
497 @cindex Relative
498 @cindex relative octave specification
499
500 Octaves are specified by adding @code{'} and @code{,} to pitch names.
501 When you copy existing music, it is easy to accidentally put a pitch in
502 the wrong octave and hard to find such an error.  To prevent these
503 errors, LilyPond features octave entry.
504
505 @cindex @code{\relative}
506 @example
507   \relative @var{startpitch} @var{musicexpr}
508 @end example
509
510 The octave of notes that appear in @var{musicexpr} are calculated as
511 follows: If no octave changing marks are used, the basic interval
512 between this and the last note is always taken to be a fourth or less
513 (This distance is determined without regarding alterations; a
514 @code{fisis} following a @code{ceses} will be put above the
515 @code{ceses})
516
517 The octave changing marks @code{'} and @code{,} can be added to raise or
518 lower the pitch by an extra octave.  Upon entering relative mode, an
519 absolute starting pitch must be specified that will act as the
520 predecessor of the first note of @var{musicexpr}.
521
522 Entering music that changes octave frequently  is easy in relative mode.
523 @lilypond[fragment,singleline,verbatim,center]
524   \relative c'' {
525     b c d c b c bes a 
526   }
527 @end lilypond
528
529 And octave changing marks are used for intervals greater than a fourth.
530 @lilypond[fragment,verbatim,center]
531   \relative c'' {
532     c g c f, c' a, e'' }
533 @end lilypond
534
535 If the preceding item is a chord, the first note of the chord is used
536 to determine the first note of the next chord. However, other notes
537 within the second chord are determined by looking at the immediately
538 preceding note.
539
540 @lilypond[fragment,verbatim,center]
541   \relative c' {
542     c <<c e g>> 
543     <<c' e g>>
544     <<c, e' g>>
545   }
546 @end lilypond 
547 @cindex @code{\notes}
548
549 The pitch after the @code{\relative} contains a note name.  To parse
550 the pitch as a note name, you have to be in note mode, so there must
551 be a surrounding @code{\notes} keyword (which is not
552 shown here).
553
554 The relative conversion will not affect @code{\transpose},
555 @code{\chords} or @code{\relative} sections in its argument.  If you
556 want to use relative within transposed music, you must place an
557 additional @code{\relative} inside the @code{\transpose}.
558
559
560 @node Bar check
561 @subsection Bar check
562 @cindex Bar check
563
564 @cindex bar check
565 @cindex @code{barCheckSynchronize}
566 @cindex @code{|}
567
568
569 Whenever a bar check is encountered during interpretation, a warning
570 message is issued if it does not fall at a measure boundary.  This can
571 help you find errors in the input.  Depending on the value of
572 @code{barCheckSynchronize}, the beginning of the measure will be
573 relocated, so this can also be used to shorten measures.
574
575 A bar check is entered using the bar symbol, `@code{|}'.
576 @example
577   \time 3/4 c2 e4 | g2.
578 @end example
579
580
581
582 @cindex skipTypesetting
583
584 Failed bar checks are caused by entering incorrect
585 durations. Incorrect durations often completely garble up the score,
586 especially if it is polyphonic, so you should start correcting the
587 score by scanning for failed bar checks and incorrect durations.  To
588 speed up this process, you can use @code{skipTypesetting}, described
589 in the next section.
590
591 @node Skipping corrected music
592 @subsection Skipping corrected music
593
594 The property @code{Score.skipTypesetting} can be used to switch on and
595 off typesetting completely during the interpretation phase. When
596 typesetting is switched off, the music is processed much more quickly.
597 You can use this to skip over the parts of a score that you have already
598 checked for errors. 
599
600 @lilypond[fragment,singleline,verbatim]
601 \relative c'' { c8 d
602 \property Score.skipTypesetting = ##t
603   e f g a g c, f e d
604 \property Score.skipTypesetting = ##f
605 c d b bes a g c2 } 
606 @end lilypond
607
608
609
610
611 @node Staff notation
612 @section Staff notation
613
614 This section deals with music notation that occurs on staff level,
615 such as keys, clefs and time signatures.
616
617 @cindex Staff notation
618
619 @menu
620 * Staff symbol::                
621 * Key signature::               
622 * Clef::                        
623 * Time signature::              
624 * Unmetered music::             
625 * Bar lines::                   
626 @end menu
627
628 @node Staff symbol
629 @subsection Staff symbol
630
631 @cindex adjusting staff symbol
632 @cindex StaffSymbol, using \property
633 @cindex staff lines, setting number of
634
635 Staff is a the general name for Notes, dynamic signs, etc. are grouped
636 with a set of horizontal lines, into a staff (plural `staves'). In our
637 system, these lines are drawn using a separate graphical object called
638 staff symbol.  
639
640 This object is created whenever a @internalsref{Staff} context is
641 created.  You can not change the appearance of the staff symbol by
642 using @code{\override} or @code{\set}.  At the moment that
643 @code{\property Staff} is interpreted, a Staff context is made, and
644 the @internalsref{StaffSymbol} is created before any @code{\override} is
645 effective. You can deal with this either overriding properties in a
646 @code{\translator} definition, or by using @code{\outputproperty}.
647
648 @refbugs
649
650 If you end a staff halfway a piece, the staff symbol may not end
651 exactly on the barline.
652
653
654 @node Key signature
655 @subsection Key signature
656 @cindex Key
657
658 @cindex @code{\key}
659
660 The key signature indicates the scale in which a piece is played. It
661 is denoted by a set of alterations (flats or sharps) at the start of
662 the staff.
663
664 @syntax
665
666 Setting or changing the key signature is done with the @code{\key}
667 command.
668 @example
669   @code{\key} @var{pitch} @var{type}
670 @end example
671
672 @cindex @code{\minor}
673 @cindex @code{\major}
674 @cindex @code{\minor}
675 @cindex @code{\ionian}
676 @cindex @code{\locrian}
677 @cindex @code{\aeolian}
678 @cindex @code{\mixolydian}
679 @cindex @code{\lydian}
680 @cindex @code{\phrygian}
681 @cindex @code{\dorian}
682
683 Here, @var{type} should be @code{\major} or @code{\minor} to get
684 @var{pitch}-major or @var{pitch}-minor, respectively.
685 The standard mode names @code{\ionian},
686 @code{\locrian}, @code{\aeolian}, @code{\mixolydian}, @code{\lydian},
687 @code{\phrygian}, and @code{\dorian} are also defined.
688
689 @seealso
690
691 This command sets the context property
692 @internalsref{Staff}.@code{keySignature}.  Non-standard key signatures
693 can be specified by setting this property directly.
694
695 The printed signature is a @internalsref{KeySignature} object, typically
696 created in @internalsref{Staff} context.
697
698 @cindex @code{keySignature}
699
700
701 @node Clef
702 @subsection Clef
703 @cindex @code{\clef}
704
705 The clef indicates which lines of the staff correspond to which
706 pitches.
707
708 @syntax
709
710 The clef can be set or changed with the @code{\clef} command:
711 @lilypond[fragment,verbatim]
712   \key f\major  c''2 \clef alto g'2
713 @end lilypond
714
715 Supported clef-names include 
716 @c Moved standard clefs to the top /MB
717 @table @code
718 @item treble, violin, G, G2
719 G clef on 2nd line
720 @item alto, C
721  C clef on 3rd line
722 @item tenor
723  C clef on 4th line
724 @item bass, F
725  F clef on 4th line
726 @item french
727  G clef on 1st line, so-called French violin clef
728 @item soprano
729  C clef on 1st line
730 @item mezzosoprano
731  C clef on 2nd line
732 @item baritone
733  C clef on 5th line
734 @item varbaritone
735  F clef on 3rd line
736 @item subbass
737  F clef on 5th line
738 @item percussion
739  percussion clef
740 @end table
741
742 By adding @code{_8} or @code{^8} to the clef name, the clef is
743 transposed one octave down or up, respectively.   You have to
744 enclose @var{clefname} in quotes if you use underscores or digits in the
745 name. For example,
746 @example
747         \clef "G_8"
748 @end example
749
750 This command is equivalent to setting @code{clefGlyph},
751 @code{clefPosition} (which controls the Y position of the clef),
752 @code{centralCPosition} and @code{clefOctavation}. A clef is printed
753 when any of these properties are changed.
754
755 @seealso
756
757 The object for this symbol is @internalsref{Clef}. 
758
759
760
761
762 @node Time signature
763 @subsection Time signature
764 @cindex Time signature
765 @cindex meter
766 @cindex @code{\time}
767
768 Time signature indicates the metrum of a piece: a regular pattern of
769 strong and weak beats. It is denoted by a fraction at the start of the
770 staff.
771
772 @syntax
773
774 The time signature is set or changed by the @code{\time}
775 command.
776 @lilypond[fragment,verbatim]
777  \time 2/4 c'2 \time 3/4 c'2. 
778 @end lilypond
779
780 The actual symbol that is printed can be customized with the @code{style}
781 property. Setting it to @code{#'()} uses fraction style for 4/4 and
782 2/2 time.
783
784 This command sets the property @code{timeSignatureFraction},
785 @code{beatLength} and @code{measureLength} in the @code{Timing}
786 context, which is normally aliased to @internalsref{Score}.  The property
787 @code{timeSignatureFraction} determine where bar lines should be
788 inserted, and how automatic beams should be generated.  Changing the
789 value of @code{timeSignatureFraction} also causes a time signature
790 symbol to be printed.
791
792 More options are available through the Scheme function
793 @code{set-time-signature}. In combination with the
794 @internalsref{Measure_grouping_engraver}, it will create
795 @internalsref{MeasureGrouping} signs. Such signs ease reading
796 rhythmically complex modern music.  In the following example, the 9/8
797 measure is subdivided in 2, 2, 2 and 3. This is passed to
798 @code{set-time-signature} as the third argument @code{(2 2 2 3)}.
799
800 @lilypond[verbatim]
801 \score { \notes \relative c'' {
802    #(set-time-signature 9 8 '(2 2 2 3))
803    g8-[ g-] d-[ d-] g-[ g-] a8-[-( bes g-]-) | 
804    #(set-time-signature 5 8 '(3 2))
805    a4. g4
806    }
807    \paper {
808        linewidth = -1.0
809        \translator { \StaffContext
810          \consists "Measure_grouping_engraver"
811    }}}
812 @end lilypond 
813
814 @seealso
815
816 The object for this symbol is @internalsref{TimeSignature}.  There are
817 many more options for its layout.  See
818 @inputfileref{input/test,time.ly} for more examples.
819
820 @refbugs
821
822 Automatic beaming does not use measure grouping specified with
823 @code{set-time-signature}.
824
825
826 @subsection Partial
827 @cindex Partial
828 @cindex anacrusis
829 @cindex upbeat
830 @cindex partial measure
831 @cindex measure, partial
832 @cindex shorten measures
833 @cindex @code{\partial}
834
835 Partial measures, for example in upbeats, are entered using the
836 @code{\partial} command:
837 @lilypond[fragment,verbatim]
838 \partial 16*5  c'16 c4 f16 a'2. ~ a'8. a'16 | g'1
839 @end lilypond
840
841 The syntax for this command is 
842 @example
843   \partial @var{duration} 
844 @end example
845 This is  internally translated into
846 @example
847   \property Timing.measurePosition = -@var{length of duration}
848 @end example
849 @cindex @code{|}
850 The property @code{measurePosition} contains a rational number
851 indicating how much of the measure has passed at this point.
852
853 @node Unmetered music
854 @subsection Unmetered music
855
856 Bar lines and bar numbers are calculated automatically. For unmetered
857 music (e.g. cadenzas), this is not desirable.  By setting
858 @code{Score.timing} to false, this automatic timing can be switched
859 off.
860
861 @node Bar lines
862 @subsection Bar lines
863 @cindex Bar lines
864
865 @cindex @code{\bar}
866 @cindex measure lines
867 @cindex repeat bars
868
869
870 Bar lines delimit measures, but are also used to indicate
871 repeats. Line breaks may only happen on barlines.
872
873 @syntax
874
875 Bar lines are inserted automatically, but if you need a special type
876 of barline, you can force one using the @code{\bar} command:
877 @lilypond[relative=1,fragment,verbatim]
878    c4 \bar "|:" c4
879 @end lilypond
880
881 The following bar types are available
882 @lilypond[fragment,  relative, singleline, verbatim]
883 c4
884 \bar "|" c
885 \bar "" c
886 \bar "|:" c
887 \bar "||" c
888 \bar ":|" c
889 \bar ".|" c
890 \bar ".|." c
891 \bar "|." 
892 @end lilypond
893
894 In scores with many staves, the barlines are automatically placed at
895 top level, and they are connected between different staves of a
896 @internalsref{StaffGroup}:
897 @lilypond[fragment, verbatim]
898 < \context StaffGroup <
899   \context Staff = up { e'4 d'
900      \bar "||"
901      f' e' }
902   \context Staff = down { \clef bass c4 g e g } >
903 \context Staff = pedal { \clef bass c2 c2 } >
904 @end lilypond
905
906
907 The command @code{\bar @var{bartype}} is a short cut for
908 doing  @code{\property Score.whichBar = @var{bartype}}
909 Whenever @code{whichBar} is set to a string, a bar line of that type is
910 created.  @code{whichBar} is usually set automatically: at the start of
911 a measure it is set to @code{defaultBarType}. The contents of
912 @code{repeatCommands} is used to override default measure bars.
913
914 @code{whichBar} can also be set directly, using @code{\property} or
915 @code{\bar  }.  These settings take precedence over the automatic
916 @code{whichBar} settings. 
917
918 @cindex whichBar
919 @cindex repeatCommands
920 @cindex defaultBarType
921
922
923 @seealso
924
925 You are encouraged to use @code{\repeat} for repetitions.  See
926 @ref{Repeats}.
927
928 The bar line objects that are created at @internalsref{Staff} are
929 called @internalsref{BarLine}, the bar lines that span staffs are
930 @internalsref{SpanBar}s.
931
932
933 @node Polyphony
934 @section Polyphony
935 @cindex polyphony
936
937 The easiest way to enter fragments with more than one voice on a staff
938 is to split chords using the separator @code{\\}.  You can use it for
939 small, short-lived voices (make a chord of voices) or for single
940 chords:
941
942 @lilypond[verbatim,fragment]
943 \context Voice = VA \relative c'' {
944  c4 < { f d e  } \\ { b c2 } > c4 < g' \\ b, \\  f' \\ d' >
945 }
946 @end lilypond
947
948 The separator causes @internalsref{Voice} contexts to be instantiated,
949 bearing the names @code{"1"}, @code{"2"}, etc. In each of these
950 contexts, vertical direction of slurs, stems, etc. are set
951 appropriately.
952
953 This can also be done by instantiating @internalsref{Voice} contexts
954 by hand, and using @code{\voiceOne}, up to @code{\voiceFour} to assign
955 a stem directions and horizontal shift for each part.
956 @c
957
958 @lilypond[singleline, verbatim]
959 \relative c''
960 \context Staff < \context Voice = VA { \voiceOne cis2 b  }
961   \context Voice = VB { \voiceThree b4 ais ~ ais4 gis4 } 
962   \context Voice = VC { \voiceTwo fis4~  fis4 f ~ f  } >
963 @end lilypond
964
965 Normally, note heads with a different number of dots are not merged, but
966 if you set the object property @code{merge-differently-dotted}, they are:
967 @lilypond[verbatim,fragment,singleline]
968 \relative c' \context Voice < {
969      g8 g8 
970      \property Staff.NoteCollision \override
971         #'merge-differently-dotted = ##t
972      g8 g8
973   } \\ { [g8. f16] [g8. f16] } 
974   >
975 @end lilypond
976
977 Similarly, you can merge half note heads with eighth notes, by setting
978 @code{merge-differently-headed}:
979 @lilypond[fragment, relative=2,verbatim]
980 \context Voice < {
981     c8 c4.
982     \property Staff.NoteCollision
983       \override #'merge-differently-headed = ##t
984     c8 c4. } \\ { c2 c2 } >
985 @end lilypond
986
987 LilyPond also vertically shifts rests that are opposite of a stem. 
988
989 @lilypond[singleline,fragment,verbatim]
990 \context Voice < c''4 \\  r4 >
991 @end lilypond
992
993 @seealso
994
995 The objects responsible for resolving collisions are
996 @internalsref{NoteCollision} and @internalsref{RestCollision}.  See
997 also example files @inputfileref{input/regression/,collision-dots.ly},
998 @inputfileref{input/regression/,collision-head-chords.ly},
999 @inputfileref{input/regression/,collision-heads.ly},
1000 @inputfileref{input/regression/,collision-mesh.ly}, and
1001 @inputfileref{input/regression/,collisions.ly}.
1002
1003
1004 @refbugs
1005
1006 Resolving collisions is a very intricate subject, and LilyPond only
1007 handles a few situations. When it can not cope, you are advised to use
1008 @code{force-hshift} of the @internalsref{NoteColumn} object and pitched
1009 rests to override typesetting decisions.
1010
1011 @node Beaming
1012 @section Beaming
1013
1014 Beams are used to group short notes into chunks that are aligned with
1015 the metrum. They are inserted automatically in most cases.
1016
1017 @lilypond[fragment,verbatim, relative=2]
1018 \time 2/4 c8 c c c \time 6/8 c c c c8. c16  c8
1019 @end lilypond
1020
1021 If you are not satisfied with the automatic beaming, you can enter the
1022 beams explicitly. If you have beaming patterns that differ from the
1023 defaults, you can also set your own.
1024
1025 See also @internalsref{Beam}.
1026
1027
1028 @cindex Automatic beams
1029 @subsection Manual beams
1030 @cindex beams, manual
1031 @cindex @code{]}
1032 @cindex @code{[}
1033
1034 In some cases it may be necessary to override the automatic beaming
1035 algorithm.  For example, the auto beamer will not beam over rests or
1036 bar lines, If you want that, specify the begin and end point manually
1037 using @code{[} and @code{]}.
1038
1039 @lilypond[fragment,relative,verbatim]
1040   \context Staff {
1041     r4 r8-[ g' a r8-] r8 g-[ | a-] r8
1042   }
1043 @end lilypond
1044
1045 @cindex @code{stemLeftBeamCount}
1046
1047 Normally, beaming patterns within a beam are determined automatically.
1048 When this mechanism fouls up, the properties
1049 @code{Voice.stemLeftBeamCount} and @code{Voice.stemRightBeamCount} can
1050 be used to control the beam subdivision on a stem.  If you set either
1051 property, its value will be used only once, and then it is erased.
1052
1053 @lilypond[fragment,relative,verbatim]
1054   \context Staff {
1055     f8-[ r16 f g a-]
1056     f8-[ r16 \property Voice.stemLeftBeamCount = #1 f g a-]
1057   }
1058 @end lilypond
1059 @cindex @code{stemRightBeamCount}
1060
1061
1062 The property @code{subdivideBeams} can be set in order to subdivide
1063 all 16th or shorter beams at beat positions.  This accomplishes the
1064 same effect as twiddling with @code{stemLeftBeamCount} and
1065 @code{stemRightBeamCount}, but it take less typing.
1066
1067
1068 @lilypond[relative=1,verbatim,noindent]
1069         c16-[ c c c c c c c-]
1070         \property Voice.subdivideBeams = ##t
1071         c16-[ c c c c c c c-]
1072         c32-[ c c c c c c c c c c c c c c c-]
1073         \property Score.beatLength = #(ly:make-moment 1 8)
1074         c32-[ c c c c c c c c c c c c c c c-]
1075 @end lilypond
1076 @cindex subdivideBeams
1077
1078 Kneed beams are inserted automatically, when a large gap is detected
1079 between the note heads.  This behavior can be tuned through the object
1080 property @code{auto-knee-gap}.
1081
1082 @cindex beams, kneed
1083 @cindex kneed beams
1084 @cindex auto-knee-gap
1085
1086
1087
1088 @refbugs
1089
1090 @cindex hara kiri
1091
1092 Automatically kneed beams can not be used together with Hara Kiri
1093 staves.
1094
1095 [TODO from bugs]
1096
1097 The Automatic beamer does not put @strong{unfinished} beams on the
1098 last notes of a score.
1099
1100 @menu
1101 * Setting automatic beam behavior ::  
1102 @end menu
1103
1104 @ignore
1105 @no de Beam typography
1106 @sub section Beam typography
1107
1108 One of the strong points of LilyPond is how beams are formatted. Beams
1109 are quantized, meaning that the left and right endpoints beams start
1110 exactly on staff lines. Without quantization, small wedges of white
1111 space appear between the beam and staff line, and this looks untidy.
1112
1113 Beams are also slope-damped: melodies that go up or down should also
1114 have beams that go up or down, but the slope of the beams should be
1115 less than the slope of the notes themselves.
1116
1117 Some beams should be horizontal. These are so-called concave beams. 
1118
1119 [TODO: some pictures.]
1120 @end ignore
1121
1122
1123 @node Setting automatic beam behavior 
1124 @subsection Setting automatic beam behavior 
1125
1126 @cindex @code{autoBeamSettings}
1127 @cindex @code{(end * * * *)}
1128 @cindex @code{(begin * * * *)}
1129 @cindex automatic beams, tuning
1130 @cindex tuning automatic beaming
1131
1132 [TODO: use \applycontext]
1133
1134 In normal time signatures, automatic beams can start on any note but can
1135 only end in a few positions within the measure: beams can end on a beat,
1136 or at durations specified by the properties in
1137 @code{Voice.autoBeamSettings}. The defaults for @code{autoBeamSettings}
1138 are defined in @file{scm/auto-beam.scm}.
1139
1140 The value of @code{autoBeamSettings} is changed using
1141 @code{\override} and unset using @code{\revert}:
1142 @example
1143 \property Voice.autoBeamSettings \override #'(@var{BE} @var{P} @var{Q} @var{N} @var{M}) = @var{dur}
1144 \property Voice.autoBeamSettings \revert #'(@var{BE} @var{P} @var{Q} @var{N} @var{M})
1145 @end example
1146 Here, @var{BE} is the symbol @code{begin} or @code{end}. It determines
1147 whether the rule applies to begin or end-points.  The quantity
1148 @var{P}/@var{Q} refers to the length of the beamed notes (and `@code{*
1149 *}' designates notes of any length), @var{N}/@var{M} refers to a time
1150 signature (wildcards, `@code{* *}' may be entered to designate all time
1151 signatures).
1152
1153 For example, if you want automatic beams to end on every quarter note,
1154 you can use the following:
1155 @example
1156 \property Voice.autoBeamSettings \override
1157     #'(end * * * *) = #(ly:make-moment 1 4)
1158 @end example
1159 Since the duration of a quarter note is 1/4 of a whole note, it is
1160 entered as @code{(ly:make-moment 1 4)}.
1161
1162 The same syntax can be used to specify beam starting points. In this
1163 example, automatic beams can only end on a dotted quarter note. 
1164 @example
1165 \property Voice.autoBeamSettings \override
1166     #'(end * * * *) = #(ly:make-moment 3 8)
1167 @end example
1168 In 4/4 time signature, this means that automatic beams could end only on
1169 3/8 and on the fourth beat of the measure (after 3/4, that is 2 times
1170 3/8 has passed within the measure).
1171
1172 You can also restrict rules to specific time signatures. A rule that
1173 should only be applied in @var{N}/@var{M} time signature is formed by
1174 replacing the second asterisks by @var{N} and @var{M}. For example, a
1175 rule for 6/8 time exclusively looks like
1176 @example
1177 \property Voice.autoBeamSettings \override
1178     #'(begin * * 6 8) =  ... 
1179 @end example
1180
1181 If you want a rule to apply to certain types of beams, you can use the
1182 first pair of asterisks. Beams are classified according to the shortest
1183 note they contain. For a beam ending rule that only applies to beams
1184 with 32nd notes (and no shorter notes), you would use @code{(end 1
1185 32 * *)}.
1186
1187 @c not true
1188 @c Automatic beams can not be put on the last note in a score.
1189
1190 If a score ends while an automatic beam has not been ended and is still
1191 accepting notes, this last beam will not be typeset at all.
1192
1193 @cindex automatic beam generation
1194 @cindex autobeam
1195 @cindex @code{Voice.autoBeaming}
1196 @cindex lyrics
1197
1198 For melodies that have lyrics, you may want to switch off 
1199 automatic beaming. This is done by setting @code{Voice.autoBeaming} to
1200 @code{#f}. 
1201
1202
1203 @refbugs
1204
1205 It is not possible to specify beaming parameters for beams with mixed
1206 durations, that differ from the beaming parameters of all separate
1207 durations, i.e., you'll have to specify manual beams to get:
1208
1209 @lilypond[singleline,fragment,relative,noverbatim,quote]
1210   \property Voice.autoBeamSettings
1211   \override #'(end * * * *) = #(ly:make-moment 3 8)
1212   \time 12/8 c'8 c c c16 c c c c c c-[ c c c-] c8 c c4
1213 @end lilypond
1214 It is not possible to specify beaming parameters that act differently in
1215 different parts of a measure. This means that it is not possible to use
1216 automatic beaming in irregular meters such as @code{5/8}.
1217
1218 @node Accidentals
1219 @section Accidentals
1220 @cindex Accidentals
1221
1222 This section describes how to change the way that LilyPond automatically
1223 inserts accidentals before the running notes.
1224
1225 [TODO: identifier vs. macro]
1226
1227 @menu
1228 * Using the predefined accidental macros::  
1229 * Defining your own accidental typesettings::  
1230 @end menu
1231
1232 @node Using the predefined accidental macros
1233 @subsection Using the predefined accidental macros
1234 The constructs for describing the accidental typesetting rules are
1235 quite hairy, so non-experts should stick to the macros defined in
1236 @file{ly/property-init.ly}.
1237 @cindex @file{property-init.ly}
1238
1239 The macros operate on the ``Current'' context (see @ref{Context properties}). This
1240 means that the macros shuold normally be invoked right after the
1241 creation of the context in which the accidental typesetting described
1242 by the macro is to take effect. I.e. if you want to use
1243 piano-accidentals in a pianostaff then you issue
1244 @code{\pianoAccidentals} first thing after the creation of the piano
1245 staff:
1246 @example
1247 \score @{
1248     \notes \relative c'' <
1249         \context Staff = sa @{ cis4 d e2 @}
1250         \context GrandStaff <
1251             \pianoAccidentals
1252             \context Staff = sb @{ cis4 d e2 @}
1253             \context Staff = sc @{ es2 c @}
1254         >
1255         \context Staff = sd @{ es2 c @}
1256     >
1257 @}
1258 @end example
1259 @lilypond[singleline]
1260 \score {
1261     \notes \relative c'' <
1262         \context Staff = sa { cis4 d e2 }
1263         \context GrandStaff <
1264             \pianoAccidentals
1265             \context Staff = sb { cis4 d e2 }
1266             \context Staff = sc { es2 c }
1267         >
1268         \context Staff = sd { es2 c }
1269     >
1270     \paper {
1271         \translator {
1272             \StaffContext
1273             minimumVerticalExtent = #'(-4.0 . 4.0)
1274         }
1275     }
1276 }
1277 @end lilypond
1278
1279 The macros are:
1280 @table @code
1281 @item \defaultAccidentals
1282       @cindex @code{\defaultAccidentals}
1283       This is the default typesetting behaviour. It should correspond
1284       to 18th century common practice: Accidentals are
1285       remembered to the end of the measure in which they occur and
1286       only on their own octave.
1287
1288 @item \voiceAccidentals
1289       @cindex @code{\voiceAccidentals}
1290       The normal behaviour is to remember the accidentals on
1291       Staff-level.
1292       This macro, however, typesets accidentals individually for each
1293       voice.
1294       Apart from that the rule is similar to
1295       @code{\defaultAccidentals}.
1296
1297       This leads to some weird and often unwanted results
1298       because accidentals from one voice do not get cancelled in other
1299       voices:
1300 @lilypond[singleline,relative,fragment,verbatim,quote]
1301     \context Staff <
1302         \voiceAccidentals
1303         <
1304          { es g } \\
1305          { c, e }
1306      > >
1307 @end lilypond
1308       Hence you should only use @code{\voiceAccidentals} if the voices
1309 are to be read solely by individual musicians. If the staff is to be
1310 used by one musician (e.g., a conductor) then you use
1311 @code{\modernVoiceAccidentals} or @code{\modernVoiceCautionaries}
1312 instead.
1313
1314 @item \modernAccidentals
1315       @cindex @code{\modernAccidentals}
1316       This rule  corresponds to the common practice in the 20th
1317       century.
1318       The rule is  more complex than @code{\defaultAccidentals}.
1319       You get all the same accidentals, but temporary
1320       accidentals also get cancelled in other octaves. Further more,
1321       in the same octave, they also get cancelled in the following measure:
1322 @lilypond[singleline,fragment,verbatim]
1323       \modernAccidentals
1324       cis' c'' cis'2 | c'' c'
1325 @end lilypond
1326
1327 @item \modernCautionaries
1328       @cindex @code{\modernCautionaries}
1329      This rule is similar to @code{\modernAccidentals}, but the
1330      ``extra'' accidentals (the ones not typeset by
1331      @code{\defaultAccidentals}) are typeset as cautionary accidentals
1332      (i.e. in reduced size):
1333 @lilypond[singleline,fragment,verbatim]
1334       \modernCautionaries
1335       cis' c'' cis'2 | c'' c'
1336 @end lilypond
1337
1338       @cindex @code{\modernVoiceAccidentals}
1339 @item \modernVoiceAccidentals
1340 is used for multivoice accidentals to be read both by musicians
1341 playing one voice and musicians playing all voices.  Accidentals are
1342 typeset for each voice, but they @emph{are} cancelled across voices in
1343 the same @internalsref{Staff}.
1344
1345       @cindex @code{\modernVoiceCautionaries}
1346 @item \modernVoiceCautionaries
1347 is the same as
1348 @code{\modernVoiceAccidentals}, but with the extra accidentals (the
1349 ones not typeset by @code{\voiceAccidentals}) typeset as cautionaries.
1350 Even though all accidentals typeset by @code{\defaultAccidentals}
1351 @emph{are} typeset by this macro then some of them are typeset as
1352 cautionaries.
1353
1354 @item \pianoAccidentals
1355       @cindex @code{\pianoAccidentals}
1356       20th century practice for piano notation. Very similar to
1357       @code{\modernAccidentals} but accidentals also get cancelled
1358       across the staves in the same @internalsref{GrandStaff} or
1359       @internalsref{PianoStaff}.
1360
1361 @item \pianoCautionaries
1362       @cindex @code{\pianoCautionaries}
1363       As @code{\pianoAccidentals} but with the extra accidentals
1364       typeset as cautionaries.
1365
1366 @item \noResetKey
1367       @cindex @code{\noResetKey}
1368       Same as @code{\defaultAccidentals} but with accidentals lasting
1369       ``forever'' and not only until the next measure:
1370 @lilypond[singleline,fragment,verbatim,relative]
1371       \noResetKey
1372       c1 cis cis c
1373 @end lilypond
1374
1375 @item \forgetAccidentals
1376       @cindex @code{\forgetAccidentals}
1377       This is sort of the opposite of @code{\noResetKey}: Accidentals
1378       are not remembered at all - and hence all accidentals are
1379       typeset relative to the key signature, regardless of what was
1380       before in the music:
1381 @lilypond[singleline,fragment,verbatim,relative]
1382       \forgetAccidentals
1383       \key d\major c4 c cis cis d d dis dis
1384 @end lilypond
1385 @end table
1386
1387 @node Defining your own accidental typesettings
1388 @subsection Defining your own accidental typesettings
1389
1390 This section must be considered gurus-only, and hence it must be
1391 sufficient with a short description of the system and a reference to
1392 the internal documentation.
1393
1394 The algorithm tries several different rules, and uses the rule
1395 that gives the highest number of accidentals.  Each rule consists of
1396 @table @var
1397 @item context:
1398       In which context is the rule applied. For example, if
1399 @var{context} is @internalsref{Score} then all staves share
1400 accidentals, and if @var{context} is @internalsref{Staff} then all
1401 voices in the same staff share accidentals, but staves do not.
1402 @item octavation:
1403       Whether the accidental changes all octaves or only the current
1404       octave.
1405 @item lazyness:
1406       Over how many barlines the accidental lasts.
1407       If @var{lazyness} is @code{-1} then the accidental is forget
1408       immediately, and if @var{lazyness} is @code{#t} then the accidental
1409       lasts forever.
1410
1411 [TODO: should use  +infinity for this case?]
1412
1413 @end table
1414
1415 @seealso
1416
1417 @internalsref{Accidental_engraver},
1418
1419
1420 @refbugs
1421
1422 Currently the simultaneous notes are considered to be entered in
1423 sequential mode. This means that in a chord the accidentals are
1424 typeset as if the notes in the chord happened one at a time - in the
1425 order in which they appear in the input file.
1426
1427 This is only a problem when there are simultaneous notes whose
1428 accidentals depend on each other.  The problem only occurs when using
1429 non-default accidentals. In the default scheme, accidentals only
1430 depend on other accidentals with the same pitch on the same staff, so
1431 no conflicts possible.
1432
1433 This example shows two examples of the same music giving different
1434 accidentals depending on the order in which the notes occur in the
1435 input file:
1436
1437 @lilypond[singleline,fragment,verbatim]
1438 \property Staff.autoAccidentals = #'( Staff (any-octave . 0) )
1439 cis'4 <<c'' c'>> r2 | cis'4 <<c' c''>> r2
1440 | <<cis' c''>> r | <<c'' cis'>> r | 
1441 @end lilypond
1442
1443 This problem can be solved by manually inserting @code{!} and @code{?}
1444 for the problematic notes.
1445
1446 @node Expressive marks
1447 @section Expressive marks
1448
1449
1450 @menu
1451 * Slurs ::                      
1452 * Phrasing slurs::              
1453 * Breath marks::                
1454 * Tempo::                       
1455 * Text spanners::               
1456 * Analysis brackets::           
1457 @end menu
1458
1459 @node Slurs 
1460 @subsection Slurs
1461 @cindex Slurs
1462
1463 A slur indicates that notes are to be played bound or @emph{legato}.
1464
1465 @syntax
1466
1467 They are entered using parentheses:
1468 @lilypond[fragment,verbatim,center]
1469   f'-( g'-)-( a'-) [a'8 b'-(-] a'4 g'2 f'4-)
1470   <<c' e'>>2-( <<b d'>>2-)
1471 @end lilypond
1472
1473
1474 @c TODO: should explain that ^( and _( set directions
1475 @c should set attachments with ^ and _ ?  
1476
1477 Slurs avoid crossing stems, and are generally attached to note heads.
1478 However, in some situations with beams, slurs may be attached to stem
1479 ends.  If you want to override this layout you can do this through the
1480 object property @code{attachment} of @internalsref{Slur} in
1481 @internalsref{Voice} context.  Its value is a pair of symbols, specifying
1482 the attachment type of the left and right end points.
1483
1484 @lilypond[fragment,relative,verbatim]
1485   \slurUp
1486   \property Voice.Stem \set #'length = #5.5
1487   g'8-(g g4-)
1488   \property Voice.Slur \set #'attachment = #'(stem . stem)
1489   g8-( g g4-)
1490 @end lilypond
1491
1492 If a slur would strike through a stem or beam, the slur will be moved
1493 away upward or downward. If this happens, attaching the slur to the
1494 stems might look better:
1495
1496 @lilypond[fragment,relative,verbatim]
1497   \stemUp \slurUp
1498   d32-( d'4 d8..-)
1499   \property Voice.Slur \set #'attachment = #'(stem . stem)
1500   d,32-( d'4 d8..-)
1501 @end lilypond
1502
1503 @seealso
1504
1505 @seeinternals{Slur}.
1506
1507
1508 @refbugs
1509
1510 Producing nice slurs is a difficult problem, and LilyPond currently
1511 uses a simple, empiric method to produce slurs. In some cases, the
1512 results of this method are ugly.
1513
1514
1515 @cindex Adjusting slurs
1516
1517 @node Phrasing slurs
1518 @subsection Phrasing slurs
1519
1520 @cindex phrasing slurs
1521 @cindex phrasing marks
1522
1523 A phrasing slur (or phrasing mark) connects chords and is used to
1524 indicate a musical sentence. It is started using @code{\(} and @code{\)}
1525 respectively.
1526
1527 @lilypond[fragment,verbatim,center,relative]
1528   \time 6/4 c'-\(  d-( e-) f-( e-)  d-\) 
1529 @end lilypond
1530
1531 Typographically, the phrasing slur behaves almost exactly like a
1532 normal slur.  Although they behave similar to normal slurs, phrasing
1533 slurs count as different objects.  A @code{\slurUp} will have no
1534 effect on a phrasing slur; instead, you should use
1535 @code{\phrasingSlurUp}, @code{\phrasingSlurDown}, and
1536 @code{\phrasingSlurBoth}.
1537
1538 The commands @code{\slurUp}, @code{\slurDown}, and @code{\slurBoth}
1539 will only affect normal slurs and not phrasing slurs.
1540
1541 @seealso
1542
1543 See also @seeinternals{PhrasingSlur}. Phrasing slurs have the same
1544 limitations in their formatting.
1545
1546 @node Breath marks
1547 @subsection Breath marks
1548
1549 Breath marks are entered using @code{\breathe}.
1550
1551
1552 @lilypond[fragment,relative]
1553 c'4 \breathe d4
1554 @end lilypond
1555
1556 The glyph of the breath mark can be tweaked by overriding the
1557 @code{text} property of the @code{BreathingSign} grob with the name of
1558 any glyph of @ref{The Feta font}.  For example,
1559 @lilypond[fragment,verbatim,relative]
1560 c'4
1561 \property Voice.BreathingSign \override #'text = #"scripts-rvarcomma"
1562 \breathe
1563 d4
1564 @end lilypond
1565
1566 @seealso 
1567
1568 @seeinternals{BreathingSign},
1569 @inputfileref{input/regression/,breathing-sign.ly}.
1570
1571
1572 @node Tempo
1573 @subsection Tempo
1574 @cindex Tempo
1575 @cindex beats per minute
1576 @cindex metronome marking
1577
1578 Metronome settings can be entered as follows:
1579
1580 @cindex @code{\tempo}
1581 @example
1582   \tempo @var{duration} = @var{perminute} 
1583 @end example
1584
1585 For example, @code{\tempo 4 = 76} requests output with 76 quarter notes
1586 per minute.
1587   
1588 @refbugs
1589   
1590 The tempo setting is not printed, but is only used in the MIDI
1591 output. You can trick lily into producing a metronome mark,
1592 though. Details are in @ref{Text markup}.
1593
1594 [TODO: make note markup.]
1595
1596
1597 @node Text spanners
1598 @subsection Text spanners
1599 @cindex Text spanners
1600
1601 Some textual indications, e.g. @i{rallentando} or @i{accelerando}, are
1602 often extended over many measures. This is indicated by following the
1603 text with a dotted line.  You can create such texts using text
1604 spanners. The syntax is as follows:
1605 @example
1606  \startTextSpan
1607  \stopTextSpan
1608 @end example
1609 The string to be printed, as well as the style, is set through object
1610 properties.
1611
1612 An application is to fake octavation indications.
1613
1614 @lilypond[fragment,relative,verbatim]
1615  \relative c' {  a''' b c a
1616   \property Voice.TextSpanner \set #'type = #'dotted-line
1617   \property Voice.TextSpanner \set #'edge-height = #'(0 . 1.5)
1618   \property Voice.TextSpanner \set #'edge-text = #'("8va " . "")
1619   \property Staff.centralCPosition = #-13
1620   a-\startTextSpan b c a-\stopTextSpan }
1621 @end lilypond
1622
1623
1624 @seealso
1625
1626 @internalsref{TextSpanner}, @inputfileref{input/regression/,text-spanner.ly}.
1627
1628
1629 @node Analysis brackets
1630 @subsection Analysis brackets
1631 @cindex brackets
1632 @cindex phrasing brackets
1633 @cindex musicological analysis
1634 @cindex note grouping bracket
1635
1636 Brackets are used in musical analysis to indicate structure in musical
1637 pieces. LilyPond supports a simple form of nested horizontal brackets.
1638 To use this, add the @internalsref{Horizontal_bracket_engraver} to
1639 @internalsref{Staff} context.  A bracket is started with
1640 @code{\groupOpen} and closed with @code{\groupClose}. This produces
1641 @internalsref{HorizontalBracket} objects.
1642
1643 @lilypond[singleline,verbatim]
1644 \score { \notes \relative c'' {  
1645         c4-\groupOpen-\groupOpen
1646         c4-\groupClose
1647         c4-\groupOpen
1648         c4-\groupClose-\groupClose
1649   }
1650   \paper { \translator {
1651             \StaffContext \consists "Horizontal_bracket_engraver"
1652         }}}
1653 @end lilypond
1654
1655 @refbugs
1656
1657 Bracket endings should be angled/slanted. (TODO)
1658  
1659
1660
1661 @node Ornaments
1662 @section Ornaments
1663 @cindex Ornaments
1664
1665 [TODO: ornaments vs. expressive marks]
1666
1667 @menu
1668 * Articulations::               
1669 * Text scripts::                
1670 * Grace notes::                 
1671 * Glissando ::                  
1672 * Dynamics::                    
1673 @end menu
1674
1675
1676 @node Articulations
1677 @subsection Articulations
1678 @cindex Articulations
1679
1680 @cindex articulations
1681 @cindex scripts
1682 @cindex ornaments
1683
1684 A variety of symbols can appear above and below notes to indicate
1685 different characteristics of the performance. They are added to a note
1686 by adding a dash and the the character signifying the
1687 articulation. They are demonstrated here.
1688
1689 @lilypondfile[notexidoc]{script-abbreviations.ly}
1690
1691 The script is automatically placed, but if you need to force
1692 directions, you can use @code{_} to force them down, or @code{^} to
1693 put them up:
1694 @lilypond[fragment, verbatim]
1695   c''4^^ c''4_^
1696 @end lilypond
1697
1698
1699 Other symbols can be added using the syntax
1700 @var{note}@code{-\}@var{name}. Again, they can be forced up or down
1701 using @code{^} and @code{_}.
1702
1703 @cindex accent
1704 @cindex marcato
1705 @cindex staccatissimo
1706 @cindex fermata
1707 @cindex stopped
1708 @cindex staccato
1709 @cindex portato
1710 @cindex tenuto
1711 @cindex upbow
1712 @cindex downbow
1713 @cindex foot marks
1714 @cindex organ pedal marks
1715 @cindex turn
1716 @cindex open
1717 @cindex flageolet
1718 @cindex reverseturn
1719 @cindex trill
1720 @cindex prall
1721 @cindex mordent
1722 @cindex prallprall
1723 @cindex prallmordent
1724 @cindex prall, up
1725 @cindex prall, down
1726 @cindex mordent
1727 @cindex thumb marking
1728 @cindex segno
1729 @cindex coda
1730 @cindex varcoda
1731
1732 @lilypondfile[notexidoc]{script-chart.ly}
1733
1734
1735 @cindex fingering
1736
1737 Fingering instructions can also be entered in this shorthand. For
1738 finger changes, use markup texts:
1739 @c
1740 @lilypond[verbatim, singleline, fragment]
1741       c'4-1 c'4-2 c'4-3 c'4-4
1742       c'^\markup { \fontsize #-3 \number "2-3" }
1743 @end lilypond
1744
1745 @cindex finger change
1746 @cindex scripts
1747 @cindex superscript
1748 @cindex subscript
1749
1750 @lilypond[verbatim,singleline,fragment,relative=1]
1751         << c-1  e-2 g-3 b-5 >> 4
1752         \property Voice.fingerHorizontalDirection = #LEFT
1753         << c-1  es-3 g-5 >> 4
1754         \property Voice.fingerHorizontalDirection = #RIGHT
1755         << c-1  e-2 g-3 b-5 >> 4-\arpeggio
1756         \property Voice.fingerHorizontalDirection = #LEFT
1757         << c_1  e-2 g-3 b^5 >> 4
1758 @end lilypond
1759         
1760 @seealso
1761
1762 @internalsref{Script} and @internalsref{Fingering}.
1763
1764 @refbugs
1765
1766 All of these note ornaments appear in the printed output but have no
1767 effect on the MIDI rendering of the music.
1768
1769
1770 @node Text scripts
1771 @subsection Text scripts
1772 @cindex Text scripts
1773
1774 It is possible to place arbitrary strings of text or markup text (see
1775 @ref{Text markup}) above or below notes by using a string:
1776 @code{c^"text"}.  By default, these indications do not influence the
1777 note spacing, but by using the command @code{\fatText}, the widths
1778 will be taken into account.
1779 @c
1780 @lilypond[fragment,singleline,verbatim] \relative c' {
1781 c4^"longtext" \fatText c4_"longlongtext" c4 }
1782 @end lilypond
1783
1784 It is possible to use @TeX{} commands in the strings, but this should be
1785 avoided because it makes it impossible for LilyPond to compute the
1786 exact length of the string, which may lead to collisions.  Also, @TeX{}
1787 commands will not work with direct PostScript output.
1788
1789 @seealso
1790
1791 @internalsref{TextScript} objects.
1792
1793 @ref{Text markup} describes how to change the font or access
1794 special symbols in text scripts.
1795
1796
1797
1798 @node Grace notes
1799 @subsection Grace notes
1800
1801
1802
1803 @cindex @code{\grace}
1804 @cindex ornaments
1805 @cindex grace notes
1806
1807 Grace notes are ornaments that are written out
1808
1809 @lilypond[relative=2,verbatim,ifragment] c4 \grace c16 c4 \grace {
1810 [c16 d16] } c4
1811 @end lilypond
1812
1813 In normal notation, grace notes take up no logical
1814 time in a measure. Such an idea is practical for normal notation, but
1815 is not strict enough to put it into a program. The model that LilyPond
1816 uses for grace notes internally is that all timing is done in two
1817 steps:
1818
1819 Every point in musical time consists of two rational numbers: one
1820 denotes the logical time, one denotes the grace timing. The above
1821 example is shown here with timing tuples.
1822
1823 @lilypond[]
1824 \score { \notes \relative c''{ 
1825   c4^"(0,0)"  \grace c16_" "_"(1/4,-1/16)"  c4^"(1/4,0)"  \grace {
1826   [c16_"(2/4,-1/8)"  d16^"(2/4,-1/16)" ] } c4_" "_"(2/4,0)"
1827   }
1828 \paper {  linewidth = 8.\cm }
1829 }
1830 @end lilypond
1831
1832
1833 The placement of these grace notes is synchronized between different
1834 staves.
1835
1836 @lilypond[relative=2,verbatim,fragment] 
1837 < \context Staff = SA { e4 \grace { c16-[ d e f-] } e4 }
1838   \context Staff = SB { c'4 \grace { g8 b } c4 } >
1839 @end lilypond
1840
1841
1842 Unbeamed eighth notes and shorter by default have a slash through the
1843 stem. This can be controlled with object property @code{stroke-style} of
1844 @internalsref{Stem}. The change in formatting is accomplished by
1845 inserting @code{\startGraceMusic} before handling the grace notes, and
1846 @code{\stopGraceMusic} after finishing the grace notes.
1847 You can add to these definitions to globally change grace note
1848 formatting. The standard definitions are in @file{ly/grace-init.ly}.
1849
1850 [TODO discuss Scheme functionality.]
1851
1852
1853 The @code{\override} is carefully matched with a @code{\revert}.
1854
1855 @cindex slash
1856 @cindex grace slash
1857
1858 @lilypond[fragment,verbatim]
1859 \relative c'' \context Voice {
1860   \grace c8 c4 \grace { [c16 c16] } c4
1861   \grace { 
1862     \property Voice.Stem \override #'stroke-style = #'() 
1863     c16 
1864     \property Voice.Stem \revert #'stroke-style
1865   } c4
1866 }
1867 @end lilypond
1868
1869
1870
1871 If you want to end a note with a grace note, then the standard trick
1872 is to put the grace notes before a phantom ``space note'', e.g.
1873 @lilypond[fragment,verbatim, relative=2]
1874 \context Voice {
1875     < { d1^\trill ( }
1876      { s2 \grace { [c16 d] } } >
1877    )c4
1878 }
1879 @end lilypond
1880
1881 A @code{\grace} section has some default values, and LilyPond will
1882 use those default values unless you specify otherwise inside the
1883 @code{\grace} section.  For example, if you specify \slurUp
1884 @emph{before} your @code{\grace} section, a slur which starts inside
1885 the @code{\grace} will not be forced up, even if the slur ends outside
1886 of the @code{\grace}.  Note the difference between the first and
1887 second bars in this example:
1888
1889 @lilypond[fragment,verbatim]
1890 \relative c'' \context Voice {
1891     \slurUp
1892     \grace {
1893         a4 ( }
1894     ) a4 a4 () a2
1895     \slurBoth
1896
1897     \grace {
1898         \slurUp
1899         a4 ( }
1900     ) a4 a4 () a2
1901     \slurBoth
1902
1903 }
1904 @end lilypond
1905
1906
1907 @refbugs
1908
1909 Grace notes can not be used in the smallest size (@file{paper11.ly}).
1910
1911 Grace note synchronization can also lead to surprises. Staff notation,
1912 such as key signatures, barlines, etc. are also synchronized. Take
1913 care when you mix staves with grace notes and staves without.
1914
1915 @lilypond[relative=2,verbatim,fragment]
1916 < \context Staff = SA { e4 \bar "|:" \grace c16 d4 }
1917   \context Staff = SB { c4 \bar "|:"  d4 } >
1918 @end lilypond
1919
1920 Grace sections should only be used within sequential music
1921 expressions.  Nesting, juxtaposing, or ending sequential music with a
1922 grace section is not supported, and might produce crashes or other
1923 errors.
1924
1925
1926 @node Glissando 
1927 @subsection Glissando
1928 @cindex Glissando 
1929
1930 @cindex @code{\glissando}
1931
1932 A glissando is a smooth change in pitch. It is denoted by a line or a
1933 wavy line between two notes.
1934
1935 @syntax
1936
1937 A glissando line can be requested by attaching a @code{\glissando} to
1938 a note:
1939
1940 @lilypond[fragment,relative,verbatim]
1941   c'-\glissando c'
1942 @end lilypond
1943
1944 @seealso
1945
1946 @seeinternals{Glissando}.
1947
1948
1949 @refbugs
1950
1951 Printing of an additional text (such as @emph{gliss.}) must be done
1952 manually.
1953
1954
1955 @node Dynamics
1956 @subsection Dynamics
1957 @cindex Dynamics
1958
1959
1960
1961 @cindex @code{\ppp}
1962 @cindex @code{\pp}
1963 @cindex @code{\p}
1964 @cindex @code{\mp}
1965 @cindex @code{\mf}
1966 @cindex @code{\f}
1967 @cindex @code{\ff}
1968 @cindex @code{\fff}
1969 @cindex @code{\ffff}
1970 @cindex @code{\fp}
1971 @cindex @code{\sf}
1972 @cindex @code{\sff}
1973 @cindex @code{\sp}
1974 @cindex @code{\spp}
1975 @cindex @code{\sfz}
1976 @cindex @code{\rfz}
1977
1978
1979 Absolute dynamic marks are specified using an identifier after a
1980 note: @code{c4-\ff}.  The available dynamic marks are: @code{\ppp},
1981 @code{\pp}, @code{\p}, @code{\mp}, @code{\mf}, @code{\f}, @code{\ff},
1982 @code{\fff}, @code{\fff}, @code{\fp}, @code{\sf}, @code{\sff},
1983 @code{\sp}, @code{\spp}, @code{\sfz}, and @code{\rfz}.
1984
1985 @lilypond[verbatim,singleline,fragment,relative]
1986   c'-\ppp c-\pp c -\p c-\mp c-\mf c-\f c-\ff c-\fff
1987   c2-\sf c-\rfz
1988 @end lilypond
1989
1990 @cindex @code{\cr}
1991 @cindex @code{\rc}
1992 @cindex @code{\decr}
1993 @cindex @code{\rced}
1994 @cindex @code{\<}
1995 @cindex @code{\>}
1996 @cindex @code{\"!}
1997
1998
1999
2000 A crescendo mark is started with @code{\cr} and terminated with
2001 @code{\endcr}, and decrescendi similarly with @code{\decr} and
2002 @code{\enddecr}.  There are also shorthands for these marks.  A
2003 crescendo can be started with @code{\<} and a decrescendo can be
2004 started with @code{\>}.  Either one can be terminated with @code{\!}.
2005 Because these marks are bound to notes, if you must use spacer notes
2006 if marks during one note are needed.
2007
2008 @lilypond[fragment,verbatim,center,quote]
2009   c''-\< c''-\!   d''-\decr e''-\rced 
2010   < f''1 { s4 s4-\< s4-\! \>  s4-\! } >
2011 @end lilypond
2012 This may give rise to very short hairpins. Use @code{minimum-length}
2013 in @internalsref{Voice}.@internalsref{HairPin} to lengthen these, e.g.
2014
2015 @example
2016  \property Staff.Hairpin \override #'minimum-length = #5
2017 @end example
2018
2019 You can also use a text saying @emph{cresc.} instead of hairpins. Here
2020 is an example how to do it:
2021
2022 @lilypond[fragment,relative=2,verbatim]
2023   c4 \cresc c4 \endcresc c4
2024 @end lilypond
2025
2026
2027 @cindex crescendo
2028 @cindex decrescendo
2029
2030 You can also supply your own texts:
2031 @lilypond[fragment,relative,verbatim]
2032   \context Voice {
2033     \property Voice.crescendoText = "cresc. poco"
2034     \property Voice.crescendoSpanner = #'dashed-line
2035     a'2-\mf-\< a a a-\!
2036   }
2037 @end lilypond
2038
2039 @cindex diminuendo
2040
2041 @seealso
2042
2043 Dynamics are objects of @internalsref{DynamicText} and
2044 @internalsref{Hairpin}. Vertical positioning of these symbols is
2045 handled by the @internalsref{DynamicLineSpanner} object.
2046
2047 If you want to adjust padding or vertical direction of the dynamics,
2048 you must set properties for the @internalsref{DynamicLineSpanner}
2049 object. Predefined identifiers to set the vertical direction are
2050 \dynamicUp and \dynamicDown.
2051
2052 @cindex direction, of dynamics
2053 @cindex @code{\dynamicDown}
2054 @cindex @code{\dynamicUp}
2055
2056
2057 @node Repeats
2058 @section Repeats
2059
2060
2061 @cindex repeats
2062 @cindex @code{\repeat}
2063
2064 To specify repeats, use the @code{\repeat} keyword.  Since repeats
2065 should work differently when played or printed, there are a few
2066 different variants of repeats.
2067
2068 @table @code
2069 @item unfold
2070 Repeated music is fully written (played) out.  Useful for MIDI
2071 output, and entering repetitive music.
2072
2073 @item volta
2074 This is the normal notation: Repeats are not written out, but
2075 alternative endings (voltas) are printed, left to right.
2076
2077 @ignore
2078 @item fold
2079 Alternative endings are written stacked. This has limited use but may be
2080 used to typeset two lines of lyrics in songs with repeats, see
2081 @inputfileref{input,star-spangled-banner.ly}.
2082 @end ignore
2083
2084 @item tremolo
2085 Make tremolo beams.
2086
2087 @item percent
2088 Make beat or measure repeats. These look like percent signs.
2089
2090 @end table  
2091
2092 @menu
2093 * Repeat syntax::               
2094 * Repeats and MIDI::            
2095 * Manual repeat commands::      
2096 * Tremolo repeats::             
2097 * Tremolo subdivisions::        
2098 * Measure repeats::             
2099 @end menu
2100
2101 @node Repeat syntax
2102 @subsection Repeat syntax
2103
2104
2105 Repetition is a central concept in music, and multiple notations exist
2106 for repetitions.
2107
2108 @syntax
2109
2110 LilyPond has one syntactic construct for specifying different types of
2111 repeats.  The syntax is
2112
2113 @example
2114   \repeat @var{variant} @var{repeatcount} @var{repeatbody}
2115 @end example
2116
2117 If you have alternative endings, you may add
2118 @cindex @code{\alternative}
2119 @example
2120  \alternative @code{@{} @var{alternative1}
2121             @var{alternative2}
2122             @var{alternative3} @dots{} @code{@}}
2123 @end example
2124 where each @var{alternative} is a music expression.  If you do not
2125 give enough alternatives for all of the repeats, then the first
2126 alternative is assumed to be played more than once.
2127
2128 Normal notation repeats are used like this:
2129 @lilypond[fragment,verbatim]
2130   c'1
2131   \repeat volta 2 { c'4 d' e' f' }
2132   \repeat volta 2 { f' e' d' c' }
2133 @end lilypond
2134
2135 With alternative endings:
2136 @lilypond[fragment,verbatim]
2137   c'1
2138   \repeat volta 2 {c'4 d' e' f'} 
2139   \alternative { {d'2 d'} {f' f} }
2140 @end lilypond
2141
2142 @ignore
2143 Folded repeats look like this:
2144
2145
2146 @li lypond[fragment,verbatim]
2147   c'1
2148   \repeat fold 2 {c'4 d' e' f'} 
2149   \alternative { {d'2 d'} {f' f} }
2150
2151 @end lilypond
2152 @end ignore
2153
2154
2155 @lilypond[fragment,verbatim]
2156 \context Staff {
2157   \relative c' {
2158     \partial 4
2159     \repeat volta 4 { e | c2 d2 | e2 f2 | }
2160     \alternative { { g4 g g } { a | a a a a | b2. } }
2161   }
2162 }
2163 @end lilypond
2164
2165 @node Repeats and MIDI
2166 @subsection Repeats and MIDI
2167
2168 @cindex expanding repeats
2169
2170 For instructions on how to unfold repeats for MIDI output, see the
2171 example file @inputfileref{input/test,unfold-all-repeats.ly}.
2172
2173
2174 @refbugs
2175
2176 Timing information is not remembered at the start of an alternative,
2177 so you have to reset timing information after a repeat, e.g. using a
2178 bar-check (See @ref{Bar check}), setting @code{Score.measurePosition}
2179 or entering @code{\partial}.  Slurs or ties are also not repeated.
2180
2181
2182 @node Manual repeat commands
2183 @subsection Manual repeat commands
2184
2185 @cindex @code{repeatCommands}
2186
2187 The property @code{repeatCommands} can be used to control the layout of
2188 repeats. Its value is a Scheme list of repeat commands, where each repeat
2189 command can be
2190
2191 @table @code
2192 @item 'start-repeat
2193  Print a |: bar line
2194 @item 'end-repeat
2195  Print a :| bar line
2196 @item (volta . @var{text})
2197  Print a volta bracket saying @var{text}. The text can be specified as
2198 a text string or as a markup text, see @ref{Text markup}. Do not
2199 forget to change the font, as the default number font does not contain
2200 alphabetic characters.
2201 @item (volta . #f) 
2202  Stop a running volta bracket
2203 @end table
2204
2205 @lilypond[verbatim, fragment]
2206  c''4
2207     \property Score.repeatCommands = #'((volta "93") end-repeat)
2208  c''4 c''4
2209     \property Score.repeatCommands = #'((volta #f))
2210  c''4 c''4
2211 @end lilypond
2212
2213
2214 @seealso
2215
2216 Repeat brackets are @internalsref{VoltaBracket} objects.
2217
2218 @node Tremolo repeats
2219 @subsection Tremolo repeats
2220 @cindex tremolo beams
2221
2222 To place tremolo marks between notes, use @code{\repeat} with tremolo
2223 style.  
2224 @lilypond[verbatim,center,singleline]
2225 \score { 
2226   \context Voice \notes\relative c' {
2227     \repeat "tremolo" 8 { c16 d16 }
2228     \repeat "tremolo" 4 { c16 d16 }    
2229     \repeat "tremolo" 2 { c16 d16 }
2230     \repeat "tremolo" 4 c16
2231   }
2232 }
2233 @end lilypond
2234
2235 @seealso
2236
2237 Tremolo beams are @internalsref{Beam} objects. Single stem tremolos are
2238 @internalsref{StemTremolo}. 
2239
2240 @refbugs
2241
2242 The single stem tremolo @emph{must} be entered without @code{@{} and
2243 @code{@}}.
2244
2245 @node Tremolo subdivisions
2246 @subsection Tremolo subdivisions
2247 @cindex tremolo marks
2248 @cindex @code{tremoloFlags}
2249
2250 Tremolo marks can be printed on a single note by adding
2251 `@code{:}[@var{length}]' after the note.  The length must be at least 8.
2252 A @var{length} value of 8 gives one line across the note stem.  If the
2253 length is omitted, then then the last value (stored in
2254 @code{Voice.tremoloFlags}) is used.
2255
2256 @lilypond[verbatim,fragment,center]
2257   c'2:8 c':32 | c': c': |
2258 @end lilypond
2259
2260 [TODO : stok is te kort bij 32en]
2261
2262 @refbugs
2263
2264 Tremolos in this style do not carry over into the MIDI output.
2265
2266
2267 @node Measure repeats
2268 @subsection Measure repeats
2269
2270 @cindex percent repeats
2271 @cindex measure repeats
2272
2273 In the @code{percent} style, a note pattern can be repeated. It is
2274 printed once, and then the pattern is replaced with a special sign.
2275 Patterns of a one and two measures are replaced by percent-like signs,
2276 patterns that divide the measure length are replaced by slashes.
2277
2278 @lilypond[verbatim,singleline]
2279  \context Voice { \repeat  "percent" 4  { c'4 }
2280     \repeat "percent" 2 { c'2 es'2 f'4 fis'4 g'4 c''4 }
2281 }
2282 @end lilypond   
2283
2284 @seealso
2285
2286 @internalsref{RepeatSlash}, @internalsref{PercentRepeat}, and
2287 @internalsref{DoublePercentRepeat}.
2288
2289 @refbugs
2290
2291 You can not nest percent repeats, e.g. by filling in the first measure
2292 with slashes, and repeating that measure with percents.
2293
2294 @node Rhythmic music
2295 @section Rhythmic music
2296
2297 Sometimes you might want to show only the rhythm of a melody.  This can
2298 be done with the rhythmic staff. All pitches of notes on such a staff
2299 are squashed, and the  staff itself  looks has  a single staff line:
2300
2301 @lilypond[fragment,relative,verbatim]
2302   \context RhythmicStaff {
2303       \time 4/4
2304       c4 e8 f  g2 | r4 g r2 | g1:32 | r1 |
2305   }
2306 @end lilypond
2307
2308 @menu
2309 * Percussion staves::           
2310 * Percussion midi output::      
2311 @end menu
2312
2313 @node Percussion staves
2314 @subsection Percussion staves
2315 @cindex percussion
2316 @cindex drums
2317
2318 To typeset more than one piece of percussion to be played by the same
2319 musician one typically uses a multiline staff where each staff
2320 position refers to a specific piece of percussion.
2321
2322 @syntax
2323
2324 LilyPond is has a set of Scheme functions that can be used to typeset
2325 percussion staves. The system is based on the general MIDI
2326 drum-pitches.  Include @file{ly/drumpitch-init.ly} to use drum
2327 pitches. This file defines the pitches from the Scheme variable
2328 @code{drum-pitch-names}, the definition of which can be read in
2329 @file{scm/drums.scm}.  Each piece of percussion has a full name and an
2330 abbreviated name, and both the full name or the abbreviation may be
2331 used in input files.
2332
2333 To typeset the music on a staff apply the function @code{drums->paper}
2334 to the percussion music. This function takes a list of percussion
2335 instrument names, notehead scripts and staff positions (that is:
2336 pitches relative to the C-clef) and transforms the input
2337 music by moving the pitch, changing the notehead and (optionally)
2338 adding a script:
2339 @c
2340 @lilypond[singleline,verbatim,quote]
2341 \include "drumpitch-init.ly"
2342 up = \notes { crashcymbal4 hihat8 halfopenhihat hh hh hh openhihat }
2343 down = \notes { bassdrum4 snare8 bd r bd sn4 }
2344 \score {
2345     \apply #(drums->paper 'drums) \context Staff <
2346         \clef percussion
2347         \context Voice = up { \voiceOne \up }
2348         \context Voice = down { \voiceTwo \down }
2349     >
2350 }
2351
2352 @end lilypond
2353 In the above example the music was transformed using the list @code{'drums}.
2354 Currently the following lists are defined in @file{scm/drums.scm}:
2355 @table @code
2356 @item 'drums
2357 To typeset a typical drum kit on a five-line staff.
2358
2359 @lilypond[noindent]
2360 \include "drumpitch-init.ly"
2361 nam = \lyrics { cymc cyms cymr hh hhc hho hhho hhp cb hc
2362     bd sn ss tomh tommh tomml toml tomfh tomfl }
2363 mus = \notes  { cymc cyms cymr hh hhc hho hhho hhp cb hc
2364     bd sn ss tomh tommh tomml toml tomfh tomfl s16 }
2365 \score {
2366     <
2367         \apply #(drums->paper 'drums) \context Staff <
2368             \clef percussion
2369             \mus
2370         >
2371         \context Lyrics \nam 
2372     >
2373     \paper {
2374         linewidth = 100.0\mm
2375         \translator {
2376             \StaffContext
2377             \remove Bar_engraver
2378             \remove Time_signature_engraver
2379             minimumVerticalExtent = #'(-4.0 . 5.0)
2380         }
2381         \translator {
2382             \VoiceContext
2383             \remove Stem_engraver
2384         }
2385    }   
2386 }
2387 @end lilypond
2388
2389 Scheme supports six different toms.  When there fewer toms, simply
2390 select the toms that produce the desired result, i.e., to get toms on
2391 the three middle lines you use @code{tommh}, @code{tomml} and
2392 @code{tomfh}.
2393
2394 Because general MIDI does not contain rimshots the sidestick is used
2395 for this purpose instead.
2396 @item 'timbales
2397 To typeset timbales on a two line staff.
2398 @lilypond[singleline]
2399 \include "drumpitch-init.ly"
2400 nam = \lyrics { timh ssh timl ssl cb }
2401 mus = \notes  { timh ssh timl ssl cb s16 }
2402 \score {
2403     <
2404         \apply #(drums->paper 'timbales) \context Staff <
2405             \clef percussion
2406             \mus
2407         >
2408         \context Lyrics \nam 
2409     >
2410     \paper {
2411         \translator {
2412             \StaffContext
2413             \remove Bar_engraver
2414             \remove Time_signature_engraver
2415             StaffSymbol \override #'line-count = #2
2416             StaffSymbol \override #'staff-space = #2
2417             minimumVerticalExtent = #'(-3.0 . 4.0)
2418         }
2419         \translator {
2420             \VoiceContext
2421             \remove Stem_engraver
2422         }
2423
2424     }   
2425 }
2426 @end lilypond
2427 @item 'congas
2428 To typeset congas on a two line staff.
2429 @lilypond[singleline]
2430 \include "drumpitch-init.ly"
2431 nam = \lyrics { cgh cgho cghm ssh cgl cglo cglm ssl }
2432 mus = \notes  { cgh cgho cghm ssh cgl cglo cglm ssl s16 }
2433 \score {
2434     <
2435         \apply #(drums->paper 'congas) \context Staff <
2436             \clef percussion
2437             \mus
2438         >
2439         \context Lyrics \nam 
2440     >
2441     \paper {
2442         \translator {
2443             \StaffContext
2444             \remove Bar_engraver
2445             \remove Time_signature_engraver
2446             StaffSymbol \override #'line-count = #2
2447             StaffSymbol \override #'staff-space = #2
2448             minimumVerticalExtent = #'(-3.0 . 4.0)
2449         }
2450         \translator {
2451             \VoiceContext
2452             \remove Stem_engraver
2453         }
2454     }   
2455 }
2456 @end lilypond
2457 @item 'bongos
2458 To typeset bongos on a two line staff.
2459 @lilypond[singleline]
2460 \include "drumpitch-init.ly"
2461 nam = \lyrics { boh boho bohm ssh bol bolo bolm ssl }
2462 mus = \notes  { boh boho bohm ssh bol bolo bolm ssl s16 }
2463 \score {
2464     <
2465         \apply #(drums->paper 'bongos) \context Staff <
2466             \clef percussion
2467             \mus
2468         >
2469         \context Lyrics \nam 
2470     >
2471     \paper {
2472         \translator {
2473             \StaffContext
2474             \remove Bar_engraver
2475             \remove Time_signature_engraver
2476             StaffSymbol \override #'line-count = #2
2477             StaffSymbol \override #'staff-space = #2
2478             minimumVerticalExtent = #'(-3.0 . 4.0)
2479         }
2480         \translator {
2481             \VoiceContext
2482             \remove Stem_engraver
2483         }
2484     }   
2485 }
2486 @end lilypond
2487 @item 'percussion
2488 To typeset all kinds of simple percussion on one line staves.
2489 @lilypond[singleline]
2490 \include "drumpitch-init.ly"
2491 nam = \lyrics { tri trio trim gui guis guil cb cl tamb cab mar hc }
2492 mus = \notes  { tri trio trim gui guis guil cb cl tamb cab mar hc s16 }
2493 \score {
2494     <
2495         \apply #(drums->paper 'percussion) \context Staff <
2496             \clef percussion
2497             \mus
2498         >
2499         \context Lyrics \nam 
2500     >
2501     \paper {
2502         \translator {
2503             \StaffContext
2504             \remove Bar_engraver
2505             \remove Time_signature_engraver
2506             StaffSymbol \override #'line-count = #1
2507             minimumVerticalExtent = #'(-2.0 . 3.0)
2508         }
2509         \translator {
2510             \VoiceContext
2511             \remove Stem_engraver
2512         }
2513     }   
2514 }
2515 @end lilypond
2516 @end table
2517
2518 If you do not like any of the predefined lists you can define your own
2519 list at the top of your file:
2520
2521 @lilypond[singleline, verbatim]
2522 #(define mydrums `(
2523         (bassdrum     default   #f        ,(ly:make-pitch -1 2 0))
2524         (snare        default   #f        ,(ly:make-pitch 0 1 0))
2525         (hihat        cross     #f        ,(ly:make-pitch 0 5 0))
2526         (pedalhihat   xcircle   "stopped" ,(ly:make-pitch 0 5 0))
2527         (lowtom       diamond   #f        ,(ly:make-pitch -1 6 0))
2528 ))
2529 \include "drumpitch-init.ly"
2530 up = \notes { hh8 hh hh hh hhp4 hhp }
2531 down = \notes { bd4 sn bd toml8 toml }
2532 \score {    
2533     \apply #(drums->paper 'mydrums) \context Staff <
2534         \clef percussion
2535         \context Voice = up { \voiceOne \up }
2536         \context Voice = down { \voiceTwo \down }
2537     >
2538 }
2539 @end lilypond
2540
2541 To use a modified existing list, one can prepend modifications to the
2542 the existing list:
2543
2544 @example
2545 #(define mydrums (append `(
2546    (bassdrum default #f ,(ly:make-pitch -1 2 0))
2547    (lowtom   diamond #f ,(ly:make-pitch -1 6 0))
2548 ) drums ))
2549 @end example
2550
2551 The file @file{drumpitch-init.ly} replaces the normal pitch names, so
2552 you have to reinclude @file{nederlands.ly} after the
2553 drum-pattern-definitions to enter normal notes.
2554 @c
2555 @lilypond[singleline,verbatim]
2556 \include "drumpitch-init.ly"
2557 up = \notes { crashcymbal4 hihat8 halfopenhihat hh hh hh openhihat }
2558 down = \notes { bassdrum4 snare8 bd r bd sn4 }
2559 \include "nederlands.ly"
2560 bass = \notes \transpose c c,, { a4. e8 r e g e }
2561 \score {
2562     <
2563         \apply #(drums->paper 'drums) \context Staff = drums <
2564             \clef percussion
2565             \context Voice = up { \voiceOne \up }
2566             \context Voice = down { \voiceTwo \down }
2567         >
2568         \context Staff = bass { \clef "F_8" \bass }
2569     >
2570 }
2571 @end lilypond
2572
2573 @node Percussion midi output
2574 @subsection Percussion midi output
2575
2576 In order to produce correct midi output you need to produce two score
2577 blocks---one for the paper and one for the midi output.  To use the
2578 percussion channel you set the property @code{instrument} to
2579 @code{'drums}. Because the drum-pitches themself are similar to the
2580 general midi pitches all you have to do is to insert the voices with
2581 none of the scheme functions to get the correct midi output:
2582
2583 @example
2584 \score @{    
2585     \apply #(drums->paper 'mydrums) \context Staff <
2586         \clef percussion
2587         @{ \up @}  \\
2588         @{ \down @}
2589     >
2590     \paper@{@}
2591 @}
2592 \score @{    
2593     \context Staff <
2594         \property Staff.instrument = #'drums
2595         \up \down
2596     >
2597     \midi@{@}
2598 @}
2599 @end example
2600
2601 @refbugs
2602
2603 This scheme is to be considered a temporary implementation.
2604
2605
2606 @node Piano music
2607 @section Piano music
2608
2609 Piano staves are two normal staves coupled with a brace.  The staves
2610 are largely independent, but sometimes voices can cross between the
2611 two staves.  The same notation is also used for harps and other key
2612 instruments.  The @internalsref{PianoStaff} is especially built to
2613 handle this cross-staffing behavior.  In this section we discuss the
2614 @internalsref{PianoStaff} and some other pianistic peculiarities.
2615
2616
2617 @menu
2618 * Automatic staff changes::     
2619 * Manual staff switches::       
2620 * Pedals::                      
2621 * Arpeggio::                    
2622 * Voice follower lines::        
2623 @end menu 
2624
2625 @refbugs
2626
2627 There is no support for putting chords across staves.  You can get
2628 this result by increasing the length of the stem in the lower stave so
2629 it reaches the stem in the upper stave, or vice versa. An example is
2630 included with the distribution as @inputfileref{input/test,stem-cross-staff.ly}.
2631
2632 Dynamics are not centered, but kludges do exist. See
2633 @inputfileref{input/templates,piano-dynamics.ly}.
2634
2635 @cindex cross staff stem
2636 @cindex stem, cross staff
2637
2638
2639 @c fixme: should have hyperlinks as well.
2640
2641
2642
2643
2644
2645 @node Automatic staff changes
2646 @subsection Automatic staff changes
2647 @cindex Automatic staff changes
2648
2649 Voices can switch automatically between the top and the bottom
2650 staff. The syntax for this is
2651 @example
2652   \autochange Staff \context Voice @{ @dots{}@var{music}@dots{} @}
2653 @end example        
2654 The autochanger switches on basis of pitch (central C is the turning
2655 point), and it looks ahead skipping over rests to switch rests in
2656 advance. Here is a practical example:
2657         
2658 @lilypond[verbatim,singleline,quote]
2659 \score { \notes \context PianoStaff <
2660   \context Staff = "up" {
2661     \autochange Staff \context Voice = VA < \relative c' {
2662        g4 a  b c d r4 a g } > }
2663   \context Staff = "down" {
2664        \clef bass
2665        s1*2
2666 } > }
2667 @end lilypond
2668 Spacer rests are used to prevent the bottom staff from
2669 terminating too soon.
2670
2671
2672 @refbugs
2673
2674 The staff switches often do not end up in optimal places. For high
2675 quality output staff switches should be specified manually.
2676
2677  
2678
2679 @node Manual staff switches
2680 @subsection Manual staff switches
2681
2682 @cindex manual staff switches
2683 @cindex staff switch, manual
2684
2685 Voices can be switched between staves manually, using the following command:
2686 @example
2687   \translator Staff = @var{staffname} @var{music}
2688 @end example
2689 The string @var{staffname} is the name of the staff. It switches the
2690 current voice from its current staff to the Staff called
2691 @var{staffname}. Typically @var{staffname} is @code{"up"} or
2692 @code{"down"}.
2693
2694
2695 @node Pedals
2696 @subsection Pedals
2697 @cindex Pedals
2698
2699 Pianos have pedals that alter the way sound are produced. Generally, a
2700 piano has three pedals, sustain, una corda, and sostenuto.
2701
2702 @syntax
2703
2704 Piano pedal instruction can be expressed by attaching
2705 @code{\sustainDown}, @code{\sustainUp}, @code{\unaCorda},
2706 @code{\treCorde}, @code{\sostenutoDown} and @code{\sostenutoUp} to a
2707 note or chord.
2708
2709 The symbols that are printed can be modified by setting
2710 @code{pedal@var{X}Strings}, where @var{X} is one of the pedal types:
2711 Sustain, Sostenuto or UnaCorda.  Refer to the generated documentation
2712 of @internalsref{SustainPedal} for more information.
2713
2714 Pedals can also be indicated by a sequence of brackets, by setting the 
2715 @code{pedal-type} property of @internalsref{SustainPedal} objects: 
2716
2717 @lilypond[fragment,verbatim]
2718 \property Staff.SustainPedal \override #'pedal-type = #'bracket
2719  c''4-\sustainDown d''4 e''4
2720  a'4-\sustainUp-\sustainDown
2721  f'4 g'4 a'4-\sustainUp
2722 @end lilypond
2723
2724 A third style of pedal notation is a mixture of text and brackets,
2725 obtained by setting @code{pedal-type} to @code{mixed}:
2726
2727 @lilypond[fragment,verbatim]
2728 \property Staff.SustainPedal \override #'pedal-type = #'mixed
2729 c''4-\sustainDown d''4 e''4
2730 c'4-\sustainUp-\sustainDown
2731  f'4 g'4 a'4-\sustainUp
2732 @end lilypond
2733
2734 The default '*Ped' style for sustain and damper pedals corresponds to
2735 @code{\pedal-type = #'text}. However, @code{mixed} is the default style
2736 for a sostenuto pedal:
2737
2738 @lilypond[fragment,verbatim]
2739 c''4-\sostenutoDown d''4 e''4 c'4 f'4 g'4 a'4-\sostenutoUp
2740 @end lilypond
2741
2742 For fine-tuning of the appearance of a pedal bracket, the properties
2743 @code{edge-width}, @code{edge-height}, and @code{shorten-pair} of
2744 @code{PianoPedalBracket} objects (see the detailed documentation of
2745 @internalsref{PianoPedalBracket}) can be modified.  For example, the bracket
2746 may be extended to the end of the note head.
2747
2748 @lilypond[fragment,verbatim]
2749 \property Staff.PianoPedalBracket \override
2750    #'shorten-pair = #'(0 . -1.0)
2751 c''4-\sostenutoDown d''4 e''4 c'4
2752 f'4 g'4 a'4-\sostenutoUp
2753 @end lilypond
2754
2755 @node Arpeggio
2756 @subsection Arpeggio
2757 @cindex Arpeggio
2758
2759 @cindex broken arpeggio
2760 @cindex @code{\arpeggio}
2761
2762 You can specify an arpeggio sign on a chord by attaching an
2763 @code{\arpeggio} to a chord.
2764
2765
2766 @lilypond[fragment,relative,verbatim]
2767   <<c e g c>>-\arpeggio
2768 @end lilypond
2769
2770 When an arpeggio crosses staves in piano music, you attach an arpeggio
2771 to the chords in both staves, and set
2772 @internalsref{PianoStaff}.@code{connectArpeggios}.
2773
2774 @lilypond[fragment,relative,verbatim]
2775   \context PianoStaff <
2776     \property PianoStaff.connectArpeggios = ##t
2777     \context Voice = one  { <<c' e g c>>-\arpeggio }
2778     \context Voice = other { \clef bass  <<c,, e g>>-\arpeggio }
2779   >
2780 @end lilypond
2781
2782 This command creates @internalsref{Arpeggio} objects.  Cross staff
2783 arpeggios are @internalsref{PianoStaff}.@internalsref{Arpeggio}.
2784
2785 The direction of the arpeggio is sometimes denoted by adding an
2786 arrowhead to the wiggly line.  This can be typeset by setting
2787 @code{arpeggio-direction}.
2788
2789 @lilypond[fragment,relative,verbatim]
2790   \context Voice {
2791      \property Voice.Arpeggio \set #'arpeggio-direction = #1
2792      <<c e g c>>-\arpeggio
2793      \property Voice.Arpeggio \set #'arpeggio-direction = #-1
2794      <<c e g c>>-\arpeggio
2795   }
2796 @end lilypond
2797
2798 A square bracket on the left indicates that the player should not
2799 arpeggiate the chord. To draw these brackets, set the
2800 @code{molecule-callback} property of @code{Arpeggio} or
2801 @code{PianoStaff.Arpeggio} objects to @code{\arpeggioBracket}, and use
2802 @code{\arpeggio} statements within the chords as before.
2803
2804 @lilypond[fragment,relative,verbatim]
2805     \property PianoStaff.Arpeggio \override
2806         #'molecule-callback = \arpeggioBracket
2807        <<c' e g c>>-\arpeggio
2808 @end lilypond
2809
2810
2811 @refbugs
2812
2813 It is not possible to mix connected arpeggios and unconnected
2814 arpeggios in one @internalsref{PianoStaff} at the same time.
2815
2816 @node  Voice follower lines
2817 @subsection Voice follower lines
2818
2819
2820 [TODO: invent better name]
2821
2822 @cindex follow voice
2823 @cindex staff switching
2824 @cindex cross staff
2825
2826 @cindex @code{followVoice}
2827
2828 Whenever a voice switches to another staff a line connecting the notes
2829 can be printed automatically. This is enabled if the property
2830 @code{PianoStaff.followVoice} is set to true:
2831
2832 @lilypond[fragment,relative,verbatim]
2833   \context PianoStaff <
2834     \property PianoStaff.followVoice = ##t
2835     \context Staff \context Voice {
2836       c1
2837       \translator Staff=two
2838       b2 a
2839     }
2840     \context Staff=two { \clef bass \skip 1*2 }
2841   >  
2842 @end lilypond
2843
2844 The associated object is @internalsref{VoiceFollower}.
2845
2846
2847 @node Vocal music
2848 @section Vocal music
2849
2850 For a discussion of how to put lyrics into a score, see section
2851 @code{Printing lyrics} in the tutorial.
2852
2853 [TODO: Move lyrics section from tutorial to here?]
2854
2855 See also the sections on @ref{Slurs} and @ref{Breath marks}.
2856
2857 [TODO: Move slurs / breath marks section to here?]
2858
2859 [TODO: Write subsection upon usage of ChoirStaff.]
2860
2861 For entering quotes in Lyrics mode, use the following
2862 @example
2863 "\"God\"" is "`King'"
2864 @end example
2865
2866 You can use empty syllables, e.g. @code{_4} or @code{" "4} to enter
2867 lyrics. This can confuse the LilyPond -- for example, this might put
2868 (empty) lyrics under rests. To remedy this, use @code{\skip}.
2869
2870
2871 @menu
2872 * Ambitus::                     
2873 @end menu
2874
2875 @node Ambitus
2876 @subsection Ambitus
2877 @cindex ambitus
2878
2879 The term @emph{ambitus} denotes a range of pitches for a given voice in
2880 a part of music.  It also may denote the pitch range that a musical
2881 instrument is capable of playing.  Most musical instruments have their
2882 ambitus standardized (or at least there is agreement upon the minimal
2883 ambitus of a particular type of instrument), such that a composer or
2884 arranger of a piece of music can easily meet the ambitus constraints of
2885 the targeted instrument.  However, the ambitus of the human voice
2886 depends on individual physiological state, including education and
2887 training of the voice.  Therefore, a singer potentially has to check for
2888 each piece of music if the ambitus of that piece meets his individual
2889 capabilities.  This is why the ambitus of a piece may be of particular
2890 value to vocal performers.
2891
2892 The ambitus is typically notated on a per-voice basis at the very
2893 beginning of a piece, e.g. nearby the initial clef or time signature of
2894 each staff.  The range is graphically specified by two noteheads, that
2895 represent the minimum and maximum pitch.  Some publishers use a textual
2896 notation: they put the range in words in front of the corresponding
2897 staff.  Lilypond currently only supports the graphical ambitus notation.
2898
2899 To apply, add the @internalsref{Ambitus_engraver} to the
2900 @internalsref{Voice} context, i.e.
2901
2902 @example
2903   \paper @{ \translator @{
2904       \VoiceContext
2905       \consists Ambitus_engraver
2906     @} @}
2907 @end example
2908
2909 For example,
2910
2911 @lilypond[singleline]
2912 upper = \notes \relative c {
2913   \clef "treble"
2914   \key c \minor
2915   as'' c e2 bes f cis d4 e f2 g
2916 }
2917 lower = \notes \relative c {
2918   \clef "treble"
2919   \key e \major
2920   e'4 b g a c es fis a cis b a g f e d2
2921 }
2922 \score {
2923   \context ChoirStaff {
2924     <
2925       \context Staff = one { \upper }
2926       \context Staff = three { \lower }
2927     >
2928   }
2929   \paper {
2930     \translator {
2931       \VoiceContext
2932       \consists Ambitus_engraver
2933     }
2934   }
2935 }
2936 @end lilypond
2937
2938
2939 @seealso
2940
2941 @internalsref{Ambitus}, @inputfileref{input/regression/,ambitus.ly}.
2942
2943 @node Tablatures
2944 @section Tablatures
2945
2946 Tablature notation is used for notating music for plucked string
2947 instruments.  It notates pitches not by using note heads, but by
2948 indicating on which string and fret a note must be played.  LilyPond
2949 offers limited support for tablature.
2950
2951 @menu
2952 * Tablatures basic::            
2953 * Non-guitar tablatures::       
2954 @end menu
2955
2956 @node Tablatures basic
2957 @subsection Tablatures basic
2958 @cindex Tablatures basic
2959
2960 The string number associated to a note is given as a backslash
2961 followed by a number, e.g. @code{c4\3} for a C quarter on the third
2962 string. By default, string 1 is the highest one, and the tuning
2963 defaults to the standard guitar tuning (with 6 strings).  The notes
2964 are printed as tablature, by using @internalsref{TabStaff} and
2965 @internalsref{TabVoice} contexts.
2966
2967 @lilypond[fragment,verbatim]
2968 \notes \context TabStaff  {
2969  a,4\5 c'\2 a\3 e'\1
2970  e\4 c'\2 a\3 e'\1
2971 }
2972 @end lilypond
2973
2974 If you do not specify a string number then one is selected
2975 automatically: the first string that does not give a fret number less
2976 than @code{minimumFret} is selected. The default value for
2977 @code{minimumFret} is 0.
2978
2979
2980 @example
2981 e8 fis gis a b cis' dis' e'
2982 \property TabStaff.minimumFret = #8
2983 e8 fis gis a b cis' dis' e'
2984 @end example
2985 @lilypond[noindent]
2986 frag = \notes {
2987     \key e \major
2988     e8 fis gis a b cis' dis' e'
2989     \property TabStaff.minimumFret = #8
2990     e8 fis gis a b cis' dis' e'
2991 }
2992 \score {
2993   \context StaffGroup <
2994     \context Staff { \clef "G_8" \frag }
2995     \context TabStaff { \frag }
2996   >
2997 }
2998 @end lilypond
2999
3000 @seealso
3001
3002 @internalsref{TabStaff}, @internalsref{TabVoice}
3003
3004 @refbugs
3005
3006 Chords are not handled in a special way, and hence the automatic
3007 string selector may easily select the same string to two notes in a
3008 chord.
3009
3010
3011 @node Non-guitar tablatures
3012 @subsection Non-guitar tablatures
3013 @cindex Non-guitar tablatures
3014
3015  You can change the number of strings, by setting the number of lines
3016 in the @internalsref{TabStaff} (the @code{line-count} property of
3017 @internalsref{TabStaff} can only be changed using
3018 @code{\outputproperty}, for more information, see @ref{Tuning per
3019 object}.
3020
3021 You can change the tuning of the strings. A string tuning is given as
3022 a Scheme list with one integer number for each string, the number
3023 being the pitch (measured in semitones relative to central C) of an
3024 open string.  The numbers specified for @code{stringTuning} are the
3025 numbers of semitones to subtract or add, starting the specified pitch
3026 by default middle C, in string order: thus the notes are e, a, d, and
3027 g.
3028
3029 @lilypond[fragment,verbatim]
3030   \context TabStaff <
3031
3032     \outputproperty #(make-type-checker 'staff-symbol-interface)
3033                     #'line-count = #4
3034     \property TabStaff.stringTunings =  #'(-5 -10 -15 -20)
3035     
3036     \notes {
3037       a,4 c' a e' e c' a e'
3038     }
3039   > 
3040 @end lilypond
3041
3042 Finally, it is possible to change the Scheme function to format the
3043 tablature note text. The default is
3044 @var{fret-number-tablature-format}, which uses the fret number. For
3045 some instruments that do not use this notation, you can create a
3046 special tablature formatting function. This function takes three
3047 argument: the string number, the string tuning and the note pitch.
3048
3049 @refbugs
3050
3051 As tablature is a recent feature, most of the guitar special effects
3052 such as bend are not yet supported.
3053
3054
3055 @node Chords
3056 @section Chords
3057 @cindex Chords
3058
3059 LilyPond has support for both entering and printing chords. 
3060 @lilypond[verbatim,singleline]
3061 twoWays = \notes \transpose c c' {
3062   \chords {
3063     c1 f:sus4 bes/f
3064   }
3065   <<c e g>>
3066   <<f bes c'>>
3067   <<f bes d'>>
3068   }
3069
3070 \score {
3071    < \context ChordNames \twoWays
3072      \context Voice \twoWays > }
3073 @end lilypond
3074
3075 This example also shows that the chord printing routines do not try to
3076 be intelligent. If you enter @code{f bes d}, it does not interpret
3077 this as an inversion.
3078
3079 Chords are represented as a set of pitches. They are internally
3080 stored as simultaneous music expressions. This means you can enter
3081 chords by name and print them as notes, enter them as notes and print
3082 them as chord names, or (the most common case) enter them by name, and
3083 print them as name.
3084
3085 @menu
3086 * Chords mode::                 
3087 * Printing chord names::       
3088 @end menu
3089
3090
3091 @node Chords mode
3092 @subsection Chords mode
3093 @cindex Chords mode
3094
3095 Chord mode is a mode where you can input sets of pitches using common
3096 names.  It is introduced by the keyword @code{\chords}.
3097 In chords mode,  a  chord is entered by the root, which is entered
3098 like a common pitch, for example,
3099 @lilypond[fragment,verbatim,quote, relative=1]
3100 \chords { es4.  d8 c2 }
3101 @end lilypond
3102 @cindex chord entry
3103 @cindex chord mode
3104
3105 Other chords may be entered by suffixing a colon, and introducing a
3106 modifier, and optionally, a number, for example
3107 @c
3108 @lilypond[fragment,verbatim,quote]
3109 \chords { e1:m e1:7 e1:m7  }
3110 @end lilypond
3111 The first number following the root is taken to be the `type' of the
3112 chord, thirds are added to the root until it reaches the specified
3113 number, for example.
3114 @lilypond[fragment,verbatim]
3115  \chords { c:3 c:5 c:6 c:7 c:8 c:9 c:10 c:11 }
3116 @end lilypond
3117
3118 @cindex root of chord
3119 @cindex additions, in chords
3120 @cindex removals, in  chords
3121
3122 More complex chords may also be constructed  adding separate steps
3123 to a chord. Additions are added after the  number following
3124 the colon, and are separated by dots. For example
3125 @c
3126 @lilypond[verbatim,fragment,quote]
3127   \chords { c:5.6 c:3.7.8 c:3.6.13 }
3128 @end lilypond
3129 Chord steps can be  altered by suffixing a @code{-} or @code{+} sign
3130 to the number, for example:
3131 @lilypond[verbatim,fragment,quote]
3132   \chords { c:7+ c:5+.3-  c:3-.5-.7- }
3133 @end lilypond
3134 Removals are specified similarly, and are introduced by a caret.  They
3135 must come after the additions.
3136 @lilypond[verbatim,fragment]
3137   \chords { c^3 c:7^5 c:9^3.5 }
3138 @end lilypond
3139
3140 Modifiers can be used to change pitches. The following modifiers are
3141 supported
3142 @table @code
3143 @item m
3144   is the minor chord. This modifier lowers the 3rd and (if present) the 7th step.
3145 @item dim
3146   is the   diminished chord. This modifier lowers the 3rd, 5th and (if present)
3147   the 7th step 
3148 @item aug
3149   is the augmented chord. This modifier raises the 5th step.
3150 @item maj
3151   is the major 7th chord. This modifier raises the 7th step if present.  
3152 @item sus
3153   is the suspended 4th or 2nd. This modifier removes the 3rd
3154 step. Append either @code{2} or @code{4} to add the 2nd or 4th step to
3155 the chord.
3156 @end table
3157 Modifiers can be mixed with additions. 
3158 @lilypond[verbatim,fragment]
3159   \chords { c:sus4 c:7sus4 c:dim7 c:m6 } 
3160 @end lilypond
3161
3162 @cindex modifiers, in chords. 
3163 @cindex @code{aug}
3164 @cindex @code{dim}
3165 @cindex @code{maj}
3166 @cindex @code{sus}
3167 @cindex @code{m}
3168
3169 Since the unaltered 11 does sound well when combined with the
3170 unaltered 3, the 11 is removed in this case, unless it is added
3171 explicitly). For example,
3172 @lilypond[fragment,verbatim]
3173   \chords { c:13 c:13.11 c:m13 }
3174 @end lilypond 
3175
3176 @cindex @code{/}
3177
3178 An inversion (putting one pitch of the chord on the bottom), as well
3179 as bass notes, can be specified by appending
3180 @code{/}@var{pitch} to the chord. 
3181 @lilypond[fragment,verbatim,center]
3182    \chords { c1 c/g c/f }
3183 @end lilypond 
3184 @cindex @code{/+}
3185 If you do not want to remove the bass note from the chord, but rather
3186 add the note, then you can use @code{/+}@var{pitch}.
3187
3188 @lilypond[fragment,verbatim,center]
3189    \chords { c1 c/+g c/+f }
3190 @end lilypond 
3191
3192 Chords is a mode similar to @code{\lyrics}, @code{\notes} etc.  Most
3193 of the commands continue to work, for example, @code{r} and
3194 @code{\skip} can be used to insert rests and spaces, and
3195 @code{\property} may be used to change various settings.
3196
3197
3198
3199 @refbugs
3200
3201 Each step can only be present in a chord once.  The following
3202 simply produces the augmented chord, since @code{5+} is interpreted
3203 last.
3204 @cindex clusters
3205 @lilypond[verbatim,fragment]
3206   \chords { c:5.5-.5+ }
3207 @end lilypond
3208
3209 In chord mode, dashes and carets are used to indicate chord additions
3210 and subtractions, so articulation scripts can not be entered.
3211
3212
3213 @node Printing chord names
3214 @subsection Printing chord names
3215
3216 @cindex printing chord names
3217 @cindex chord names
3218 @cindex chords
3219
3220 For displaying printed chord names, use the @internalsref{ChordNames} context.
3221 The chords may be entered either using the notation described above, or
3222 directly using simultaneous music.
3223
3224 @lilypond[verbatim,singleline]
3225 scheme = \notes {
3226   \chords {a1 b c} <<d f g>>  <<e g b>>
3227 }
3228 \score {
3229   \notes<
3230     \context ChordNames \scheme
3231     \context Staff \transpose c c' \scheme
3232   >
3233 }
3234 @end lilypond
3235
3236 You can make the chord changes stand out by setting
3237 @internalsref{ChordNames}.@code{chordChanges} to true.  This will only
3238 display chord names when there is a change in the chords scheme and at
3239 the start of a new line.
3240
3241 @lilypond[verbatim]
3242 scheme = \chords {
3243   c1:m c:m \break c:m c:m d
3244 }
3245 \score {
3246   \notes <
3247     \context ChordNames {
3248         \property ChordNames.chordChanges = ##t
3249         \scheme }
3250     \context Staff \transpose c c' \scheme
3251   >
3252 \paper{linewidth= 9.\cm}
3253 }
3254 @end lilypond
3255
3256 The default chord name layout is a system for Jazz music, proposed by
3257 Klaus Ignatzek (See @ref{Literature}).
3258
3259 [TODO: add description for banter other jazz.]
3260
3261 The Ignatzek chord name formatting can be tuned in a number of ways
3262 through the following properties:
3263 @table @code
3264 @item chordNameExceptions
3265 This is a list that contains the chords that have special formatting.
3266 For an example, see
3267 @inputfileref{input/regression/,chord-name-exceptions.ly}.
3268
3269 @item majorSevenSymbol
3270 This property contains the markup object used for the 7th step, when
3271 it is major. Predefined options are @code{whiteTriangleMarkup},
3272 @code{blackTriangleMarkup}.  See
3273 @inputfileref{input/regression/,chord-name-major7.ly} for an example.
3274
3275 @item chordNameSeparator
3276 Different parts of a chord name are normally separated by a
3277 slash. By setting @code{chordNameSeparator}, you can specify other
3278 separators, e.g.
3279 @lilypond[fragment,verbatim]
3280 \context ChordNames \chords {
3281       c:7sus4
3282       \property ChordNames.chordNameSeparator
3283         = \markup { "|" }
3284       c:7sus4 }
3285 @end lilypond
3286 @end table
3287
3288
3289 @seealso
3290
3291 @inputfileref{input/regression/,chord-name-major7.ly},
3292 @inputfileref{input/regression/,chord-name-exceptions.ly},
3293 @file{scm/chords-ignatzek.scm}, @file{scm/chord-entry.scm}
3294
3295
3296 @refbugs
3297
3298 Chord names are determined solely from the list of pitches. Chord
3299 inversions are not identified, and neither are added bass notes. This
3300 may result in strange chord names when chords are entered with the
3301 @code{<< .. >>} syntax.
3302
3303
3304
3305
3306 @node Writing parts
3307 @section Writing parts
3308
3309 Orchestral music involves some special notation, both in the full score,
3310 as in the individual parts. This section explains how to tackle common
3311 problems in orchestral music.
3312
3313
3314
3315 @menu
3316 * Rehearsal marks::             
3317 * Bar numbers::                 
3318 * Instrument names::            
3319 * Transpose::                   
3320 * Multi measure rests::         
3321 * Automatic part combining::    
3322 * Hara kiri staves::            
3323 * Sound output for transposing instruments::  
3324 @end menu
3325
3326
3327 @node Rehearsal marks
3328 @subsection Rehearsal marks
3329 @cindex Rehearsal marks
3330 @cindex mark
3331 @cindex @code{\mark}
3332
3333 To print a  rehearsal mark, use the @code{\mark} command. 
3334 @lilypond[fragment,verbatim]
3335 \relative c'' {
3336   c1 \mark "A"
3337   c1 \mark "B"
3338   c1 \mark "12"
3339   c1 \mark "13"
3340   c1
3341 }
3342 @end lilypond
3343
3344 The mark is incremented automatically if you use @code{\mark
3345 \default}. The value to use is stored in the property
3346 @code{rehearsalMark} is used and automatically incremented.
3347
3348 The @code{\mark} command can also be used to put signs like coda,
3349 segno and fermatas on a barline. Use @code{\markup} to
3350 to access the appropriate symbol.
3351
3352 @lilypond[fragment,verbatim,relative=1]
3353   c1 \mark \markup { \musicglyph #"scripts-ufermata" }
3354   c1
3355 @end lilypond
3356
3357 In this case, during line breaks,
3358 marks must also be printed at the end of the line, and not at the
3359 beginning. Use the following to force that behavior
3360 @example
3361 \property Score.RehearsalMark \override
3362   #'break-visibility = #begin-of-line-invisible
3363 @end example
3364
3365 @cindex fermatas
3366 @cindex coda
3367 @cindex segno
3368 @cindex barlines, putting symbols on 
3369
3370 @seealso
3371
3372 The object is @internalsref{RehearsalMark} in @internalsref{Score}
3373 context. See @inputfileref{input/test,boxed-molecule.ly} for putting
3374 boxes around the marks.
3375
3376
3377 @node Bar numbers
3378 @subsection Bar numbers
3379
3380
3381 @cindex bar numbers
3382 @cindex measure numbers
3383 @cindex currentBarNumber
3384
3385 Bar numbers are printed by default at the start of the line.  The
3386 number itself is stored in the 
3387 @code{currentBarNumber} property,
3388 which is normally updated automatically for every measure.
3389
3390 Bar numbers can be typeset at regular intervals instead of at the
3391 beginning of each line. This is illustrated in the following example,
3392 whose source is available as
3393 @inputfileref{input/test/,bar-number-every-fifth.ly}
3394
3395 @lilypondfile[notexidoc]{bar-number-every-fifth.ly}
3396
3397 The start of that numbering can also be reset, as demonstrated in
3398 @inputfileref{input/test/,bar-number-every-5-reset.ly}.
3399
3400 @lilypondfile[notexidoc]{bar-number-every-5-reset.ly}
3401
3402
3403 @seealso
3404
3405 @internalsref{BarNumber}.
3406 @inputfileref{input/test/,bar-number-every-5-reset.ly}.
3407 @inputfileref{input/test/,bar-number-every-fifth.ly}
3408
3409 @refbugs
3410
3411 Bar numbers can collide with the @internalsref{StaffGroup} bracket, if
3412 there is one at the top. To solve this, You have to twiddle with the
3413 @internalsref{padding} property of @internalsref{BarNumber} if your
3414 score starts with a @internalsref{StaffGroup}.
3415
3416 @node Instrument names
3417 @subsection Instrument names
3418
3419 In an orchestral score, instrument names are printed left of the
3420 staffs.
3421
3422 This can be achieved by setting @internalsref{Staff}.@code{instrument}
3423 and @internalsref{Staff}.@code{instr}. This will print a string before
3424 the start of the staff. For the first start, @code{instrument} is
3425 used, for the next ones @code{instr} is used.
3426
3427 @lilypond[verbatim,singleline]
3428   \property Staff.instrument = "ploink " { c''4 }  
3429 @end lilypond
3430
3431 You can also use markup texts to construct more complicated instrument
3432 names.
3433
3434 @lilypond[fragment,verbatim,singleline]
3435   \notes \context Staff = treble {
3436     \property Staff.instrument = \markup {
3437         \column << "Clarinetti"
3438           { "in B"
3439             \smaller \musicglyph #"accidentals--1"
3440           }
3441           >>
3442      }
3443      { c''1 }
3444   }
3445 @end lilypond
3446
3447
3448 @refbugs
3449
3450 When you put a name on a grand staff or piano staff the width of the
3451 brace is not taken into account. You must add extra spaces to the end of
3452 the name to avoid a collision.
3453
3454 @node Transpose
3455 @subsection Transpose
3456 @cindex Transpose
3457 @cindex transposition of pitches
3458 @cindex @code{\transpose}
3459
3460 A music expression can be transposed with @code{\transpose}.  The syntax
3461 is
3462 @example
3463   \transpose @var{from} @var{to} @var{musicexpr}
3464 @end example
3465
3466 This means that @var{musicexpr} is transposed by the interval
3467 between @var{from} and @var{to}.
3468
3469 @code{\transpose} distinguishes between enharmonic pitches: both
3470 @code{\transpose c cis} or @code{\transpose c des} will transpose up
3471 half a tone.  The first version will print sharps and the second
3472 version will print flats.
3473
3474 @lilypond[singleline, verbatim]
3475 mus =\notes { \key d \major cis d fis g }
3476 \score { \notes \context Staff {
3477   \clef "F" \mus
3478   \clef "G"
3479   \transpose c g' \mus
3480   \transpose c f' \mus
3481 }}
3482 @end lilypond
3483
3484 @refbugs
3485
3486 If you want to use both @code{\transpose} and @code{\relative}, then
3487 you must put @code{\transpose} outside of @code{\relative}, since
3488 @code{\relative} will have no effect music that appears inside a
3489 @code{\transpose}.
3490
3491
3492 @node  Multi measure rests
3493 @subsection Multi measure rests
3494 @cindex Multi measure rests
3495
3496 @cindex @code{R}
3497
3498 Multi measure rests are entered using `@code{R}'. It is specifically
3499 meant for full bar rests and for entering parts: the rest can expand to
3500 fill a score with rests, or it can be printed as a single multimeasure
3501 rest. This expansion is controlled by the property
3502 @code{Score.skipBars}. If this is set to true, Lily will not expand
3503 empty measures, and the appropriate number is added automatically.
3504
3505 @lilypond[fragment,verbatim]
3506  \time 4/4 r1 | R1 | R1*2
3507  \property Score.skipBars = ##t R1*17  R1*4
3508 @end lilypond
3509
3510 The @code{1} in @code{R1} is similar to the duration notation used for
3511 notes. Hence, for time signatures other than 4/4, you must enter other
3512 durations.  This can be done with augmentation dots or fractions:
3513
3514 @lilypond[fragment,verbatim]
3515  \property Score.skipBars = ##t
3516  \time 3/4
3517   R2. | R2.*2
3518  \time 13/8
3519  R1*13/8
3520  R1*13/8*12
3521 @end lilypond
3522
3523 A @code{R} spanning a single measure is printed as a whole rest
3524 centered in the measure (or a breve when the measure lasts longer than
3525 two whole notes), regardless of the time signature.
3526
3527  
3528
3529 @cindex text on multi-measure rest
3530 @cindex script on multi-measure rest
3531 @cindex fermata on multi-measure rest
3532
3533 Texts can be added to multi-measure rests by using the
3534 @var{note}-@code{markup} syntax.  In this case, the number is
3535 replaced. If you need both texts and the number, you must add the
3536 number by hand. An identifier (@code{fermataMarkup}) is provided for
3537 adding fermatas.
3538
3539
3540 @lilypond[verbatim,fragment]
3541   \time 3/4
3542   R2._\markup { "Ad lib" }
3543   R2.^\fermataMarkup
3544 @end lilypond
3545
3546
3547 @cindex whole rests for a full measure 
3548
3549 @seealso
3550
3551 The object for this object is @internalsref{MultiMeasureRest},
3552 @internalsref{MultiMeasureRestNumber} (for the default number), and
3553 @internalsref{MultiMeasureRestText} (for user specified texts).
3554
3555 @refbugs
3556
3557 It is not possible to use fingerings (e.g. @code{R1-4}) to put numbers
3558 over multi-measure rests.
3559
3560 @cindex condensing rests
3561
3562 There is no way to automatically condense multiple rests into a single
3563 multimeasure rest. Multi measure rests do not take part in rest
3564 collisions.
3565
3566 Be careful when entering multimeasure rests followed by whole notes,
3567 @example
3568  R1*4 cis cis 
3569 @end example
3570 will enter two notes lasting four measures each. The result will look
3571 ok, but the bar numbering will be off.
3572
3573 @node Automatic part combining
3574 @subsection Automatic part combining
3575 @cindex automatic part combining
3576 @cindex part combiner
3577
3578
3579 Automatic part combining is used to merge two parts of music onto a
3580 staff.  It is aimed at typesetting orchestral scores.  When the two
3581 parts are identical for a period of time, only one is shown.  In
3582 places where the two parts differ, they are typeset as separate
3583 voices, and stem directions are set automatically.  Also, solo and
3584 @emph{a due} parts are identified and can be marked.
3585
3586 @syntax
3587
3588 The syntax for part combining is
3589
3590 @example
3591   \partcombine @var{context} @var{musicexpr1} @var{musicexpr2}
3592 @end example
3593 where the pieces of music @var{musicexpr1} and @var{musicexpr2} will be
3594 combined into one context of type @var{context}.  The music expressions
3595 must be interpreted by contexts whose names should start with @code{one}
3596 and @code{two}.
3597
3598 The following example demonstrates the basic functionality of the part
3599 combiner: putting parts on one staff, and setting stem directions and
3600 polyphony.
3601
3602 @lilypond[verbatim,singleline,fragment]
3603   \context Staff <
3604     \context Voice=one \partcombine Voice
3605       \context Thread=one \relative c'' {
3606         g a () b r
3607       }
3608       \context Thread=two \relative c'' {
3609         g r4 r f
3610       }
3611   >
3612 @end lilypond
3613
3614 The first @code{g} appears only once, although it was
3615 specified twice (once in each part).  Stem, slur and tie directions are
3616 set automatically, depending whether there is a solo or unisono. The
3617 first part (with context called @code{one}) always gets up stems, and
3618 `solo', while the second (called @code{two}) always gets down stems and
3619 `Solo II'.
3620
3621 If you just want the merging parts, and not the textual markings, you
3622 may set the property @var{soloADue} to false.
3623
3624 @lilypond[verbatim,singleline,fragment]
3625   \context Staff <
3626     \property Staff.soloADue = ##f
3627     \context Voice=one \partcombine Voice
3628       \context Thread=one \relative c'' {
3629         b4 a c g
3630       }
3631       \context Thread=two \relative c'' {
3632         d,2 a4 g'
3633       }
3634   >
3635 @end lilypond
3636
3637 @seealso
3638
3639  Look at the documentation of the responsible engravers,
3640 @code{Thread_devnull_engraver}, @code{Voice_devnull_engraver} and
3641 @code{A2_engraver}.
3642
3643 @refbugs
3644
3645 The syntax for naming contexts in inconsistent with the syntax for
3646 combining stanzas.
3647
3648 In @code{soloADue} mode, when the two voices play the same notes on and
3649 off, the part combiner may typeset @code{a2} more than once in a
3650 measure.
3651
3652 @lilypond[fragment,singleline]
3653   \context Staff <
3654     \context Voice=one \partcombine Voice
3655       \context Thread=one \relative c'' {
3656         c b c b c a c a
3657       }
3658       \context Thread=two \relative c'' {
3659         b b b b f a f a
3660       }
3661   >
3662 @end lilypond
3663
3664 The part combiner is slated to be rewritten [TODO: explain why] .
3665
3666 @cindex @code{Thread_devnull_engraver}
3667 @cindex @code{Voice_engraver}
3668 @cindex @code{A2_engraver}
3669
3670 @node Hara kiri staves
3671 @subsection Hara kiri staves
3672
3673 In orchestral scores, staff lines that only have rests are usually removed.
3674 This saves some space. This style is called `French Score'. 
3675
3676 @syntax
3677
3678 This is supported through the hara kiri@footnote{Hara kiri is the
3679 vulgar name for Seppuku, is the ritual suicide of the Japanese
3680 Samourai warriors.} staff. This staff commits suicide when it finds
3681 itself to be empty after the line-breaking process.  It will not
3682 disappear when it contains normal rests, you must use multi measure
3683 rests.
3684
3685 For @internalsref{Lyrics}, @internalsref{LyricsVoice},
3686 @internalsref{ChordNames} and @internalsref{FiguredBass}, hara-kiri is
3687 switched on by default. For normal staffs, hara kiri is available as a
3688 specialized @internalsref{Staff} context, with the name identifier
3689 @code{\HaraKiriStaffContext}.  Observe how the second staff in this
3690 example disappears in the second line.
3691
3692 @lilypond[verbatim]
3693 \score  {
3694   \notes \relative c' <
3695     \context Staff = SA { e4 f g a \break c1 }
3696     \context Staff = SB { c4 d e f \break R1 }
3697   >
3698   \paper {
3699     linewidth = 6.\cm 
3700     \translator { \HaraKiriStaffContext }
3701   }
3702 }
3703 @end lilypond
3704
3705
3706 @node Sound output for transposing instruments
3707 @subsection Sound output for transposing instruments
3708
3709 When you want to make a MIDI file from a score containing transposed
3710 and untransposed instruments, you have to instruct LilyPond the pitch
3711 offset (in semitones) for the transposed instruments. This is done
3712 using the @code{transposing} property. It does not affect printed
3713 output.
3714
3715 @cindex @code{transposing}
3716
3717 @example
3718         \property Staff.instrument = #"Cl. in B-flat"
3719         \property Staff.transposing = #-2
3720 @end example
3721
3722
3723 @node Ancient notation 
3724 @section Ancient notation
3725
3726 @cindex Vaticana, Editio
3727 @cindex Medicaea, Editio
3728 @cindex hufnagel
3729 @cindex Petrucci
3730 @cindex mensural
3731
3732 [TODO: write introduction on ancient notation]
3733
3734 @menu
3735 * Ancient note heads::          
3736 * Ancient clefs ::              
3737 * Custodes::                    
3738 * Divisiones::                  
3739 * Ligatures::                   
3740 * Figured bass::                
3741 @end menu
3742
3743
3744 @node Ancient note heads
3745 @subsection Ancient note heads
3746
3747 To get a longa note head, you have to use mensural note heads. This
3748 is accomplished by setting the @code{style} property of the
3749 NoteHead object to @code{mensural}. There is also a note head style
3750 @code{baroque} which gives mensural note heads for @code{\longa} and
3751 @code{\breve} but standard note heads for shorter notes.
3752
3753 @lilypond[fragment,singleline,verbatim]
3754  \property Voice.NoteHead \set #'style = #'mensural
3755  a'\longa
3756 @end lilypond
3757
3758 @node Ancient clefs 
3759 @subsection Ancient clefs
3760
3761 LilyPond supports a variety of clefs, many of them ancient.
3762
3763 For modern clefs, see section @ref{Clef}.  For the percussion clef, see
3764 section @ref{Percussion staves}.  For the @code{TAB} clef, see section
3765 @ref{Tablatures}.
3766
3767 The following table shows all ancient clefs that are supported via the
3768 @code{\clef} command.  Some of the clefs use the same glyph, but differ
3769 only with respect to the line they are printed on.  In such cases, a
3770 trailing number in the name is used to enumerate these clefs.  Still,
3771 you can manually force a clef glyph to be typeset on an arbitrary line,
3772 as described in section @ref{Clef}.  The note printed to the right side
3773 of each clef denotes the @code{c'} with respect to the clef.
3774
3775 @table @code
3776
3777 @c --- This should go somewhere else: ---
3778 @c @item modern style G clef (glyph: @code{clefs-G})
3779 @c
3780 @c Supported clefs:
3781 @c @code{treble}, @code{violin}, @code{G}, @code{G2}, @code{french}
3782 @c
3783 @c @lilypond[26pt]{\property Staff.TimeSignature \set #'transparent = ##t \clef "G" c'}
3784 @c
3785 @c @item modern style F clef (glyph: @code{clefs-F})
3786 @c
3787 @c Supported clefs:
3788 @c @code{varbaritone}, @code{bass}, @code{F}, @code{subbass}
3789 @c
3790 @c @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "F" c'}
3791 @c
3792 @c @item modern style C clef (glyph: @code{clefs-C})
3793 @c
3794 @c Supported clefs:
3795 @c @code{soprano}, @code{mezzosoprano}, @code{alto}, @code{C},
3796 @c @code{tenor}, @code{baritone}
3797 @c
3798 @c @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "C" c'}
3799
3800 @item modern style mensural C clef (glyph: @code{clefs-neo_mensural_c'})
3801
3802 Supported clefs:
3803 @code{neo_mensural_c1}, @code{neo_mensural_c2},
3804 @code{neo_mensural_c3}, @code{neo_mensural_c4}
3805
3806 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "neo_mensural_c2" c'}
3807
3808 @item petrucci style mensural C clef (glyph: @code{clefs-petrucci_c1})
3809
3810 Supported clefs:
3811 @code{petrucci_c1}
3812 for 1st staffline
3813
3814 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "petrucci_c1" c'}
3815
3816 @item petrucci style mensural C clef (glyph: @code{clefs-petrucci_c2})
3817
3818 Supported clefs:
3819 @code{petrucci_c2}
3820 for 2nd staffline
3821
3822 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "petrucci_c2" c'}
3823
3824 @item petrucci style mensural C clef (glyph: @code{clefs-petrucci_c3})
3825
3826 Supported clefs:
3827 @code{petrucci_c3}
3828 for 3rd staffline
3829
3830 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "petrucci_c3" c'}
3831
3832 @item petrucci style mensural C clef (glyph: @code{clefs-petrucci_c4})
3833
3834 Supported clefs:
3835 @code{petrucci_c4}
3836 for 4th staffline
3837
3838 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "petrucci_c4" c'}
3839
3840 @item petrucci style mensural C clef (glyph: @code{clefs-petrucci_c5})
3841
3842 Supported clefs:
3843 @code{petrucci_c5}
3844 for 5th staffline
3845
3846 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "petrucci_c5" c'}
3847
3848 @item petrucci style mensural F clef (glyph: @code{clefs-petrucci_f})
3849
3850 Supported clefs:
3851 @code{petrucci_f}
3852
3853 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "petrucci_f" c'}
3854
3855 @item petrucci style mensural G clef (glyph: @code{clefs-petrucci_g})
3856
3857 Supported clefs:
3858 @code{petrucci_g}
3859
3860 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "petrucci_g" c'}
3861
3862 @item historic style mensural C clef (glyph: @code{clefs-mensural_c'})
3863
3864 Supported clefs:
3865 @code{mensural_c1}, @code{mensural_c2}, @code{mensural_c3},
3866 @code{mensural_c4}
3867
3868 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "mensural_c2" c'}
3869
3870 @item historic style mensural F clef (glyph: @code{clefs-mensural_f})
3871
3872 Supported clefs:
3873 @code{mensural_f}
3874
3875 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "mensural_f" c'}
3876
3877 @item historic style mensural G clef (glyph: @code{clefs-mensural_g})
3878
3879 Supported clefs:
3880 @code{mensural_g}
3881
3882 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "mensural_g" c'}
3883
3884 @item Editio Vaticana style do clef (glyph: @code{clefs-vaticana_do})
3885
3886 Supported clefs:
3887 @code{vaticana_do1}, @code{vaticana_do2}, @code{vaticana_do3}
3888
3889 @lilypond{\context Staff \outputproperty #(make-type-checker 'staff-symbol-interface) #'line-count = #4 \property Staff.TimeSignature \set #'transparent = ##t \clef "vaticana_do2" c'}
3890
3891 @item Editio Vaticana style fa clef (glyph: @code{clefs-vaticana_fa})
3892
3893 Supported clefs:
3894 @code{vaticana_fa1}, @code{vaticana_fa2}
3895
3896 @lilypond{\context Staff \outputproperty #(make-type-checker 'staff-symbol-interface) #'line-count = #4 \property Staff.TimeSignature \set #'transparent = ##t \clef "vaticana_fa2" c'}
3897
3898 @item Editio Medicaea style do clef (glyph: @code{clefs-medicaea_do})
3899
3900 Supported clefs:
3901 @code{medicaea_do1}, @code{medicaea_do2}, @code{medicaea_do3}
3902
3903 @lilypond{\context Staff \outputproperty #(make-type-checker 'staff-symbol-interface) #'line-count = #4 \property Staff.TimeSignature \set #'transparent = ##t \clef "medicaea_do2" c'}
3904
3905 @item Editio Medicaea style fa clef (glyph: @code{clefs-medicaea_fa})
3906
3907 Supported clefs:
3908 @code{medicaea_fa1}, @code{medicaea_fa2}
3909
3910 @lilypond{\context Staff \outputproperty #(make-type-checker 'staff-symbol-interface) #'line-count = #4 \property Staff.TimeSignature \set #'transparent = ##t \clef "medicaea_fa2" c'}
3911
3912 @item historic style hufnagel do clef (glyph: @code{clefs-hufnagel_do})
3913
3914 Supported clefs:
3915 @code{hufnagel_do1}, @code{hufnagel_do2}, @code{hufnagel_do3}
3916
3917 @lilypond{\context Staff \outputproperty #(make-type-checker 'staff-symbol-interface) #'line-count = #4 \property Staff.TimeSignature \set #'transparent = ##t \clef "hufnagel_do2" c'}
3918
3919 @item historic style hufnagel fa clef (glyph: @code{clefs-hufnagel_fa})
3920
3921 Supported clefs:
3922 @code{hufnagel_fa1}, @code{hufnagel_fa2}
3923
3924 @lilypond{\context Staff \outputproperty #(make-type-checker 'staff-symbol-interface) #'line-count = #4 \property Staff.TimeSignature \set #'transparent = ##t \clef "hufnagel_fa2" c'}
3925
3926 @item historic style hufnagel combined do/fa clef (glyph: @code{clefs-hufnagel_do_fa})
3927
3928 Supported clefs:
3929 @code{hufnagel_do_fa}
3930
3931 @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "hufnagel_do_fa" c'}
3932
3933 @c --- This should go somewhere else: ---
3934 @c @item modern style percussion clef (glyph: @code{clefs-percussion})
3935 @c
3936 @c Supported clefs:
3937 @c @code{percussion}
3938 @c
3939 @c @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "percussion" c'}
3940 @c
3941 @c @item modern style tab clef (glyph: @code{clefs-tab})
3942 @c
3943 @c Supported clefs:
3944 @c @code{tab}
3945 @c
3946 @c @lilypond{\context Staff \outputproperty #(make-type-checker 'staff-symbol-interface) #'line-count = #6 \property Staff.TimeSignature \set #'transparent = ##t \clef "tab" c'}
3947
3948 @end table
3949
3950 @emph{Modern style} means ``as is typeset in current editions of
3951 transcribed mensural music''.
3952
3953 @emph{Petrucci style} means ``inspired by printings published by the
3954 famous engraver Petrucci (1466-1539)''.
3955
3956 @emph{Historic style} means ``as was typeset or written in contemporary
3957 historic editions (other than those of Petrucci)''.
3958
3959 @emph{Editio XXX style} means ``as is/was printed in Editio XXX''.
3960
3961 Petrucci used C clefs with differently balanced left-side vertical
3962 beams, depending on which staffline it was printed.
3963
3964
3965 @node Custodes
3966 @subsection Custodes
3967
3968 @cindex custos
3969 @cindex custodes
3970
3971 A @emph{custos} (plural: @emph{custodes}; latin word for `guard') is a
3972 staff context symbol that appears at the end of a staff line.  It
3973 anticipates the pitch of the first note(s) of the following line and
3974 thus helps the player or singer to manage line breaks during
3975 performance, thus enhancing readability of a score.
3976
3977 @lilypond[verbatim]
3978 \score {
3979   \notes { c'1 \break
3980         \property Staff.Custos \set #'style = #'mensural
3981         d' }
3982   \paper {
3983     \translator {
3984       \StaffContext
3985       \consists Custos_engraver
3986     }
3987   }
3988 }
3989 @end lilypond
3990
3991 Custodes were frequently used in music notation until the 17th century.
3992 There were different appearances for different notation styles.
3993 Nowadays, they have survived only in special forms of musical notation
3994 such as via the @emph{editio vaticana} dating back to the beginning of
3995 the 20th century.
3996
3997 For typesetting custodes, just put a @code{Custos_engraver} into the
3998 Staff context when declaring the @code{\paper} block, as shown in the
3999 following example.  In the @code{\paper} block, you can also globally
4000 control the appearance of the custos symbol by setting the custos
4001 @code{style} property.
4002
4003 @example
4004 \paper @{
4005   \translator @{
4006       \StaffContext
4007       \consists Custos_engraver
4008       Custos \override #'style = #'mensural
4009   @}
4010 @}
4011 @end example
4012
4013 The property can also be set locally, for example in a @code{\notes}
4014 block:
4015
4016 @example
4017 \notes @{
4018   \property Staff.Custos \override #'style = #'vaticana
4019   c'1 d' e' d' \break c' d' e' d'
4020 @}
4021 @end example
4022
4023 Currently, the following styles are supported:
4024
4025 @lilypond
4026 \score {
4027     \notes {
4028         \fatText
4029         s
4030         ^\markup { "vaticana" }
4031         ^\markup { \musicglyph #"custodes-vaticana-u0" }
4032         s
4033         ^\markup { "medicaea" }
4034         ^\markup { \musicglyph #"custodes-medicaea-u0" }
4035         s
4036         ^\markup { "hufnagel" }
4037         ^\markup { \musicglyph #"custodes-hufnagel-u0" }
4038         s
4039         ^\markup { "mensural" }
4040         ^\markup { \musicglyph #"custodes-mensural-u0" }
4041     }
4042     \paper {
4043         linewidth = -1.0
4044         interscoreline = 1
4045         \translator {
4046             \ScoreContext
4047             \remove "Bar_number_engraver"
4048             TextScript \override #'extra-X-extent = #'(-1 . 1)
4049         }
4050         \translator{
4051             \StaffContext
4052             \remove "Clef_engraver"
4053             \remove "Key_engraver"
4054             \remove "Time_signature_engraver"
4055             \remove "Staff_symbol_engraver"
4056             minimumVerticalExtent = ##f
4057         }
4058     }
4059 }
4060 @end lilypond
4061
4062 If the boolean property @code{adjust-if-on-staffline} is set to
4063 @code{#t} (which it is by default), lily typesets slightly different
4064 variants of the custos glyph, depending on the pitch of the custos,
4065 i.e. depending on the glyph being typeset either on a staffline or
4066 between two stafflines.  The idea is that the glyph will optically fit
4067 well into the staff, with the appendage on the right of the custos
4068 always ending at the same vertical position between two stafflines
4069 regardless of the pitch.  If you set @code{adjust-if-on-staffline} to
4070 @code{#f}, then lily takes regardless of the pitch always a glyph that
4071 is a compromise of the former two variants.
4072
4073 Just like stems can be attached to noteheads in two directions
4074 @emph{up} and @emph{down}, each custos glyph is available with its
4075 appendage pointing either up or down.  If the pitch of a custos is
4076 above a selectable position, the appendage will point downwards; if
4077 the pitch is below this position, the appendage will point upwards.
4078 Use property @code{neutral-position} to select this position.  By
4079 default, it is set to @code{0}, such that the neutral position is the
4080 center of the staff.  Use property @code{neutral-direction} to control
4081 what happens if a custos is typeset on the neutral position itself.
4082 By default, this property is set to @code{-1}, such that the appendage
4083 will point downwards.  If set to @code{1}, the appendage will point
4084 upwards.  Other values such as @code{0} are reserved for future
4085 extensions and should not be used.
4086
4087 Example:
4088
4089 @example
4090 \notes @{
4091     \property Staff.Custos \set #'neutral-position = #4
4092     \property Staff.Custos \set #'neutral-direction = #-1
4093     \property Staff.Custos \set #'adjust-if-on-staffline = ##t
4094
4095     ...
4096
4097 @}
4098 @end example
4099
4100 @node Divisiones
4101 @subsection Divisiones
4102
4103 @cindex divisio
4104 @cindex divisiones
4105 @cindex finalis
4106
4107 A @emph{divisio} (plural: @emph{divisiones}; latin word for
4108 `division') is a staff context symbol that is used to structure
4109 Gregorian music into phrases and sections.  The musical meaning of
4110 @emph{divisio minima}, @emph{divisio maior} and @emph{divisio maxima}
4111 can be characterized as short, medium and long pause, somewhat like
4112 @ref{Breath marks}.  The @emph{finalis} sign not only marks the end of
4113 a chant, but is also frequently used within a single
4114 antiphonal/responsorial chant to mark the end of each section.
4115
4116 To use divisiones, just include the file @code{gregorian-init.ly}.  It
4117 contains definitions that you can apply by just inserting
4118 @code{\divisiominima}, @code{\divisiomaior}, @code{\divisiomaxima},
4119 and @code{\finalis} at proper places into your lilypond files.
4120
4121 @lilypond[verbatim]
4122 \include "gregorian-init.ly"
4123 \score {
4124     \notes {
4125         \context Staff = staff \addlyrics \notes \transpose c c' {
4126             \property Score.timing = ##f
4127             \property Score.barAlways = ##t
4128             \property Staff.BarLine \override #'transparent = ##t
4129             \property Voice.Stem \override #'transparent = ##t
4130             g4( )a g e( )f e
4131             ^\markup { "divisio minima" }
4132             \divisiominima
4133             g4( )a g e( )f e
4134             ^\markup { "divisio maior" }
4135             \divisiomaior
4136             g4( )a g e( )f e
4137             ^\markup { "divisio maxima" }
4138             \divisiomaxima
4139             g4( )a g e( )f e
4140             ^\markup { "finalis" }
4141             \finalis
4142             g4( )a g e( )f e
4143         }
4144         \context Lyrics = lyrics \lyrics {
4145             Blah blub, blah blam.
4146             Blah blub, blah blam.
4147             Blah blub, blah blam.
4148             Blah blub, blah blam.
4149             Blah blub, blah blam.
4150         }
4151     }
4152 }
4153 @end lilypond
4154
4155 Some editions use @emph{virgula} or @emph{caesura} instead of divisio
4156 minima.  Therefore, @code{gregorian-init.ly} also defines
4157 @code{\virgula} and @code{\caesura}.
4158
4159 @lilypond[verbatim]
4160 \include "gregorian-init.ly"
4161 \score {
4162     \notes {
4163         \context Staff = staff \addlyrics \notes \transpose c c' {
4164             \property Score.timing = ##f
4165             \property Score.barAlways = ##t
4166             \property Staff.BarLine \override #'transparent = ##t
4167             \property Voice.Stem \override #'transparent = ##t
4168             g4( )a g e( )f e
4169             ^\markup { "virgula" }
4170             \virgula
4171             g4( )a g e( )f e
4172             ^\markup { "caesura" }
4173             \caesura
4174             g4( )a g e( )f e
4175         }
4176         \context Lyrics = lyrics \lyrics {
4177             Blah blub, blah blam.
4178             Blah blub, blah blam.
4179             Blah blub, blah blam.
4180         }
4181     }
4182 }
4183 @end lilypond
4184
4185 @node Ligatures
4186 @subsection Ligatures
4187
4188 @cindex Ligatures
4189
4190 @c TODO: Should double check if I recalled things correctly when I wrote
4191 @c down the following paragraph by heart.
4192 In musical terminology, a ligature is a coherent graphical symbol that
4193 represents at least two different notes.  Ligatures originally appeared
4194 in the manuscripts of Gregorian chant notation roughly since the 9th
4195 century as an allusion to the accent symbols of greek lyric poetry to
4196 denote ascending or descending sequences of notes.  Both, the shape and
4197 the exact meaning of ligatures changed tremendously during the following
4198 centuries: In early notation, ligatures where used for monophonic tunes
4199 (Gregorian chant) and very soon denoted also the way of performance in
4200 the sense of articulation.  With upcoming multiphony, the need for a
4201 metric system arised, since multiple voices of a piece have to be
4202 synchronized some way.  New notation systems were invented, that used
4203 the manifold shapes of ligatures to now denote rhythmical patterns
4204 (e.g. black mensural notation, mannered notation, ars nova).  With the
4205 invention of the metric system of the white mensural notation, the need
4206 for ligatures to denote such patterns disappeared.  Nevertheless,
4207 ligatures were still in use in the mensural system for a couple of
4208 decades until they finally disappeared during the late 16th / early 17th
4209 century.  Still, ligatures have survived in contemporary editions of
4210 Gregorian chant such as the Editio Vaticana from 1905/08.
4211
4212 Syntactically, ligatures are simply enclosed by @code{\[} and @code{\]}.
4213 Some ligature styles (such as Editio Vaticana) may need additional input
4214 syntax specific for this particular type of ligature.  By default, the
4215 @internalsref{LigatureBracket} engraver just marks the start and end of
4216 a ligature by small square angles:
4217
4218 @lilypond[singleline,verbatim]
4219 \score {
4220     \notes \transpose c c' {
4221         \[ g c a f d' \]
4222         a g f
4223         \[ e f a g \]
4224     }
4225 }
4226 @end lilypond
4227
4228 To select a specific style of ligatures, a proper ligature engraver has
4229 to be added to the @internalsref{Voice} context, as explained in the
4230 following subsections.  Currently, Lilypond only supports white mensural
4231 ligatures with certain limitations.  Support for Editio Vaticana will be
4232 added in the future.
4233
4234 @menu
4235 * White mensural ligatures::    
4236 @end menu
4237
4238 @node White mensural ligatures
4239 @subsubsection White mensural ligatures
4240
4241 @cindex Mensural ligatures
4242 @cindex White mensural ligatures
4243
4244 Lilypond has limited support for white mensural ligatures.  The
4245 implementation is still experimental; it currently may output strange
4246 warnings or even crash in some cases or produce weird results on more
4247 complex ligatures.  To engrave white mensural ligatures, in the paper
4248 block the @internalsref{MensuralLigature} engraver has to be put into
4249 the @internalsref{Voice} context (and you probably want to remove the
4250 @internalsref{LigatureBracket} engraver).  There is no additional input
4251 language to describe the shape of a white mensural ligature.  The shape
4252 is rather determined solely from the pitch and duration of the enclosed
4253 notes.  While this approach may take a new user quite a while to get
4254 accustomed, it has a great advantage: this way, lily has full musical
4255 information about the ligature.  This is not only required for correct
4256 MIDI output, but also allows for automatic transcription of the
4257 ligatures.
4258
4259 Example:
4260
4261 @lilypond[singleline,verbatim]
4262 \score {
4263     \notes \transpose c c' {
4264         \property Score.timing = ##f
4265         \property Score.defaultBarType = "empty"
4266         \property Voice.NoteHead \set #'style = #'neo_mensural
4267         \property Staff.TimeSignature \set #'style = #'neo_mensural
4268         \clef "petrucci_g"
4269         \[ g\longa c\breve a\breve f\breve d'\longa \]
4270         s4
4271         \[ e1 f1 a\breve g\longa \]
4272     }
4273     \paper {
4274         \translator {
4275             \VoiceContext
4276             \remove Ligature_bracket_engraver
4277             \consists Mensural_ligature_engraver
4278         }
4279     }
4280 }
4281 @end lilypond
4282
4283 Without replacing @code{Ligature_bracket_engraver} with
4284 @code{Mensural_ligature_engraver}, the same music transcribes to the
4285 following:
4286
4287 @lilypond[singleline,verbatim]
4288 \score {
4289     \notes \transpose c c' {
4290         \property Score.timing = ##f
4291         \property Score.defaultBarType = "empty"
4292         \property Voice.NoteHead \set #'style = #'neo_mensural
4293         \property Staff.TimeSignature \set #'style = #'neo_mensural
4294         \clef "petrucci_g"
4295         \[ g\longa c\breve a\breve f\breve d'\longa \]
4296         s4
4297         \[ e1 f1 a\breve g\longa \]
4298     }
4299 }
4300 @end lilypond
4301
4302 @node Figured bass
4303 @subsection Figured bass
4304
4305 @cindex Basso continuo
4306
4307 LilyPond has limited support for figured bass:
4308
4309 @lilypond[verbatim,fragment]
4310 <
4311  \context Voice \notes { \clef bass dis4  c d ais}
4312  \context FiguredBass
4313    \figures {
4314     < 6 >4 < 7 >8 < 6+ [_!] >
4315     < 6 >4 <6 5 [3+] >
4316    }
4317  >
4318 @end lilypond
4319
4320 The support for figured bass consists of two parts: there is an input
4321 mode, introduced by @code{\figures}, where you can enter bass figures
4322 as numbers, and there is a context called @internalsref{FiguredBass}
4323 that takes care of making @internalsref{BassFigure} objects.
4324
4325 In figures input mode, a group of bass figures is delimited by
4326 @code{<} and @code{>}. The duration is entered after the @code{>}.
4327 @example
4328         <4 6>
4329 @end example
4330 @lilypond[fragment]
4331 \context FiguredBass
4332 \figures { <4 6> }
4333 @end lilypond
4334
4335 Accidentals are added to the numbers if you alterate them by
4336 appending @code{-}, @code{!}  and @code{+}.
4337
4338 @example
4339   <4- 6+ 7!>
4340 @end example
4341 @lilypond[fragment]
4342   \context FiguredBass
4343 \figures { <4- 6+ 7!> }
4344 @end lilypond
4345
4346 Spaces or dashes may be inserted by using @code{_}. Brackets are
4347 introduced with @code{[} and @code{]}.
4348
4349 @example
4350         < [4 6] 8 [_ 12]>
4351 @end example
4352 @lilypond[fragment]
4353  \context FiguredBass
4354 \figures { < [4 6] 8 [_ 12]> }
4355 @end lilypond
4356
4357 Although the support for figured bass may superficially resemble chord
4358 support, it works much simpler: in figured bass simply stores the
4359 numbers, and then prints the numbers you entered. There is no
4360 conversion to pitches, and no realizations of the bass are played in
4361 the MIDI file.
4362
4363 Internally, the code produces markup texts internally. You can use any
4364 of the markup text properties to override formatting. For example, the
4365 vertical spacing of the figures may be set with @code{baseline-skip}.
4366
4367
4368 @node Contemporary notation
4369 @section Contemporary notation
4370
4371 @menu
4372 * Clusters::                    
4373 * Fermatas::                    
4374 @end menu
4375
4376 @node Clusters
4377 @subsection Clusters
4378
4379 @cindex cluster
4380
4381 In musical terminology, a @emph{cluster} denotes a range of
4382 simultaneously sounding pitches that may change over time.  The set of
4383 available pitches to apply usually depends on the accoustic source.
4384 Thus, in piano music, a cluster typically consists of a continous range
4385 of the semitones as provided by the piano's fixed set of a chromatic
4386 scale.  In choral music, each singer of the choir typically may sing an
4387 arbitrary pitch within the cluster's range that is not bound to any
4388 diatonic, chromatic or other scale.  In electronic music, a cluster
4389 (theoretically) may even cover a continuous range of pitches, thus
4390 resulting in coloured noise, such as pink noise.
4391
4392 Clusters can be notated in the context of ordinary staff notation by
4393 engraving simple geometrical shapes that replace ordinary notation of
4394 notes.  Ordinary notes as musical events specify starting time and
4395 duration of pitches; however, the duration of a note is expressed by the
4396 shape of the note head rather than by the horizontal graphical extent of
4397 the note symbol.  In contrast, the shape of a cluster geometrically
4398 describes the development of a range of pitches (vertical extent) over
4399 time (horizontal extent).  Still, the geometrical shape of a cluster
4400 covers the area in wich any single pitch contained in the cluster would
4401 be notated as an ordinary note.  From this point of view, it is
4402 reasonable to specify a cluster as the envelope of a set of notes.  This
4403 is exactly how to construct a cluster with lilypond.
4404
4405 @lilypond[singleline,verbatim]
4406 \score {
4407     \context PianoStaff <
4408         \context Voice = voiceI { % same as voiceII, but with ordinary notes
4409             \notes \relative c' {
4410                 c4 f4
4411                 a4 <e4 d'4> | \break
4412                 < g8 a8 > < e8 a8 > a4 c1 < d4 b4 > e4 |
4413                 c4 a4 f4 g4 a4
4414             }
4415         }
4416         \context Voice = voiceII { % same as voiceI, but with cluster notation
4417             \notes \relative c' {
4418
4419                 % hide notes, accidentals, etc.
4420                 \property Thread.NoteHead \set #'transparent = ##t
4421                 \property Voice.Stem \set #'transparent = ##t
4422                 \property Voice.Beam \set #'transparent = ##t
4423                 \property Staff.Accidental \set #'transparent = ##t
4424
4425                 \property Voice.Cluster \set #'padding = #0.01
4426                 \property Voice.Cluster \set #'shape = #'ramp
4427
4428                 c4 f4
4429                 \startCluster
4430                 a4 <e4 d'4> | \break
4431                 < g8 a8 > < e8 a8 > a4 c1 < d4 b4 > e4 |
4432                 c4 \stopCluster a4 f4 g4 a4
4433             }
4434         }
4435     >
4436 }
4437 @end lilypond
4438
4439 Note that the second voice differs from the first one only by the
4440 additional keywords @code{\startCluster} and @code{\stopCluster} and the
4441 fact that notes, accidentals, etc. are hidden.  A future version of
4442 lilypond may automatically hide notes, accidentals, etc. within the
4443 scope of clusters.
4444
4445 Also note that a music expression like @code{< @{ g8 e8 @} a4 >} is
4446 illegal; in such a case, you can instead use the expression @code{< g8
4447 a8 > < e8 a8 >}.
4448
4449 By default, cluster engraver is in the voice context.  This allows
4450 putting ordinary notes and clusters together in the same staff, even
4451 simultaneously.  However, in such a case no attempt is made to
4452 automatically avoid collisions between ordinary notes and clusters.
4453
4454 The geometrical shape can be further controlled with grob properties
4455 @code{padding} and @code{shape}.  @code{padding} adds to the vertical
4456 extent of the shape (top and bottom) and is expressed in units of
4457 staffspace.  Since the pitch range of a single pitch is infinitely
4458 small, if padding is set to @code{0.0}, this possibly results in an
4459 invisible shape, if you,for example, say @code{ \startCluster c d e
4460 \endCluster}.  The default value for @code{padding} therefore is
4461 @code{0.25}, such that a single pitch roughly shows the same height as a
4462 note head.  Property @code{shape} controls how the overall shape of the
4463 cluster is constructed from the set of notes.  Currently supported
4464 values are @code{leftsided-stairs}, @code{rightsided-stairs},
4465 @code{centered-stairs}, and @code{ramp}.
4466
4467 @node Fermatas
4468 @subsection Fermatas
4469
4470 @cindex fermatas
4471
4472 Currently, lilypond supports the following fermata symbols that are
4473 frequently used in contemporary music notation:
4474
4475 @lilypond[singleline,verbatim]
4476 \score {
4477     \notes {
4478         \fatText
4479         b'
4480         ^\shortfermata
4481         _\shortfermata
4482         ^\markup { short fermata }
4483         r
4484         b'
4485         ^\fermata
4486         _\fermata
4487         ^\markup { fermata }
4488         r
4489         b'
4490         ^\longfermata
4491         _\longfermata
4492         ^\markup { long fermata }
4493         r
4494         b'
4495         ^\verylongfermata
4496         _\verylongfermata
4497         ^\markup { very long fermata }
4498         r
4499     }
4500 }
4501 @end lilypond
4502
4503 See @ref{Articulations} for general instructions how to apply scripts
4504 such as fermatas to a @code{\notes@{@}} block.
4505
4506
4507 @node Tuning output
4508 @section Tuning output
4509
4510 LilyPond tries to take as much formatting as possible out of your
4511 hands. Nevertheless, there are situations where it needs some help, or
4512 where you want to override its decisions. In this section we discuss
4513 ways to do just that.
4514
4515 Formatting is internally done by manipulating so called objects (graphic
4516 objects). Each object carries with it a set of properties (object
4517 properties) specific to that object.  For example, a stem object has
4518 properties that specify its direction, length and thickness.
4519
4520 The most direct way of tuning the output is by altering the values of
4521 these properties. There are two ways of doing that: first, you can
4522 temporarily change the definition of a certain type of object, thus
4523 affecting a whole set of objects.  Second, you can select one specific
4524 object, and set a object property in that object.
4525
4526 @menu
4527 * Tuning groups of objects ::   
4528 * Tuning per object ::          
4529 * Font selection::              
4530 * Text markup::                 
4531 @end menu
4532
4533 @node Tuning groups of objects 
4534 @subsection Tuning groups of objects 
4535
4536 @cindex object description
4537
4538 A object definition is a Scheme association list, that is stored in a
4539 context property.  By assigning to that property (using plain
4540 @code{\property}), you can change the resulting objects.
4541
4542 @lilypond[verbatim, fragment,quote]
4543 c'4 \property Voice.NoteHead  = #'() c'4
4544 @end lilypond
4545 This mechanism is fairly crude, since you can only set, but not modify,
4546 the definition of an object. Also, it will thoroughly confuse LilyPond.
4547
4548 The definition of an object is actually a list of default object
4549 properties. For example, the definition of the Stem object (available
4550 in @file{scm/grob-description.scm}), includes the following definitions for
4551 @internalsref{Stem}
4552
4553 @example
4554         (thickness . 0.8)
4555         (beamed-lengths . (0.0 2.5 2.0 1.5))
4556         (Y-extent-callback . ,Stem::height)
4557         @var{...}
4558 @end example
4559
4560 You can add a property on top of the existing definition, or remove a
4561 property, thus overriding the system defaults:
4562 @lilypond[verbatim,quote]
4563 c'4 \property Voice.Stem \override #'thickness = #4.0
4564 c'4 \property Voice.Stem \revert #'thickness
4565 c'4
4566 @end lilypond
4567 You should balance @code{\override} and @code{\revert}. If that is too
4568 much work, you can use the @code{\set} shorthand. It performs a revert
4569 followed by an override. The following example gives exactly the same
4570 result as the previous one. 
4571 @lilypond[verbatim,quote]
4572 c'4 \property Voice.Stem \set #'thickness = #4.0
4573 c'4 \property Voice.Stem \set #'thickness = #0.8
4574 c'4
4575 @end lilypond
4576 If you use @code{\set}, you must explicitly restore the default.
4577
4578
4579 Formally the syntax for these constructions is
4580 @example
4581 \property @var{context}.@var{grobname} \override @var{symbol} = @var{value}
4582 \property @var{context}.@var{grobname} \set @var{symbol} = @var{value}
4583 \property @var{context}.@var{grobname} \revert @var{symbol}
4584 @end example
4585 Here @var{symbol} is a Scheme expression of symbol type, @var{context}
4586 and @var{grobname} are strings and @var{value} is a Scheme expression.
4587
4588
4589 If you revert a setting which was not set in the first place, then it
4590 has no effect. However, if the setting was set as a system default, it
4591 may remove the default value, and this may give surprising results,
4592 including crashes.  In other words, @code{\override} and @code{\revert},
4593 must be carefully balanced.
4594
4595 These are examples of correct nesting of @code{\override}, @code{\set},
4596 @code{\revert}. 
4597
4598 A clumsy but correct form:
4599 @example
4600   \override \revert \override \revert \override \revert
4601 @end example
4602
4603 Shorter version of the same:
4604 @example 
4605   \override \set \set  \revert
4606 @end example
4607
4608 A short form, using only @code{\set}. This requires you to know the
4609 default value:
4610 @example
4611   \set \set \set \set @var{to default value}
4612 @end example
4613
4614 If there is no default (i.e. by default, the object property is unset),
4615 then you can use
4616 @example
4617   \set \set \set \revert
4618 @end example
4619
4620 For the digirati, the object description is an Scheme association
4621 list. Since a Scheme list is a singly linked list, we can treat it as a
4622 stack, and @code{\override} and @code{\revert} are just push and pop
4623 operations. This pushing and popping is also used for overriding
4624 automatic beaming settings.
4625
4626 @refbugs
4627
4628 LilyPond will hang or crash if @var{value} contains cyclic references.
4629 The backend is not very strict in type-checking object properties. If you
4630 @code{\revert} properties that are expected to be set by default,
4631 LilyPond may crash.
4632
4633
4634
4635
4636 @node Tuning per object 
4637 @subsection Tuning per object 
4638
4639 @cindex \once
4640 Tuning a single object is most often done with @code{\property}. The
4641 form,
4642 @example
4643         \once \property @dots{}
4644 @end example
4645 @c
4646 applies a setting only during one moment in the score:  the
4647 original setting for stem thickness is restored automatically in the
4648 following example
4649 @c
4650 @lilypond[verbatim, fragment, relative=1]
4651   c4 
4652   \once \property Voice.Stem \set #'thickness = #4
4653   c4
4654   c4
4655 @end lilypond
4656
4657 @cindex \once
4658 @cindex \outputproperty
4659
4660 A second way of tuning objects is the more arcane @code{\outputproperty}
4661 feature.  The syntax is as follows:
4662 @example
4663 \outputproperty @var{predicate} @var{symbol} = @var{value}
4664 @end example
4665 Here @code{predicate} is a Scheme function taking a object argument, and
4666 returning a boolean.  This statement is processed by the
4667 @code{Output_property_engraver}.  It instructs the engraver to feed all
4668 objects that it sees to @var{predicate}. Whenever the predicate returns
4669 true, the object property @var{symbol} will be set to @var{value}.
4670
4671 This command is only single shot, in contrast to @code{\override} and
4672 @code{\set}.
4673
4674 You will need to combine this statement with @code{\context} to select
4675 the appropriate context to apply this to.
4676
4677 In the following example, all note heads occurring at current staff
4678 level, are shifted up and right by setting their @code{extra-offset}
4679 property.
4680
4681 @lilypond[fragment,verbatim,singleline]
4682 \relative c'' { c4
4683   \context Staff \outputproperty
4684   #(make-type-checker 'note-head-interface)
4685   #'extra-offset = #'(0.5 . 0.75)
4686   <<c e g>>8 }
4687 @end lilypond
4688
4689 @cindex @code{extra-offset}
4690
4691 In this example, the predicate checks the @code{text} object property, to
4692 shift only the `m.d.' text,  but not the fingering instruction "2".
4693 @lilypond[verbatim,singleline]
4694 #(define (make-text-checker text)
4695    (lambda (grob) (equal? text (ly:get-grob-property grob 'text))))
4696
4697 \score {    
4698   \notes\relative c''' {
4699     \property Voice.Stem \set #'direction = #1
4700     \outputproperty #(make-text-checker "m.d.")
4701       #'extra-offset = #'(-3.5 . -4.5)
4702     a^2^"m.d."    
4703   }
4704 }
4705 @end lilypond
4706
4707 @refbugs
4708
4709 If possible, avoid this feature: the semantics are not very clean, and
4710 the syntax and semantics are up for rewrite.
4711
4712
4713
4714
4715 @node Font selection
4716 @subsection Font selection
4717
4718 The most common thing to change about the appearance of fonts is
4719 their size. The font size of a @internalsref{Voice},
4720 @internalsref{Staff} or @internalsref{Thread} context, can be easily
4721 changed by setting the @code{fontSize} property for that context:
4722 @lilypond[fragment,relative=1,verbatim,quote]
4723   c4 c4 \property Voice.fontSize = #-1
4724   f4 g4
4725 @end lilypond
4726  This command will not change the size of variable symbols, such as
4727 beams or slurs.  You can use this command to get smaller symbol for
4728 cue notes, but that involves some more subtleties. An elaborate
4729 example of those is in @inputfileref{input/test,cue-notes.ly}.
4730
4731 @cindex cue notes
4732 @cindex font size
4733 @cindex size
4734 @cindex symbol size
4735 @cindex glyph size
4736
4737 The font used for printing a object can be selected by setting
4738 @code{font-name}, e.g.
4739 @example
4740   \property Staff.TimeSignature
4741     \set #'font-name = #"cmr17"
4742 @end example
4743 You may use any font which is available to @TeX{}, such as foreign
4744 fonts or fonts that do not belong to the Computer Modern font family.
4745 Font selection for the standard fonts, @TeX{}'s Computer Modern fonts,
4746 can also be adjusted with a more fine-grained mechanism.  By setting
4747 the object properties described below, you can select a different font.
4748 All three mechanisms work for every object that supports
4749 @code{font-interface}.
4750
4751 @table @code
4752 @item font-family
4753  A symbol indicating the general class of the typeface.  Supported are
4754 @code{roman} (Computer Modern), @code{braces} (for piano staff
4755 braces), @code{music} (the standard music font), @code{ancient} (the
4756 ancient notation font) @code{dynamic} (font for dynamic signs) and
4757 @code{typewriter}. 
4758   
4759 @item font-shape
4760   A symbol indicating the shape of the font, there are typically several
4761   font shapes available for each font family. Choices are @code{italic},
4762   @code{caps} and @code{upright} 
4763
4764 @item font-series
4765 A  symbol indicating the series of the font. There are typically several
4766 font series for each font family and shape. Choices are @code{medium}
4767 and @code{bold}. 
4768
4769 @item font-relative-size
4770   A number indicating the size relative the standard size.  For example,
4771   with 20pt staff height, relative size -1  corresponds to 16pt staff
4772   height, and relative size +1 corresponds to 23 pt staff height.
4773
4774 @item font-design-size
4775 A number indicating  the design size of the font. 
4776
4777 This is a feature of the Computer Modern Font: each point size has a
4778 slightly different design. Smaller design sizes are relatively wider,
4779 which enhances readability.
4780 @end table
4781
4782 For any of these properties, the value @code{*} (i.e. the @emph{symbol},
4783 @code{*}, entered as @code{#'*}), acts as a wildcard. This can be used
4784 to override default setting, which are always present. For example:
4785 @example
4786   \property Lyrics.LyricText \override #'font-series = #'bold
4787   \property Lyrics.LyricText \override #'font-family = #'typewriter
4788   \property Lyrics.LyricText \override #'font-shape  = #'*
4789 @end example
4790
4791 @cindex @code{font-style}
4792
4793 There are also pre-cooked font selection qualifiers. These are
4794 selected through the object property @code{font-style}.  For example,
4795 the style @code{finger} selects family @code{number} and relative size
4796 @code{-3}.  Styles available include @code{volta}, @code{finger},
4797 @code{tuplet}, @code{timesig}, @code{mmrest}, @code{script},
4798 @code{large}, @code{Large} and @code{dynamic}. The style sheets and
4799 tables for selecting fonts are located in @file{scm/font.scm}. Refer
4800 to this file for more information.
4801
4802 @cindex magnification
4803
4804 The size of the font may be scaled with the object property
4805 @code{font-magnification}.  For example, @code{2.0} blows up all
4806 letters by a factor 2 in both directions.
4807
4808 @refbugs
4809
4810 Relative size is not linked to any real size.
4811
4812 There is no style sheet provided for other fonts besides the @TeX{}
4813 family, and the style sheet can not be modified easily.
4814
4815 @cindex font selection
4816 @cindex font magnification
4817 @cindex @code{font-interface}
4818
4819
4820 @node Text markup
4821 @subsection Text markup
4822 @cindex text markup
4823 @cindex markup text
4824
4825
4826 @cindex typeset text
4827
4828 LilyPond has an internal mechanism to typeset texts. You can access it
4829 with the keyword @code{\markup}. Within markup mode, you can enter texts
4830 similar to lyrics: simply enter them, surrounded by spaces. 
4831 @cindex markup
4832
4833 @lilypond[verbatim,fragment,relative=1]
4834  c1^\markup { hello }
4835  c1_\markup { hi there }
4836  c1^\markup { hi \bold there, is \italic anyone home? }
4837 @end lilypond
4838
4839 @cindex font switching
4840
4841 The line of the example demonstrates font switching commands.  The
4842 command only apply to the first following word; enclose a set of texts
4843 with braces to apply a command to more words.
4844 @example
4845   \markup @{ \bold @{ hi there @} @}
4846 @end example
4847 For clarity, you can also do this for single arguments, e.g.
4848 @example
4849   \markup @{ is \italic @{ anyone @} home @}
4850 @end example
4851
4852 @cindex font size, texts
4853
4854 The following size commands set abolute sizes
4855
4856 @cindex \teeny
4857 @cindex \tiny
4858 @cindex \small
4859 @cindex \large
4860 @cindex \huge
4861
4862 @table @code
4863 @item \teeny
4864 @item \tiny
4865 @item \small
4866 @item \large
4867 @item \huge
4868 @end table
4869
4870 You can also make letter larger or smaller relative to their neighbors,
4871 with the commands @code{\larger} and @code{\smaller}.
4872 @cindex smaller
4873 @cindex larger
4874
4875 @cindex font style, for texts
4876 @cindex \bold
4877 @cindex \dynamic
4878 @cindex \number
4879 @cindex \italic
4880
4881 The following font change commands are defined:
4882 @table @code
4883 @item \dynamic
4884 This changes to the font used for dynamic signs. Note that this font
4885 does not contain all characters of the alphabet.
4886 @item \number
4887 This changes to the font used for time signatures. It only contains
4888 numbers and a few punctuation marks.
4889 @item \italic
4890 @item \bold
4891 @end table
4892
4893 @cindex raising text
4894 @cindex lowering text
4895 @cindex moving text
4896 @cindex translating text
4897
4898 @cindex \sub
4899 @cindex \super
4900
4901 Raising and lowering texts can be done with @code{\super} and
4902 @code{\sub}.
4903
4904 @lilypond[verbatim,fragment,relative=1]
4905  c1^\markup { E "=" mc \super "2" }
4906 @end lilypond
4907
4908 @cindex \raise
4909
4910 If you want to give an explicit amount for lowering or raising, use
4911 @code{\raise}.  This command takes a Scheme valued argument,
4912 @lilypond[verbatim,fragment,relative=1,quote]
4913  c1^\markup { C \small \raise #1.0 { "9/7+" }}
4914 @end lilypond
4915 The argument to @code{\raise} is the vertical displacement amount,
4916 measured in (global) staff spaces.
4917
4918 Other commands taking  single arguments include
4919 @table @code
4920
4921 @item \bracket, \hbracket
4922  Bracket the argument markup.
4923
4924 @item \musicglyph
4925 @cindex \musicglyph
4926   This is converted to a musical symbol, e.g. @code{\musicglyph
4927 #"accidentals-0"} will select the natural sign from the music font.
4928 See @ref{The Feta font} for  a complete listing of the possible glyphs.
4929 @item \char
4930 This produces a single character, e.g. @code{\char #65} produces the 
4931 letter 'A'.
4932
4933 @item \hspace #@var{amount}
4934 @cindex \hspace
4935 This produces a invisible object taking horizontal space.
4936 @example 
4937 \markup @{ A \hspace #2.0 B @} 
4938 @end example
4939 will put extra space between A and B. Note that lilypond 
4940 inserts space before and after @code{\hspace}. 
4941
4942 @item \fontsize #@var{size}
4943 @cindex \fontsize
4944 This sets the relative font size, eg.
4945 @example
4946 A \fontsize #2 @{ B C @} D
4947 @end example
4948
4949
4950 This will enlarge the B and the C by two steps.
4951 @item  \translate #(cons @var{x} @var{y})
4952 @cindex  \translate
4953 This translates an object. Its first argument is a cons of numbers
4954 @example
4955 A \translate #(cons 2 -3) @{ B C @} D
4956 @end example
4957 This moves `B C' 2 spaces to the right, and 3 down.
4958
4959 @item \magnify  #@var{mag}
4960 @cindex \magnify
4961 This sets the font magnification for the its argument. In the following
4962 example, the middle A will be 10% larger.
4963 @example
4964 A \magnify #1.1 @{ A @} A
4965 @end example
4966
4967
4968 @item \override #(@var{key} . @var{value})
4969 @cindex \override
4970 This overrides a  formatting property for its argument. The argument
4971 should be a key/value pair, e.g.
4972 @example
4973 m \override #'(font-family . math) m m
4974 @end example
4975 @end table
4976
4977 In markup mode you can compose expressions, similar to mathematical
4978 expressions, XML documents and music expressions.  The braces group
4979 notes into horizontal lines. Other types of lists also exist: you can
4980 stack expressions grouped with @code{<<}, and @code{>>} vertically with
4981 the command @code{\column}. Similarly, @code{\center} aligns texts by
4982 their center lines. 
4983
4984 @lilypond[verbatim,fragment,relative=1]
4985  c1^\markup { \column << a bbbb c >> }
4986  c1^\markup { \center << a bbbb c >> }
4987  c1^\markup { \line << a b c >> }
4988 @end lilypond
4989
4990
4991
4992 The markup mechanism is very flexible and extensible.  Refer to
4993 @file{scm/new-markup.scm} for more information on extending the markup
4994 mode.
4995
4996
4997 @cindex metronome mark
4998
4999 One practical application of complicated markup is to fake a metronome
5000 marking:
5001
5002 @lilypond[verbatim]
5003 eighthStem = \markup \combine
5004         \musicglyph #"flags-stem"
5005         \translate #'(0.0 . 3.5) \musicglyph #"flags-u3"
5006 eighthNote = \markup
5007         \override #'(word-space . 0.0)
5008         { \musicglyph #"noteheads-2"
5009           \translate #'(-0.05 . 0.1) \eighthStem }
5010
5011 \score {
5012   \notes\relative c'' {
5013     a1^\markup { \magnify #0.9 \eighthNote " = 64" }
5014   }
5015 }
5016 @end lilypond
5017
5018 @refbugs
5019
5020 @cindex kerning
5021
5022 LilyPond does not account for kerning in its text formatting, so it
5023 spaces texts slightly too wide.
5024
5025 Syntax errors for markup mode are confusing.
5026
5027
5028 @node Global layout
5029 @section Global layout
5030
5031 The global layout determined by three factors: the page layout, the
5032 line breaks and the spacing. These all influence each other: The
5033 choice of spacing determines how densely each system of music is set,
5034 where line breaks breaks are chosen, and thus ultimately how many
5035 pages a piece of music takes. In this section we will explain how the
5036 lilypond spacing engine works, and how you can tune its results.
5037
5038 Globally spoken, this procedure happens in three steps: first,
5039 flexible distances (``springs'') are chosen, based on durations. All
5040 possible line breaking combination are tried, and the one with the
5041 best results---a layout that has uniform density and requires as
5042 little stretching or cramping as possible---is chosen. When the score
5043 is processed by @TeX{}, page are filled with systems, and page breaks
5044 are chosen whenever the page gets full.
5045
5046 @menu
5047 * Vertical spacing::            
5048 * Horizontal spacing::          
5049 * Font Size::                   
5050 * Line breaking::               
5051 * Page layout::                 
5052 @end menu
5053
5054
5055 @node Vertical spacing
5056 @subsection Vertical spacing
5057
5058 @cindex vertical spacing
5059 @cindex distance between staves
5060 @cindex staff distance
5061 @cindex between staves, distance
5062 @cindex staffs per page
5063
5064
5065 The height of each system is determined automatically by lilypond, to
5066 keep systems from bumping into each other, some minimum distances are
5067 set.  By changing these, you can put staves closer together, and thus
5068 put more  systems onto one page.
5069
5070 Normally staves are stacked vertically. To make
5071 staves maintain a distance, their vertical size is padded. This is
5072 done with the property @code{minimumVerticalExtent}. It takes a pair
5073 of numbers, so if you want to make it smaller from its, then you could
5074 set
5075 @example
5076   \property Staff.minimumVerticalExtent = #'(-4 . 4)
5077 @end example
5078 This sets the vertical size of the current staff to 4 staff-space on
5079 either side of the center staff line.  The argument of
5080 @code{minimumVerticalExtent} is interpreted as an interval, where the
5081 center line is the 0, so the first number is generally negative.  you
5082 could also make the staff larger at the bottom by setting it to
5083 @code{(-6 . 4)}. The default value is @code{(-6 . 6)}.
5084
5085 Vertical aligment of staves is handled by the
5086 @internalsref{VerticalAlignment} object, which lives at
5087 @internalsref{Score} level.
5088
5089 The piano staves are handled a little differently: to make cross-staff
5090 beaming work correctly, it necessary that the distance between staves
5091 is fixed.  This is also done with a @internalsref{VerticalAlignment}
5092 object, created in @internalsref{PianoStaff}, but a forced distance is
5093 set. This is done with the object property #'forced-distance. If you
5094 want to override this, use a @code{\translator} block as follows:
5095 @example
5096   \translator @{
5097     \PianoStaffContext
5098     VerticalAlignment \override #'forced-distance = #9
5099   @}
5100 @end example
5101 This would bring the staves together at a distance of 9 staff spaces,
5102 and again this is measured from the center line of each staff.
5103
5104
5105
5106 @node Horizontal spacing
5107 @subsection Horizontal Spacing
5108
5109 The spacing engine translates differences in durations into
5110 stretchable distances (``springs'') of differing lengths. Longer
5111 durations get more space, shorter durations get less.  The basis for
5112 assigning spaces to durations, is that the shortest durations get a
5113 fixed amount of space, and the longer durations get more: doubling a
5114 duration adds a fixed amount of space to the note.
5115
5116 For example, the following piece contains lots of half, quarter and
5117 8th notes, the eighth note is followed by 1 note head width. The The
5118 quarter note is followed by 2 NHW, the half by 3 NHW, etc.
5119 @lilypond[fragment, verbatim, relative=1]
5120  c2 c4. c8 c4. c8 c4. c8 c8 c8 c4 c4 c4
5121 @end lilypond
5122
5123 These two amounts of space are @code{shortest-duration-space}
5124 @code{spacing-increment}, object properties of
5125 @internalsref{SpacingSpanner}. Normally @code{spacing-increment} is
5126 set to 1.2, which is the width of a note head, and
5127 @code{shortest-duration-space} is set to 2.0, meaning that the
5128 shortest note gets 2 noteheads of space. For normal notes, this space
5129 is always counted from the left edge of the symbol, so the short notes
5130 in a score is generally followed by one note head width of space.
5131
5132 If one would follow the above procedure exactly, then adding a single
5133 32th note to a score that uses 8th and 16th notes, would widen up the
5134 entire score a lot. The shortest note is no longer a 16th, but a 64th,
5135 thus adding 2 noteheads of space to every note. To prevent this, the
5136 shortest duration for spacing is not the shortest note in the score,
5137 but the most commonly found shortest note.  Notes that are even
5138 shorter this are followed by a space that is proportonial to their
5139 duration relative to the common shortest note.  So if we were to add
5140 only a few 16th notes to the example above, they would be followed by
5141 half a NHW:
5142
5143 @lilypond[fragment, verbatim, relative=1]
5144  c2 c4. c8 c4. [c16 c] c4. c8 c8 c8 c4 c4 c4
5145 @end lilypond
5146
5147 The most common shortest duration is determined as follows: in every
5148 measure, the shortest duration is determined. The most common short
5149 duration, is taken as the basis for the spacing, with the stipulation
5150 that this shortest duration should always be equal to or shorter than
5151 1/8th note. The shortest duration is printed when you run lilypond
5152 with @code{--verbose}.  These durations may also be customized. If you
5153 set the @code{common-shortest-duration} in
5154 @internalsref{SpacingSpanner}, then this sets the base duration for
5155 spacing. The maximum duration for this base (normally 1/8th), is set
5156 through @code{base-shortest-duration}.
5157
5158 @cindex @code{common-shortest-duration}
5159 @cindex @code{base-shortest-duration}
5160 @cindex @code{stem-spacing-correction}
5161 @cindex @code{spacing}
5162
5163 In the introduction it was explained that stem directions influence
5164 spacing. This is controlled with @code{stem-spacing-correction} in
5165 @internalsref{NoteSpacing}. The @code{StaffSpacing} object contains the
5166 same property for controlling the stem/barline spacing. In the
5167 following example shows these corrections, once with default settings,
5168 and once with exaggerated corrections.  
5169
5170 @lilypond
5171     \score { \notes {
5172       c'4 e''4 e'4 b'4 |
5173       b'4 e''4 b'4 e''4|
5174       \property Staff.NoteSpacing \override #'stem-spacing-correction
5175       = #1.5
5176       \property Staff.StaffSpacing \override #'stem-spacing-correction
5177       = #1.5
5178       c'4 e''4 e'4 b'4 |
5179       b'4 e''4 b'4 e''4|      
5180     }
5181     \paper { linewidth = -1. } }
5182 @end lilypond
5183
5184 @cindex SpacingSpanner, overriding properties
5185
5186 The @internalsref{SpacingSpanner}, is score wide, so its properties
5187 must be overriden from the @code{\paper} block, e.g.
5188 @example
5189 \paper @{ \translator  @{
5190   \ScoreContext
5191   SpacingSpanner \override #'spacing-increment = #3.0
5192 @} @}
5193 @end example
5194
5195
5196 @refbugs
5197
5198 Spacing is determined on a score wide basis. If you have a score that
5199 changes its character (measured in durations) halfway during the
5200 score, the part containing the longer durations will be spaced too
5201 widely.
5202
5203 Generating optically pleasing spacing is black magic. LilyPond tries
5204 to deal with a number of frequent cases. Here is an example that is
5205 not handled correctly, due to the combination of chord collisions and
5206 kneed stems.
5207
5208 @lilypond
5209 \score {
5210      \context PianoStaff \notes \transpose c c'' <
5211      \context Staff = up { s1 }
5212      \context Staff = down { [c8 c \translator Staff=up <<c d>> c 
5213 \translator Staff=down c c c] }
5214      >
5215      \paper { linewidth = -1 }
5216 }
5217 @end lilypond
5218
5219
5220
5221 @node Font Size
5222 @subsection Font size
5223 @cindex font size, setting
5224 @cindex staff size, setting
5225 @cindex @code{paper} file
5226
5227 The Feta font provides musical symbols at seven different sizes.
5228 These fonts are 11 point, 13 point, 16 point, 19 pt, 20 point, 23
5229 point, and 26 point.  The point size of a font is the height of the
5230 five lines in a staff when displayed in the font.
5231
5232 Definitions for these sizes are the files @file{paperSZ.ly}, where
5233 @code{SZ} is one of 11, 13, 16, 19, 20, 23 and 26.  If you include any
5234 of these files, the identifiers @code{paperEleven},
5235 @code{paperThirteen}, @code{paperSixteen}, @code{paperNineteen},
5236 @code{paperTwenty}, @code{paperTwentythree}, and @code{paperTwentysix}
5237 are defined respectively.  The default @code{\paper} block is also
5238 set. These files should be imported at toplevel, i.e.
5239 @example
5240         \include "paper26.ly"
5241         \score @{  ... @}
5242 @end example
5243
5244 The font definitions are generated using a Scheme function. For more
5245 details, see the file @file{scm/font.scm}.
5246
5247
5248
5249 @node Line breaking
5250 @subsection Line breaking
5251
5252 @cindex line breaks
5253 @cindex breaking lines
5254
5255 Line breaks are normally computed automatically. They are chosen such
5256 that it looks neither cramped nor loose, and that consecutive lines have
5257 similar density.
5258
5259 Occasionally you might want to override the automatic breaks; you can
5260 do this by  specifying @code{\break}. This will force a line break at
5261 this point.  Line breaks can only occur at places where there are bar
5262 lines.  If you want to have a line break where there is no bar line,
5263 you can force an invisible bar line by entering @code{\bar
5264 ""}. Similarly, @code{\noBreak} forbids a line break at a certain
5265 point.
5266
5267
5268 @cindex regular line breaks
5269 @cindex four bar music. 
5270
5271 If you want linebreaks at regular intervals, you can use the following:
5272 @example
5273 <  \repeat 7 unfold @{ s1 * 4 \break  @}
5274    @emph{real music}
5275
5276 @end  example
5277 This makes the following 28 measures (assuming 4/4 time) be broken every
5278 4 measures.
5279
5280 @node Page layout
5281 @subsection Page layout
5282
5283 @cindex page breaks
5284 @cindex breaking pages
5285
5286 @cindex @code{indent}
5287 @cindex @code{linewidth}
5288
5289 The most basic settings influencing the spacing are @code{indent} and
5290 @code{linewidth}. They are set in the @code{\paper} block. They
5291 control the indentation of the first line of music, and the lengths of
5292 the lines.  If @code{linewidth} set to a negative value, a single
5293 unjustified line is produced.  A similar effect for scores that are
5294 longer than one line, can be produced by setting @code{raggedright} to
5295 true in the @code{\paper} block.
5296
5297 @cindex page layout
5298 @cindex vertical spacing
5299
5300 The page layout process happens outside lilypond. Ly2dvi sets page
5301 layout instructions. Ly2dvi responds to the following variables in the
5302 @code{\paper} block.  The variable @code{textheight} sets the total
5303 height of the music on each page.  The spacing between systems is
5304 controlled with @code{interscoreline}, its default is 16pt.
5305 The distance between the score lines will stretch in order to fill the
5306 full page @code{interscorelinefill} is set to a positive number.  In
5307 that case @code{interscoreline} specifies the minimum spacing.
5308
5309 @cindex @code{textheight}
5310 @cindex @code{interscoreline}
5311 @cindex @code{interscorelinefill}
5312
5313 If the variable @code{lastpagefill} is defined (that is, it gets any
5314 value assigned in the @code{\paper} block), systems are evenly
5315 distributed vertically on the last page.  This might produce ugly
5316 results in case there are not enough systems on the last page.  Note
5317 that @command{lilypond-book} ignores @code{lastpagefill}.  See
5318 @ref{Integrating text and music with lilypond-book} for
5319 more information.
5320
5321 @cindex @code{lastpagefill}
5322
5323 Page breaks are normally computed by @TeX{}, so they are not under
5324 direct control of LilyPond.  However, you can insert a commands into
5325 the @file{.tex} output to instruct @TeX{} where to break pages. You
5326 can insert a @code{\newpage} from within lilypond. This is done by
5327 setting the @code{between-systems-strings} on the
5328 @internalsref{NonMusicalPaperColumn} where the system is broken.
5329
5330 @cindex paper size
5331 @cindex page size
5332 @cindex @code{papersize}
5333
5334 To change the paper size, you must first set the
5335 @code{papersize} paper variable variable.  Set it to
5336 the strings @code{a4}, @code{letter}, or @code{legal}.  After this
5337 specification, you must set the font as described above.  If you want
5338 the default font, then use the 20 point font.
5339
5340 @example
5341         \paper@{ papersize = "a4" @}
5342         \include "paper16.ly"
5343 @end example
5344
5345 The file @code{paper16.ly}  will now include a file named @file{a4.ly}, which
5346 will set the paper variables @code{hsize} and @code{vsize} (used by
5347 Lilypond and @code{ly2dvi})
5348
5349
5350
5351
5352
5353 @node Sound
5354 @section Sound
5355 @cindex Sound
5356
5357 LilyPond can produce MIDI output.  The performance lacks lots of
5358 interesting effects, such as swing, articulation, slurring, etc., but it
5359 is good enough for proof-hearing the music you have entered.  Ties,
5360 dynamics and tempo changes are interpreted.
5361
5362 Dynamic marks, crescendi and decrescendi translate into MIDI volume
5363 levels.  Dynamic marks translate to a fixed fraction of the available
5364 MIDI volume range, crescendi and decrescendi make the the volume vary
5365 linearly between their two extremities.  The fractions be adjusted by
5366 overriding the @code{absolute-volume-alist} defined in
5367 @file{scm/midi.scm}.
5368
5369 For each type of musical instrument (that MIDI supports), a volume range
5370 can be defined.  This gives you basic equalizer control, which can
5371 enhance the quality of the MIDI output remarkably.  You can add
5372 instruments and ranges or change the default settings by overriding the
5373 @code{instrument-equalizer-alist} defined in @file{scm/midi.scm}.
5374
5375 Both loudness controls are combined to produce the final  MIDI volume. 
5376
5377 @menu
5378 * MIDI block::                  
5379 * MIDI instrument names::       
5380 @end menu
5381
5382
5383 @node MIDI block
5384 @subsection MIDI block
5385 @cindex MIDI block
5386
5387
5388 The MIDI block is analogous to the paper block, but it is somewhat
5389 simpler.  The @code{\midi} block can contain:
5390 @cindex MIDI block
5391
5392 @itemize @bullet
5393   @item  a @code{\tempo} definition
5394   @item  context definitions
5395 @end itemize
5396
5397 Assignments in the @code{\midi} block are not allowed.
5398
5399
5400
5401 @cindex context definition
5402
5403 Context definitions follow precisely the same syntax as within the
5404 \paper block.  Translation modules for sound are called performers.
5405 The contexts for MIDI output are defined in @file{ly/performer-init.ly}.
5406
5407
5408 @node MIDI instrument names
5409 @subsection MIDI instrument names
5410
5411 @cindex instrument names
5412 @cindex @code{Staff.midiInstrument}
5413 @cindex @code{Staff.instrument}
5414
5415 The MIDI instrument name is set by the @code{Staff.midiInstrument}
5416 property or, if that property is not set, the @code{Staff.instrument}
5417 property.  The instrument name should be chosen from the list in
5418 @ref{MIDI instruments}.
5419
5420 @refbugs
5421
5422 If the selected string does not exactly match, then LilyPond uses the
5423 default (Grand Piano). It is not possible to select an instrument by
5424 number.
5425
5426