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 @version
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 discusses the actual programs and operating system-specific
58 short tricks, tips, and examples.
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.
77 programming fancy tweaks in lilypond.
79 @item @ref{Internals}:
80 information about LilyPond's internal structures, which is
81 required for constructing tweaks.
88 @divClass{column-center-bottom}
89 @subheading Other material
93 @item @ref{Translated}:
94 translation status for non-English readers.
97 manuals for older versions and downloadable versions.
99 @item @ref{Development}:
100 manuals for the unstable version.
103 these manuals are published under the GNU Free Documentation
113 * Learning:: Learning.
114 * Glossary:: Glossary.
116 * Notation:: Reference.
118 * Snippets:: Snippets.
121 * Extend:: Programming.
122 * Internals:: Internals.
123 * Translated:: Translation.
131 @c TRANSLATORS: most of the text in this file came from
132 @c LM 1.1 About the documentation (before this section was
133 @c removed in July 2009).
136 @unnumberedsec Learning
138 @divClass{column-left-top}
139 @subheading Learning manual
141 This book explains how to begin learning LilyPond, as well as
142 explaining some key concepts in easy terms. You should read these
143 chapters in a linear fashion.
145 There is a paragraph @strong{See also} at the end of each section,
146 which contains cross-references to other sections: you should not
147 follow these cross-references at first reading. When you have
148 read all of the manual, you may want to read some sections again
149 and follow those cross-references for more information.
152 @c FIXME: new format; please leave here.
153 @divClass{column-right-bottom}
158 @item @rlearningnamed{Top,Learning}:
159 read this manual in the same format as this one.
163 @subheading All formats
165 @divClass{keep-bullets}
168 @item @uref{learning/index.html, Learning (split HTML)}:
169 the manual is split between many HTML pages.
170 @emph{(small download for each page)}
172 @item @uref{learning-big-page.html, Learning (big HTML)}:
173 read this manual as one huge HTML page.
174 @emph{(large single download, around 10? Mb)}
176 @item @uref{learning.pdf, learning.pdf}:
177 download as a PDF file.
178 @emph{(large single download, 2.8 Mb)}
180 @item @uref{FIXME, learning.info}:
181 GNU info format for documentation. FIXME, link broken.
189 @unnumberedsec Glossary
191 @divClass{column-left-top}
194 This explains musical terms, and includes translations to various
195 languages. If you are not familiar with music notation or music
196 terminology (especially if you are a non-native English speaker),
197 it is highly advisable to consult the glossary.
201 @c FIXME: new format; please leave here.
202 @divClass{column-right-bottom}
207 @item @rglosnamed{Top,Music glossary}:
208 read this manual in the same format as this one.
212 @subheading All formats
214 @divClass{keep-bullets}
217 @item @uref{music-glossary/index.html, Glossary (split HTML)}:
218 the manual is split between many HTML pages.
219 @emph{(small download for each page)}
221 @item @uref{music-glossary-big-page.html, Glossay (big HTML)}:
222 read this manual as one huge HTML page.
223 @emph{(large single download, around 10? Mb)}
225 @item @uref{music-glossary.pdf, glossary.pdf}:
226 download as a PDF file.
227 @emph{(large single download, 2.8 Mb)}
229 @item @uref{FIXME, glossary.info}:
230 GNU info format for documentation. FIXME, link broken.
240 @divClass{column-left-top}
243 This book gives a brief history of music typography, followed by
244 an examination of LilyPond's engraving techniques. A comparison
245 between LilyPond and other music engraving systems is given.
247 @warning{The detailed typographical examples are easier to analyze
248 in the PDF version due to its higher resolution.}
252 @divClass{column-right-top}
257 @item @ressaynamed{Top,Essay}:
258 read this manual in the same format as this one.
263 @divClass{column-center-bottom}
264 @subheading All formats
266 @divClass{keep-bullets}
269 @item @uref{essay/index.html, Essay (split HTML)}:
270 the manual is split between many HTML pages.
271 @emph{(small download for each page)}
273 @item @uref{essay-big-page.html, Essay (big HTML)}:
274 read this manual as one huge HTML page.
275 @emph{(large single download, around FIXME? Mb)}
277 @item @uref{essay.pdf, essay.pdf}:
278 download as a PDF file.
279 @emph{(large single download, FIXME? Mb)}
281 @item @uref{FIXME, essay.info}:
282 GNU info format for documentation. FIXME, link broken.
290 @unnumberedsec Notation
292 @divClass{column-left-top}
293 @subheading Notation reference
295 This book explains all the LilyPond commands which produce
298 @warning{The Notation reference assumes that the reader knows
299 basic material covered in the Learning manual and is familiar with
300 the English musical terms presented in the Musical Glossary.}
304 @divClass{column-right-top}
309 @item @rusernamed{Top,Notation}:
310 read this manual in the same format as this one.
315 @divClass{column-center-bottom}
316 @subheading All formats
318 @divClass{keep-bullets}
321 @item @uref{notation/index.html, Notation (split HTML)}:
322 the manual is split between many HTML pages.
323 @emph{(small download for each page)}
325 @item @uref{notation-big-page.html, Notation (big HTML)}:
326 read this manual as one huge HTML page.
327 @emph{(large single download, around 10? Mb)}
329 @item @uref{notation.pdf, notation.pdf}:
330 download as a PDF file.
331 @emph{(large single download, 2.8 Mb)}
333 @item @uref{FIXME, notation.info}:
334 GNU info format for documentation. FIXME, link broken.
344 @divClass{column-left-top}
345 @subheading Usage manual
347 This book explains how to execute the programs, how to integrate
348 LilyPond notation with other programs, and suggests @qq{best
349 practices} for efficient use. It is recommended reading before
350 attempting any large projects.
353 @divClass{column-right-top}
358 @item @rprogramnamed{Top,Usage}:
359 read this manual in the same format as this one.
364 @divClass{column-center-bottom}
365 @subheading All formats
367 @divClass{keep-bullets}
370 @item @uref{usage/index.html, Usage (split HTML)}:
371 the manual is split between many HTML pages.
372 @emph{(small download for each page)}
374 @item @uref{usage-big-page.html, Usage (big HTML)}:
375 read this manual as one huge HTML page.
376 @emph{(large single download, around 10? Mb)}
378 @item @uref{usage.pdf, usage.pdf}:
379 download as a PDF file.
380 @emph{(large single download, 2.8 Mb)}
382 @item @uref{FIXME, lilypond-usage.info}:
383 GNU info format for documentation. FIXME, link broken.
391 @unnumberedsec Snippets
393 @divClass{column-left-top}
396 This shows a selected set of LilyPond snippets from the
397 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
398 (LSR). All the snippets are in the public domain.
400 Please note that this document is not an exact subset of LSR. LSR
401 is running a stable LilyPond version, so any snippet which
402 demonstrates new features of a development version must be added
403 separately. These are stored in @file{input/new/} in the LilyPond
406 The list of snippets for each subsection of the Notation are also
407 linked from the @strong{See also} portion.
410 @divClass{column-right-top}
415 @item @rlsrnamed{Top,Snippets}:
416 read this manual in the same format as this one.
421 @divClass{column-center-bottom}
422 @subheading All formats
424 @divClass{keep-bullets}
427 @item @uref{snippets/index.html, Snippets (split HTML)}:
428 the manual is split between many HTML pages.
429 @emph{(small download for each page)}
431 @item @uref{snippets-big-page.html, Snippets (big HTML)}:
432 read this manual as one huge HTML page.
433 @emph{(large single download, around 10? Mb)}
435 @item @uref{snippets.pdf, snippets.pdf}:
436 download as a PDF file.
437 @emph{(large single download, 2.8 Mb)}
439 @item @uref{FIXME, snippets.info}:
440 GNU info format for documentation. FIXME, link broken.
450 @divClass{column-center-top}
451 @subheading Introductory questions
453 @subsubheading Where are the graphical canvas, menus, and toolbars?
455 LilyPond requires you to write music as text. Please read about
456 our @ref{Text input}.
459 @subsubheading There's a lot of documentation! Do I need to read it?
461 You need to read the @ref{Learning, Learning manual}. As for the
462 rest of documentation, you only need to read the sections which
463 discuss the notation that you wish to create.
466 @subsubheading That's still a lot of reading! Is it worth it?
468 Please decide for yourself; the reasons why you might want to use
469 LilyPond are given in the @ref{Introduction}.
473 @divClass{column-center-bottom}
474 @subheading Usage questions
476 @subsubheading Something isn't working! How do I fix it?
478 This is explained in @rprogram{Troubleshooting}.
481 @subsubheading Why do you change the syntax?
483 This is explained in @rprogram{Why does the syntax change?}.
489 @unnumberedsec Changes
491 @divClass{column-left-top}
494 This is a summary of important changes and new features in
495 LilyPond since the previous stable version.
499 @divClass{column-right-top}
504 @item @rchangesnamed{Top,Changes}:
505 read this manual in the same format as this one.
510 @divClass{column-center-bottom}
511 @subheading All formats
513 @divClass{keep-bullets}
516 @c Changes isn't available as a split manual.
517 @c (maybe it should be, but it isn't so far)
518 @c @item @uref{changes/index.html, Changes (split HTML)}:
519 @c the manual is split between many HTML pages.
520 @c @emph{(small download for each page)}
522 @c @item @uref{changes-big-page.html, Changes (big HTML)}:
523 @c read this manual as one huge HTML page.
524 @c @emph{(large single download, around 10? Mb)}
526 @item @uref{changes.html, Changes}:
527 read this manual as a HTML page.
529 @item @uref{changes.pdf, changes.pdf}:
530 download as a PDF file.
531 @emph{(small single download, 0.5 ?? Mb)}
533 @item @uref{FIXME, changes.info}:
534 GNU info format for documentation. FIXME, link broken.
542 @unnumberedsec Extend
544 @divClass{column-left-top}
545 @subheading Extend LilyPond
547 This manual explains how to write extensions to LilyPond.
551 @divClass{column-right-top}
556 @item @rextendnamed{Top,Extend}:
557 read this manual in the same format as this one.
562 @divClass{column-center-bottom}
563 @subheading All formats
565 @divClass{keep-bullets}
568 @item @uref{extending/index.html, Extend (split HTML)}:
569 the manual is split between many HTML pages.
570 @emph{(small download for each page)}
572 @item @uref{extending-big-page.html, Extend (big HTML)}:
573 read this manual as one huge HTML page.
574 @emph{(large single download, around 10? Mb)}
576 @item @uref{extending.pdf, extending.pdf}:
577 download as a PDF file.
578 @emph{(large single download, 2.8 Mb)}
580 @item @uref{FIXME, extending.info}:
581 GNU info format for documentation. FIXME, link broken.
589 @unnumberedsec Internals
591 @divClass{column-left-top}
592 @subheading Internals reference
594 This is a set of heavily cross linked HTML pages which document
595 the nitty-gritty details of each and every LilyPond class, object,
596 and function. It is produced directly from the formatting
597 definitions in the source code.
599 Almost all formatting functionality that is used internally is
600 available directly to the user. For example, most variables that
601 control thickness values, distances, etc., can be changed in input
602 files. There are a huge number of formatting options, and all of
603 them are described in this document. Each section of the Notation
604 Reference has a @b{See also} subsection, which refers to the
605 generated documentation. In the HTML document, these subsections
606 have clickable links.
610 @divClass{column-right-top}
615 @item @rinternalsnamed{Top,Internals}:
616 read this manual in the same format as this one.
621 @divClass{column-center-bottom}
622 @subheading All formats
624 @divClass{keep-bullets}
627 @item @uref{internals/index.html, Internals (split HTML)}:
628 the manual is split between many HTML pages.
629 @emph{(small download for each page)}
631 @item @uref{internals-big-page.html, Internals (big HTML)}:
632 read this manual as one huge HTML page.
633 @emph{(large single download, around 10? Mb)}
635 @item @uref{internals.pdf, internals.pdf}:
636 download as a PDF file.
637 @emph{(large single download, 2.8 Mb)}
639 @item @uref{FIXME, internals.info}:
640 GNU info format for documentation. FIXME, link broken.
649 @unnumberedsec Translated
651 @divClass{column-center-bottom}
652 @subheading Translation status
654 TODO: clean up / prettify
656 @uref{translations.html}.
664 @divClass{column-left-top}
665 @subheading Downloadable versions
667 FIXME: compare tarball vs. zip size, ask about windows users
668 dealing with tarballs (both gz and bz2), etc.
670 @divClass{keep-bullets}
679 @item info zip maybe?!?!
686 @divClass{column-right-top}
687 @subheading Previous stable versions
689 @divClass{keep-bullets}
692 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
693 LilyPond 2.12 Documentation}
695 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
696 LilyPond 2.10 Documentation}
698 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
699 LilyPond 2.8 Documentation}
712 @divClass{column-center-top}
713 @subheading Documentation license
715 The documentation for GNU LilyPond is published under the GNU Free
716 Documentation License. An introduction to this license, and our
717 reasons for choosing it, is given in @ref{Freedom}.
721 @divClass{column-center-bottom}
722 @subheading GNU Free Documentation License 1.1