@c -*-texinfo-*-
+
@node Introduction
@chapter Introduction
-LilyPond is a program to print sheet music. If you have used notation
-programs before, then the way to use this program might be surprising
-at first sight: in order to print music you have to enter musical
-codes in a file. Then you run the program on the file, and the music
-is produced without any further intervention. For example, something
-like this:
+There are a lot of programs that let you print sheet music with a
+computer, but most of them do not do good job. Most computer
+printouts have a bland, mechanical look, and are unpleasant to play
+from. If you agree with us on that, then you will like LilyPond: we
+have tried to capture the original look of hand-engraved music. We
+have tuned our algorithms, font-designs, and program settings to make
+the program produce prints that match the quality of the old editions
+we love to see and love to play from.
+
+@menu
+* Notation in LilyPond ::
+* Engraving in LilyPond::
+* Typography and program architecture::
+* Music representation::
+* Example applications::
+* About this manual::
+@end menu
+
+
+@node Notation in LilyPond
+@section Notation in LilyPond
+
+
+@cindex engraving
+@cindex typography
-@lilypond[fragment,verbatim, relative 1, intertext="produces this:
-"]
-\key c \minor r8 c16 b c8 g as c16 b c8 d | g,4
+Printing sheet music consists of two non-trivial tasks. First, one has
+to master music notation: the science of knowing which symbols to use
+for what. Second, one has to master music engraving: the art of
+placing symbols such that the result looks pleasing.
+
+Common music notation is a system of recording music that has evolved
+over the past 1000 years. The form that is now in common use, dates
+from the early renaissance. Although, the basic form (i.e. note heads on a
+5-line staff) has not changed, the details still change to express the
+innovations of contemporary notation. Hence, it encompasses some 500
+years of music. Its applications range from monophonic melodies to
+monstrous counterpoint for large orchestras.
+
+How can we get a grip on such a many-headed beast, and force it into
+the confines of a computer program? Our solution is to make a strict
+distinction between notation, @emph{what} symbols to use, and
+engraving, @emph{where} to put them. Anything related to the second
+question is considered ``engraving'' (i.e. typography).
+
+For tackling the first problem, notation, we have broken up the
+problem into digestible (and programmable) chunks: every type of
+symbol is handled by a separate program module, a so-called plug-in.
+Each plug-in are completely modular and independent, so each can be
+developed and improved separately. When put together, the plug-ins
+can solve the music notation program in cooperation. People that put
+graphics to musical ideas are called copyists or engravers, so by
+analogy, each plug-in is also called @code{engraver}.
+
+In the following example, we see how we start out with a note head
+engraver.
+
+@lilypond[]
+\include "engraver-example.lyinc"
+
+\score { \topVoice
+\paper {
+ \translator { \VoiceContext
+ \remove "Stem_engraver"
+ \remove "Phrasing_slur_engraver"
+ \remove "Slur_engraver"
+ \remove "Script_engraver"
+ \remove "Beam_engraver"
+ \remove "Auto_beam_engraver"
+
+ }
+ \translator { \StaffContext
+ \remove "Accidental_engraver"
+ \remove "Key_engraver"
+ \remove "Clef_engraver"
+ \remove "Bar_engraver"
+ \remove "Time_signature_engraver"
+ \remove "Staff_symbol_engraver"
+ \consists "Pitch_squash_engraver"
+ }
+
+}
+}
@end lilypond
-@cindex encoding music
+Then a @code{Staff_symbol_engraver} adds the staff:
+
+@lilypond[]
+\include "engraver-example.lyinc"
+
+\score { \topVoice
+\paper {
+ \translator { \VoiceContext
+ \remove "Stem_engraver"
+ \remove "Phrasing_slur_engraver"
+ \remove "Slur_engraver"
+ \remove "Script_engraver"
+ \remove "Beam_engraver"
+ \remove "Auto_beam_engraver"
+
+ }
+ \translator { \StaffContext
+ \remove "Accidental_engraver"
+ \remove "Key_engraver"
+ \remove "Clef_engraver"
+ \remove "Bar_engraver"
+ \consists "Pitch_squash_engraver"
+ \remove "Time_signature_engraver"
+ }
+
+}
+}
+@end lilypond
-Encoding music using letters and digits may appear strange,
-intimidating or even clumsy at first. Nevertheless, when you take the
-effort to learn the codes and the program you will find that it is
-easier than it seems. Entering music can be done quickly, and you
-never have to remember how you made the program do something
-complicated: it is all in the input code, and you only have to read
-the file to see how it works. Moreover, you are rewarded with very
-nicely looking output.
+ The @code{Clef_engraver} defines a reference point for the staff:
+
+@lilypond[]
+\include "engraver-example.lyinc"
+
+\score { \topVoice
+\paper {
+ \translator { \VoiceContext
+ \remove "Stem_engraver"
+ \remove "Phrasing_slur_engraver"
+ \remove "Slur_engraver"
+ \remove "Script_engraver"
+ \remove "Beam_engraver"
+ \remove "Auto_beam_engraver"
+ }
+ \translator { \StaffContext
+ \remove "Accidental_engraver"
+ \remove "Key_engraver"
+ \remove "Bar_engraver"
+ \remove "Time_signature_engraver"
+ }
+
+}
+}
+@end lilypond
-In this chapter, we will explain the reasoning behind this unusual
-design, and how this approach affects you as a user.
+And the @code{Stem_engraver} adds stems:
+
+@lilypond[]
+\include "engraver-example.lyinc"
+
+\score { \topVoice
+\paper {
+ \translator { \VoiceContext
+ \remove "Phrasing_slur_engraver"
+ \remove "Slur_engraver"
+ \remove "Script_engraver"
+ \remove "Beam_engraver"
+ \remove "Auto_beam_engraver"
+ }
+ \translator { \StaffContext
+ \remove "Accidental_engraver"
+ \remove "Key_engraver"
+ \remove "Bar_engraver"
+ \remove "Time_signature_engraver"
+ }
+}
+}
+@end lilypond
-@menu
-* Batch processing::
-* Music engraving::
-* Computerized typography ::
-* Music representation::
-* Example applications::
-* About this manual::
-@end menu
+The @code{Stem_engraver} is notified of any note head coming along.
+Every time one (or more, for a chord) note head(s) is seen, a stem
+object is created, and attached to the note head.
-@node Batch processing
-@section Batch processing
+By adding engravers for beams, slurs, accents, accidentals, bar lines,
+time signature, and key signature, we get a complete piece of
+notation.
-@cindex GUI
-@cindex Batch
-@cindex UNIX
+@lilypond[]
+\include "engraver-example.lyinc"
-LilyPond is a @emph{batch} program. To use it, one enters commands in a
-file, and runs the program on that file. The output is produced without
-requiring any further interaction.
+\score { \topVoice }
+@end lilypond
-When we started developing LilyPond, we were still studying at the
-university. We were interested in music notation, not as publishers
-or musicians, but as programmers and scientists. We wanted to figure
-to what extent formatting sheet music could be automated. Back then
-GUIs were not as ubiquitous as they are today, and we were immersed in
-the UNIX operating system, where it is very common to use compilers to
-achieve computing tasks. So, our computerized music engraving
-experiment took on the form of a compiler.
-@ignore
-@cindex free software
-@cindex sharing software
+This system works well for monophonic music, but what about
+polyphony? In polyphonic notation, many voices can share a staff.
-You can freely use, modify and redistribute LilyPond. This choice was
-also motivated by our academic background. In the scientific community
-it has always been a tradition to share knowledge, also if that
-knowledge was packaged as software. One of the most visible groups
-that stimulated this philosophy, was the Free Software Foundation,
-whose popular GNU project aimed to replace closed and proprietary
-computing solutions with free (as in ``Libre'') variants. We jumped on
-that bandwagon, and released LilyPond as free software. That is the
-reason that you can get LilyPond at no cost and without any strings
-attached.
-@end ignore
+@lilypond[]
+\include "engraver-example.lyinc"
+\score { \context Staff << \topVoice \\ \botVoice >> }
+@end lilypond
+In this situation, the accidentals and staff are shared, but the
+stems, slurs, beams, etc. are private to each voice. Hence, engravers
+should be grouped. The engravers for note head, stems, slurs, etc. go
+into a group called ``Voice context,'' while the engravers for key,
+accidental, bar, etc. go into a group called ``Staff context.'' In the
+case of polyphony, a single Staff context contains more than one Voice
+context. In polyphonic notation, many voices can share a staff:
+Similarly, more Staff contexts can be put into a single Score context.
+
+@lilypond[]
+\include "engraver-example.lyinc"
+\score {
+<< \new Staff << \topVoice \\ \botVoice >>
+\new Staff << \pah \\ \hoom >>
+ >>
+}
+@end lilypond
-@node Music engraving
-@section Music engraving
+@node Engraving in LilyPond
+@section Engraving in LilyPond
-@cindex engraving
-@cindex typography
-Making sheet music may seem trivial at first (``you print 5 lines, and
-then put in the notes at different heights''), @emph{music engraving},
-i.e. professional music typography, is in another ballpark. The term
-`music engraving' derives from the traditional process of music
+The term music engraving derives from the traditional process of music
printing. Only a few decades ago, sheet music was made by cutting and
-stamping the music into zinc or pewter plates, mirrored. The plate
+stamping the music into zinc or pewter plates, in mirror image. The plate
would be inked, and the depressions caused by the cutting and stamping
-would hold ink. An image was formed by pressing paper to the
-plate. Stamping and cutting was completely done by hand. Making
+would hold ink. An image was formed by pressing paper to the
+plate. The stamping and cutting was completely done by hand. Making
corrections was cumbersome, so engraving had to be done correctly in
-one go. As you can imagine this was a highly specialized skill, much
-more so than the traditional process of printing books.
+one go. Of course, this was a highly specialized skill, much more so
+than the traditional process of printing books.
@cindex craftsmanship
@cindex master
-In the traditional German craftsmanship six years of full-time
+In the traditional German system of craftsmanship six years of full-time
training, more than any other craft, were required before a student
could call himself a master of the art. After that many more years of
practical experience were needed to become an established music
advanced software, music requires lots of manual fine tuning before it
is acceptable for publication.
-When we wanted to write a computer program to create music typography,
-we encountered the first problem: there were no sets of musical
-symbols available: either they were not available freely, or they did
-not look well to our taste. Not let down, we decided to try font
-design ourselves. We created a font of musical symbols, relying on
-nice printouts of hand-engraved music. The experience helped develop
-a typographical taste, and it made us appreciate subtle design
-details. Without that experience, we would not have realized the
-shortcomings of the fonts were that we admired at first.
+Sheet music is performance material: everything is done to aid the
+musician in letting him perform better. Music often is far away from
+its reader---it might be on a music stand. To make it clearly
+readable, traditionally printed sheet music always uses bold symbols,
+on heavy staff lines, and is printed on large sheets of paper. This
+``strong'' look is also present in the horizontal spacing. To
+minimize the number of page breaks, (hand-engraved) sheet music is
+spaced very tightly. Yet, by a careful distribution of white space,
+the feeling of balance is retained, and a clutter of symbols is
+avoided.
+
+
+We have used these observations in designing LilyPond. The images
+below show the flat symbol. On the left, a scan from a Henle edition,
+which was made by a computer, and in the center is the flat from a
+hand engraved B@"{a}renreiter edition of the same music. The left scan
+illustrates typical flaws of computer print: the symbol is much
+lighter, the staff lines are thinner, and the glyph has a straight
+layout with sharp corners. By contrast, the B@"{a}renreiter has a bold
+and almost voluptuous rounded look. Our flat symbol is designed
+after, among others, this one. It is tuned it to harmonize with the
+thickness of our staff lines, which are also much thicker than Henle's
+lines.
+
+@multitable @columnfractions .1 .3 .3 .3
+@item @tab
+@iftex
+@image{henle-flat-bw,4cm}
+@end iftex
+@html
+<img src=henle-flat-bw.png>
+@end html
+
+@tab
+@iftex
+@image{baer-flat-bw,4cm}
+@end iftex
+@html
+<img src=baer-flat-bw.png>
+@end html
+
+@tab
+@iftex
+@image{lily-flat-bw,4cm}
+@end iftex
+@html
+<img src=lily-flat-bw.png>
+@end html
+
+@item @tab
+Henle (2000)
+@tab
+B@"{a}renreiter (1950)
+@tab
+LilyPond Feta font (2003)
+
+@end multitable
-@lilypond[noindent]
-#(define magfact 3.0)
-\score { \notes { as'2 r4 }
- \paper {
- raggedright = ##t
- \translator {
- \ScoreContext
- AccidentalPlacement \override #'right-padding = #3.0
- StaffSymbol \override #'transparent = ##t
- Clef \override #'transparent = ##t
- TimeSignature \override #'transparent = ##t
- Accidental \override #'font-magnification = #magfact
- Rest \override #'font-magnification = #magfact
- NoteHead \override #'font-magnification = #magfact
- Stem \override #'transparent = ##t
- } } }
-@end lilypond
@cindex musical symbols
@cindex font
@cindex blackness
@cindex balance
-
-The figure above shows a few notable glyphs. For example, the
-vertical stem of the flat symbol should be brushed slightly,
-i.e. becoming wider at the top. the half-notehead is not elliptic but
-slightly diamond shaped. Fine endings, such as the one on the bottom
-of the quarter rest, should not end in sharp points, but rather in
-rounded shapes. Taken together, the blackness of the font must be
-carefully tuned together with the thickness of lines, beams and slurs
-to give a strong yet balanced overall impression.
-
-Producing a strong and balanced look is the real challenge of music
-engraving. It is a recurring theme with many variations. In spacing,
-strength and balance are in layout that is `heavy' enough---without
-big gaps of space--- and without big clusters of black. The
-distribution of space should reflect the character of the music.
-
-Spacing is an example of a subtlety of formatting music. The distances
-between notes should reflect the durations between notes, but adhering
-with mathematical precision to the duration will lead to a poor
-result. Shown here is an example of a motive, printed twice. It is
-printed using exact mathematical spacing, and with some
-corrections. Can you spot which fragment is which?
-
+In spacing, the distribution of space should reflect the durations
+between notes. However, adhering with mathematical precision to the
+duration will lead to a poor result. Shown here is an example of a
+motive, printed twice. It is printed using exact mathematical spacing,
+and with some corrections. Can you spot which fragment is which?
@cindex optical spacing
@lilypond[noindent]
\score { \notes {
- \property Staff.NoteSpacing \set #'stem-spacing-correction
- = #0.6
+ \override Staff.NoteSpacing #'stem-spacing-correction
+ = #0.6
c'4 e''4 e'4 b'4 |
\stemDown b'4 e''4 a'4 e''4| \stemBoth
- \property Staff.NoteSpacing \override #'stem-spacing-correction
- = #0.0
- \property Staff.StaffSpacing \override #'stem-spacing-correction
- = #0.0
+ \bar "||"
+ \override Staff.NoteSpacing #'stem-spacing-correction
+ = #0.0
+ \override Staff.StaffSpacing #'stem-spacing-correction
+ = #0.0
c'4 e''4 e'4 b'4 |
\stemDown b'4 e''4 a'4 e''4|
}
@cindex regular rhythms
@cindex regular spacing
-The fragment that was printed uses only quarter notes: notes that are
-played in a constant rhythm. The spacing should reflect
-that. Unfortunately, the eye deceives us a little: the eye not only
-notices the distance between note heads, but also between consecutive
-stems. As a result, the notes of a up-stem/down-stem combination
-should be put farther apart, and the notes of a down-up combination
-should be put closer together, all depending on the combined vertical
-positions of the notes. The first two measures are printed with this
-correction, the last two measures without. The notes in the last two
-measures form down-stem/up-stems clumps of notes.
-
-@node Computerized typography
-@section Computerized typography
-
-The example in the previous section is one illustration of how subtle
-music engraving can be is a subtle. Producing good engraving requires
-skill and knowledge.
-
-
-It was our challenge to see if we could put typographical knowledge
-into a computer program. Capturing that knowledge has two aspects:
-first, it has to be acquired. Then, it has to be encoded in
-data-structures and algorithms. As the previous example shows, there
-is a lot of subtlety involved in music engraving, and unfortunately,
-only a small fraction of these tiny details are documented.
-
-One reason for the time that it takes to become a master engraver, is
-that all these details must be learned either from experience or from
-other engravers: as an engraver gets older and wiser, he will be able
+The fragment only uses quarter notes: notes that are played in a
+constant rhythm. The spacing should reflect that. Unfortunately, the
+eye deceives us a little: not only does it notice the distance between
+note heads, it also takes into account the distance between
+consecutive stems. As a result, the notes of an up-stem/down-stem
+combination should be put farther apart, and the notes of a down-up
+combination should be put closer together, all depending on the
+combined vertical positions of the notes. The first two measures are
+printed with this correction, the last two measures without. The notes
+in the last two measures form down-stem/up-stems clumps of notes.
+
+@node Typography and program architecture
+@section Typography and program architecture
+
+Producing good engraving requires skill and knowledge. As the
+previous examples show, there is a lot of subtlety involved in music
+engraving, and unfortunately, only a small fraction of these details
+are documented. Master engravers must learn all these details from
+experience or from other engravers, which is why it takes so long to
+become a master. As an engraver gets older and wiser, he will be able
to produce better and more complex pieces. A similar situation is
-present when putting typography into computer programs. It is not
-possible to come up with a final solution for a problem at the first
-try. Instead, we start out with simple solution that might cover 75%
-of the cases, and gradually refine that solution over the course of
-months or years, so that 90 or 95 % of the cases are handled.
-
-This has an important implication for the design of the
-program. During development, almost every piece of formatting code
-must be considered as temporary. When the need arises, is to be
-replaced a solution that will cover even more cases. A clean way to
-accomplish this, is a ``plug-in'' architecture: an architecture where
-new pieces of code can be inserted in the program dynamically. In
-such a program, a new solution can be developed along-side the
-existing code. It can be perfected separately until it is better than
-the existing solution, at which point, the new solution is switched on
-by default, and the old one is removed.
+present when putting typographical knowledge into a computer program.
+It is not possible to come up with a definitive solution for a problem
+at the first try. Instead, we start out with simple solution that
+might cover 75% of the cases, and gradually refine that solution over
+the course of months or years, so 90 or 95 % of the cases are
+handled.
+
+This has an important implication for the design of the program: at
+any time, almost every piece of formatting code must be considered as
+temporary. When the need arises, it is to be replaced a solution that
+will cover even more cases. A ``plug-in'' architecture is a clean
+way to accomplish this. This is an architecture where new pieces of
+code can be inserted in the program dynamically. In such a program, a
+new solution can be developed along-side the existing code. For
+testing, it is plugged in, but for production use, the old solution is
+used. The new module can be perfected separately until it is better
+than the existing solution, at which point it replaces the old one.
Until that time, users must have a way to deal with imperfections:
these 25%, 10% or 5% of the cases that are not handled
automatically. In these cases, a user must be able to override
-formatting decisions. A way to accomplish this, is to store decisions
-in generic variables, and let the user manipulate these variables.
-For example, consider the following fragment of notation.
+formatting decisions. To accomplish this we store decisions in generic
+variables, and let the user manipulate thosed. For example, consider
+the following fragment of notation:
@lilypond
-\score { \notes {
- g'4-\f g4
+\score { \notes \relative c'' {
+\stemUp
+ a4_\f f,8
}
\paper { raggedright = ##t }
}
The position of the forte symbol is slightly awkward, because it is
next to the low note, whereas dynamics should be below notes in
general. This may be remedied by inserting extra space between the
-high note and the `f', as shown in this example
+high note and the `f', as shown in this example:
@lilypond
-\score { \notes {
- \once\property Voice. DynamicLineSpanner \override #'padding = #4.0
- g'4-\f g4
+\score { \notes \relative c'' {
+\stemUp
+ \once\override DynamicLineSpanner #'padding = #4.0
+ a4_\f f,8
}
\paper { raggedright = ##t }
}
@end lilypond
-This was achieved with the input statement
+This was achieved with the following input statement:
@example
- \property Voice. DynamicLineSpanner \override #'padding = #4.0
+ \once \override DynamicLineSpanner #'padding = #4.0
@end example
-which increases the amount of space (@code{padding}) between the note
-and the dynamic symbol to 4.0 (which is measured in staff space, so
-4.0 equals the height of a staff).
+It increases the amount of space (@code{padding}) between the note and
+the dynamic symbol to 4.0 (which is measured in staff space, so 4.0
+equals the height of a staff). The keyword @code{\once} indicates that
+this is a tweak: it is only done one time.
Both design aspects, a plug-in architecture, and formatting variables,
are built on top of GUILE, an interpreter for the programming language
default layout, and wants heavier stems. Normally, they are @code{1.3}
times the thickness of staff lines, but suppose that their editions
require them to be twice the thickness of the staff lines. The same
-mechanism can be used to adjust a setting globally. By issuing
+mechanism can be used to adjust a setting globally. By issuing the
+following command, the entire piece is now formatted with thicker stems:
@example
- \property Score.Stem \override #'thickness = #2.0
+ \override Score.Stem #'thickness = #3.0
@end example
-the entire piece is formatted with thick stems:
+
@lilypond
-\score { \notes {
- \property Score.Stem \override #'thickness = #2.0
- \once\property Voice. DynamicLineSpanner \override #'padding = #4.0
- g'4-\f g4
+\score { \notes \relative c'' {
+ \override Score.Stem #'thickness = #3.0
+ \once\override DynamicLineSpanner #'padding = #4.0
+\stemUp
+ a4_\f f,8
}
\paper { raggedright = ##t }
}
@code{Side_position_interface::aligned_side}. If we want to replace
this function by a more advanced one, we could issue
@example
- \property Voice.DynamicLineSpanner \override #'Y-offset-callbacks
- = #`(,gee-whiz-gadget)
+ \override DynamicLineSpanner #'Y-offset-callbacks
+ = #(list gee-whiz-gadget)
@end example
@noindent
there is no need to fear: normally, it is not necessary to define
style-sheets or rewrite formatting functions. In fact, LilyPond gets a
lot of formatting right automatically, so adjusting individual layout
-situations is not needed very often at all.
+situations is not needed often at all.
@node Music representation
@section Music representation
-One of the big questions when writing batch programs, is what kind of
-input the program should expect. Many music notation programs offer a
-graphical interface that shows notation, and allow you to enter the
-music by placing notes on a staff. From our point of view, this design
-is a form of cheating. After all, the core message of a piece of music
-notation simply is the music itself. If you start by offering notation
-to the user, you have already skipped one conversion, even if it is
-implicit. If we want to generate music notation from something else,
-then the obvious candidate for the source is the music itself.
+Our premise is that LilyPond is a system that does music formatting
+completely automatically. Under this assumption, the output does not
+have to be touched up. Consequently, an interactive display of the
+output, where it is possible to reposition notation elements, is
+superfluous. This implies that the program should be a batch program:
+the input is entered in a file, which then is @emph{compiled}, i.e.
+put through the program. The final output is produced as a file ready
+to view or print. The compiler fills in all the details of the
+notation, those details should be left out of the input file. In other
+words, the input should mirror the content as closely as possible. In
+the case of music notation the content is the music itself, so that is
+what the input should consist of.
On paper this theory sounds very good. In practice, it opens a can of
worms. What really @emph{is} music? Many philosophical treatises must
There are also more practical concerns. Our users have to key in the
music into the file directly, so the input format should have a
-friendly syntax. As programmers and scientists, we want a
-clean formal definition. After all, producing music notation is a
-difficult problem, and in the scientific world, problems can only be
-solved if they are well-specified. Moreover, formally defined formats
-are easier to write programs for.
-
-These ideas shaped our music representation: it is a compact format
-that can easily be typed by hand. It complex musical constructs from
-simple entities like notes and rests, in much the same way that one
-builds complex formulas from simple expressions such as numbers and
-mathematical operators.
+friendly syntax: a quarter note C is entered as @code{c4}, the code
+@code{r8.} signifies a dotted eighth rest.
+
+Notes and rests form the simplest musical expressions in the input
+syntax. More complex constructs are produced by combining them into
+compound structures. This is done in much the same way that complex
+mathematical formulas are built from simple expressions such as
+numbers and operators.
+
+In effect, the input format is a language, and the rules of that
+language can be specified succinctly with a so-called context-free
+grammar. The grammar formally specificies what types of input form
+valid `sentences'. Reading such languages, and splitting them into
+grammatical structures is a problem with standard solutions.
+Moreover, rigid definitions make the format easier to understand: a
+concise formal definition permits a simple informal description.
+
+The user-interface of LilyPond is its syntax. That part is what users
+see most. As a results, some users think that music representation is
+a very important or interesting problem. In reality, less than 10% of
+the source code of the program handles reading and representing the
+input, and they form the easy bits of the program. In our opinion,
+producing music notation, and formatting it prettily are much more
+interesting and important than music representation: solving
+these problems takes up most of the bulk of the code, and they are the
+most difficult things to get right.
@node Example applications
@section Example applications
-As programmers and hedonists we enjoy beauty in code, and code that
-produces beautiful typeset music, but nevertheless this program can
-applied to do useful things. In this section, we show a few small
-examples of what is possible.
-
-The simplest application is printing notes.
+We have written LilyPond as an experiment of how to condense the art
+of music engraving into a computer program. Thanks to all that hard
+work, the program can now be used to perform useful tasks. The
+simplest application is printing notes:
@lilypond[relative=1]
\time 2/4 c4 c g'4 g a4 a g2
@end lilypond
-To these notes, chord names and lyrics may be added, yielding
-a lead sheet.
+By adding chord names and lyrics we obtain a lead sheet:
@lilypond[raggedright]
-\score { <
+\score { <<
\context ChordNames \chords { c2 c f2 c }
\notes \relative c' { \time 2/4 c4 c g'4 g a4 a g2 }
- \context Lyrics \lyrics { twin4 kle twin kle lit tle star2 } > }
+ \context Lyrics \lyrics { twin4 kle twin kle lit tle star2 } >> }
@end lilypond
-The following example combines some more exotic uses of notation
+Polyphonic notation and piano music can also be printed. The following
+example combines some more exotic constructs:
@lilypondfile{screech-boink.ly}
-The fragments shown above have all been written by hand, but that is not
-a requirement. Since the formatting engine is mostly automatic, it can
-serve as an output means for other programs that manipulate music. It
-can also be used to convert databases of musical fragments to images for
-use on websites on multimedia presentations.
+The fragments shown above have all been written by hand, but that is
+not a requirement. Since the formatting engine is mostly automatic, it
+can serve as an output means for other programs that manipulate
+music. For example, it can also be used to convert databases of
+musical fragments to images for use on websites and multimedia
+presentations.
This manual also shows an application: the input format is plain text,
and can therefore be easily embedded in other text-based formats, such
@node About this manual
@section About this manual
-The manual is divided into the following chapters
+The manual is divided into the following chapters:
@itemize @bullet
@item
@ifhtml The
@end ifhtml
@emph{@ref{Tutorial}}
-gives a gentle introduction into typesetting music.
+gives a gentle introduction to typesetting music.
First time users should start here.
@item
@ifhtml
The
@end ifhtml
@emph{@ref{Notation manual}}
-discusses topics grouped by notation construct.
+discusses topics grouped by notation construct. Once you master the
+basics, this is the place to look up details.
+@item
+@ifhtml
+The
+@end ifhtml
+@emph{@ref{Literature list}}
+ contains a set of useful reference books, for those who wish to know
+ more on notation and engraving.
@item
@ifhtml
The
@end ifhtml
@emph{@ref{Technical manual}}
@c
-discusses the general design of the program, and how to extend
+discusses the general design of the program, and how to extend its
functionality.
@item
@ifhtml
- The chapter
+The chapter
@end ifhtml
@emph{@ref{Invoking LilyPond}} explains how to run LilyPond and its helper
programs.
+
+@item
+@ifhtml
+The
+@end ifhtml
+@emph{@ref{lilypond-book manual}}
+explains the details behind creating documents with in-line music
+examples (like this manual).
+
+
+@item
+@ifhtml
+The chapter
+@end ifhtml
+@emph{@ref{Converting from other formats}}
+explains how to run the conversion programs. These programs
+are supplied with the LilyPond package, and convert a variety of music
+formats to the @code{.ly} format. In addition, this section explains
+how to upgrade input files from previous versions of LilyPond.
+
@end itemize
-Once you are experienced, you can simply use the manual as reference:
+Once you are an experienced user, you can use the manual as reference:
there is an extensive index@footnote{If you are looking for something,
-and you cannot find it by using the index, that is considered a bug.
-In that case, please file a bug report}, but the document is also
+and you cannot find it in the manual, that is considered a bug. In
+that case, please file a bug report.}, but the document is also
available in
@ifnothtml
a big HTML page,
@cindex using the manual
-If you are not familiar with music notation, or music terminology
-(especially if you are a foreigner), then it is advisable to consult
-the glossary as well. The glossary explains musical terms, and
-includes translations to various languages. It is a
+If you are not familiar with music notation or music terminology
+(especially if you are a non-native English speaker), then it is
+advisable to consult the glossary as well. The glossary explains
+musical terms, and includes translations to various languages. It is a
@ifhtml
-@uref{../glossary.html,separate document}
+@uref{../music-glossary.html,separate document}.
@end ifhtml
@ifnothtml
-separate document, available in HTML and PDF and can be printed as
-well.
+separate document, available in HTML and PDF.
@end ifnothtml
@cindex idiom
@cindex jargon
This manual is not complete without a number of other documents. They
are not available in print, but should be included with the
-documentation package for your platform
+documentation package for your platform:
@itemize @bullet
@item
-Generated internal documentation.
+Program reference
@ifhtml
-available @uref{../lilypond-internals/lilypond-internals.html,here}
+(available @uref{../lilypond-internals/lilypond-internals.html,here})
@end ifhtml
+The program reference is a set of heavily crosslinked HTML pages,
+which documents the nit-gritty details of each and every LilyPond
+class, object and function. It is produced directly from the
+formatting definitions used.
+
Almost all formatting functionality that is used internally, is
available directly to the user. For example, all variables that
control thicknesses, distances, etc, can be changed in input
-files. There are a huge number of formatting options, and it would be
-impossible to describe them all in a hand-written manual. The
-generated internal documentation is a heavily crosslinked HTML
-document, produced directly from the formatting definitions used. It
-documents the nit-gritty details of each and every LilyPond class, object and
-function.
-
-Each section of the reference manual has a @b{See also}
-subsection, with links (in the HTML document, at least) to the
-generated documentation.
+files. There are a huge number of formatting options, and all of them
+are described in the generated documentation. Each section of the
+notation manual has a @b{See also} subsection, which refers to the
+the generated documentation. In the HTML document, these subsections
+have clickable links.
@item
Templates
@ifhtml
-(available @uref{../../../input/templates/out-www/collated-files.html,here})
+(available @uref{../../../input/template/out-www/collated-files.html,here})
@end ifhtml
-When you have gone through the tutorial, in theory you are able to
-start writing input files. In practice, writing files from scratch
-turns out to be intimidating. To give a headstart, we have collected
-a number of often-used formats in example files. These files can be
-used as a start, by copying the template, and adding notes in the
-appropriate places.
+After you have gone through the tutorial, you should be able to write
+input files. In practice, writing files from scratch turns out to be
+intimidating. To give you a headstart, we have collected a number of
+often-used formats in example files. These files can be used as a
+start: simply copy the template, and add notes in the appropriate
+places.
@item
Various input examples
@ifhtml
-available @uref{../../../input/test/out-www/collated-files.html,here}
+(available @uref{../../../../input/test/out-www/collated-files.html,here})
@end ifhtml
@cindex snippets
@item
- The regression test
+ The regression tests
@ifhtml
-available @uref{../../../input/regression/out-www/collated-files.html,here}
+(available @uref{../../../input/regression/out-www/collated-files.html,here})
@end ifhtml
-We strive to test each feature in one test file. This collection of is
-primarily to help us debug problems, but it can be instructive to see
-how we excercise the program. The format is like the input examples.
+This collection of files tests each notation and engraving feature of
+LilyPond in one file. The collection is primarily there to help us
+debug problems, but it can be instructive to see how we excercise the
+program. The format is like the tips and tricks document.
@end itemize
+In all HTML documents that have music fragments embedded, the LilyPond
+input that was used to produce that image can be viewed by clicking
+the image.
+
The location of the documentation files that are mentioned here can
vary from system to system. On occasion, this manual refers to
initialization and example files. Throughout this manual, we refer to
@cindex index
Finally, this and all other manuals, are available online both as PDF
-files for print and HTML files for browsing. They are available from
-the web site, which can be found at @uref{http://www.lilypond.org/}.
+files and HTML from the web site, which can be found at
+@uref{http://www.lilypond.org/}.
@cindex website
@cindex URL
projects / lilypond.git / blobdiff