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 and downloadable 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 @divClass{column-left-top}
135 @subheading Learning manual
137 This book explains how to begin learning LilyPond, as well as
138 explaining some key concepts in easy terms. You should read these
139 chapters in a linear fashion.
141 There is a paragraph @strong{See also} at the end of each section,
142 which contains cross-references to other sections: you should not
143 follow these cross-references at first reading. When you have
144 read all of the manual, you may want to read some sections again
145 and follow those cross-references for more information.
148 @divClass{column-right-top}
149 @subheading Read it now
153 @item @rlearningnamed{Top,Learning}:
154 read this manual in the same format as this one.
159 @divClass{column-center-bottom}
160 @subheading Other formats
162 @divClass{keep-bullets}
165 @item @uref{../learning/index.html, Learning (split HTML)}:
166 the manual is split between many HTML pages.
167 @emph{(small download for each page)}
169 @item @uref{../learning-big-page.html, Learning (big HTML)}:
170 read this manual as one huge HTML page.
171 @emph{(large single download, around 10? Mb)}
173 @item @uref{../learning.pdf, learning.pdf}:
174 download as a PDF file.
175 @emph{(large single download, 2.8 Mb)}
177 @item @uref{FIXME, learning.info}:
178 GNU info format for documentation. FIXME, link broken.
186 @unnumberedsec Glossary
188 @divClass{column-left-top}
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.
198 @divClass{column-right-top}
199 @subheading Read it now
204 @rglosnamed{Top,Music glossary}:
205 read this manual in the same format as this one.
210 @divClass{column-center-bottom}
211 @subheading Other formats
213 @divClass{keep-bullets}
216 @item @uref{../glossary/index.html, Glossary (split HTML)}:
217 the manual is split between many HTML pages.
218 @emph{(small download for each page)}
220 @item @uref{../glossary-big-page.html, Glossay (big HTML)}:
221 read this manual as one huge HTML page.
222 @emph{(large single download, around 10? Mb)}
224 @item @uref{../glossary.pdf, glossary.pdf}:
225 download as a PDF file.
226 @emph{(large single download, 2.8 Mb)}
228 @item @uref{FIXME, glossary.info}:
229 GNU info format for documentation. FIXME, link broken.
239 @divClass{column-left-top}
242 This book gives a brief history of music typography, followed by
243 an examination of LilyPond's engraving techniques. A comparison
244 between LilyPond and other music engraving systems is given.
248 @divClass{column-right-top}
249 @subheading Read it now
253 @item @ressaynamed{Top,Essay}:
254 read this manual in the same format as this one.
259 @divClass{column-center-bottom}
260 @subheading Other formats
262 @divClass{keep-bullets}
265 @item @uref{../essay/index.html, Essay (split HTML)}:
266 the manual is split between many HTML pages.
267 @emph{(small download for each page)}
269 @item @uref{../essay-big-page.html, Essay (big HTML)}:
270 read this manual as one huge HTML page.
271 @emph{(large single download, around FIXME? Mb)}
273 @item @uref{../essay.pdf, essay.pdf}:
274 download as a PDF file.
275 @emph{(large single download, FIXME? Mb)}
277 @item @uref{FIXME, essay.info}:
278 GNU info format for documentation. FIXME, link broken.
286 @unnumberedsec Notation
288 @divClass{column-left-top}
289 @subheading Notation reference
291 This book explains all the LilyPond commands which produce
294 @warning{The Notation assumes that the reader knows
295 basic material covered in the Learning and is familiar with
296 the English musical terms presented in the Musical Glossary.}
299 @divClass{column-right-top}
300 @subheading Read it now
304 @item @rusernamed{Top,Notation}:
305 read this manual in the same format as this one.
310 @divClass{column-center-bottom}
311 @subheading Other formats
313 @divClass{keep-bullets}
316 @item @uref{../notation/index.html, Notation (split HTML)}:
317 the manual is split between many HTML pages.
318 @emph{(small download for each page)}
320 @item @uref{../notation-big-page.html, Notation (big HTML)}:
321 read this manual as one huge HTML page.
322 @emph{(large single download, around 10? Mb)}
324 @item @uref{../notation.pdf, notation.pdf}:
325 download as a PDF file.
326 @emph{(large single download, 2.8 Mb)}
328 @item @uref{FIXME, notation.info}:
329 GNU info format for documentation. FIXME, link broken.
339 @divClass{column-left-top}
340 @subheading Learning manual
342 This book explains how to execute the programs, how to integrate
343 LilyPond notation with other programs, and suggests @qq{best
344 practices} for efficient use. It is recommended reading before
345 attempting any large projects.
348 @divClass{column-right-top}
349 @subheading Read it now
353 @item @rprogramnamed{Top,Usage}:
354 read this manual in the same format as this one.
359 @divClass{column-center-bottom}
360 @subheading Other formats
362 @divClass{keep-bullets}
365 @item @uref{../application/index.html, Usage (split HTML)}:
366 the manual is split between many HTML pages.
367 @emph{(small download for each page)}
369 @item @uref{../application-big-page.html, Usage (big HTML)}:
370 read this manual as one huge HTML page.
371 @emph{(large single download, around 10? Mb)}
373 @item @uref{../application.pdf, application.pdf}:
374 download as a PDF file.
375 @emph{(large single download, 2.8 Mb)}
377 @item @uref{FIXME, application.info}:
378 GNU info format for documentation. FIXME, link broken.
386 @unnumberedsec Snippets
388 @divClass{column-left-top}
389 @subheading Learning manual
391 This shows a selected set of LilyPond snippets from the
392 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
393 (LSR). All the snippets are in the public domain.
395 Please note that this document is not an exact subset of LSR. LSR
396 is running a stable LilyPond version, so any snippet which
397 demonstrates new features of a development version must be added
398 separately. These are stored in @file{input/new/} in the LilyPond
401 The list of snippets for each subsection of the Notation are also
402 linked from the @strong{See also} portion.
405 @divClass{column-right-top}
406 @subheading Read it now
410 @item @rlsrnamed{Top,Snippets}:
411 read this manual in the same format as this one.
416 @divClass{column-center-bottom}
417 @subheading Other formats
419 @divClass{keep-bullets}
422 @item @uref{../snippets/index.html, Snippets (split HTML)}:
423 the manual is split between many HTML pages.
424 @emph{(small download for each page)}
426 @item @uref{../snippets-big-page.html, Snippets (big HTML)}:
427 read this manual as one huge HTML page.
428 @emph{(large single download, around 10? Mb)}
430 @item @uref{../snippets.pdf, snippets.pdf}:
431 download as a PDF file.
432 @emph{(large single download, 2.8 Mb)}
434 @item @uref{FIXME, snippets.info}:
435 GNU info format for documentation. FIXME, link broken.
445 @divClass{column-center-top}
446 @subheading Introductory questions
448 @subsubheading Where are the graphical canvas, menus, and toolbars?
450 LilyPond requires you to write music as text. Please read about
451 our @ref{Text input}.
454 @subsubheading There's a lot of documentation! Do I need to read it?
456 You need to read the @ref{Learning, Learning manual}. As for the
457 rest of documentation, you only need to read the sections which
458 discuss the notation that you wish to create.
461 @subsubheading That's still a lot of reading! Is it worth it?
463 Please decide for yourself; the reasons why you might want to use
464 LilyPond are given in the @ref{Introduction}.
468 @divClass{column-center-bottom}
469 @subheading Usage questions
471 @subsubheading Something isn't working! How do I fix it?
473 This is explained in @@ref@{FIXME LM or AU x.y@}.
476 @subsubheading Why do you change the syntax?
478 This is explained in @@ref@{FIXME AU x.y@}.
484 @unnumberedsec Changes
486 @divClass{column-left-top}
487 @subheading Learning manual
489 This is a summary of important changes and new features in
490 LilyPond since the previous stable version.
494 @divClass{column-right-top}
495 @subheading Read it now
499 @item @rchangesnamed{Top,Changes}:
500 read this manual in the same format as this one.
505 @divClass{column-center-bottom}
506 @subheading Other formats
508 @divClass{keep-bullets}
511 @c Changes isn't available as a split manual.
512 @c (maybe it should be, but it isn't so far)
513 @c @item @uref{../changes/index.html, Changes (split HTML)}:
514 @c the manual is split between many HTML pages.
515 @c @emph{(small download for each page)}
517 @c @item @uref{../changes-big-page.html, Changes (big HTML)}:
518 @c read this manual as one huge HTML page.
519 @c @emph{(large single download, around 10? Mb)}
521 @item @uref{../changes.html, Changes}:
522 read this manual as a HTML page.
524 @item @uref{../changes.pdf, changes.pdf}:
525 download as a PDF file.
526 @emph{(small single download, 0.5 ?? Mb)}
528 @item @uref{FIXME, changes.info}:
529 GNU info format for documentation. FIXME, link broken.
538 @unnumberedsec Internals
540 @divClass{column-left-top}
541 @subheading Learning manual
543 This is a set of heavily cross linked HTML pages which document
544 the nitty-gritty details of each and every LilyPond class, object,
545 and function. It is produced directly from the formatting
546 definitions in the source code.
548 Almost all formatting functionality that is used internally is
549 available directly to the user. For example, most variables that
550 control thickness values, distances, etc., can be changed in input
551 files. There are a huge number of formatting options, and all of
552 them are described in this document. Each section of the Notation
553 Reference has a @b{See also} subsection, which refers to the
554 generated documentation. In the HTML document, these subsections
555 have clickable links.
559 @divClass{column-right-top}
560 @subheading Read it now
564 @item @rinternalsnamed{Top,Internals}:
565 read this manual in the same format as this one.
570 @divClass{column-center-bottom}
571 @subheading Other formats
573 @divClass{keep-bullets}
576 @item @uref{../internals/index.html, Internals (split HTML)}:
577 the manual is split between many HTML pages.
578 @emph{(small download for each page)}
580 @item @uref{../internals-big-page.html, Internals (big HTML)}:
581 read this manual as one huge HTML page.
582 @emph{(large single download, around 10? Mb)}
584 @item @uref{../internals.pdf, internals.pdf}:
585 download as a PDF file.
586 @emph{(large single download, 2.8 Mb)}
588 @item @uref{FIXME, internals.info}:
589 GNU info format for documentation. FIXME, link broken.
598 @unnumberedsec Translated
606 @divClass{column-left-top}
607 @subheading Downloadable versions
609 FIXME: compare tarball vs. zip size, ask about windows users
610 dealing with tarballs (both gz and bz2), etc.
612 @divClass{keep-bullets}
621 @item info zip maybe?!?!
628 @divClass{column-right-top}
629 @subheading Previous stable versions
631 @divClass{keep-bullets}
634 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
635 LilyPond 2.12 Documentation}
637 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
638 LilyPond 2.10 Documentation}
640 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
641 LilyPond 2.8 Documentation}
654 @divClass{column-center-top}
655 @subheading Documentation license
657 The documentation for GNU LilyPond is published under the GNU Free
658 Documentation License. An introduction to this license, and our
659 reasons for choosing it, is given in @ref{Freedom}.
663 @divClass{column-center-bottom}
664 @subheading GNU Free Documentation License 1.1