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