]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/user/refman.itely
b463a79c61af15188a163a3708552514facf3ccf
[lilypond.git] / Documentation / user / refman.itely
1 @c -*-texinfo-*-
2 @c TODO: 
3 @c - Reinsert subsection commands that were lost in the
4 @c   ancient conversion from YODL!  /MB
5 @c - Restructure! Separate internal commands from user level commands. /MB
6 @c - Add some words about Guile.  /MB
7 @c - Fix indexing (keyindex) so it doesn't add line breaks  /MB
8
9 @c ugh: because of @include, we need to fill in these nodes
10 @node Reference Manual
11 @chapter Reference Manual
12
13 @menu
14 * Overview::                       Overview
15 * Top level::                      Top level
16 * Pitch names::                    Pitch names
17 * Lexical conventions::            Lexical conventions
18 * Other languages::                Note names in various languages
19 * Lexical modes::                          modes
20 * Types::                          Types
21 * Music expressions::              Music expressions
22 * Atomic music expressions::       Atomic music expressions
23 * Note specification::             notedesc
24 * barlines::                       barlines
25 * Manual beams::                   Manual beam
26 * stem tremolo::                   tremolo
27 * Compound music expressions::     Compound music expressions
28 * relative::                       relative
29 * Repeats::                        Repeats      
30 * transpose::                      transpose
31 * Ambiguities::                    Ambiguities
32 * Notation conversion specifics::  Notation conversion specifics
33 * Automatic Beaming::              Automatic Beaming
34 * Chord Names::                    Chord Names
35 * lyricprint::                     lyricprint
36 * Notation Contexts::              Notation Contexts
37 * Properties::                     Changing formatting
38 * Page layout::                    Layout
39 * contextdefs::                    contextdefs
40 * Sound output::                   Sound output
41 * midilist::                       midilist
42 * Pre-defined Identifiers::        Pre-defined Identifiers
43 @c May be fragile.  Better make single link to generated doco?
44 * Interpretation contexts:(lilypond-internals)LilyPond interpretation contexts.
45 * Engravers:(lilypond-internals)LilyPond engravers.
46 * Backend:(lilypond-internals)LilyPond backend.
47 @end menu
48
49
50
51 @node Overview
52 @section Overview
53
54 This document@footnote{This document has been revised for LilyPond 1.2.}
55 describes the the GNU LilyPond input format This format represents a
56 piece of music in an elegant way, but contains enough information for
57 both automatic typesetting and automatic performances.
58
59 LilyPond input can be classified  into three types:
60 @itemize @bullet
61   @item musical expressions: a musical expression is some combination of
62 rest, notes, lyrics
63   @item output definitions: recipes for translating those musical
64 expressions into performances (MIDI) or graphics (eg. PostScript).
65
66   @item declarations: by declaring and naming musical expressions, you
67 can enter and edit them in manageable chunks.
68 @end itemize
69
70
71
72 @node Top level
73 @section Top level
74
75 @cindex top level
76
77 This section describes what you may enter at top level.
78
79
80
81 @cindex score definition
82
83 The output is generated combining a music expression with an output
84 definition.  A score block has the following syntax:
85
86 @example
87   \score @{ @var{musicexpr} @var{outputdefs} @}
88 @end example
89
90 @var{outputdefs} are zero or more output definitions.  If no output
91 definition is supplied, the default @code{\paper} block will be added.
92
93 @cindex header
94
95 @keyindex{header}
96
97 The syntax is
98
99 @example
100   \header @{ @var{key1} = @var{val1};
101              @var{key2} = @var{val2}; @dots{} @}
102 @end example
103
104 A header describes the file's contents.  It can also appear in a
105 @code{\score} block.  Tools like @code{ly2dvi}@indexcode{ly2dvi} can use this
106 information for generating titles.  Key values that are used by
107 @code{ly2dvi} are: title, subtitle, composer, opus, poet, instrument,
108 metre, arranger, piece and tagline.
109
110 It is customary to put the @code{\header} at the top of the file.
111
112 @node Pitch names
113 @section Pitch names
114
115 Note names and chord modifiers can be customised for nationalities.
116 languages and conventions.  The syntax is as follows.
117 @example
118    \pitchnames @keyindex{pitchnames} @var{scheme-alist}
119    \chordmodifiers@keyindex{chordmodifiers} @var{scheme-alist}
120 @end example
121
122 See @file{ly/nederlands.ly} and @file{ly/chord-modifiers.ly} for
123 specific examples how to do this.  tables can be tailored specified
124 using. Some national note names have been provided, see @ref{Other
125 languages}.
126
127 A @code{\paper} block at top level sets the default paper block.  A
128 @code{\midi} block at top level works similarly.
129
130
131
132 Identifier assignments may appear at top level.  Semicolons are
133 forbidden after top level assignments.
134
135
136
137 @node Lexical conventions
138 @section Lexical conventions
139
140 @cindex lexical conventions
141
142
143
144 @unnumberedsubsec Comments
145
146 @cindex comment
147
148 @indexcode{%}
149
150
151 A one line comment is introduced by a `@code{%}' character. 
152 Block comments are started by `@code{%@{}' and ended by `@code{%@}}'. 
153 They cannot be nested.
154
155 @unnumberedsubsec Scheme
156
157 @indexcode{#}
158
159 LilyPond contains a Scheme interpreter (the GUILE library) for
160 internal use. The interpreter is accessed by the pound sign:
161
162 Whereever the syntax allows Scheme expressions, you may enter one as
163
164 @example
165   #@var{scheme}
166 @end example
167
168 Evaluates the specified Scheme code. If this is used at toplevel, then
169 the result is discarded. Example:
170 @example
171   \property Staff.TestObject \override #'symbol =  #(+ 1 2)
172 @end example
173
174 (in this case, @code{\override} expects two Scheme expressions. 
175
176 [refer appendix/ online intro on Scheme] 
177
178 @unnumberedsubsec Keywords
179
180 @cindex keyword
181
182 Keywords start with a backslash, followed by a number of lower case
183 alphabetic characters.  These are all the keywords.
184
185 @example
186 apply arpeggio autochange spanrequest commandspanrequest
187 simultaneous sequential accepts alternative bar breathe
188 char chordmodifiers chords clef cm consists consistsend
189 context denies duration dynamicscript elementdescriptions
190 font grace header in lyrics key mark musicalpitch
191 time times midi mm name pitchnames notes outputproperty
192 override set revert partial paper penalty property pt
193 relative remove repeat addlyrics partcombine score
194 script stylesheet skip textscript tempo translator
195 transpose type
196 @end example
197
198 @unnumberedsubsec Integers
199
200 @cindex integer
201
202 Formed from an optional minus sign followed by digits.  Arithmetic
203 operations cannot be done with integers, and integers cannot be mixed
204 with reals.
205
206 @unnumberedsubsec Reals
207
208 @cindex real
209  
210
211 Formed from an optional minus sign and a sequence of digits followed
212 by a @emph{required} decimal point and an optional exponent such as
213 @code{-1.2e3}.  Reals can be built up using the usual operations:
214 `@code{+}@indexcode{+}', `@code{-}@indexcode{-}', `@code{*}@indexcode{*}', and
215 `@code{/}@indexcode{/}', with parentheses for grouping.
216
217 A real constant can be followed by one of the dimension
218 keywords:
219 @cindex dimensions
220  @code{\mm}@keyindex{mm},
221 @code{\pt}@keyindex{pt}, @code{\in}@keyindex{in}, or
222 @code{\cm}@keyindex{cm}, for millimeters, points, inches and
223 centimeters, respectively.  This converts the number to a real that
224 is the internal representation of dimensions.
225
226
227 @unnumberedsubsec
228 @cindex string
229  
230 Begins and ends with the `@code{"}' character.  To include a `@code{"}'
231 character in a string write `@code{\"}'.  Various other backslash
232 sequences have special interpretations as in the C language.  A string
233 that contains no spaces can be written without the quotes.  See
234 @ref{Lexical modes} for details on unquoted strings; their interpretation varies
235 depending on the situation.  Strings can be concatenated with the
236 `@code{+}' operator.
237
238 The tokenizer accepts the following commands. They have no grammatical
239 function, hence they can appear anywhere in the input.
240
241 @example
242   \maininput@keyindex{maininput}
243 @end example
244
245 This command is used in init files to signal that the user file must
246 be read. This command cannot be used in a user file.
247
248 @unnumberedsubsec file inclusion
249
250 @example
251   \include@keyindex{include} @var{file}
252 @end example
253
254 Include @var{file}.  The argument @var{file} may be a quoted string (an
255 unquoted string will not work here!) or a string identifier.  The full
256 filename including the @file{.ly} extension must be given,
257
258 @unnumberedsubsec Version information 
259
260 @example
261   \version@keyindex{version} @var{string} ;
262 @end example
263
264 Specify the version of LilyPond that a file was written for.  The
265 argument is a version string in quotes, for example @code{"1.2.0"}. 
266 This is used to detect invalid input, and to aid
267 @code{convert-ly}, a tool that automatically upgrades input files.
268
269
270 @node Other languages
271 @section Other languages
272 @cindex Other languages
273
274 Note name definitions have been provided in various languages. 
275 Simply include the language specific init file.  For example:
276 `@code{\include "english.ly"}'.  The available language files and the
277 names they define are:
278
279 @example 
280                         Note Names               sharp       flat
281 nederlands.ly  c   d   e   f   g   a   bes b   -is         -es
282 english.ly     c   d   e   f   g   a   bf  b   -s/-sharp   -f/-flat
283 deutsch.ly     c   d   e   f   g   a   b   h   -is         -es
284 norsk.ly       c   d   e   f   g   a   b   h   -iss/-is    -ess/-es
285 svenska.ly     c   d   e   f   g   a   b   h   -iss        -ess
286 italiano.ly    do  re  mi  fa  sol la  sib si  -d          -b
287 catalan.ly     do  re  mi  fa  sol la  sib si  -d/-s       -b 
288 @end example 
289
290 Pitch names can be redefined using the @code{\pitchnames} command, see
291 @ref{Pitch names}.
292
293 @node Lexical modes
294 @section Lexical modes
295 @cindex Lexical modes
296 @cindex modes
297
298
299 To simplify entering notes, lyrics, and chords, @emph{Lilypond} has three
300 special input modes on top of the default mode.  In each mode, words
301 are identified on the input.  If @code{"word"} is encountered, it is
302 treated as a string.  If @code{\word} is encountered, it is treated as
303 a keyword or as an identifier.  The behavior of the modes differs in
304 two ways: Different modes treat unquoted words differently, and
305 different modes have different rules for deciding what is a word.
306
307 @table @samp
308   @item Normal mode.
309 @cindex mode!normal
310  
311     At the start of parsing, @emph{Lilypond} is in Normal mode.  In Normal
312     mode, a word is an alphabetic character followed by alphanumeric
313     characters.  If @code{word} is encountered on the input it is
314     treated as a string.
315
316   @item Note mode.
317 @cindex mode!note
318
319     Note mode is introduced by the keyword
320     @code{\notes}@keyindex{notes}.  In Note mode, words can only
321     contain alphabetic characters.  If @code{word} is encountered,
322     LilyPond first checks for a notename of @code{word}.  If no
323     notename is found, then @code{word} is treated as a string.
324
325     Since combinations of numbers and dots are used for indicating
326     durations, it is not possible to enter real numbers in this mode.
327
328   @item Chord mode.
329 @cindex mode!chord
330
331     Chord mode is introduced by the keyword
332     @code{\chords}@keyindex{chords}.  It is similar to Note mode, but
333     words are also looked up in a chord modifier table (containing
334     @code{maj}, @code{dim}, etc).
335
336     Since combinations of numbers and dots are used for indicating
337     durations, you can not enter real numbers in this mode.  Dashes
338     and carets are used to indicate chord additions and subtractions,
339     so scripts can not be entered in Chord mode.
340
341   @item Lyrics mode. 
342 @cindex mode!lyric
343
344     Lyrics mode is introduced by the keyword
345     @code{\lyrics}@keyindex{lyrics}.  This mode has rules that make it
346     easy to include punctuation and diacritical marks in words.  A
347     word in Lyrics mode begins with: an alphabetic character,
348     `@code{_}', `@code{?}', `@code{!}', `@code{:}', `@code{'}', the
349     control characters @code{^A} through @code{^F}, @code{^Q} through
350     @code{^W}, @code{^Y}, @code{^^}, any 8-bit character with ASCII code
351     over 127, or a two-character combination of a backslash followed
352     by one of `@code{`}', `@code{'}', `@code{"}', or
353     `@code{^}'.@footnote{The purpose of Lyrics mode is that you can
354     enter lyrics in @TeX{} format or a standard encoding without
355     needing quotes.  The precise definition of this mode indeed is
356     ludicrous.  This will remain so until the authors of LilyPond
357     acquire a deeper understanding of character encoding, or someone
358     else steps up to fix this.}
359
360     Subsequent characters of a word can be any character that is not
361     a digit and not white space.  One important consequence of this
362     is that a word can end with `@code{@}}', which may be confusing if
363     you thought the closing brace was going to terminate Lyrics
364     mode.@footnote{LilyPond will issue a warning, though.}  Any
365     `@code{_}' character which appears in an unquoted word is
366     converted to a space.  This provides a mechanism for introducing
367     spaces into words without using quotes.  Quoted words can also be
368     used in Lyrics mode to specify words that cannot be written with
369     the above rules.  Here are some examples.  Not all of these words
370     are printable by @TeX{}.
371
372 @example 
373 Ah!             % a word
374 2B_||_!2B       % not a word because it starts with a digit
375 ``Hello''       % not a word because it starts with `
376 _ _ _ _         % 4 words, each one a space 
377 @end example 
378
379     Since combinations of numbers and dots are used for indicating
380     durations, you can not enter real numbers in this mode.
381 @end table
382
383 [todo: include short table showign differences] 
384
385 @node Types
386 @section Types
387
388 @cindex  Identifiers
389
390 [say something about types]
391
392 All of the information in a LilyPond input file, is represented as a
393 Scheme value. In addition to normal Scheme data types (such as pair,
394 number, boolean, etc.), LilyPond has a number of specialized data types,
395
396 @itemize @bullet
397   @item Input
398   @item c++-function
399   @item Music: see @ref{Music expressions}
400   @item Identifier
401   @item Translator_def:
402 See section @ref{contextdefs} for more information
403
404   @item Duration
405   @item Pitch
406   @item Score
407   @item Music_output_def (TODO: this is not really a Scheme object
408 yet. Nevertheless, you can use identifiers to make references to them )
409   @item Moment (rational number)
410 @end itemize
411
412 LilyPond also includes some transient object types. Objects of these
413 types are built during a LilyPond run, and do not `exist' per se within
414 your input file. These objects are created as a result of your input
415 file, so you can include commands in the input to manipulate them,
416 during a lilypond run.
417
418 @itemize @bullet
419   @item Grob: short for Graphical object. See @ref{Grobs}. 
420   @item Molecule: device-independent page output object,
421     including dimensions.  Produced by some Grob functions
422     See @ref{Molecules}
423   @item Translator: object that produces audio objects or Grobs.
424   @item Font_metric: object representing a font. (Not yet user
425 accessible.)
426
427 @c  @item Audio_element: (todo,  smobme)
428 @end itemize
429
430 Identifiers allow objects to be assigned to names during the parse
431 stage.  To assign an identifier, you use `@var{name}=@var{value}' and to
432 refer to an identifier, you preceed its name with a backslash:
433 `@code{\}@var{name}'.  Identifier assignments must appear at top level
434 in the @emph{Lilypond} file.  Semicolons are forbidden after assignments
435 appearing at top level but they are obligatory after assignments
436 appearing in the @code{\paper} block, see Section @ref{Page layout}.
437
438 @var{value} is any valid Scheme value or any of the input-types listed
439 above.
440
441 An identifier can be created with any string for its name, but you will
442 only be able to refer to identifiers whose names begin with a letter,
443 being entirely alphanumeric.  It is impossible to refer to an identifier
444 whose name is the same as the name of a keyword.
445
446 The right hand side of an identifier assignment is parsed completely
447 before the assignment is done, so it is allowed to redefine an
448 identifier in terms of its old value, e.g.
449
450 @example
451   foo = \foo * 2.0
452 @end example
453
454 When an identifier is referenced, the information it points to is
455 copied.  For this reason, an identifier reference must always be the
456  first item in a block.
457 @example
458 \paper  @{
459    foo = 1.0
460    \paperIdent % wrong and invalid
461 @}
462
463 \paper @{
464    \paperIdent % correct
465    foo = 1.0
466 @}
467 @end example
468
469
470 @node Music expressions
471 @section Music expressions
472
473 @cindex music expressions
474
475 Music in @emph{Lilypond} is entered as a music expression.  Notes, rests,
476 lyric syllables are music expressions (the atomic
477 expressions),
478 @cindex atomic music expressions
479 and you can combine music expressions to form new ones.  This example
480 forms a compound expressions out of the quarter @code{c} note and a
481 @code{d} note:
482
483 @example 
484 \sequential @{ c4 d4 @} 
485 @end example 
486
487 The meaning of this compound expression is to play the `@code{c}'
488 first, and then the `@code{d}' (as opposed to playing them
489 simultaneously, for instance).
490
491 Atomic music expression are discussed in
492 subsection @ref{Atomic music expressions}.  Compound music expressions are
493 discussed in subsection @ref{Compound music expressions}.
494
495
496
497 @node Atomic music expressions
498 @section Atomic music expressions
499
500
501
502
503 @cindex pitch
504
505 @cindex duration
506  
507
508 The syntax for pitch specification is
509
510
511 @example
512   \musicalpitch@keyindex{musicalpitch} @{ @var{octave} @var{note} @var{shift} @}
513 @end example
514
515 @var{octave} is specified by an integer, zero for the octave
516 containing middle C.  @var{note} is a number from 0 to 7, with 0
517 corresponding to C and 7 corresponding to B.  The shift is zero for a
518 natural, negative to add flats, or positive to add sharps.
519
520 In Note and Chord mode, pitches may be designated by names.  See
521 section @ref{Other languages} for pitch names in different languages.
522
523 The syntax for duration specification is
524
525 @example
526  \duration@keyindex{duration}
527    @{ @var{length} @var{dotcount} @}
528 @end example
529
530 @var{length} is the negative logarithm (base 2) of the duration:
531 1 is a half note, 2 is a quarter note, 3 is an eighth
532 note, etc.  The number of dots after the note is given by
533 @var{dotcount}.
534
535 In Note, Chord, and Lyrics mode, durations may be designated by
536 numbers and dots.  
537
538
539 @node Note specification
540 @section Note specification
541 @cindex Note specification
542
543 @cindex pitches
544
545 @cindex entering notes
546
547 A note specification has the form
548
549 @example
550   @var{pitch}[@var{octavespec}][!][?][@var{duration}]
551 @end example
552
553 The pitch of the note is specified by the note's name.
554
555
556 The default names are the Dutch note names.  The notes are specified
557 by the letters `@code{c}' through `@code{b}', where `@code{c}' is an
558 octave below middle C and the letters span the octave above that C. 
559 In Dutch,
560 @cindex notenames!Dutch
561 a sharp is formed by adding `@code{-is}' to the end of a pitch name.  A
562 flat is formed by adding `@code{-es}'. Double sharps and double flats
563 are obtained by adding `@code{-isis}' or `@code{-eses}'.  `@code{aes}'
564 and `@code{ees}' are contracted to `@code{as}' and `@code{es}' in Dutch,
565 but both forms will be accepted.
566
567 LilyPond has predefined sets of notenames for various languages.  See
568 @ref{Other languages}.
569
570
571
572 The optional octave specification takes the form of a series of
573 single quote (`@code{'}@indexcode{'}') characters or a series of comma
574 (`@code{,}@indexcode{,}') characters.  Each @code{'} raises the pitch by one
575 octave; each @code{,} lowers the pitch by an octave.
576
577 @lilypond[fragment,verbatim,center]
578   c' d' e' f' g' a' b' c''
579 @end lilypond
580
581 @lilypond[fragment,verbatim,center]
582   cis' dis' eis' fis' gis' ais' bis'
583 @end lilypond
584
585 @lilypond[fragment,verbatim,center]
586   ces' des' es' fes' ges' as' bes'
587 @end lilypond
588
589 @lilypond[fragment,verbatim,center]
590   cisis' eisis' gisis' aisis' beses'
591 @end lilypond
592
593 @lilypond[fragment,verbatim,center]
594   ceses' eses' geses' ases' beses'
595 @end lilypond
596
597 Whenever a C-sharp is desired,  you must specify a C-sharp.  LilyPond
598 will determine what accidentals to typeset depending on the key and
599 context.  A reminder accidental 
600 @cindex reminder accidental
601  can be
602 forced by adding an exclamation mark `@code{!}' after the pitch.  A
603 cautionary accidental, 
604 @cindex cautionary accidental
605  i.e., an
606 accidental within parentheses can be obtained by adding the question
607 mark `@code{?}@indexcode{?}' after the pitch.
608
609 @lilypond[fragment,verbatim,center]
610   cis' d' e' cis'  c'? d' e' c'!
611 @end lilypond
612
613
614 @cindex duration
615
616 Durations are entered as their reciprocal values.  For notes longer
617 than a whole note, use identifiers.
618
619 @quotation
620
621 @example 
622 c'\longa c'\breve  
623 c'1 c'2 c'4 c'8 c'16 c'32 c'64 c'64 
624 @end example 
625
626 @end quotation
627
628 @quotation
629
630 @lilypond[]
631 \score {
632   \notes \relative c'' {
633     a\longa a\breve  
634     a1 a2 a4 a8 a16 a32 a64 a64 
635   }
636   \paper {
637 %{    \translator {
638       \StaffContext
639         \remove "Clef_engraver";
640         \remove "Staff_symbol_engraver";
641     } %}
642   }
643 }
644 @end lilypond
645 @end quotation
646
647 @quotation
648
649 @example 
650 r\longa r\breve  
651 r1 r2 r4 r8 r16 r32 r64 r64 
652 @end example 
653
654 @end quotation
655
656 @quotation
657
658 @lilypond[]
659 \score {
660   \notes \relative c'' {
661     r\longa r\breve  
662     r1 r2 r4 r8 r16 r32 r64 r64 
663   }
664   \paper {
665     loose_column_distance = 2.5 * \staffspace;
666     linewidth = -1.0;
667     \translator {
668         \StaffContext
669         \remove "Clef_engraver";
670         \remove "Staff_symbol_engraver";
671         \remove "Bar_engraver";
672     }
673   }
674 }
675 @end lilypond
676 @end quotation
677
678 If the duration is omitted then it is set equal to the previous
679 duration.  If there is no previous duration, a quarter note is
680 assumed.  The duration can be followed by a dot (`@code{.}@indexcode{.}')
681 to obtain dotted note lengths.
682
683 @lilypond[fragment,verbatim,center]
684   a'4. b'4.
685 @end lilypond
686
687 You can alter the length of duration by writing
688 `@code{*}@var{fraction}' after it.  This will not affect the
689 appearance of note heads or rests.
690
691
692 Rests are entered like notes, with note name `@code{r}@indexcode{r}', or
693 `@code{R}@indexcode{R}'.  There is also a note name
694 `@code{s}@indexcode{s}', which produces a space of the specified
695 duration.  `@code{R}' is specifically meant for entering parts: the
696 @code{R} rest can expand to fill a score with rests, or it can be
697 printed as a single multimeasure rest.
698
699 You can control the expansion by setting the property
700 @code{Score.skipBars}. If this is set to true, Lily will not expand
701 empty measures, and the multimeasure rests automatically adds the
702 appropriate number.
703
704 Note that there is currently no way to condense multiple rests into a
705 single multimeasure rest.
706
707
708
709 @cindex lyrics expressions
710
711 Syllables are entered like notes, with pitches replaced by text.  For
712 example, `@code{Twin-4 kle4 twin-4 kle4}' enters four syllables, each
713 with quarter note duration.  Note that the hyphen has no special
714 meaning for lyrics, and does not introduce special symbols.  See
715 section @ref{Lexical modes} for a description of what is interpreted as
716 lyrics.
717
718 Spaces can be introduced into a lyric either by using quotes
719 (`@code{"}') or by using an underscore without quotes: `@code{He_could4
720 not4}'.  All unquoted underscores are converted to spaces.  Printing
721 lyrics is discussed in section @ref{lyricprint}.
722
723
724
725 @cindex properties
726
727 @example
728   \property@keyindex{property}
729     @var{contextname}.@var{propname} =  @var{value}
730 @end example
731
732 Sets the @var{propname} property of the context @var{contextname} to
733 the specified @var{value}.  All three arguments are strings. 
734 Depending on the context, it may be necessary to quote the strings or
735 to leave space on both sides of the dot.
736
737
738
739 @cindex translator switches
740
741 @example
742   \translator@keyindex{translator}
743     @var{contexttype} = @var{name}
744 @end example
745
746 A music expression indicating that the context which is a direct
747 child of the a context of type @var{contexttype} should be shifted to
748 a context of type @var{contexttype} and the specified name.
749
750 Usually this is used to switch staffs in Piano music, e.g.
751
752 @example
753   \translator Staff = top @var{Music}
754 @end example
755
756
757 @cindex output properties
758
759
760 These allow you to tweak what is happening in the back-end
761 directly. If you want to control every detail of the output
762 formatting, this is the feature to use. The downside to this is that
763 you need to know exactly how the backend works. Example:
764
765
766 @lilypond[fragment,verbatim]
767 \relative c'' { c4
768         \context Staff \outputproperty
769                 #(make-type-checker 'Note_head)
770                 #'extra-offset = #'(5.0 . 7.5)
771 <c8 e g> }
772 @end lilypond
773
774 This selects all note heads occurring at current staff level, and sets
775 the extra-offset of those heads to (5,7.5), shifting them up and
776 right.
777
778 Use of this feature is entirely on your own risk: if you use this, the
779 result will depend very heavily on the implementation of the backend,
780 which we change regularly and unscrupulously.
781
782
783 @cindex commands
784
785 Commands are music expressions that have no duration.   
786
787
788 @example
789   @code{\key}@keyindex{key} @var{pitch} @var{type} @code{;}
790 @end example
791
792 Change the key signature.  @var{type} should be
793 @code{\major}@keyindex{major} or @code{\minor}@keyindex{minor} to get
794 @var{pitch}-major or @var{pitch}-minor, respectively.  The second
795 argument is optional; the default is major keys.  The @var{\context}
796 argument can also be given as an integer, which tells the number of
797 semitones that should be added to the pitch given in the subsequent
798 @code{\key}@keyindex{key} commands to get the corresponding major key,
799 e.g., @code{\minor}@keyindex{minor} is defined as 3.  The standard
800 mode names @code{\ionian}@keyindex{ionian},
801 @code{\locrian}@keyindex{locrian}, @code{\aeolian}@keyindex{aeolian},
802 @code{\mixolydian}@keyindex{mixolydian}, @code{\lydian}@keyindex{lydian},
803 @code{\phrygian}@keyindex{phrygian}, and @code{\dorian}@keyindex{dorian}
804 are also defined.
805
806         
807 @example
808   \mark@keyindex{mark} @var{unsigned};
809   \mark @var{string};
810 @end example
811
812 Prints a mark over or under the staff.  You must add
813 @code{Mark_engraver}@indexcode{Mark_engraver} to the Score context for
814 this to work.
815
816 @node barlines
817 @section barlines
818
819 @example
820   \bar@keyindex{bar} @var{bartype};
821 @end example
822
823 This is a short-cut for doing
824 @example
825   \property Score.whichBar = @var{bartype} 
826 @end example
827
828 You are encouraged to use @code{\repeat} for repetitions.  See
829 @ref{Repeats}, and the documentation of @code{whichBar} in
830 @ref{(lilypond-internals)LilyPond context properties}.
831
832
833 @example
834   \time@keyindex{time} @var{numerator}@code{/}@var{denominator} @code{;}
835 @end example
836
837 A short-cut for doing
838 @example
839      \property Score.timeSignatureFraction = #'(@var{numerator} . @var{denominator})
840 @end example
841
842 See the documentation of @code{timeSignatureFraction}
843
844 @example
845
846   \tempo@keyindex{tempo} @var{duration} = @var{perminute} @code{;}
847 @end example
848
849 Used to specify the tempo.  For example, `@code{\tempo 4 = 76;}'
850 requests output with 76 quarter notes per minute.
851
852 @example
853   \partial@keyindex{partial} @var{duration} @code{;}
854 @end example
855
856 Short cut for 
857
858 @example
859   \property Score.measurePosition = @var{length of duration}
860 @end example
861
862 See the documentation of @code{measurePosition}.
863
864 @cindex anacrusis
865
866 @cindex upstep
867
868 @example
869
870   @code{|}@indexcode{|}
871 @cindex bar check
872
873 @end example
874
875 @cindex shorten measures
876
877 @cindex upstep
878
879 `@code{|}' is a bar check.  Whenever a bar check is encountered during
880 interpretation, a warning message is issued if it doesn't fall at a
881 measure boundary.  This can help you finding errors in the input.
882 Depending on the value of @code{barCheckNoSynchronize}
883 @indexcode{barCheckNoSynchronize} The beginning of the measure will be
884 relocated, so this can also be used to shorten measures.
885
886
887 @example
888   \penalty@keyindex{penalty} @var{int} @code{;}
889 @end example
890
891 Discourage or encourage line breaks.  See identifiers
892 @code{\break}@keyindex{break} and @code{\nobreak}@keyindex{nobreak} in
893 section [on identifiers] [FIXME].
894
895 @example
896   \clef@keyindex{clef} @var{clefname} @code{;}
897 @end example
898
899 Short-cut for
900
901 @example
902   \property Clef.clefGlyph = @var{symbol associated with clefname} 
903   \property Clef.clefPosition = @var{clef Y-position for clefname}
904   \property Clef.clefOctavation = @var{extra pitch of clefname}
905 @end example
906
907 Supported clef-names include 
908
909 [todo]
910
911 @example
912
913   \skip@keyindex{skip} @var{duration} @code{;}
914 @end example
915
916 Skips the amount of time specified by @var{duration}.  If no other
917 music is played, a gap will be left for the skipped time with no
918 notes printed.  It works in Note Mode or Lyrics Mode.  In Note mode,
919 this has the same effect as the space rest `@code{s}'.
920
921
922 @node Manual beams
923 @section Manual beams
924 @cindex beams
925
926 A beam is specified by surrounding the beamed notes with brackets
927 `@code{[}@indexcode{[}' and `@code{]}@indexcode{]}'.  
928
929 @lilypond[fragment,verbatim,center]
930   [a'8 a'] [a'16 a' a' a']
931 @end lilypond
932
933 Some more elaborate constructions:
934
935 @lilypond[fragment,verbatim,center]
936   [a'16 <a' c''> c'' <a' c''>]
937   \times 2/3 { [e'8 f' g'] }
938 @end lilypond
939
940 Beaming can be generated automatically; see section @ref{Automatic Beaming}.
941
942
943 To place tremolo marks between notes, use @code{\repeat} with tremolo
944 style.
945 @cindex tremolo beams
946 To create tremolo beams on a single note, simply attach
947 `@code{:}@var{length}' to the note itself.
948
949 @lilypond[fragment,verbatim,center]
950   \repeat "tremolo" 8 { c16 d16 }
951   \repeat "tremolo" 4 { c16 d16 }    
952 @end lilypond
953
954 @lilypond[fragment,verbatim,center]
955   c'4:32
956 @end lilypond
957
958
959 @cindex --@@@code{-}@code{-}
960
961 @indexcode{__}
962
963 @cindex extender
964
965 @cindex hyphen
966
967 The syntax for an extender mark is `@code{__}'.  This syntax can only
968 be used within lyrics mode.  The syntax for a spanning hyphen (i.e.,
969 a hyphen that will be printed between two lyric syllables) is
970 `@code{-}@code{-}'.
971
972
973 @cindex ties
974
975 A tie connects two adjacent note heads of the same pitch.  When used
976 with chords, it connects all of the note heads whose pitches match.
977 Ties are indicated using the tilde symbol `@code{~}@indexcode{~}'.
978 If you try to tie together chords which have no common pitches, a
979 warning message will appear and no ties will be created.
980
981 @lilypond[fragment,verbatim,center]
982   e' ~ e' <c' e' g'> ~ <c' e' g'>
983 @end lilypond
984
985
986
987 [TODO: explain Requests]
988
989
990 @cindex articulations
991
992 @cindex scripts
993
994 @cindex ornaments
995
996 A variety of symbols can appear above and below notes to indicate
997 different characteristics of the performance.  These symbols can be
998 added to a note with `@var{note}@code{-\}@var{name}'.  Numerous symbols
999 are defined in @file{script.ly} and @file{script.scm}.  Symbols can be
1000 forced to appear above or below the note by writing
1001 `@var{note}@code{^\}@var{name}' and `@var{note}@code{_\}@var{name}'
1002 respectively.  Here is a chart showing symbols above notes, with the
1003 name of the corresponding symbol appearing underneath.
1004
1005 @lilypond[]
1006
1007   \score {
1008     < \notes {
1009         c''-\accent      c''-\marcato      c''-\staccatissimo c''-\fermata 
1010         c''-\stopped     c''-\staccato     c''-\tenuto        c''-\upbow
1011         c''-\downbow     c''^\lheel        c''-\rheel         c''^\ltoe
1012         c''-\rtoe        c''-\turn         c''-\open          c''-\flageolet
1013         c''-\reverseturn c''-\trill        c''-\prall         c''-\mordent
1014         c''-\prallprall  c''-\prallmordent c''-\upprall       c''-\downprall
1015         c''-\thumb       c''-\segno        c''-\coda
1016       }
1017       \context Lyrics \lyrics {  
1018         accent__      marcato__      staccatissimo__ fermata
1019         stopped__     staccato__     tenuto__        upbow
1020         downbow__     lheel__        rheel__         ltoe
1021         rtoe__        turn__         open__          flageolet
1022         reverseturn__ trill__        prall__         mordent
1023         prallprall__  prallmordent__ uprall__        downprall
1024         thumb__       segno__        coda
1025       }
1026     >
1027     \paper {
1028       linewidth = 5.875\in;          
1029       indent    = 0.0;
1030     }
1031   }
1032
1033 @end lilypond
1034
1035 In addition, it is possible to place arbitrary strings of text or
1036 @TeX{} above or below notes by using a string instead of an
1037 identifier: `@code{c^"text"}'.  Fingerings 
1038 @cindex fingering
1039  can be
1040 placed by simply using digits.  All of these note ornaments appear in
1041 the printed output but have no effect on the MIDI rendering of the
1042 music.
1043
1044 To save typing, fingering instructions (digits 0 to 9 are
1045 supported) and single characters shorthands exist for a few
1046 common symbols
1047
1048 @lilypond[]
1049
1050   \score {
1051     \notes {
1052       \property Voice.textStyle = typewriter
1053       c''4-._"c-."      s4
1054       c''4--_"c-{}-"    s4
1055       c''4-+_"c-+"      s4
1056       c''4-|_"c-|"      s4
1057       c''4->_"c->"      s4
1058       c''4-^_"c-\\^{ }" s4
1059       c''4-1_"c-1"      s4
1060       c''4-2_"c-2"      s4
1061       c''4-3_"c-3"      s4
1062       c''4-4_"c-4"      s4
1063     }
1064     \paper {
1065       linewidth = 5.875 \in;
1066       indent    = 0.0;
1067     }
1068   }
1069
1070 @end lilypond
1071
1072 Dynamic marks are specified by using an identifier after a note:
1073 `@code{c4-\ff}' (the dash is optional for dynamics: `@code{c4 \ff})'.  
1074 The available dynamic marks are:
1075 @code{\ppp}@keyindex{ppp},
1076 @code{\pp}@keyindex{pp}, @code{\p}@keyindex{p}, @code{\mp}@keyindex{mp},
1077 @code{\mf}@keyindex{mf}, @code{\f}@keyindex{f}, @code{\ff}@keyindex{ff},
1078 @code{\fff}@keyindex{fff}, @code{\fff}@keyindex{ffff},
1079 @code{\fp}@keyindex{fp}, @code{\sf}@keyindex{sf},
1080 @code{\sff}@keyindex{sff}, @code{\sp}@keyindex{sp},
1081 @code{\spp}@keyindex{spp}, @code{\sfz}@keyindex{sfz}, and
1082 @code{\rfz}@keyindex{rfz}.
1083
1084
1085 @example
1086
1087   \textscript@keyindex{textscript} @var{text} @var{style}
1088 @end example
1089
1090 Defines a text to be printed over or under a note.  @var{style} is a
1091 string that may be one of @code{roman}, @code{italic}, @code{typewriter}, 
1092 @code{bold}, @code{Large}, @code{large}, @code{dynamic} or @code{finger}.
1093
1094 You can attach a general textscript request using this syntax:
1095
1096 @quotation
1097
1098 @example 
1099 c4-\textscript "6" "finger"
1100 c4-\textscript "foo" "normal" 
1101 @end example 
1102
1103 @end quotation
1104
1105 This is equivalent to `@code{c4-6 c4-"foo"}'.  
1106
1107
1108 @cindex scripts
1109
1110 @example
1111
1112   \script@keyindex{script} @var{alias}
1113 @end example
1114
1115 Prints a symbol above or below a note.  The argument is a string
1116 which points into the script-alias table defined in @file{script.scm}.
1117 The scheme definitions specify whether the symbol follows notes into
1118 the staff, dependence of symbol placement on staff direction, and a
1119 priority for placing several symbols over one note.  Usually the
1120 @code{\script}@keyindex{script} keyword is not used directly.  Various
1121 helpful identifier definitions appear in @file{script.ly}.
1122
1123
1124 @cindex slur
1125
1126 Slurs connects chords and try to avoid crossing stems.  A slur is
1127 started with `@code{(}' and stopped with `@code{)}'.  The
1128 starting `@code{(}' appears to the right of the first note in
1129 the slur.  The terminal `@code{)}' appears to the left of the
1130 first note in the slur.  This makes it possible to put a note in
1131 slurs from both sides:
1132
1133 @lilypond[fragment,verbatim,center]
1134   f'()g'()a' [a'8 b'(] a'4 g'2 )f'4
1135 @end lilypond
1136
1137
1138 @cindex crescendo
1139
1140 A crescendo mark is started with @code{\cr}@keyindex{cr} and terminated
1141 with @code{\rc}@keyindex{rc}.  A decrescendo mark is started with
1142 @code{\decr}@keyindex{decr} and terminated with
1143 @code{\rced}@keyindex{rced}.  There are also shorthands for these
1144 marks.  A crescendo can be started with @code{\<}@keyindex{<} and a
1145 decrescendo can be started with @code{\>}@keyindex{>}.  Either one can
1146 be terminated with @code{\!}@keyindex{"!}.  Note that @code{\!}
1147 must go before the last note of the dynamic mark whereas @code{\rc}
1148 and @code{\rced} go after the last note.  Because these marks are
1149 bound to notes, if you want to get several marks during one note, you
1150 must use spacer notes.
1151
1152 @lilypond[fragment,verbatim,center]
1153   c'' \< \! c''   d'' \decr e'' \rced 
1154   < f''1 { s4 \< \! s2 \> \! s4 } >
1155 @end lilypond
1156
1157
1158 @example
1159
1160   \spanrequest@keyindex{spanrequest} @var{startstop} @var{type}
1161 @end example
1162
1163 Define a spanning request. The @var{startstop} parameter is either -1
1164 (@code{\start}@keyindex{start}) or 1 (@code{\stop}@keyindex{stop}) and
1165 @var{type} is a string that describes what should be started.
1166 Supported types are @code{crescendo}, @code{decrescendo},
1167 @code{beam}, @code{slur}.  This is an internal command.  Users should
1168 use the shorthands which are defined in the initialization file
1169 @file{spanners.ly}.
1170
1171 You can attach a (general) span request to a note using
1172
1173 @lilypond[fragment,verbatim,center]
1174   c'4-\spanrequest \start "slur"
1175   c'4-\spanrequest \stop "slur"
1176 @end lilypond
1177
1178 The slur syntax with parentheses is a shorthand for this.
1179
1180
1181 @node stem tremolo
1182 @section stem tremolo
1183 @cindex tremolo marks
1184
1185 Tremolo marks can be printed on a single note by adding
1186 `@code{:}[@var{length}]' after the note.  The length must be at
1187 least 8.  A @var{length} value of 8 gives one line across
1188 the note stem.  If the length is omitted, then the last value is
1189 used, or the value of the @code{tremoloFlags}@indexcode{tremoloFlags} property if there was
1190 no last value.
1191
1192 @lilypond[verbatim,fragment,center]
1193   c'2:8 c':32
1194 @end lilypond
1195
1196
1197
1198 @node Compound music expressions
1199 @section Compound music expressions
1200
1201 @cindex compound music expressions
1202
1203 Music expressions are compound data structures.  You can nest music
1204 expressions any way you like.  This simple example shows how three
1205 chords can be expressed in two different ways:
1206
1207 @lilypond[fragment,verbatim,center]
1208   \notes \context Staff {
1209     \cadenzaOn
1210     <a c'> <b  d' > <c' e'>
1211     < { a b  c' } { c' d' e' } >
1212   }
1213 @end lilypond
1214
1215 @cindex context selection
1216 @c @keyindex{context}
1217
1218 @example
1219   \context @var{contexttype} [= @var{contextname}] @var{musicexpr}
1220 @end example
1221
1222 Interpret @var{musicexpr} within a context of type @var{contexttype}. 
1223 If the context does not exist, it will be created.  The new context
1224 can optionally be given a name.  
1225
1226 @cindex input modes
1227
1228 @cindex mode switch
1229
1230 Mode switching keywords form compound music expressions: @code{\notes}
1231 @keyindex{notes} @var{musicexpr}, @code{\chords} @keyindex{chords}
1232 @var{musicexpr}, and @code{\lyrics} @keyindex{lyrics} @var{musicexpr}. 
1233 These expressions do not add anything to the meaning of their
1234 arguments.  They are just a way to indicate that the arguments should
1235 be parsed in indicated mode.  See @ref{Lexical modes} for more
1236 information on modes.
1237
1238 @cindex sequential music
1239
1240
1241
1242 @example
1243
1244   \sequential@keyindex{sequential}
1245     @code{@{} @var{musicexprlist} @code{@}}
1246 @end example
1247
1248 This means that list should be played or written in sequence, i.e.,
1249 the second after the first, the third after the second.  The duration
1250 of sequential music is the the sum of the durations of the elements. 
1251 There is a shorthand, which leaves out the keyword:
1252
1253 @example
1254
1255   @code{@{} @var{musicexprlist} @code{@}}
1256 @end example
1257
1258
1259
1260 @cindex simultaneous music
1261
1262 @indexcode{<}
1263 @indexcode{>}
1264
1265 @example
1266
1267   \simultaneous@keyindex{simultaneous}
1268     @code{@{} @var{musicexprlist} @code{@}}
1269 @end example
1270
1271 It constructs a music expression where all of its arguments start at
1272 the same moment.  The duration is the maximum of the durations of the
1273 elements.  The following shorthand is a common idiom:
1274
1275 @example
1276
1277   @code{<} @var{musicexprlist} @code{>}
1278 @end example
1279
1280 If you try to use a chord as the first thing in your score, you might
1281 get multiple staffs instead of a chord.
1282
1283 @lilypond[verbatim,center]
1284   \score {
1285     \notes <c''4 e''>
1286     \paper {
1287       linewidth = -1.;
1288     }
1289   }
1290 @end lilypond
1291
1292 This happens because the chord is interpreted by a score context.
1293 Each time a note is encountered a default Voice context (along with a
1294 Staff context) is created.  The solution is to explicitly instantiate
1295 a Voice context:
1296
1297 @lilypond[verbatim,center]
1298   \score {
1299     \notes\context Voice <c''4 e''>
1300     \paper {
1301       linewidth = -1.;
1302     }
1303   }
1304 @end lilypond
1305
1306
1307
1308
1309 @node relative
1310 @section relative
1311 @cindex relative pitch specification
1312
1313 It is easy to get confused by octave changing marks and accidentally
1314 putting a pitch in the wrong octave.  A much better way of entering a
1315 note's octave is `the relative octave' mode.
1316
1317 @example
1318
1319   \relative@keyindex{relative} @var{startpitch} @var{musicexpr}
1320 @end example
1321
1322 The octave of notes that appear in @var{musicexpr} are calculated as
1323 follows: If no octave changing marks are used, the basic interval
1324 between this and the last note is always taken to be a fourth or
1325 less.@footnote{The interval is determined without regarding
1326 accidentals.  A @code{fisis} following a @code{ceses} will be put above
1327 the @code{ceses}.}  The octave changing marks `@code{'}' and `@code{,}'
1328 can then be added to raise or lower the pitch by an extra octave. 
1329 Upon entering relative mode, an absolute starting pitch must be
1330 specified that will act as the predecessor of the first note of
1331 @var{musicexpr}.
1332
1333 Entering scales is straightforward in relative mode.
1334
1335 @lilypond[fragment,verbatim,center]
1336   \relative c' {
1337     c d e f g a b c c,
1338   }
1339 @end lilypond
1340
1341 And octave changing marks are used for intervals greater than a fourth.
1342
1343 @lilypond[fragment,verbatim,center]
1344   \relative c'' {
1345     c g c f, c' a, e'' }
1346 @end lilypond
1347
1348 If the preceding item is a chord, the first note of the chord is used
1349 to determine the first note of the next chord.  But other notes
1350 within the second chord are determined by looking at the immediately
1351 preceding note.
1352
1353 @lilypond[fragment,verbatim,center]
1354   \relative c' {
1355     c <c e g> 
1356     <c' e g>
1357     <c, e' g>
1358   }
1359 @end lilypond 
1360
1361 The pitch after the @code{\relative} contains a notename.  To parse
1362 the pitch as a notename, you have to be in note mode, so there must
1363 be a surrounding @code{\notes}@keyindex{notes} keyword (which is not
1364 shown here).
1365
1366 The relative conversion will not affect @code{\transpose} or
1367 @code{\relative} sections in its argument.  If you want to use
1368 relative within transposed music, you must place an additional
1369 @code{\relative} inside the @code{\transpose}.
1370
1371 It is strongly recommended to use relative pitch mode: less work,
1372 less error-prone, and more readable.
1373
1374
1375
1376 Chord names are a way to generate simultaneous music expressions that
1377 correspond with traditional chord names.  It can only be used in
1378 Chord mode (see section @ref{Lexical modes}).
1379
1380 @example
1381
1382   @var{tonic}[@var{duration}][@code{-}@var{modifiers}][@code{^}@var{subtractions}][@code{/}@var{inversion}][@code{/+}@var{bass}].
1383 @end example
1384
1385 @var{tonic} should be the tonic note of the chord, and @var{duration}
1386 is the chord duration in the usual notation.  There are two kinds of
1387 modifiers.  One type is @emph{chord additions}, which are obtained by
1388 listing intervals separated by dots.  An interval is written by its
1389 number with an optional `@code{+}' or `@code{-}' to indicate raising or
1390 lowering by half a step.  Chord additions has two effects: It adds
1391 the specified interval and all lower odd numbered intervals to the
1392 chord, and it may lower or raise the specified interval.  Intervals
1393 must be separated by a dot (`@code{.}').
1394
1395 @quotation
1396
1397 @lilypond[fragment,verbatim]
1398 \transpose c'' {
1399   \chords {
1400     c1  c:3-       c:7     c:8
1401     c:9 c:9-.5+.7+ c:3-.5- c:4.6.8
1402   }
1403 }
1404
1405 @end lilypond
1406 @end quotation
1407
1408 The second type of modifier that may appear after the `@code{:}' is a
1409 named modifier.  Named modifiers are listed in the file
1410 @file{chord-modifiers.ly}.  The available modifiers are `@code{m}' and
1411 `@code{min}' which lower the 3rd half a step, `@code{aug}@indexcode{aug}' which
1412 raises the 5th, `@code{dim}@indexcode{dim}' which lowers the 5th,
1413 `@code{maj}@indexcode{maj}' which adds a raised 7th, and `@code{sus}@indexcode{sus}'
1414 which replaces the 5th with a 4th.
1415
1416 @quotation
1417
1418 @lilypond[fragment,verbatim]
1419 \transpose c'' {
1420   \chords {
1421     c1:m c:min7 c:maj c:aug c:dim c:sus
1422   }
1423 }
1424
1425 @end lilypond
1426 @end quotation
1427  
1428
1429 Chord subtractions are used to eliminate notes from a chord.  The
1430 notes to be subtracted are listed after a `@code{^}' character,
1431 separated by dots.
1432
1433 @lilypond[fragment,verbatim,center]
1434   \transpose c'' {
1435     \chords {
1436       c1^3 c:7^5.3 c:8^7
1437     }
1438   }
1439 @end lilypond 
1440
1441 Chord inversions can be specified by appending `@code{/}@indexcode{/}' and
1442 the name of a single note to a chord.  This has the effect of
1443 lowering the specified note by an octave so it becomes the lowest
1444 note in the chord.  If the specified note is not in the chord, a
1445 warning will be printed.
1446
1447 @lilypond[fragment,verbatim,center]
1448   \transpose c''' {
1449     \chords {
1450       c1 c/e c/g c:7/e
1451     }
1452   }
1453
1454 @end lilypond 
1455
1456 Bass notes can be added by `@code{/+}@indexcode{/+}' and
1457 the name of a single note to a chord.  This has the effect of
1458 adding the specified note to the chord, lowered by an octave,
1459 so it becomes the lowest note in the chord.
1460
1461 @lilypond[fragment,verbatim,center]
1462   \transpose c''' {
1463     \chords {
1464       c1 c/+c c/+g c:7/+b
1465     }
1466   }
1467
1468 @end lilypond 
1469
1470 Throughout these examples, chords have been shifted around the staff
1471 using @code{\transpose}.
1472
1473 You should not combine @code{\relative} with named chords. 
1474
1475
1476
1477 @cindex tuplets
1478
1479 Tuplets are made out of a music expression by multiplying their
1480 duration with a fraction.
1481
1482 @example
1483
1484   \times@keyindex{times} @var{fraction} @var{musicexpr}
1485 @end example
1486
1487 The duration of @var{musicexpr} will be multiplied by the fraction. 
1488 In print, the fraction's denominator will be printed over the notes,
1489 optionally with a bracket.  The most common tuplet is the triplet in
1490 which 3 notes have the length of 2, so the notes are 2/3 of
1491 their written length:
1492
1493 @lilypond[fragment,verbatim,center]
1494   g'4 \times 2/3 {c'4 c' c'} d'4 d'4
1495 @end lilypond
1496
1497
1498
1499 @cindex grace notes
1500
1501 @example
1502
1503   \grace@keyindex{grace} @var{musicexpr}
1504 @end example
1505
1506 A grace note expression has duration 0; the next real note is
1507 assumed to be the main note.
1508
1509 You cannot have the grace note after the main note, in terms of
1510 duration, and main notes, but you can typeset the grace notes to the
1511 right of the main note using the property
1512 @code{graceAlignPosition}@indexcode{graceAlignPosition}.
1513
1514 When grace music is interpreted, a score-within-a-score is set up:
1515 @var{musicexpr} has its own time bookkeeping, and you could (for
1516 example) have a separate time signature within grace notes.  While in
1517 this score-within-a-score, you can create notes, beams, slurs, etc.
1518 Unbeamed eighth notes and shorter by default have a slash through the
1519 stem.  This behavior can be controlled with the
1520 @code{flagStyle}@indexcode{flagStyle} property.
1521
1522 @quotation
1523
1524 @lilypond[fragment,verbatim]
1525 \relative c'' {
1526   \grace c8 c4 \grace { [c16 c16] } c4
1527   \grace { \property Grace.flagStyle = "" c16 } c4
1528 }
1529
1530 @end lilypond
1531 @end quotation
1532
1533 At present, nesting @code{\grace}@keyindex{grace} notes, e.g.
1534
1535 @example
1536
1537   @code{\grace @{ \grace c32 c16 @} c4}
1538 @end example
1539
1540 may result in run-time errors of LilyPond.  Since the meaning of such
1541 a construct is unclear, we don't consider this a loss.  Similarly,
1542 juxtaposing two @code{\grace} sections is syntactically valid, but
1543 makes no sense and may cause runtime errors.
1544
1545 Ending a staff or score with grace notes may also generate a run-time
1546 error, since there will be no main note to attach the grace notes to.
1547
1548
1549
1550 @node Repeats
1551 @section Repeats
1552 @cindex repeats
1553
1554
1555 In order to specify repeats, use the @code{\repeat}@keyindex{repeat}
1556 keyword.  Since repeats look and sound differently when played or
1557 printed, there are a few different variants of repeats.
1558
1559 @table @samp
1560   @item unfolded  
1561     Repeated music is fully written (played) out.  Useful for MIDI
1562     output.
1563
1564   @item volta  
1565     This is the normal notation: Repeats are not written out, but
1566     alternative endings (voltas) are printed, left to right.
1567
1568   @item folded  
1569     Alternative endings are written stacked, which is useful for
1570     lyrics.
1571 @end table  
1572
1573 The syntax for repeats is
1574
1575 @example
1576
1577   \repeat @var{variant} @var{repeatcount} @var{repeatbody}
1578 @end example
1579
1580 If you have alternative endings, you may add
1581
1582 @example
1583
1584   \alternative@keyindex{alternative}
1585     @code{@{} @var{alternative1}
1586             @var{alternative2}
1587             @var{alternative3} @dots{} @code{@}}
1588 @end example
1589
1590 where each @var{alternative} is a Music expression.
1591
1592 Normal notation repeats are used like this:
1593
1594 @quotation
1595
1596 @lilypond[fragment,verbatim]
1597   c'1
1598   \repeat volta 2 { c'4 d' e' f' }
1599   \repeat volta 2 { f' e' d' c' }
1600
1601 @end lilypond
1602 @end quotation
1603
1604 With alternative endings:
1605
1606 @quotation
1607
1608 @lilypond[fragment,verbatim]
1609   c'1
1610   \repeat volta 2 {c'4 d' e' f'} 
1611   \alternative { {d'2 d'} {f' f} }
1612
1613 @end lilypond
1614 @end quotation
1615
1616 Folded repeats look like this:@footnote{Folded repeats offer little
1617 more over simultaneous music.  However, it is to be expected that
1618 more functionality -- especially for the MIDI backend -- will be
1619 implemented.}
1620
1621 @quotation
1622
1623 @lilypond[fragment,verbatim]
1624   c'1
1625   \repeat fold 2 {c'4 d' e' f'} 
1626   \alternative { {d'2 d'} {f' f} }
1627
1628 @end lilypond
1629 @end quotation
1630
1631 @quotation
1632
1633 @lilypond[fragment,verbatim]
1634 \context Staff {
1635   \relative c' {
1636     \partial 4;
1637     \repeat volta 2 { e | c2 d2 | e2 f2 | }
1638     \alternative { { g4 g g } { a | a a a a | b1 } }
1639   }
1640 }
1641
1642 @end lilypond
1643 @end quotation
1644
1645 If you don't give enough alternatives for all of the repeats, then
1646 the first alternative is assumed to be repeated often enough to equal
1647 the specified number of repeats.
1648
1649 @quotation
1650
1651 @lilypond[fragment,verbatim]
1652 \context Staff {
1653   \relative c' {
1654     \repeat volta 3 { \partial 4; e | c2 d2 | e2 f2 | }
1655     \alternative { { g4 g g }
1656                    {\partial 1; e4 e e } 
1657                    {\partial 1; a a a a | b1 } }
1658   }
1659 }
1660
1661 @end lilypond
1662 @end quotation
1663
1664 It is possible to nest @code{\repeat}.  This is not entirely
1665 supported: the notes will come be in the right places, but the repeat
1666 bars will not.
1667
1668
1669
1670
1671 @node transpose
1672 @section transpose
1673 @cindex transposition of pitches
1674
1675 A music expression can be transposed with
1676 @code{\transpose}@keyindex{transpose}.  The syntax is
1677
1678 @example
1679
1680   \transpose @var{pitch} @var{musicexpr}
1681 @end example
1682
1683 This means that middle C in @var{musicexpr} is transposed to
1684 @var{pitch}.
1685
1686 @code{\transpose} distinguishes between enharmonic pitches: both
1687 @code{\transpose cis'} or @code{\transpose des'} will transpose up half
1688 a tone.  The first version will print sharps and the second version
1689 will print flats.
1690
1691 @quotation
1692
1693 @lilypond[fragment,verbatim]
1694 \context Staff {
1695   \clef "F";
1696   { \key e \major; c d e f }
1697   \clef "G";
1698   \transpose des'' { \key e \major; c d e f }
1699   \transpose cis'' { \key e \major; c d e f }
1700 }
1701
1702 @end lilypond
1703 @end quotation
1704
1705 If you want to use both @code{\transpose} and @code{\relative}, then
1706 you must use @code{\transpose} first.  @code{\relative} will have no
1707 effect music that appears inside a @code{\transpose}.
1708
1709
1710
1711 @cindex automatic lyric durations
1712
1713 If you have lyrics that are set to a melody, you can import the
1714 rhythm of that melody into the lyrics using @code{\addlyrics}.
1715 @keyindex{addlyrics} The syntax for this is
1716
1717 @example
1718
1719   \addlyrics @var{musicexpr1 musicexpr2}
1720 @end example
1721
1722 This means that both @var{musicexpr1} and @var{musicexpr2} are
1723 interpreted, but that every non-command atomic music expression
1724 (``every syllable'') in @var{musicexpr2} is interpreted using timing
1725 of @var{musicexpr1}.
1726
1727 If the property @code{automaticMelismata}@indexcode{automaticMelismata} is set in the
1728 context of @var{musicexpr1}, no lyrics will be put on slurred or tied
1729 notes.
1730
1731 @quotation
1732
1733 @lilypond[verbatim,fragment]
1734 \addlyrics
1735 \transpose c'' {
1736   \property Voice.automaticMelismata = ##t
1737   c8 () cis d8. e16 f2
1738 }
1739 \context Lyrics \lyrics {
1740  do4 re mi fa }
1741
1742 @end lilypond
1743 @end quotation
1744
1745 You should use a single rhythm melody, and single rhythm lyrics (a
1746 constant duration is the obvious choice).  If you do not, you will get
1747 undesired effects when using multiple stanzas:
1748
1749 @quotation
1750
1751 @lilypond[verbatim,fragment]
1752 \addlyrics
1753 \transpose c'' {
1754   c8 () cis d8. e16 f2
1755 }
1756 \context Lyrics \lyrics
1757 < { do4 re mi fa }
1758   { do8 re mi fa } >
1759
1760 @end lilypond
1761 @end quotation
1762
1763 It is valid (but probably not very useful) to use notes instead of
1764 lyrics for @var{musicexpr2}.
1765
1766
1767
1768
1769 @node Ambiguities
1770 @section Ambiguities
1771
1772 @cindex ambiguities
1773
1774 The grammar contains a number of ambiguities.@footnote{The authors
1775 hope to resolve them at a later time.}
1776
1777 @itemize @bullet
1778   @item  The assignment
1779
1780          @example 
1781 foo = bar 
1782 @end example 
1783
1784        can be interpreted as making a string identifier @code{\foo}
1785        containing @code{"bar"}, or a music identifier @code{\foo}
1786        containing the syllable `bar'.
1787
1788   @item  The assignment
1789
1790          @example 
1791 foo = -6 
1792 @end example 
1793
1794        can be interpreted as making an integer identifier
1795        containing -6, or a Request identifier containing the
1796        fingering `6' (with neutral direction).
1797
1798   @item  If you do a nested repeat like
1799
1800        @quotation
1801
1802 @example 
1803 \repeat @dots{}
1804 \repeat @dots{}
1805 \alternative 
1806 @end example 
1807
1808        @end quotation
1809
1810        then it is ambiguous to which @code{\repeat} the
1811        @code{\alternative} belongs.  This is the classic if-then-else
1812        dilemma.  It may be solved by using braces.
1813
1814   @item  (an as yet unidentified ambiguity :-)
1815 @end itemize
1816
1817
1818
1819 @node Notation conversion specifics
1820 @section Notation conversion specifics
1821
1822
1823 @node Automatic Beaming
1824 @section Automatic Beaming
1825 @cindex automatic beam generation
1826 @cindex autobeam
1827
1828 @c beamAuto vs autoBeam ?
1829
1830 By default, LilyPond will generate beams automatically.  This feature
1831 can be disabled by setting the
1832 @code{Voice.beamAuto}@indexcode{Voice.beamAuto} property to false.
1833 It can be overridden for specific cases by specifying explicit beams.
1834
1835
1836 A large number of Voice properties are used to decide how to generate
1837 beams.  Their default values appear in @file{scm/auto-beam.scm}.  In
1838 general, beams can begin anywhere, but their ending location is
1839 significant.  Beams can end on a beat, or at durations specified by the
1840 properties in
1841 @code{Voice.autoBeamSettings}@indexcode{Voice.autoBeamSettings}.
1842 To end beams every quarter note, for example, you could set the property
1843 @code{(end * * * *)} @indexcode{(end * * * *)} to `@code{(make-moment 1
1844 4)}'.  To end beams at every three eighth notes you would set
1845 it to `@code{(make-moment 1 8)}'.
1846 The same syntax can be used to specify beam
1847 starting points using
1848 @code{(begin * * * *)}@indexcode{(begin * * * *)}, eg:
1849 @quotation
1850 @example
1851 \property Voice.autoBeamSettings \override
1852     #'(end * * * *) = #(make-moment 1 4)
1853 \property Voice.autoBeamSettings \override
1854     #'(begin * * * *) = #(make-moment 1 8)
1855 @end example
1856 @end quotation
1857
1858 To allow different settings for different time signatures, instead of
1859 the first two asterisks @code{* *} you can specify a time signature; use
1860 @code{(end N M * *)} to restrict the definition to
1861 `@var{N}@code{/}@var{M}' time.  For example, to specify beams ending
1862 only for 6/8 time you would use the property @code{(end 6 8 * *)}.
1863
1864 To allow different endings for notes of different durations, instead of
1865 th last two asterisks you can specify a duration; use @code{(end * * N
1866 M)} to restrict the definition to beams that contain notes of
1867 `@var{N}@code{/}@var{M}' duration.
1868
1869 For example, to specify beam endings for beams that contain 32nd notes,
1870 you would use @code{(end * * 1 32)}.
1871
1872
1873 @node Chord Names
1874 @section Chord Names
1875 @cindex chord names
1876 @cindex chords
1877
1878 @cindex printing!chord names
1879
1880 For displaying printed chord names, use the
1881 @code{ChordNames}@indexcode{ChordNames} and
1882 @code{ChordNameVoice}@indexcode{ChordNameVoice} contexts.  The chords
1883 may be entered either using the notation described above, or directly
1884 using simultaneous music.
1885
1886 @quotation
1887 @lilypond[verbatim]
1888 scheme = \notes {
1889   \chords {a1 b c} <d f g>  <e g b>
1890 }
1891 \score {
1892   \notes<
1893     \context ChordNamesVoice \scheme
1894     \context Staff \transpose c'' \scheme
1895   >
1896   \paper { linewidth = -1.; }
1897 }
1898 @end lilypond
1899 @end quotation
1900
1901
1902 You can make the chord changes stand out more by setting property
1903 @code{ChordNames.chordChanges} to true.  This will only display
1904 chord names when there's a change in the chords scheme, but always
1905 display the chord name after a line break:
1906
1907 @c bug
1908 @quotation
1909 @lilypond[verbatim]
1910 scheme = \chords {
1911 %  \property ChordNames.chordChanges = ##t
1912   c1:m \break c:m c:m c:m d
1913 }
1914
1915 \score {
1916   \notes <
1917     \context ChordNamesVoice \scheme
1918     \context Staff \transpose c'' \scheme
1919   >
1920   \paper{
1921     linewidth = 40 * \staffspace;
1922   }
1923 }
1924 @end lilypond
1925 @end quotation
1926
1927
1928
1929 LilyPond examines chords specified as lists of notes to determine a
1930 name to give the chord. LilyPond will not try to
1931 identify chord inversions or added base, which may result in strange
1932 chord names when chords are entered as a list of pitches:
1933
1934 @quotation
1935 @lilypond[verbatim,center]
1936 scheme = \notes {
1937   <c'1 e' g'>
1938   <e' g' c''>
1939   <e e' g' c''>
1940 }
1941
1942 \score {
1943   <
1944     \context ChordNamesVoice \scheme
1945     \context Staff \scheme
1946   >
1947   \paper { linewidth = -1.; }
1948 }
1949 @end lilypond
1950 @end quotation
1951
1952 To specify chord inversions, append @code{/<notename>}.  To specify an
1953 added bass note, append @code{/+<notename}:
1954
1955 @quotation
1956 @lilypond[verbatim,center]
1957 scheme = \chords {
1958   d1 d/a d/+gis
1959 }
1960
1961 \score {
1962   \notes <
1963     \context ChordNames \scheme
1964     \context Staff \transpose c'' \scheme
1965   >
1966   \paper { linewidth = -1.; }
1967 }
1968 @end lilypond
1969 @end quotation
1970
1971 The chord names that LilyPond should print are fully customisable.  The
1972 default code can be found in @file{scm/chord-name.scm}.  Chord names are
1973 based on Banter style naming, which is unambiguous and has a logical
1974 structure.  Typical American style chord names are implemented as a
1975 variation on Banter names, they can be selected by setting poperty
1976 @code{ChordName.style} to @code{american}:
1977
1978 @quotation
1979 @lilypond[verbatim]
1980 \include "english.ly"
1981
1982 scheme = \chords {
1983   c         % Major triad
1984   cs:m      % Minor triad
1985   df:m5-    % Diminished triad
1986   c:5^3     % Root-fifth chord
1987   c:4^3     % Suspended fourth triad
1988   c:5+      % Augmented triad
1989   c:2^3     % "2" chord
1990   c:m5-.7-  % Diminished seventh
1991   c:7+      % Major seventh
1992   c:7.4^3   % Dominant seventh suspended fourth
1993   c:5+.7    % Augmented dominant seventh
1994   c:m5-.7   % "Half" diminished seventh
1995   c:5-.7    % Dominant seventh flat fifth
1996   c:5-.7+   % Major seventh flat fifth
1997   c:m7+     % Minor-major seventh
1998   c:m7      % Minor seventh
1999   c:7       % Dominant seventh
2000   c:6       % Major sixth
2001   c:m6      % Minor sixth
2002   c:9^7     % Major triad w/added ninth
2003   c:6.9^7   % Six/Nine chord
2004   c:9       % Dominant ninth 
2005   c:7+.9    % Major ninth
2006   c:m7.9    % Minor ninth
2007 }
2008
2009 \score {
2010   \notes <
2011     \context ChordNames \scheme
2012     \context Staff \transpose c'' \scheme
2013   >
2014   \paper {
2015     \translator { 
2016       \ChordNamesContext
2017       ChordName \override #'word-space = #1 
2018       ChordName \override #'style = #'american
2019     }
2020   }
2021 }
2022 @end lilypond
2023 @end quotation
2024
2025 Similarly, Jazz style chord names are implemented as a variation on
2026 American style names:
2027 @quotation
2028 @lilypond[verbatim]
2029 scheme = \chords {
2030   % major chords
2031   c
2032   c:6           % 6 = major triad with added sixth
2033   c:maj         % triangle = maj
2034   c:6.9^7       % 6/9 
2035   c:9^7         % add9
2036
2037   % minor chords
2038   c:m           % m = minor triad
2039   c:m.6         % m6 = minor triad with added sixth
2040   c:m.7+        % m triangle = minor major seventh chord
2041   c:3-.6.9^7    % m6/9 
2042   c:m.7         % m7
2043   c:3-.9        % m9
2044   c:3-.9^7      % madd9
2045
2046   % dominant chords
2047   c:7           % 7 = dominant
2048   c:7.5+        % +7 = augmented dominant
2049   c:7.5-        % 7b5 = hard diminished dominant
2050   c:9           % 7(9)
2051   c:9-          % 7(b9)
2052   c:9+          % 7(#9)
2053   c:13^9.11     % 7(13)
2054   c:13-^9.11    % 7(b13)
2055   c:13^11       % 7(9,13)
2056   c:13.9-^11    % 7(b9,13)
2057   c:13.9+^11    % 7(#9,13)
2058   c:13-^11      % 7(9,b13)
2059   c:13-.9-^11   % 7(b9,b13)
2060   c:13-.9+^11   % 7(#9,b13)
2061
2062   % half diminished chords
2063   c:m5-.7               % slashed o = m7b5
2064   c:9.3-.5-     % o/7(pure 9)
2065
2066   % diminished chords
2067   c:m5-.7-      % o = diminished seventh chord
2068 }
2069
2070 \score {
2071   \notes <
2072     \context ChordNames \scheme
2073     \context Staff \transpose c'' \scheme
2074   >
2075   \paper {
2076     \translator { 
2077       \ChordNamesContext
2078       ChordName \override #'word-space = #1 
2079       ChordName \override #'style = #'jazz
2080     }
2081   }
2082 }
2083 @end lilypond
2084 @end quotation
2085
2086
2087 @node lyricprint
2088 @section lyricprint
2089 @cindex lyrics
2090
2091 @cindex printing!lyrics
2092
2093
2094 Lyric syllables must be interpreted within a @code{Lyrics} context
2095
2096 @cindex context!Lyrics
2097  for printing them.
2098
2099 Here is a full example: 
2100
2101 @quotation
2102 @lilypond[verbatim]
2103 \score {
2104   <
2105     \notes \transpose c'' {
2106       c d e c | c d e c |
2107       e f g2 | e4 f g2 \bar "|.";
2108     }
2109     \context Lyrics \lyrics { 
2110       Va-4 der Ja- cob Va- der Ja- cob
2111       Slaapt gij nog?2 Slaapt4 gij nog?2
2112     }
2113   >
2114 }
2115
2116 @end lilypond
2117 @end quotation
2118
2119 You may want a continuous line after the syllables to show melismata. 
2120 To achieve this effect, add a `@code{__}' lyric as a separate word
2121 after the lyric to be extended.  This will create an extender, a line
2122 that extends over the entire duration of the lyric.  This line will
2123 run all the way to the start of the next lyric, so you may want to
2124 shorten it by using a blank lyric (using `@code{_}').
2125
2126 @quotation
2127
2128 @lilypond[verbatim]
2129 \score {
2130   <
2131     \notes \relative c'' {
2132       a4 () b () c () d | c () d () b () a | c () d () b () a
2133     }
2134     \context Lyrics \lyrics {
2135       foo1 __ | bar2. __ _4 | baz1 __
2136     }
2137   >
2138 }
2139
2140 @end lilypond
2141 @end quotation
2142
2143      
2144 If you want to have hyphens centered between syllables (rather than
2145 attached to the end of the first syllable) you can use the special
2146 `@code{-}@code{-}' lyric as a separate word between syllables.  This
2147 will result in a hyphen which length varies depending on the space
2148 between syllables, and which will be centered between the syllables. 
2149 For example:
2150
2151 @quotation
2152
2153 @lilypond[verbatim]
2154 \score {
2155   <
2156     \notes \transpose c'' {
2157       c d e c | c d e c |
2158       e f g2 | e4 f g2 \bar "|.";
2159     }
2160     \context Lyrics \lyrics {
2161       Va4 -- der Ja -- cob | Va -- der Ja -- cob |
2162       Slaapt gij nog?2 | Slaapt4 gij nog?2
2163     }
2164   >
2165 }
2166
2167 @end lilypond
2168 @end quotation
2169
2170
2171
2172 @node Notation Contexts
2173 @section Notation Contexts
2174
2175 @cindex notation contexts
2176
2177 Notation contexts are objects that only exist during a run of
2178 LilyPond.  During the interpretation phase of LilyPond, the Music
2179 expression contained in a @code{\score} block is interpreted in time
2180 order.  This is the order in which humans read, play, and write
2181 music.
2182
2183 A context is an object that holds the reading state of the
2184 expression; it contains information like
2185
2186 @itemize @bullet
2187   @item What notes are playing at this point?
2188   @item What symbols will be printed at this point?
2189   @item In what style will they printed?
2190   @item What is the current key signature, time signature, point within
2191        the measure, etc.?
2192 @end itemize
2193
2194 Contexts are grouped hierarchically: A @code{Voice} context is
2195 contained in a @code{Staff} context (because a staff can contain
2196 multiple voices at any point), a @code{Staff} context is contained in
2197 a @code{Score}, @code{StaffGroup}, or @code{ChoirStaff} context (because
2198 these can all contain multiple staffs).
2199
2200 Contexts associated with sheet music output are called @emph{notation
2201 contexts}, those for sound output are called playing contexts.
2202
2203 Contexts are created either manually or automatically.  Initially,
2204 the top level music expression is interpreted by the top level
2205 context (the @code{Score} context).  When a atomic music expression
2206 (i.e. a note, a rest, @code{\bar}, or @code{\time} commands), a nested
2207 set of contexts is created that can process these atomic expressions,
2208 as in this example:
2209
2210 @example
2211
2212   @example 
2213 \score @{ \notes < c4 > @} 
2214 @end example 
2215
2216 @end example
2217
2218 The sequential music, `@code{@{ c4 @}}' is interpreted by @code{Score}
2219 context. When the note `@code{c4}' itself is interpreted, a set of
2220 contexts is needed that will accept notes.  The default for this is a
2221 @code{Voice} context, contained in a @code{Staff} context.  Creation of
2222 these contexts results in the staff being printed.
2223
2224
2225 @cindex context
2226
2227 You can also create contexts manually, and you probably have to do so
2228 if you want to typeset complicated multiple part material.  If a
2229 `@code{\context} @var{name} @var{musicexpr}' expression is encountered
2230 during the interpretation phase, the @var{musicexpr} argument will be
2231 interpreted with a context of type @var{name}.  If you specify a name,
2232 the specific context with that name is searched.
2233
2234 If a context of the specified type and name can not be found, a new
2235 one is created.  For example,
2236
2237 @quotation
2238
2239 @lilypond[verbatim]
2240 \score {
2241   \notes \relative c'' {
2242     c4 <d4 \context Staff = "another" e4> f
2243   }
2244 }
2245
2246 @end lilypond
2247 @end quotation
2248
2249 In this example, the @code{c} and @code{d} are printed on the
2250 default staff.  For the @code{e}, a context Staff called
2251 `@code{another}' is specified; since that does not exist, a new
2252 context is created.  Within @code{another}, a (default) Voice context
2253 is created for the @code{e4}.  When all music referring to a
2254 context is finished, the context is ended as well.  So after the
2255 third quarter, @code{another} is removed.
2256
2257 Almost all music expressions inherit their interpretation context
2258 from their parent.  In other words, suppose that the syntax for a
2259 music expression is
2260
2261 @example
2262
2263   \keyword @var{musicexpr1} @var{musicexpr2} @dots{}
2264 @end example
2265
2266 When the interpretation of this music expression starts, the context
2267 for @var{musicexpr1}, @var{musicexpr2}, etc. is that of the total
2268 expression.
2269
2270 Lastly, you may wonder, why this:
2271
2272 @quotation
2273
2274 @example 
2275 \score @{
2276   \notes \relative c'' @{
2277     c4 d4 e4
2278   @}
2279 @} 
2280 @end example 
2281
2282 @end quotation
2283
2284 doesn't result in this:
2285
2286 @lilypond[]
2287
2288   \score {
2289     \notes \relative c'' {
2290       <c4> <d4> <e4>
2291     }
2292   }
2293
2294 @end lilypond
2295
2296 For the @code{c4}, a default @code{Staff} (with a contained
2297 @code{Voice}) context is created.  After the @code{c4} ends, no
2298 music refers to this default staff, so it would be ended, with the
2299 result shown.  To prevent this inconvenient behavior, the context to
2300 which the sequential music refers is adjusted during the
2301 interpretation.  So after the @code{c4} ends, the context of the
2302 sequential music is also the default @code{Voice} context. 
2303 The @code{d4} gets interpreted in the same context
2304 as @code{c4}.
2305
2306 Properties that are set in one context are inherited by all of the
2307 contained contexts.  This means that a property valid for the
2308 @code{Voice} context can be set in the @code{Score} context (for
2309 example) and thus take effect in all @code{Voice} contexts.
2310
2311 Properties can be preset within the @code{\translator} block
2312 corresponding to the appropriate context.  In this case, the syntax
2313 is
2314
2315 @example
2316   @var{propname} @code{=} @var{value}
2317 @end example
2318
2319 This assignment happens before interpretation starts, so a
2320 @code{\property} expression will override any predefined settings.
2321
2322 The property settings are used during the interpretation phase.  They
2323 are read by the LilyPond modules where interpretation contexts are
2324 built of.  These modules are called @emph{translators}.  Translators for
2325 notation are called @emph{engravers}, and translators for sound are
2326 called @emph{performers}.
2327
2328 @mbinclude properties.itely
2329
2330 @node Page layout
2331 @section Page layout
2332
2333 @subsection Paper block
2334
2335 The most important output definition is the @code{\paper} block, for
2336 music notation.  The syntax is
2337
2338 @example
2339   @code{\paper @{} [@var{paperidentifier}] @var{items} @code{@}}
2340 @end example
2341
2342 where each of the items is one of
2343
2344 @itemize @bullet
2345   @item  An assignment.  The assignment must be terminated by a
2346        semicolon.  
2347
2348   @item  A context definition.  See section @ref{contextdefs} for
2349        more information on context definitions.
2350
2351 @ignore
2352
2353                 FIXME
2354
2355
2356   @item
2357         
2358         A margin shape declaration.  The syntax is
2359
2360        @example
2361
2362          \shape @var{indent1}@code{,} @var{width1}@code{,}
2363                       @var{indent2}@code{,} @var{width2} @dots{} @code{;}
2364        @end example
2365
2366        @keyindex{shape}
2367
2368        Each pair of @var{indent} and @var{width} values is a dimension
2369        specifying how far to indent and how wide to make the line. 
2370        The indentation and width of successive lines are specified by
2371        the successive pairs of dimensions.  The last pair of
2372        dimensions will define the characeristics of all lines beyond
2373        those explicitly specified.
2374 @end ignore
2375
2376   @item  \stylesheet  declaration.  Its syntax is
2377        @example
2378                 \stylesheet @var{alist}
2379        @end example
2380
2381         See @file{font.scm} for details of @var{alist}.
2382 @end itemize
2383
2384 @subsection Paper variables 
2385
2386
2387
2388 The paper block has some variables you may want to use or change:
2389
2390 @table @samp
2391   @item @code{indent}@indexcode{indent}  
2392     The indentation of the first line of music.
2393
2394   @item @code{staffspace}@indexcode{staffspace}
2395     The distance between two staff lines, calculated from the center
2396     of the lines.  You should use either this or @code{rulethickness}
2397     as a unit for distances you modify.
2398   
2399   @item @code{linewidth}@indexcode{linewidth}  
2400     Sets the width of the lines.  If set to -1.0, a single
2401     unjustified line is produced.  If you use this variable, you
2402     probably want to define it in staff spaces, ie
2403     @example
2404         linewidth = 30 * \staffspace;
2405     @end example
2406
2407   @item @code{textheight}@indexcode{textheight}  
2408     Sets the total height of the music on each page. Only used by
2409     ly2dvi.
2410
2411   @item @code{interscoreline}@indexcode{interscoreline}  
2412     Sets the spacing between the score lines. Defaults to 16 pt.
2413
2414   @item @code{interscorelinefill}@indexcode{interscorelinefill}  
2415     If set to a positive number, the distance between the score 
2416     lines will stretch in order to fill the full page. In that
2417     case @code{interscoreline} specifies the minimum spacing.
2418     Defaults to 0.
2419
2420   @item @code{stafflinethickness}@indexcode{stafflinethickness}  
2421     Determines the thickness of staff lines, and also acts as a scaling
2422     parameter for other line thicknesses.
2423 @end table
2424
2425
2426 @subsection Line breaks
2427
2428 @cindex line breaks
2429 @cindex breaking lines
2430
2431 Line breaks are normally computed automatically. They are chosen such
2432 that the resulting spacing has low variation, and looks neither cramped
2433 nor loose.
2434
2435 Occasionally you might want to override the automatic breaks; you can do
2436 this by specifying @code{\break} (see also @ref{Pre-defined
2437 Identifiers}). This will force a line break at this point. Do remember
2438 that line breaks can only occur at places where there are barlines.  If
2439 you want to have a line break where there is no barline, you can force a
2440 barline by entering @code{\bar "";}.
2441
2442 @subsection Page breaks
2443
2444 Page breaks are normally computed by @TeX{}, so they are not under direct
2445 control.  However, you can insert a commands into the .tex output to
2446 instruct @TeX{} where to break pages. For more details, see  the
2447 example file @file{input/test/between-systems.ly}
2448
2449
2450 @cindex page breaks
2451 @cindex breaking pages
2452
2453
2454 @subsection Font size
2455
2456 @cindex font size
2457 @cindex paper size
2458
2459 The Feta font provides musical symbols at six different sizes.  These
2460 fonts are 11 point, 13 point, 16 point, 20 point,
2461 23 point, and 26 point.  The point size of a font is the
2462 height of the five lines in a staff when displayed in the font.
2463
2464 Definitions for these sizes are the files @file{paperSZ.ly}, where
2465 @code{SZ} is one of 11, 13, 16, 20, 23 and 26.  If you include any of
2466 these files, the identifiers @code{paperEleven}, @code{paperThirteen},
2467 @code{paperSixteen}, @code{paperTwenty}, @code{paperTwentythree}, and
2468 @code{paperTwentysix} are defined respectively.  The default
2469 @code{\paper} block is also set.
2470
2471 The font definitions are generated using a Scheme function. For more
2472 details, see the file @file{font.scm}.
2473
2474 @subsection paper size
2475
2476 @cindex paper size
2477 @cindex page size
2478
2479 To change the paper size, you must first set the
2480 @code{papersize}@indexcode{papersize} variable at top level.  Set it to
2481 the strings @code{a4}, @code{letter}, or @code{legal}.  After this
2482 specification, you must set the font as described above.  If you want
2483 the default font, then use the 20 point font.  The new paper size will
2484 not take effect if the font is not loaded and selected afterwards.
2485
2486 @example
2487         papersize = "a4"
2488         \include "paper16.ly"
2489
2490         \score @{
2491                 ...
2492                 \paper @{ \paperSixteen @}
2493         @}
2494 @end example
2495
2496 The file "paper16.ly" will now include a file named @file{a4.ly}, which
2497 will set the paper variables @code{hsize} and @code{vsize} (used by
2498 @code{ly2dvi})
2499
2500 @node contextdefs
2501 @section contextdefs
2502
2503 @cindex context definition
2504 @cindex translator definition
2505 @cindex engraver hacking
2506
2507
2508 A notation contexts is defined by the following information
2509
2510 @enumerate i
2511   @item  A name.
2512
2513   @item  The LilyPond modules that do the actual conversion of music to
2514        notation.  Each module is a so-called
2515        @emph{engraver}
2516 @cindex engraver
2517 .
2518
2519   @item  How these modules should cooperate, i.e. which ``cooperation
2520        module'' should be used.  This cooperation module is a special
2521        type of engraver.
2522
2523   @item  What other contexts the context can contain,
2524
2525   @item  What properties are defined.
2526 @end enumerate
2527
2528 A context definition has this syntax:
2529
2530 @example
2531
2532   \translator @code{@{}
2533                       @var{translatorinit} @var{translatormodifierlist}
2534                     @code{@}}
2535 @end example
2536
2537 @var{translatorinit} can be an identifier or of the form
2538
2539 @example
2540
2541   \type @var{typename} @code{;}
2542 @end example
2543
2544 @var{typename} is one of
2545
2546 @table @samp
2547   @item @code{Engraver_group_engraver}@indexcode{Engraver_group_engraver}  
2548     The standard cooperation engraver.
2549
2550   @item @code{Score_engraver}@indexcode{Score_engraver}  
2551     This is cooperation module that should be in the top level context.
2552
2553   @item @code{Grace_engraver_group}@indexcode{Grace_engraver_group}  
2554     This is a special cooperation module (resembling
2555     @code{Score_engraver}) that is used to created an embedded
2556     `miniscore'.
2557 @end table 
2558
2559 @var{translatormodifierlist} is a list of items where each item is
2560 one of
2561
2562 @itemize @bullet
2563   @item  @code{\consists} @var{engravername} @code{;}  
2564     Add @var{engravername} to the list of modules in this context. 
2565   The order of engravers added with @code{\consists} is
2566     significant.
2567   
2568   @item  @code{\consistsend} @var{engravername} @code{;}  
2569     Analogous to @code{\consists}, but makes sure that
2570     @var{engravername} is always added to the end of the list of
2571     engravers.
2572
2573     Some engraver types need to be at the end of the list; this
2574     insures they are put there, and stay there, if a user adds or
2575     removes engravers.  This command is usually not needed for
2576     end-users.
2577     
2578   @item  @code{\accepts} @var{contextname} @code{;}  
2579     Add @var{contextname} to the list of  context this context can
2580     contain.  The first listed context is the context to create by
2581     default.
2582
2583   @item @code{\denies}. The opposite of @code{\accepts}. Added for
2584 completeness, but is never used in practice.
2585  
2586   
2587   @item  @code{\remove} @var{engravername} @code{;}  
2588     Remove a previously added (with @code{\consists}) engraver.
2589   
2590   @item  @code{\name} @var{contextname} @code{;}  
2591     This sets name of the context, e.g. @code{Staff}, @code{Voice}.  If
2592     the name is not specified, the translator won't do anything.
2593
2594   @item  @var{propname} @code{=} @var{value} @code{;}  
2595     A property assignment.  It is allowed to use reals for
2596     @var{value}.
2597 @end itemize
2598
2599 In the @code{\paper} block, it is also possible to define translator
2600 identifiers.  Like other block identifiers, the identifier can only
2601 be used as the very first item of a translator.  In order to define
2602 such an identifier outside of @code{\score}, you must do
2603
2604 @quotation
2605
2606 @example 
2607 \paper @{
2608   foo = \translator @{ @dots{} @}
2609 @}
2610 \score @{
2611   \notes @{
2612     @dots{}
2613   @}
2614   \paper @{
2615     \translator @{ \foo @dots{} @}
2616   @}
2617 @} 
2618 @end example 
2619
2620 @end quotation
2621
2622
2623 @cindex paper types, engravers, and pre-defined translators
2624
2625 Some pre-defined identifiers can simplify modification of
2626 translators.  The pre-defined identifiers are:
2627
2628 @table @samp
2629   @item @code{StaffContext}@indexcode{StaffContext}  
2630     Default Staff context. 
2631
2632   @item @code{RhythmicStaffContext}@indexcode{RhythmicStaffContext}  
2633     Default RhythmicStaff context. 
2634
2635   @item @code{VoiceContext}@indexcode{VoiceContext}  
2636     Default Voice context.  
2637
2638   @item @code{ScoreContext}@indexcode{ScoreContext}  
2639     Default Score context. 
2640
2641   @item @code{ScoreWithNumbers}@indexcode{ScoreWithNumbers}  
2642     Score context with numbering at the Score level.
2643
2644   @item @code{BarNumberingStaffContext}@indexcode{BarNumberingStaffContext}  
2645     Staff context with numbering at the Staff level.
2646
2647   @item @code{HaraKiriStaffContext}@indexcode{HaraKiriStaffContext}  
2648     Staff context that does not print if it only contains rests. 
2649     Useful for orchestral scores.@footnote{Harakiri, also called
2650     Seppuku, is the ritual suicide of the Samourai.}
2651
2652   @item @code{OrchestralPartStaffContext}@indexcode{OrchestralPartStaffContext}
2653
2654   @item @code{OrchestralScoreContext}@indexcode{OrchestralScoreContext}
2655 @end table
2656
2657 Using these pre-defined values, you can remove or add items to the
2658 translator:
2659
2660 @quotation
2661
2662 @example 
2663 \paper @{
2664   \translator @{
2665     \StaffContext
2666     \remove Some_engraver;
2667     \consists Different_engraver;
2668   @}
2669 @} 
2670 @end example 
2671
2672 @end quotation
2673
2674       
2675 @node Sound output
2676 @section Sound output
2677
2678 The MIDI block is analogous to the paper block, but it is somewhat
2679 simpler.  The @code{\midi} block can contain:
2680 @cindex MIDI block
2681
2682 @itemize @bullet
2683   @item  a @code{\tempo} definition
2684   @item  context definitions
2685 @end itemize
2686
2687 Assignments in the @code{\midi} block are not allowed.
2688
2689
2690
2691 @cindex context definition
2692
2693 Context definitions follow precisely the same syntax as within the
2694 \paper block.  Translation modules for sound are called performers.
2695 The contexts for MIDI output are defined in @file{ly/performer.ly}.
2696
2697
2698
2699 @cindex MIDI instrument names
2700
2701 @node midilist
2702 @section midilist
2703
2704 The MIDI instrument name is set by the
2705 @code{Staff.midiInstrument}@indexcode{Staff.midiInstrument} property or,
2706 if that property is not set, the
2707 @code{Staff.instrument}@indexcode{Staff.instrument} property.  The
2708 instrument name should be chosen from the following list.  If the
2709 selected string does not exactly match, then LilyPond uses the default
2710 piano.
2711
2712 @c @quotation
2713
2714 @example 
2715 "acoustic grand"            "contrabass"           "lead 7 (fifths)"
2716 "bright acoustic"           "tremolo strings"      "lead 8 (bass+lead)"
2717 "electric grand"            "pizzicato strings"    "pad 1 (new age)"
2718 "honky-tonk"                "orchestral strings"   "pad 2 (warm)"
2719 "electric piano 1"          "timpani"              "pad 3 (polysynth)"
2720 "electric piano 2"          "string ensemble 1"    "pad 4 (choir)"
2721 "harpsichord"               "string ensemble 2"    "pad 5 (bowed)"
2722 "clav"                      "synthstrings 1"       "pad 6 (metallic)"
2723 "celesta"                   "synthstrings 2"       "pad 7 (halo)"
2724 "glockenspiel"              "choir aahs"           "pad 8 (sweep)"
2725 "music box"                 "voice oohs"           "fx 1 (rain)"
2726 "vibraphone"                "synth voice"          "fx 2 (soundtrack)"
2727 "marimba"                   "orchestra hit"        "fx 3 (crystal)"
2728 "xylophone"                 "trumpet"              "fx 4 (atmosphere)"
2729 "tubular bells"             "trombone"             "fx 5 (brightness)"
2730 "dulcimer"                  "tuba"                 "fx 6 (goblins)"
2731 "drawbar organ"             "muted trumpet"        "fx 7 (echoes)"
2732 "percussive organ"          "french horn"          "fx 8 (sci-fi)"
2733 "rock organ"                "brass section"        "sitar"
2734 "church organ"              "synthbrass 1"         "banjo"
2735 "reed organ"                "synthbrass 2"         "shamisen"
2736 "accordion"                 "soprano sax"          "koto"
2737 "harmonica"                 "alto sax"             "kalimba"
2738 "concertina"                "tenor sax"            "bagpipe"
2739 "acoustic guitar (nylon)"   "baritone sax"         "fiddle"
2740 "acoustic guitar (steel)"   "oboe"                 "shanai"
2741 "electric guitar (jazz)"    "english horn"         "tinkle bell"
2742 "electric guitar (clean)"   "bassoon"              "agogo"
2743 "electric guitar (muted)"   "clarinet"             "steel drums"
2744 "overdriven guitar"         "piccolo"              "woodblock"
2745 "distorted guitar"          "flute"                "taiko drum"
2746 "guitar harmonics"          "recorder"             "melodic tom"
2747 "acoustic bass"             "pan flute"            "synth drum"
2748 "electric bass (finger)"    "blown bottle"         "reverse cymbal"
2749 "electric bass (pick)"      "skakuhachi"           "guitar fret noise"
2750 "fretless bass"             "whistle"              "breath noise"
2751 "slap bass 1"               "ocarina"              "seashore"
2752 "slap bass 2"               "lead 1 (square)"      "bird tweet"
2753 "synth bass 1"              "lead 2 (sawtooth)"    "telephone ring"
2754 "synth bass 2"              "lead 3 (calliope)"    "helicopter"
2755 "violin"                    "lead 4 (chiff)"       "applause"
2756 "viola"                     "lead 5 (charang)"     "gunshot"
2757 "cello"                     "lead 6 (voice)" 
2758 @end example 
2759
2760 @c @end quotation
2761
2762
2763
2764 @node Pre-defined Identifiers
2765
2766 @section Pre-defined Identifiers
2767
2768 @cindex pre-defined identifiers
2769
2770
2771 Various identifiers are defined in the initialization files to
2772 provide shorthands for some settings.  Most of them are in
2773 @file{ly/declarations.ly} and @file{ly/property.ly}.
2774
2775 @table @samp
2776   @item @code{\break}@keyindex{break}  
2777     Force a line break in music by using a large argument for the
2778     keyword @code{\penalty}.
2779
2780   @item @code{\nobreak}@keyindex{nobreak}  
2781     Prevent a line break in music by using a large negative argument
2782     for the keyword @code{\penalty}.
2783
2784   @item @code{\shiftOff}@keyindex{shiftOff}  
2785     Disable horizontal shifting of note heads that collide. 
2786
2787   @item @code{\shiftOn}@keyindex{shiftOn}  
2788     Enable note heads that collide with other note heads to be
2789     shifted horiztonally. Also @code{\shiftOnn} and @code{\shiftOnnn}
2790 set different shift values.
2791
2792   @item @code{\stemBoth}@keyindex{stemBoth}  
2793     Allow stems, beams, and slurs to point either upwards or
2794     downwards, decided automatically by LilyPond.
2795
2796   @item @code{\stemDown}@keyindex{stemDown}  
2797     Force stems, beams, and slurs to point down.
2798
2799   @item @code{\stemUp}@keyindex{stemUp}  
2800     Force stems, beams and slurs to point up.
2801
2802 @end table
2803