3 redef(var)(1)(whenlatex(latexcommand({\normalfont\scshape )ARG1+latexcommand(}))\
5 def(mycode)(1)(tt(ARG1))
9 COMMENT( This document contains Mudela fragments. You need at least
10 Yodl-1.30.18 to convert this to tex or html.
17 htmlbodyopt(bgcolor)(white)
18 htmlcommand(<font color=black>)
21 \setlength{\topmargin}{-0.25in}
22 \setlength{\textheight}{9in}
23 \setlength{\textwidth}{5.875in}
24 \setlength{\oddsidemargin}{0.25in}
25 \setlength{\evensidemargin}{0.25in}
26 \usepackage[T1]{fontenc}
30 whenlatex(notableofcontents())
31 whentexinfo(notableofcontents())
33 article(Mudela, reference manual)
34 (Han-Wen Nienhuys and Jan Nieuwenhuizen)
35 (nop()PIPETHROUGH(date "+%B %d, %Y")()()nop())
41 * paragraphs have too much space.
46 latexcommand(\def\interexample{})
47 latexcommand(\def\preexample{\par})
48 latexcommand(\def\postexample{\par\medskip})
49 latexcommand(\def\file#1{{code(#1)}})
51 latexcommand(\def\texttt#1{\tt #1})
52 latexcommand(\def\textbf#1{\bf #1})
55 includefile(html-disclaimer.yo-urg)
57 bf(This document is not up to date). All rendered examples of course
58 are current, but the rest probably isn't. Adjusting the tutorial was
59 considered more important than writing the reference manual. We
60 apologize for the inconvenience.
63 This document describes the the GNU LilyPond input format, which is an
64 effective language for defining music. We call this language (rather
65 arrogantly) The Musical Definition Language or Mudela, for
66 short.footnote(If anybody comes up with a better name, we'd gladly
67 take this. Gourlay already uses Musical Description Language,
68 G-Sharp Score Definition Language. ISO standard 10743 defines a
69 Standard Music Description Language. We're not being original here.)
71 The first aim of Mudela is to define a piece of music, being complete
72 from both from a musical typesetting, as from a musical performing
75 The Musical Definition Language (Mudela), has a logical structure,
76 making use of identifiers, that allows for flexible input, and
77 definition reuse. See the documentation file file(MANIFESTO), included
78 with the LilyPond sources for reasons and design considerations.
80 The below is included for explanatory purposes only (i.e., for a
81 complete and up-to-date definition, see file(lily/parser.yy) and
84 As a related note, you should take a look at the examples and the init
85 files, as this document does not cover every aspect of Mudela yet, and
86 may be out of date.footnote(Ok, I am being pessimistic here. This
87 just is a disclaimer. Docs usually are written after the program
88 itself.) This document intends to give an idea of how it works. It is
89 not a guide on how to use it.
92 sect(Running LilyPond)
94 When invoked with a filename that has no extension, LilyPond will add
95 a file(.ly) extension. When invoked with a filename ending in
96 file(.fly), LilyPond processes the file as a music fragment using
97 file(init.fly). When file(foo.fly) is read, LilyPond does something
110 A Mudela files consists of statements, generally
111 separated by spaces, tabs or newlines. A one line comment is
112 introduced by a code(%) character. Block comments are started by
113 code(%{) and ended by code(%}). They cannot be nested.
115 Mudela supports several data types. Four types of simple constants
116 are supported: integers, reals, strings, and notes. An integer is a
117 sequence of digits such as code(12). A real is fromed from an
118 optional minus sign and a sequence of digits followed by a decimal
119 point and an optional exponent such as code(-1.2e3). A string is
120 started and ended with the code(") character. To include a code(")
121 character in a string, you must write code(\"). Various other
122 backslash sequences have special interpretations as in the C language.
123 A string that contains no spaces can be written without the quotes. A
124 note consists of a note name followed by an optional duration. See
125 section ref(notedesc) for details on this type. A dimension consists
126 of a real followed by one of the dimension keywords: code(\mm),
127 code(\pt), code(\in), or code(\cm). Dimensions are converted
128 immediately to a real which gives the dimension in points, so they can
131 Compound types are built up from the simple types. The compound types
132 are: arglist, assignlist and musiclist. An arglist is a
133 white space separated list of integers, reals and or strings surrounded
134 by braces code({) and code(}). An assignlist is a list of
135 identifier assignments, which have the form var(key)code(=)var(value).
136 The simplest musiclist is a single note. More complicated music lists
137 are formed by surrounding a list of musiclists with braces code({) and
138 code(}) or with angle brackets code(<) and code(>). Items appearing
139 in braces will be treated as serial. Items in angle brackets will be
142 A statement in Mudela has one of three forms:
143 verb(\keyword argument
144 \keyword argument1 argument2 ... ;
147 To assign an identifier you use:
149 To use an identifier, you must preceed it with a backslash: code(\).
150 verb(oboe = \notes { ... }
151 \score{ \notes { \oboe }})
152 The left-hand part of the assignment is really a string, so
153 verb("Foo bar 4 2 " = \notes { ... })
154 is also a valid assignment (but you would have trouble referencing it)
155 If you reuse identifiers, then the previous contents will be thrown
156 away after the right hand is evaluated, e.g.
157 verb(bla = \notes { \bla })
160 COMMENT(It's not clear to me what things are allowed on the RHS of
161 an identifier assignment.)
163 The following words are keywords. You can define an identifer whose
164 name is a keyword, but you will not be able to reference it.
166 verb(absdynamic font mm pt time
167 accepts grouping musicalpitch relative translator
168 bar header notenames score transpose
169 cadenza in notes script type
170 clear include octave shape version
172 cm keysignature paper spandynamic
173 consists lyric partial symboltables
174 contains mark penalty table
175 duration midi property tempo )
177 COMMENT( I don't know the proper way to make this kind of table in
181 subsect(Hierarchical structures)
183 The general structure consists of declarations:
184 verb(IDENTIFIER = \TYPE{
189 verb(\TYPE{ <type specific data> })
191 (Currently, code(\score) is the only type that can be instantiated
194 Most instantiations that use an IDENTIFIER are specified as follows:
196 verb(\TYPE{ \IDENTIFIER [...] })
198 Some exceptions on this rule have been made to prevent inputting
199 Mudela becoming tedious
206 To simplify different aspects of music definition (entering the notes
207 and manipulating them) Mudela has a number of different input "modes".
208 In each mode, words are identified on the input. If code("word") is
209 encountered, it is treated as a string. If code("\word") is
210 encountered it is treated as a keyword or as an identifier. The
211 behavior of the modes differs in two ways: different modes treat
212 unquoted words different, and different modes have different rules for
213 deciding what is a word.
218 At the start of parsing, Mudela is in normal mode.
219 In normal mode, a word is an alphabetic character followed by
220 alphanumeric characters. If code(word) is encountered on the input it
221 is treated as a string.
223 dit(Note mode) Note mode is introduced by the keyword
224 code(\notes). In Note mode, words can only contain alphabetic
225 characters. If code(word) is encountered, LilyPond first checks for a
226 notename of code(word). If no notename is found, then code(word) is
227 treated as a string. If you mistype a notename, the parser will most
228 likely complain that you should be in code(\lyric) mode to do lyrics.
230 dit(Lyric mode) Lyrics mode is introduced by the keyword
231 code(\lyric). Because of the various control characters that can
232 appear in lyrics, e.g., foreign language accents, the inputting a
233 string containing these has been made very easy. Every sequence of
234 non-digit and non-white characters starting with an alphabetic
235 character or the code(_) is considered a word. When code("word") is
236 encountered it is treated as a lyric (without the quotes). Likewise,
237 when code(word) is encountered, it is treated as a lyric. The code(_)
238 character is converted to a space; it provides a mechanism for
239 creating words that contain spaces.
240 verb(a&@&@&TSI|{[ % a word
241 1THtrhortho % not a "word"
242 Leise DOEXPAND(Fl\)DOEXPAND("u\)ss{}teren meine Sapfe % 4 words
243 _ _ _ _ % 4 words: 4 spaces
246 COMMENT(Well, " seems to present some problems. Also `` seems to be
247 problematic. So the above statement isn't quite right. Unless these
248 characters are considered to be "white")
251 These modes are of a lexical nature. Normal and Note mode largely
252 resemble each other, save the possibility of entering Reals,
253 meaning of code(_) and the resolution of words
255 What's this about reals? When can you enter them or not enter them?)
258 sect(Note Description)
261 subsect(Basic Note Specification)
263 A note specification has the form
264 var(pitch)[var(octavespec)][code(!)][var(duration)].
265 The pitch of the note is specified by the note's name.
267 LilyPond has predefined note names for various languages. The default
268 names are the Dutch note names. The notes are specified by the
269 letters code(c) through code(b), where code(c) is an octave below
270 middle C and the letters span the ocatave above that C.
271 In Dutch, a sharp is formed by adding
272 code(is). A flat is formed by adding code(es).
273 Double sharps and double flats are obtained by adding code(isis) or
275 Lily has predefined sets of notenames
276 for various nop(languages)footnote(These
277 are Dutch, English, German, Italian and Swedish.
278 Simply include the language specific init file file(language.ly).).
279 Rests are specified with the note name code(r). There is also a note
280 name code(s) which produces a nonprinting note of the specified
283 The optional octave specification takes the form of a series of single
285 code(') characters or a series of comma code(,) characters. Each
286 code(') raises the pitch by one octave; each code(,) lowers the pitch
289 mudela(fragment,verbatim,center)(
290 c' d' e' f' g' a' b' c''
293 mudela(fragment,verbatim,center)(
294 cis' dis' eis' fis' gis' ais' bis'
297 mudela(fragment,verbatim,center)(
298 ces' des' es' fes' ges' as' bes'
301 mudela(fragment,verbatim,center)(
302 cisis' eisis' gisis' aisis' beses'
305 mudela(fragment,verbatim,center)(
306 ceses' eses' geses' ases' beses'
309 Whenever a C-sharp is desired, you must specify a C-sharp. LilyPond
310 will determine what accidentals to typeset depending on the key and
312 A reminder accidental can be forced by
313 using the optional exclamation mark `code(!)'
315 mudela(fragment,verbatim,center)(
316 cis' d' e' cis' c'! d' e' c'
320 Durations are entered as their reciprocal values
321 mudela(fragment,verbatim,center)(
322 a'1 a'2 a'4 a a'8 a a'16 a'32 a'64
324 mudela(fragment,verbatim,center)(
328 If the duration is omitted then it is set equal to the previous
329 duration. If there is no previous duration, then a quarter note is
331 The duration can be followed by a dot code(.) to obtain dotted note
333 mudela(fragment,verbatim,center)(
337 In addition, the duration can be followed by a multiplier which is
338 introduced with the asterisk code(*) and can be an integer or a
339 fraction. The multiplier changes the duration that LilyPond uses
340 internally for the note, but it does not change the symbol that is
342 mudela(fragment,verbatim,center)(
343 c'4*2 c'4*2 d'8*2/3 d'8*2/3
346 Extra long notes can be obtained using the code(\breve) and
347 code(longa) durations:
348 mudela(fragment,verbatim,center)(
353 subsect(Beams and Tuplets)
355 A beam is specified by surrounding the beamed notes with brackets
357 mudela(fragment,verbatim,center)(
358 [a'8 a'] [a'16 a' a' a']
361 In order to create triplets, you must use a length multiplier after
362 the brackets. An open bracket code([) followed by a fraction
363 instructs LilyPond to print a number over the beam, and it also
364 starts multiplying all note lengths by the fraction. The closing
365 bracket code(]) should be followed by the fraction code(1/1) in order
366 to restore normal note lengths. To create a triplet without a beam,
367 place a backslace code(\) before the opening and closing brackets.
369 For example, in an ordinary triplet, the notes have duration 2/3 as
371 mudela(fragment,verbatim,center)(
372 [2/3 a'8 a' a' ]1/1 \[2/3 b'4 b' b'\]1/1
375 There is a shorthand that can be used when you
376 want notes lengths multiplied by 2/n.
377 The 2 can be omitted after the open bracket
378 and the first 1 can be omitted after the closing bracket.
379 mudela(fragment,verbatim,center)(
380 [/3 b'8 b' b' ]/1 \[/3 a'4 a'8\]/1
383 COMMENT(The rest of this section needs to be rewritten. I don't
384 understand what's going on at all here. The meaning of the lone ] is
385 unclear. And the : syntax is also unclear. --Adrian)
387 Here is a combination
388 mudela(fragment,verbatim,center)(
389 [/3 a'8 a'16 a'] a'8 \]
393 mudela(fragment,verbatim,center)(
397 mudela(fragment,verbatim,center)(
403 subsect(Slurs and Ties)
405 A tie connects two adjacent note heads
407 mudela(fragment,verbatim,center)(
411 Whereas a slur rather connects `chords',
412 and tries to avoid crossing stems
414 mudela(fragment,verbatim,center)(
418 And of course, such a (legato) slur can span several notes
419 mudela(fragment,verbatim,center)(
423 subsect(Note Ornaments)
425 A variety of symbols can appear above and below notes to indicate
426 different characteristics of the performance. These symbols can be
427 added to a note with `var(note)code(-\)var(name)'. Numerous different
428 symbols are defined in file(script.ly). Each symbol is defined using
429 the code(\script) keyword which specifies where symbols appear.
430 Symbols can be forced to appear above the note by writing
431 `var(note)code(^\)var(name)', and they can be forced to appear below
432 by writing `var(note)code(_\)var(name)'. Here is a chart showing
433 symbols above notes, with the name of the corresponding symbol
434 appearing underneath.
438 < \notes{ c''-\accent c''-\marcato c''-\staccatissimo f'-\fermata
439 c''-\stopped c''-\staccato c''-\tenuto c''-\upbow c''-\downbow
440 c''-\lheel c''-\rheel c''-\ltoe c''-\rtoe c''-\turn
441 c''-\open c''-\flageolet c''-\reverseturn
443 c''-\prall c''-\mordent c''-\prallprall c''-\prallmordent
444 c''-\upprall c''-\downprall }
446 accent marcato staccatissimo fermata stopped
447 staccato tenuto upbow downbow lheel rheel ltoe rtoe turn
448 open flageolet reverseturn
450 mordent prallprall prallmordent uprall downprall }>
451 \paper{linewidth = 5.875\in
457 In addition, it is possible to place arbitrary strings of text or
458 TeX() above or below notes by using a string instead of an identifier:
459 `code(c^"text")'. Fingerings can be placed by simply using digits.
461 To save typing, a few common symbols can be abbreviated with
465 \property Voice.textstyle = typewriter
471 c''4-^_"c-\\^{ }" s4 }
472 \paper { linewidth = 12.\cm; }})
474 Dynamic marks are specified by using an identifier after
475 a note without a dash: code(c4 \ff). The available dynamic marks
476 are: code(\ppp), code(\pp), code(\p), code(\mp), code(\mf),
477 code(\f), code(\ff), code(\fff), code(\fp), code(sf), and code(\sfz).
479 A crescendo mark is started with code(\cr) and terminated with
480 code(\rc). A decrescendo mark is started with code(\decr) and
481 terminated with code(\rced).
487 Lyrics are entered like notes, with pitches replaced
488 by text. For example code(Twin-4 kle4 twin-4 kle4) enters four
489 syllables, each with quarter note duration.
491 In order to instruct LilyPond to write lyrics underneath the
492 staff, you must enter the lyrics context with code(\type Lyrics).
493 Lyrics should be entered in lyrics mode which is entered with code(\lyric).
495 Two syllables or words that compose a single
496 duration entry are bound together using an underscore:
497 code(He_could4 not4). Here is a full example:
498 mudela(verbatim)(\score{
499 < \notes \transpose c'' {c d e c | c d e c | e f g'2 |
500 e'4 f g'2 \bar "|."; }
501 \type Lyrics \lyric {
502 DOEXPAND(Fr\)`e-4 re Ja- que DOEXPAND(Fr\)`e- re Ja- que
503 Dor- mez vous?2 Dor-4 mez vous?2 }
515 sect(Chords and Voices)
517 Here's a simple chord
518 mudela(fragment,verbatim,center)(
523 mudela(fragment,verbatim,center)(
532 mudela(fragment,verbatim)(
534 { \voiceone c'4 g' c' g' }
542 LilyPond aligns all musical objects according to the amount of time
543 they occupy. All of these objects have a duration. When music is
544 written in series using braces the duration is the sum of the
545 durations of the elements. When music is stacked using angle
546 brackets, the duration is the maximum of the durations of the
549 Because LilyPond knows the durations of all musical elements, the time
550 signature enables LilyPond to draw bar lines automatically. The time
551 signature is specified with the code(\time) keyword: code(\time 3/4).
552 If no time signature is given, LilyPond assumes 4/4. The automatic
553 generation of bar lines can toggled with the code(\cadenza) keyword,
554 and an incomplete measure at the start of the music can be created
555 using the code(\partial) keyword: code(\partial 8*2;) creates a
556 starting measure lasting two eighth notes.
558 In order to help with error checking, you can insert bar markers in
559 your music by typing code(|). Whenever LilyPond encounters a code(|)
560 that doesn't fall at a measure boundary, she prints a warning message.
562 Rhythmic grouping is a concept closely associated with this.
563 A default grouping is selected for the chosen time signature.
564 The default consists of combinations of 2 and 3 beats with as many
565 groups of 3 as possible, and the groups of 3 coming first. For
566 example, 4/4 is divided into 2+2 and 8/8 is divided into 3+3+2. This
567 default grouping can be changed using the \grouping keyword which
568 takes a list of durations to specify the grouping.
572 sect(Composition: forming bigger structures)
575 The computer savy user may be interested in a more formal
576 specification. We can capture what have learned about forming
577 sentences in Mudela in a context-free grammar.
579 latexcommand(\smallskip)
582 row(cell(em(Music))cell(: em(Note)))
583 row(cell()cell(code(|) em(Rest)))
584 row(cell()cell(code(|) code({) em(MusicList) code(})))
585 row(cell()cell(code(|) code(<) em(MusicList) code(>)))
586 row(cell()cell(code(|) em(Command)))
587 row(cell()cell(code(|) code(\type) em(string) code(=) em(string) em(Music)))
589 row(cell(em(MusicList))cell(: em(empty)))
590 row(cell()cell(code(|) em(MusicList) em(Music)))
594 latexcommand(\smallskip)
596 In mathematics you can form expressions by combining expressions,
597 which are ultimately some kind of atom or terminal symbol. The same
598 goes for Mudela: there are some basic building blocks, and by
599 combining those you create complex music.
601 You can combine music in three ways:
603 it()If you enclose a sequence of music-elements in braces ( code({)
604 and code(}) ), then you form another kind of music called
607 The duration of sequential composition is the sum of the durations of its elements
609 { c c g g a a g2 } % twinkle twinkle
610 { { c c g g} { a a g2 } }
612 it()You can stack music by enclosing a sequence of music elements
613 with code(<) and code(>). This is called simultaneous music.
614 The duration of a simultaneous composition is the maximum of the durations
615 of its elements Example:
617 <a4 {cis8 cis8} e'4> % a-major chord
619 it()You can form music by transposing music:
622 d % from c to the d that's almost one octave down
623 { e4 f4 } % the horizontal music
627 it()verb(\translator)
631 Of course you can also combine these three mechanisms.
633 { c <c e> <c e g> <c e g \transpose d' dis > } % 4 increasing chords
641 Keywords sometimes appear alone, but usually they require arguments.
642 A keyword may have a single argument, or a sequence of arguments separated
643 by spaces and terminated by a semicolon:
644 `code(\keyword argument argument ... ;)'
649 dit(code(\absdynamic) code({) var(code) code(})) Internal command for
650 printing dynamic marks such as $f$ under music. The parameter
651 var(code) is unsigned and specifies the dynamic mark to print.
652 Normally you should use the more user friendly abbreviations defined
653 in the init file file(dynamic.ly).
655 dit(code(\accepts) var(string)code(;)) This command can appear only within a
656 code(\translator) block. It specifies what contexts are allowed
658 dit(code(\bar) var(bartype)code(;)) Prints a special bar symbol, or at
659 measure boundaries, replaces the regular bar symbol with a special
660 symbol. The argument var(bartype) is a string which specifies the
661 kind of bar to print. Options are code(":|"), code("|:"),
662 code(":|:"), code("||"), code("|."), code(".|"), or code(".|.").
663 These produce respectively a right repeat, a left repeat, a double
664 repeat, a double bar, a start bar, an end bar, or a thick double bar.
665 If var(bartype) is set to code("empty") then nothing is printed, but a
666 line break is allowed at that spot. Note that the printing of special bars
667 has no effect on the MIDI output.
669 dit(code(\cadenza) var(togglevalue)code(;)) Toggles the automatic generation
670 of bar lines. If var(togglevalue) is 0 then bar line generation is
671 turne off. If var(togglevalue) is 1 then a bar is immediately
672 printed and bar generation is turned on.
674 dit(code(\clear)) Allowed only within code(\notename). Clears all the
675 previously defined note names.
677 dit(code(\clef) var(clefname)code(;)) Allowed only in music.
678 Sets the current clef. The argument is
679 a string which specifies the name of the clef. Several clef names are
680 supported. If code(_8) or code(^8) is added to the end of a clef
681 name then the clef lowered or raised an octave will be generated.
682 Here are the supported clef names with middle C shown in each clef:
686 %\property Voice.textstyle = typewriter
687 \clef subbass; c'4-"\kern-10mm subbass"
688 \clef bass; c'4^"\kern -8mm bass"
689 \clef baritone; c'4_"\kern -10mm baritone"
690 \clef varbaritone; c'4^"\kern -10mm varbaritone"
691 \clef tenor; c'4_"\kern -10mm tenor"
692 \clef "G_8"; c'4^"\kern -6mm G\_8" }
693 \paper{ linewidth= 4.5 \in;
694 Staff = \translator {
695 \type "Line_group_engraver_group";
697 defaultclef = violin;
699 % \consists "Bar_engraver";
700 \consists "Clef_engraver";
701 \consists "Key_engraver";
702 \consists "Local_key_engraver";
703 \consists "Time_signature_engraver";
704 \consists "Staff_sym_engraver";
705 \consists "Collision_engraver";
706 \consists "Rest_collision_engraver";
707 \consists "Separating_line_group_engraver";
718 \notes{\clef alto; c'4_"\kern -10mm alto"
719 \clef mezzosoprano; c'4^"\kern -10mm mezzosoprano"
720 \clef soprano; c'4_"\kern -10mm soprano"
721 \clef treble; c'4^"\kern -6mm treble"
722 \clef french; c'4_"\kern -10mm french" }
723 \paper{ linewidth= 4.5 \in;
724 Staff = \translator {
725 \type "Line_group_engraver_group";
727 defaultclef = violin;
729 % \consists "Bar_engraver";
730 \consists "Clef_engraver";
731 \consists "Key_engraver";
732 \consists "Local_key_engraver";
733 \consists "Time_signature_engraver";
734 \consists "Staff_sym_engraver";
735 \consists "Collision_engraver";
736 \consists "Rest_collision_engraver";
737 \consists "Separating_line_group_engraver";
744 The treble clef can also be obtained using the names code(G) or
745 code(violin). The bass clef is also available by code(\clef F).
747 dit(code(\cm)) Specify a dimension in centimeters.
749 dit(code(\consists) var(string)code(;)) This command can appear only within a
750 code(\translator) block. It specifies that an engraver named
751 var(string) should be added to the translator.
753 dit(code(\contains)) Produces a parse error. (There is no rule in the
754 grammar that refers to this token.)
756 dit(code(\duration) code({) var(length) var(dotcount) code(})) Specify note
757 duration. The parameter var(length) is the negative logarithm (base
758 2) of duration: 1 is a half note, 2 is a quarter note, 3 is an eighth
759 note, etc. The number of dots after the note is given by
762 dit(code(\font) var(string)) Internal command. Used within
763 code(\symboltables) to specify the font.
765 dit(code(\grouping) var(durationseq); ) Sets the metric structure of
766 the measure. Each argument specifies the duration of one metric unit.
767 For example, code(\duration 16*5;) specifies a grouping of five beats
768 together in 5/16 time. The default grouping is to have as many groups
769 of 3 as possible followed by groups of two.
771 dit(code(\in)) Specify a dimension in inches.
773 dit(code(\include) var(file)) Include the specified file. The
774 argument var(file) is a string. The full filename including the
775 file(.ly) extension must be given.
777 dit(code(\lyric) var(lyriclist)) Parse var(lyriclist) in lyrics mode.
779 dit(code(\key) var(pitch)) Change key signature to that of
782 dit(code(\keysignature) var(pitchseq);)
783 Specify an arbitrary key signature. The pitches from var(pitch) will
784 be printed in the key signature in the order that they appear on the list.
786 dit(code(\mark) var(unsigned) or code(\mark) var(string)) Allowed in
787 music only. What does this do?
789 dit(code(\musicalpitch) code({) var(octave) var(note) var(shift) code(}))
790 Specify note pitch. The octave is specified by an integer,
791 zero for the octave containing middle C. The note is a number from 0
792 to 7, with 0 corresponding to C and 7 corresponding to B. The shift
793 is zero for a natural, negative to add flats, or positive to add
796 dit(code(\notes) var(music)) Enter note mode and process the
799 dit(code(\time) var(numerator)code(/)var(denominator)) Change the time
800 signature. The default time signature is 4/4.
802 dit(code(\midi) var(statementlist)) Appears in a score block to
803 indicate that musical output should be produced. See code(\tempo).
805 dit(code(\mm)) Specify a dimension in millimeters.
807 dit(code(\header) code({) var(key1) = var(val1); var(key2) = var(val2); ... code(}))
808 Specifies information about the music. A header should appear at the
809 top of the file describing the file's contents. If a file has
810 multiple code(\score) blocks, then a header should appear in
811 each score block describing its contents. Tools like code(ly2dvi) can
812 use this information for generating titles. Some possible key values
813 are: title, opus, description, composer, enteredby, and copyright.
815 dit(code(\notenames) var(assignmentlist)) Define new note names.
816 The argument is a list of definitions of the form
817 var(name) = var(pitch), where var(pitch) is specified with the
818 code(\musicalpitch) command. Another possibility is code(\clear)
819 which can appear instead of an assignment.
821 dit(code(\octave)) Generate a parse error. Never referred to in the
824 dit(code(\output) var(string)code(;)) Allowed only in
825 code(\paper) block. The parameter var(string) specifies an alternate
826 name for the TeX() output. A file(.tex) extension will be added to
827 var(string) to produce the output file name.
829 dit(code(\partial) var(duration)) Specify that the first measure of
830 the music lasts only for the specified duration.
832 dit(code(\paper) var(statmentlist))
833 Appears in a score block to indicate that the music should be printed.
835 dit(code(\penalty) code(=) var(int)) Allowed only in musiclists.
836 Discourages line breaks.
838 dit(code(\property) var(contextname)code(.)var(propname) code(=) var(value))
839 Sets the var(propname) property of the context var(contextname) to the
840 specified var(value). All three arguments are strings.
842 dit(code(\pt)) Specify a dimension in points.
844 dit(code(\relative) var(pitch) var(music)) Processes the specified
845 var(music) in relative pitch
846 mode. In this mode, the octave of a pitch note is chosen so that the
847 note is closest to the preceeding note.
848 The argument var(pitch) is
849 the starting pitch for this comparision. In the case of chords, the
850 first note of a chord is used as the base for the pitches in the next
853 dit(code(\score) var(statementlist)) Define music.
855 dit(code(\script) code({) var(name) var(instaff) var(withstem)
856 var(location) var(invertible) var(priority) code(})) This command is
857 used the initialization file(script.ly) to define the various symbols
858 that can appear above and below notes. The first argument is the name
859 of the symbol. The second argument var(instaff) is 1 if the symbol
860 follows the notehead into the staff and 0 if the symbol stays above or
861 below the staff lines. The third parameter var(withstem) is 0 if the
862 symbol's placement does not depend on the stem direction; it is 1 if
863 the symbol should be at the stem end of the note and it is -1 if the
864 symbol should be at the note head end of the note. The argument
865 var(location) is set to 1 for symbols that always appear above the
866 staff; it is -1 for symbols that appear below the staff. If
867 var(invertible) is set to 1 then the symbol can be inverted; otherwise
868 it cannot. The last argument var(priority) sets a priority for the
869 order of placement of several symbols on a single note.
871 dit(code(\shape) code(=) var(indent1) var(width1) var(indent2)
872 var(width2) ... code(;)) Allowed only within code(\paper). Each pair
873 of var(indent) and var(width) values is a dimension specifying how far
874 to indent and how wide to make the line. The indentation and width of
875 successive lines are specified by the successive pairs of dimensions.
876 The last pair of dimensions will define the characeristics of all
877 lines beyond those explicitly specified.
879 COMMENT(First pair of dimensions seems to be skipped. At least it is
880 in the example file denneboom.ly.)
882 dit(code(\skip) var(duration)) Skips the amount of time specified by
883 var(duration). A gap will be left for the skipped time with no notes
884 printed. It works in Note Mode or Lyrics Mode (but generates a
885 mysterious error in lyrics).
887 dit(code(\spandynamic) code({) var(kind) var(toggle) code(})) Internal
888 command for crescendo and decrescendo symbols. The first parameter
889 var(kind) is set to 1 for a crescendo and -1 for a decrescendo. The
890 second parameter is set to 1 to start the mark and 2 to stop it.
891 Users should use the abbreviations which are defined in the
892 initialization file file(dynamic.ly).
894 dit(code(\symboltables)) Internal command. Used to create symbol
895 tables. See initialization files file(paper*.ly), file(feta*.ly), and
898 dit(code(\table)) Internal command. Used within code(\symboltables)
899 to specify the tables. See initialization files.
901 dit(code(\tempo) var(duration) = var(perminute)) Used within
902 code(\midi) to specify the tempo. For example,
903 `code(\midi { \tempo 4 = 76})' requests output with 76 quarter notes
906 dit(code(\translator) var(statements) or code(\translator)
907 var(context) = var(name)) The first variant appears only within
908 code(\paper) and specifies a translator for
909 converting music to notation. The translator is specified with a
910 single code(\type) statement and a series of code(\accepts), and
911 code(\consists) statements. The second variant appears in a
912 musiclist. It specifies that the current the contexts
913 contained within the specified context should be shifted to the
914 context with the specified name.
916 COMMENT( \translator seems like a strange name for the second
917 operation, and is the overloading desireable? )
919 dit(code(\type) var(contexttype) [code(=) var(contextname)]
920 var(musiclist) or code(\type) var(translatortype)code(;)) The first
921 variant is used only within musiclists to
922 create a instance of a context. The new context
923 can optionally be given a name. The second variant appears within a
924 code(\translator) block and specifies the type of translator being
927 dit(code(\transpose) var(pitch) var(music)) Transposes the specified
928 music. Middle C is tranposed to var(pitch).
930 dit(code(\version) var(string)) Specify the version of Mudela that a
931 file was written for. The argument is the version number, for example
932 code("1.0.1"). Note that the Mudela version is different from the
938 sect(Notation Contexts)
940 Notation contexts provide information that appears in printed music
941 but not in the music itself. A new musical context is created using
942 the code(\type) keyword: `code(\type) var(contexttype) [code(=)
943 var(contextname)] var(musiclist)'. The following context types are
948 dit(code(Lyrics)) Typesets lyrics.
950 dit(code(Voice)) Corresponds to a voice on a staff.
951 This context handles the conversion of noteheads,
952 dynamic signs, stems, beams, super- and subscripts, slurs, ties and rests.
954 dit(code(Staff)) Handles clefs, bar lines, keys,
955 accidentals. It can contain code(Voice) or code(Lyrics) contexts.
957 dit(code(RhythmicStaff)) A context like code(Staff) but for printing
958 rhythms. Pitches are ignored; the notes are printed on one line.
959 It can contain code(Voice) or code(Lyrics) contexts.
961 dit(code(GrandStaff)) Contains code(Staff) or code(RhythmicStaff)
962 contexts. It adds a brace on the left side grouping the staffs
963 together. The bar lines of the contained staffs are connected vertically.
964 It can contain code(Staff), code(RhythmicStaff) or code(Lyrics) contexts.
966 dit(code(StaffGroup)) Contains code(Staff) or code(RhythmicStaff)
967 contexsts. Adds a bracket on the left side, grouping the staffs
968 together. The bar lines of the contained staffs are connected vertically.
969 It can contain code(Staff), code(RhythmicStaff) or code(Lyrics) contexts.
971 dit(code(ChoireStaff)) Identical to code(StaffGroup) except that the
972 contained staffs are not connected vertically.
974 COMMENT(Odd spelling of "choir".)
976 dit(code(Score)) This is the top level notation context. It is entered with
977 the code(\score) command rather than the code(\type) command. No
978 other context can contain a code(Score) context. This context handles
979 the administration of time signatures. It also makes sure that items
980 such as clefs, time signatures, and key-signatures are aligned across
981 staffs. It can contain code(Lyrics), code(Staff),
982 code(RhythmicStaff), code(GrandStaff), code(StaffGroup), and
983 code(ChoireStaff) contexts.
987 The various contexts have properties associated with them. These
988 properties can be changed using the code(\property) command:
989 `code(\property) var(context)code(.)var(propname) code(=) var(value)'.
990 Properties can also be set within the code(\translator) block
991 corresponding to the appropriate context. In this case, they are
992 assigned by `var(propname) code(=) var(value)'.
996 dit(Lyrics properties)
999 dit(code(textstyle)) Set the font for lyrics. The available
1000 font choices are code(normaltext), code(roman), code(italic), code(bold)
1001 code(normaltext), code(large), code(Large), code(huge), and
1002 code(finger). The code(finger) font can only display numbers.
1003 Note also that you must be careful when using code(\property) in
1004 Lyrics mode. Because of the way strings are parsed, either put quotes
1005 around the arguments to code(\property) or be sure to leave a space on
1006 both sides of the dot.
1007 dit(code(textalignment))
1008 Controls alignment of lyrics.
1009 Set to -1 to align the left end of the lyric with
1010 the note; set to 1 to align the right end of the lyric with the note.
1011 Set to 0 to align the center of the lyric with the note.
1013 dit(Voice properties)
1016 dit(code(ydirection)) Determines the direction of
1017 stems, subscripts, beams, slurs, and ties. Set to -1 to force them
1018 down, 1 to force them up, or 0 to let LilyPond decide. This can be
1019 used to distinguish between voices on the same staff. The
1020 code(\stemdown), code(\stemup), and code(\stemboth) identifiers set
1022 dit(code(slurydirection)) Set to 0 for free choice of slur
1023 direction, set to 1 to force slurs up, set to 0 to force slurs down.
1024 The shorthands code(\slurup), code(\slurdown), and code(\slurboth) are
1027 dit(code(slurdash)) Set to 0 for normal slurs, 1 for dotted slurs,
1028 and a larger value for dashed slurs. Identifiers code(\slurnormal)
1029 and code(\slurdotted) are predefined to set the first two settings.
1031 dit(code(hshift)) Set to 1 to enable LilyPond to shift notes
1032 horizontally if they collide with other notes. This is useful when
1033 typesetting many voices on one staff. The identifier code(\shift) is
1034 defined to enable this.
1036 dit(code(textalignment)) Controls alignment of superscripted and
1037 subscripted text. Set to -1 to align the left end of the text with
1038 the note; set to 1 to align the right end of the text with the note.
1039 Set to 0 to align the center of the text with the note.
1040 dit(code(textstyle)) Set the text style for superscripts and
1041 subscripts. See above for list of text styles.
1043 dit(code(fontsize)) Can be used to select smaller font sizes for music. The
1044 normal font size is 0, and the two smaller sizes are -1 and -2.
1046 dit(code(pletvisibility)) Determines whether tuplets of notes are
1047 labelled. Setting to 0 shows nothing; setting to 1 shows a
1048 number; setting to 2 shows a number and a bracket if there is no
1049 beam; setting to 3 shows a number, and if there is no beam it
1050 adds a bracket; setting to 4 shows both a number and a bracket
1054 dit(Staff properties)
1058 dit(code(defaultclef)) Determines the default clef. See code(\clef)
1061 dit(code(nolines)) If set to 1, then the staff has only one line instead
1062 of the usual five lines.
1064 dit(code(barAlways)) If set to 1 a bar line is drawn after each note.
1066 dit(code(defaultBarType)) Sets the default type of bar line. See
1069 dit(code(keyoctaviation)) If set to 1, then keys are the same in all
1070 octaves. If set to 0 then the key signature for different octaves
1071 can be different and is specified independently:
1072 code(\keysignature bes fis'). The default value
1073 is 1. Can be set to zero with code(\specialkey) or reset to 1 with
1076 dit(code(instrument) and code(instr)) If code(Staff_margin_engraver) is
1077 added to the Staff translator, then the code(instrument) property is used to
1078 label the first line of the staff and the code(instr) property is used to
1079 label subsequent lines.
1080 COMMENT(Check that this works)
1082 dit(code(midi_instrument)) Sets the instrument for MIDI output.
1084 dit(code(transposing)) Tranpose the MIDI output.
1085 COMMENT(What syntax? "0 c" "2 c" ???)
1087 dit(code(ydirection)) What does this do in staff ???
1090 dit(GrandStaff properties)
1093 dit(code(maxVerticalAlign))
1094 dit(code(minVerticalAlign))
1097 dit(Score properties)
1100 dit(code(part)) Set to a part number for music with several parts.
1101 Each part has its own code(\score) block with a different part setting.
1102 dit(code(SkipBars)) ???
1104 dit(code(beamquantisation)) Set to 0 for no quantization. Set to 1 to
1105 quantize position and slope. Set to 2 to avoid wedges. These three
1106 settings are available via code(\beamposfree), code(\beamposnormal), and
1107 code(\beampostraditional).
1109 dit(code(beamslopedamping)) Set to 0 for undamped beams. Set to 1 for
1110 damped beams. Set to 100000 for beams with zero slope. The identifiers
1111 code(\beamslopeproportional), code(\beamslopedamped), and
1112 code(\beamslopezero) each set the corresponding value.
1122 bar-column-engraver.cc: "barColumnPriority"
1123 bar-number-engraver.cc: "barNumberBreakPriority"
1124 bar-number-engraver.cc: "barScriptPadding"
1125 dynamic-engraver.cc: "dynamicdir"
1126 mark-engraver.cc: "markScriptPadding"
1127 mark-engraver.cc: "markBreakPriority"
1128 span-bar-engraver.cc: "singleStaffBracket"
1129 staff-margin-engraver.cc:"marginBreakPriority"
1130 stem-engraver.cc: "abbrev"
1133 sec(Pre-defined Identifiers)
1135 Various identifiers are defined in the initialization files to
1136 provide shorthands for some settings.
1139 dit(code(\cr)) Start a crescendo.
1140 dit(code(\decr)) Start a decrescendo.
1141 dit(code(\f)) Print forte symbol on the preceeding note.
1142 dit(code(\ff)) Print fortissimo symbol on the preceeding note.
1143 dit(code(\fff)) Print fortississimo symbol on preceeding note.
1144 dit(code(\fp)) Print fortepiano symbol on preceeding note.
1145 dit(code(\mf)) Print mezzoforte symbol on preceeding note.
1146 dit(code(\mp)) Print mezzopiano symbol on preceeding note.
1147 dit(code(\normalkey)) Select normal key signatures where each octave
1148 has the same key signature. This sets the Staff.keyoctaviation property.
1149 dit(code(\p)) Print a piano symbol on preceeding note.
1150 dit(code(\pp)) Print pianissimo symbol on preceeding note.
1151 dit(code(\ppp)) Print pianississimo symbol on preceeding note.
1152 dit(code(\rc)) Terminate a crescendo.
1153 dit(code(\rced)) Terminate a decrescendo
1154 dit(code(\sf)) Print a ?? symbol on preceeding note.
1155 dit(code(\sfz)) Print a ?? symbol on preceeding note.
1156 dit(code(\shift)) Enable note heads that collide with other note heads
1157 to be shifted horiztonally. This sets the Voice.hshift property.
1158 dit(code(\slurboth)) Allow slurs to be above or below notes. This
1159 sets the Voice.slurydirection property.
1160 dit(code(\slurdown)) Force slurs to be below notes. This sets the
1161 Voice.slurydirection property.
1162 dit(code(\slurup)) Force slurs to be above notes. This sets the
1163 Voice.slurydirection property.
1164 dit(code(\specialkey)) Allow keys signatures do differ in different
1165 octaves. This sets the Staff.keyoctaviation property.
1166 dit(code(\stemboth)) Allow stems, beams, and slurs to point either
1167 direction. This sets the Voice.ydirection property.
1168 dit(code(\stemdown)) Force stems, beams, and slurs to point down.
1169 This sets the Voice.ydirection property.
1170 dit(code(\stemup)) Force stems, beams and slurs to point up. This
1171 sets the Voice.ydirectoin property.
1175 sect(The code(\paper) Block)
1177 The code(\paper) block may begin with an optional identifier reference. No
1178 identifier references are allowed anywhere else in the block.
1179 The keywords code(\shape), code(\output) and code(\translator) may
1180 appear in this block. In addition, variable assignments may appear.
1181 The variables control layout details and are set to reasonable
1182 defaults that depend on the font size in use.
1184 subsect(Paper variables)
1187 dit(var(integer)) If an integer appears on the left side of an
1188 assignment then a code(\symboltables) keyword must appear on the right
1189 side. This defines a font.
1191 dit(code(arithmetic_basicspace))
1192 dit(code(arithmetic_multiplier))
1193 dit(code(basicspace))
1194 dit(code(beam_thickness)) Specify the thickness of beams
1195 dit(code(geometric))
1196 dit(code(indent)) Sets the indentation of the first line of music.
1197 dit(code(interbeam))
1198 dit(code(interbeam4))
1199 dit(code(interline))
1200 dit(code(internote))
1201 dit(code(linewidth)) Sets the width of the lines. If it is set to
1202 -1, then a single unjustified line is produced.
1203 dit(code(notewidth))
1204 dit(code(rulethickness)) Determines thickness of staff lines and bars.
1205 dit(code(staffheight))
1206 dit(code(unitspace))