1 @c -*- coding: utf-8; mode: texinfo; -*-
3 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
5 When revising a translation, copy the HEAD committish of the
6 version that you are working on. See TRANSLATION for details.
12 @divClass{heading-center}
13 @heading Documentation for LilyPond 2.12.2
17 @divClass{column-center-top}
18 @subheading Introduction
22 @item @ref{Text input}:
23 LilyPond is a @strong{text-based} music engraver. If you are not
24 familiar with this concept, please read this now!
27 a @qq{must-read} gentle introduction to LilyPond.
30 @emph{(optional reading)}
31 explains musical terms and gives translations for users unfamiliar
32 with English musical terms.
35 @emph{(optional reading)}
36 background information about the engraving process and the
37 aesthetics of 19th century music engraving.
44 @divClass{column-left-top}
45 @subheading Regular use
50 the main portion of the documentation; provides detailed
51 information about creating notation.
54 short tricks, tips, and examples.
57 discusses the actual programs and operating system-specific
65 @divClass{column-right-top}
66 @subheading Infrequent Use
71 links to the answers of Frequently Asked Questions.
74 updates since the last major version.
76 @item @ref{Internals}:
77 information about LilyPond's internal structures, which is
78 required for constructing tweaks.
85 @divClass{column-center-bottom}
86 @subheading Other material
90 @item @ref{Translated}:
91 translation status for non-English readers.
94 manuals for older versions.
96 @item @ref{Development}:
97 manuals for the unstable version.
100 these manuals are published under the GNU Free Documentation
110 * Learning:: Learning.
111 * Glossary:: Glossary.
113 * Notation:: Reference.
115 * Snippets:: Snippets.
118 * Internals:: Internals.
119 * Translated:: Translation.
127 @c TRANSLATORS: most of the text in this file came from
128 @c LM 1.1 About the documentation (before this section was
129 @c removed in July 2009).
132 @unnumberedsec Learning
134 This book explains how to begin learning LilyPond, as well as
135 explaining some key concepts in easy terms. You should read these
136 chapters in a linear fashion.
138 There is a paragraph @strong{See also} at the end of each section,
139 which contains cross-references to other sections: you should not
140 follow these cross-references at first reading; when you have read
141 all of the Learning, you may want to read some sections
142 again and follow cross-references for further reading.
148 @rlearning{Tutorial}: gives a gentle introduction to typesetting music.
149 First time users should start here.
152 @rlearning{Fundamental concepts}: explains some general concepts about
153 the LilyPond file format. If you are not certain where to place a
154 command, read this chapter!
157 @rlearning{Tweaking output}: shows how to change the default engraving
158 that LilyPond produces.
161 @rlearning{Working on LilyPond projects}: discusses practical uses of
162 LilyPond and how to avoid some common problems. Read this before
163 undertaking large projects!
167 The Learning also contains appendices which are not part of the
168 recommended linear reading. They may be useful for later
174 @rlearning{Templates}: shows ready-made templates of LilyPond pieces.
175 Just cut and paste a template into a file, add notes, and you're
179 @rlearning{Scheme tutorial}: presents a short introduction to Scheme,
180 the programming language that music functions use. This is
181 material for advanced tweaks; many users never touch Scheme at
188 @unnumberedsec Glossary
190 @rglosnamed{Top,Music glossary}
191 this explains musical terms, and includes translations to various
192 languages. If you are not familiar with music notation or music
193 terminology (especially if you are a non-native English speaker),
194 it is highly advisable to consult the glossary.
204 @unnumberedsec Notation
206 This book explains all the LilyPond commands which produce
209 @warning{The Notation assumes that the reader knows
210 basic material covered in the Learning and is familiar with
211 the English musical terms presented in the Musical Glossary.}
216 @ruser{Musical notation}:
217 discusses topics grouped by notation construct. This section
218 gives details about basic notation that will be useful in almost
219 any notation project.
222 @ruser{Specialist notation}:
223 discusses topics grouped by notation construct. This section
224 gives details about special notation that will only be useful for
225 particular instrument (or vocal) groups.
228 @ruser{General input and output}:
229 discusses general information about LilyPond input files and
233 @ruser{Spacing issues}:
234 discusses issues which affect the global output, such as selecting
235 paper size or specifying page breaks.
238 @ruser{Changing defaults}:
239 explains how to tweak LilyPond to produce exactly the notation you
243 @ruser{Interfaces for programmers}:
244 explains how to create music functions with scheme.
248 The Notation also contains appendices with useful
254 @ruser{Literature list}:
255 contains a set of useful reference books for those who wish to
256 know more on notation and engraving.
259 @ruser{Notation manual tables}:
260 are a set of tables showing the chord names, MIDI instruments, a
261 list of color names, and the Feta font.
265 is a handy reference of the most common LilyPond commands.
268 @ruser{LilyPond command index}:
269 an index of all LilyPond @code{\commands}.
272 @ruser{LilyPond index}:
281 This book explains how to execute the programs and how to integrate
282 LilyPond notation with other programs.
288 explains how to install LilyPond, including compilation if
293 describes how to configure your computer for optimum LilyPond
294 usage, such as using special environments for certain text
298 @rprogram{Running LilyPond}:
299 shows how to run LilyPond and its helper programs. In addition,
300 this section explains how to upgrade input files from previous
301 versions of LilyPond.
304 @rprogram{LilyPond-book}:
305 explains the details behind creating documents with in-line music
306 examples, like this manual.
309 @rprogram{Converting from other formats}:
310 explains how to run the conversion programs. These programs are
311 supplied with the LilyPond package, and convert a variety of music
312 formats to the @code{.ly} format.
318 @unnumberedsec Snippets
320 @rlsrnamed{Top,LilyPond Snippets}: this shows a
321 selected set of LilyPond snippets from the
322 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
323 (LSR). All the snippets are in the public domain.
325 Please note that this document is not an exact subset of LSR. LSR
326 is running a stable LilyPond version, so any snippet which
327 demonstrates new features of a development version must be added
328 separately. These are stored in @file{input/new/} in the LilyPond
331 The list of snippets for each subsection of the Notation are
332 also linked from the @strong{See also} portion.
338 @warning{to be moved into the actual Documentation/ in master)}
341 @subheading Where are the graphical canvas, menus, and toolbars?
343 LilyPond requires you to write music as text. Please read about
344 our @ref{Text input}.
347 @subheading There's a lot of documentation! Do I need to read it?
349 You need to read the @ref{Learning}. As for the rest of
350 documentation, you only need to read the sections which discuss
351 the notation that you wish to create.
354 @subheading That's still a lot of reading! Is it worth it?
356 Please decide for yourself; the reasons why you might want to use
357 LilyPond are given in the @ref{Introduction}.
360 @subheading Something isn't working! How do I fix it?
362 This is explained in @@ref@{FIXME LM or AU x.y@}.
365 @subheading Why do you change the syntax?
367 This is explained in @@ref@{FIXME AU x.y@}.
371 @unnumberedsec Changes
373 previous-named "NEWS" doc.
375 this is a summary of important changes
376 and new features in LilyPond since the previous version.
381 @unnumberedsec Internals
383 @rinternalsnamed{Top,Internals}: this is a set
384 of heavily cross linked HTML pages which document the nitty-gritty
385 details of each and every LilyPond class, object, and function.
386 It is produced directly from the formatting definitions in the
389 Almost all formatting functionality that is used internally is
390 available directly to the user. For example, most variables that
391 control thickness values, distances, etc., can be changed in input
392 files. There are a huge number of formatting options, and all of
393 them are described in this document. Each section of the Notation
394 Reference has a @b{See also} subsection, which refers to the
395 generated documentation. In the HTML document, these subsections
396 have clickable links.
401 @unnumberedsec Translated
409 Documentation for previous stable versions:
413 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
414 LilyPond 2.12 Documentation}
416 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
417 LilyPond 2.10 Documentation}
419 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
420 LilyPond 2.8 Documentation}
430 @divClass{column-center-top}
431 @subheading Documentation license
433 The documentation for GNU LilyPond is published under the GNU Free
434 Documentation License. An introduction to this license, and our
435 reasons for choosing it, is given in @ref{Freedom}.
439 @divClass{column-center-bottom}
440 @subheading GNU Free Documentation License 1.1