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 @c TODO: do we want these links to be in larger text / bold ? CSS.
19 @c if you change this page, also change All.
20 @divClass{column-center-top}
21 @subheading Introduction
25 @item @ref{Text input}:
26 LilyPond is a @strong{text-based} music engraver. If you are not
27 familiar with this concept, please read this now!
30 a @qq{must-read} gentle introduction to LilyPond.
33 @emph{(optional reading)}
34 explains musical terms and gives translations for users unfamiliar
35 with English musical terms.
38 @emph{(optional reading)}
39 background information about the engraving process and the
40 aesthetics of 19th century music engraving.
47 @divClass{column-left-top}
48 @subheading Regular use
53 the main portion of the documentation; provides detailed
54 information about creating notation.
57 discusses the actual programs and operating system-specific
61 short tricks, tips, and examples.
68 @divClass{column-right-top}
69 @subheading Infrequent Use
74 links to the answers of Frequently Asked Questions.
77 updates since the last major version.
80 programming fancy tweaks in LilyPond.
82 @item @ref{Internals}:
83 information about LilyPond's internal structures, which is
84 required for constructing tweaks.
91 @divClass{column-center-bottom}
92 @subheading Other material
96 @item @ref{Translated}:
97 translation status for non-English readers.
100 quick links, downloadable manuals, and old manuals.
102 @item @ref{Development}:
103 manuals for the unstable version.
106 these manuals are published under the GNU Free Documentation
116 * Learning:: Learning.
117 * Glossary:: Glossary.
119 * Notation:: Reference.
121 * Snippets:: Snippets.
124 * Extend:: Programming.
125 * Internals:: Internals.
126 * Translated:: Translation.
134 @c TRANSLATORS: most of the text in this file came from
135 @c LM 1.1 About the documentation (before this section was
136 @c removed in July 2009).
139 @unnumberedsec Learning
141 @divClass{column-left-top}
142 @subheading Learning manual
144 This book explains how to begin learning LilyPond, as well as
145 explaining some key concepts in easy terms. You should read these
146 chapters in a linear fashion.
148 There is a paragraph @strong{See also} at the end of each section,
149 which contains cross-references to other sections: you should not
150 follow these cross-references at first reading. When you have
151 read all of the manual, you may want to read some sections again
152 and follow those cross-references for more information.
155 @divClass{column-right-bottom}
160 @item @rlearningnamed{Top,Learning}:
161 read this manual in the same format as this one.
165 @subheading All formats
167 @divClass{keep-bullets}
170 @item @uref{../learning/index.html, Learning (split HTML)}:
171 the manual is split between many HTML pages.
172 @emph{(small download for each page)}
174 @item @uref{../learning-big-page.html, Learning (big HTML)}:
175 read this manual as one huge HTML page.
176 @emph{(large single download, around 10? Mb)}
178 @item @uref{../learning.pdf, learning.pdf}:
179 download as a PDF file.
180 @emph{(large single download, 2.8 Mb)}
182 @c TODO: should make links to info?
183 @c @item @uref{../TODO, learning.info}:
184 @c GNU info format for documentation. link broken.
192 @unnumberedsec Glossary
194 @divClass{column-left-top}
197 This explains musical terms, and includes translations to various
198 languages. If you are not familiar with music notation or music
199 terminology (especially if you are a non-native English speaker),
200 it is highly advisable to consult the glossary.
204 @divClass{column-right-bottom}
209 @item @rglosnamed{Top,Music glossary}:
210 read this manual in the same format as this one.
214 @subheading All formats
216 @divClass{keep-bullets}
219 @item @uref{../music-glossary/index.html, Glossary (split HTML)}:
220 the manual is split between many HTML pages.
221 @emph{(small download for each page)}
223 @item @uref{../music-glossary-big-page.html, Glossay (big HTML)}:
224 read this manual as one huge HTML page.
225 @emph{(large single download, around 10? Mb)}
227 @item @uref{../music-glossary.pdf, glossary.pdf}:
228 download as a PDF file.
229 @emph{(large single download, 2.8 Mb)}
231 @c @item @uref{../TODO, glossary.info}:
232 @c GNU info format for documentation. TODO, link broken.
242 @divClass{column-left-top}
245 This book gives a brief history of music typography, followed by
246 an examination of LilyPond's engraving techniques. A comparison
247 between LilyPond and other music engraving systems is given.
249 @warning{The detailed typographical examples are easier to analyze
250 in the PDF version due to its higher resolution.}
254 @divClass{column-right-bottom}
259 @item @ressaynamed{Top,Essay}:
260 read this manual in the same format as this one.
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 ?? Mb)}
277 @item @uref{../essay.pdf, essay.pdf}:
278 download as a PDF file.
279 @emph{(large single download, ?? Mb)}
281 @c @item @uref{../TODO, essay.info}:
282 @c GNU info format for documentation. TODO, 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-bottom}
309 @item @rusernamed{Top,Notation}:
310 read this manual in the same format as this one.
314 @subheading All formats
316 @divClass{keep-bullets}
319 @item @uref{../notation/index.html, Notation (split HTML)}:
320 the manual is split between many HTML pages.
321 @emph{(small download for each page)}
323 @item @uref{../notation-big-page.html, Notation (big HTML)}:
324 read this manual as one huge HTML page.
325 @emph{(large single download, around 10? Mb)}
327 @item @uref{../notation.pdf, notation.pdf}:
328 download as a PDF file.
329 @emph{(large single download, 2.8 Mb)}
331 @c @item @uref{../TODO, notation.info}:
332 @c GNU info format for documentation. TODO, link broken.
342 @divClass{column-left-top}
343 @subheading Usage manual
345 This book explains how to execute the programs, how to integrate
346 LilyPond notation with other programs, and suggests @qq{best
347 practices} for efficient use. It is recommended reading before
348 attempting any large projects.
351 @divClass{column-right-bottom}
356 @item @rprogramnamed{Top,Usage}:
357 read this manual in the same format as this one.
361 @subheading All formats
363 @divClass{keep-bullets}
366 @item @uref{../usage/index.html, Usage (split HTML)}:
367 the manual is split between many HTML pages.
368 @emph{(small download for each page)}
370 @item @uref{../usage-big-page.html, Usage (big HTML)}:
371 read this manual as one huge HTML page.
372 @emph{(large single download, around 10? Mb)}
374 @item @uref{../usage.pdf, usage.pdf}:
375 download as a PDF file.
376 @emph{(large single download, 2.8 Mb)}
378 @c @item @uref{../TODO, lilypond-usage.info}:
379 @c GNU info format for documentation. TODO, link broken.
387 @unnumberedsec Snippets
389 @divClass{column-left-top}
392 This shows a selected set of LilyPond snippets from the
393 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
394 (LSR). All the snippets are in the public domain.
396 Please note that this document is not an exact subset of LSR. LSR
397 is running a stable LilyPond version, so any snippet which
398 demonstrates new features of a development version must be added
399 separately. These are stored in @file{input/new/} in the LilyPond
402 The list of snippets for each subsection of the Notation are also
403 linked from the @strong{See also} portion.
406 @divClass{column-right-bottom}
411 @item @rlsrnamed{Top,Snippets}:
412 read this manual in the same format as this one.
416 @subheading All formats
418 @divClass{keep-bullets}
421 @item @uref{../snippets/index.html, Snippets (split HTML)}:
422 the manual is split between many HTML pages.
423 @emph{(small download for each page)}
425 @item @uref{../snippets-big-page.html, Snippets (big HTML)}:
426 read this manual as one huge HTML page.
427 @emph{(large single download, around 10? Mb)}
429 @item @uref{../snippets.pdf, snippets.pdf}:
430 download as a PDF file.
431 @emph{(large single download, 2.8 Mb)}
433 @c @item @uref{../TODO, snippets.info}:
434 @c GNU info format for documentation. TODO, link broken.
444 @divClass{column-center-top}
445 @subheading Introductory questions
447 @subsubheading Where are the graphical canvas, menus, and toolbars?
449 LilyPond requires you to write music as text. Please read about
450 our @ref{Text input}.
453 @subsubheading There's a lot of documentation! Do I need to read it?
455 You need to read the @ref{Learning, Learning manual}. As for the
456 rest of documentation, you only need to read the sections which
457 discuss the notation that you wish to create.
460 @subsubheading That's still a lot of reading! Is it worth it?
462 Please decide for yourself; the reasons why you might want to use
463 LilyPond are given in the @ref{Introduction}.
467 @divClass{column-center-bottom}
468 @subheading Usage questions
470 @subsubheading Something isn't working! How do I fix it?
472 This is explained in @rprogram{Troubleshooting}.
475 @subsubheading Why do you change the syntax?
477 This is explained in @rprogram{Why does the syntax change?}.
483 @unnumberedsec Changes
485 @divClass{column-left-top}
488 This is a summary of important changes and new features in
489 LilyPond since the previous stable version.
493 @divClass{column-right-bottom}
498 @item @rchangesnamed{Top,Changes}:
499 read this manual in the same format as this one.
503 @subheading All formats
505 @divClass{keep-bullets}
508 @item @uref{../changes/index.html, Changes (split HTML)}:
509 the manual is split between many HTML pages.
510 @emph{(small download for each page)}
512 @item @uref{../changes-big-page.html, Changes (big HTML)}:
513 read this manual as one huge HTML page.
514 @emph{(large single download, around 10? Mb)}
516 @item @uref{../changes.pdf, changes.pdf}:
517 download as a PDF file.
518 @emph{(small single download, 0.5 ?? Mb)}
520 @c @item @uref{../TODO, changes.info}:
521 @c GNU info format for documentation. TODO, link broken.
529 @unnumberedsec Extend
531 @divClass{column-left-top}
532 @subheading Extend LilyPond
534 This manual explains how to write extensions to LilyPond.
538 @divClass{column-right-bottom}
543 @item @rextendnamed{Top,Extend}:
544 read this manual in the same format as this one.
548 @subheading All formats
550 @divClass{keep-bullets}
553 @item @uref{../extending/index.html, Extend (split HTML)}:
554 the manual is split between many HTML pages.
555 @emph{(small download for each page)}
557 @item @uref{../extending-big-page.html, Extend (big HTML)}:
558 read this manual as one huge HTML page.
559 @emph{(large single download, around 10? Mb)}
561 @item @uref{../extending.pdf, extending.pdf}:
562 download as a PDF file.
563 @emph{(large single download, 2.8 Mb)}
565 @c @item @uref{../TODO, extending.info}:
566 @c GNU info format for documentation. TODO, link broken.
574 @unnumberedsec Internals
576 @divClass{column-left-top}
577 @subheading Internals reference
579 This is a set of heavily cross linked HTML pages which document
580 the nitty-gritty details of each and every LilyPond class, object,
581 and function. It is produced directly from the formatting
582 definitions in the source code.
584 Almost all formatting functionality that is used internally is
585 available directly to the user. For example, most variables that
586 control thickness values, distances, etc., can be changed in input
587 files. There are a huge number of formatting options, and all of
588 them are described in this document. Each section of the Notation
589 Reference has a @b{See also} subsection, which refers to the
590 generated documentation. In the HTML document, these subsections
591 have clickable links.
595 @divClass{column-right-bottom}
600 @item @rinternalsnamed{Top,Internals}:
601 read this manual in the same format as this one.
605 @subheading All formats
607 @divClass{keep-bullets}
610 @item @uref{../internals/index.html, Internals (split HTML)}:
611 the manual is split between many HTML pages.
612 @emph{(small download for each page)}
614 @item @uref{../internals-big-page.html, Internals (big HTML)}:
615 read this manual as one huge HTML page.
616 @emph{(large single download, around 10? Mb)}
618 @item @uref{../internals.pdf, internals.pdf}:
619 download as a PDF file.
620 @emph{(large single download, 2.8 Mb)}
622 @c @item @uref{../TODO, internals.info}:
623 @c GNU info format for documentation. TODO, link broken.
632 @unnumberedsec Translated
634 @divClass{column-center-bottom}
635 @subheading Translation status
637 TODO: clean up / prettify
639 @uref{../translations.html}.
647 @divClass{heading-center}
648 @heading Documentation quick links
650 Links to other formats of these manuals can be found in
655 @c this should match the (main) manual page.
656 @divClass{column-center-top}
657 @subheading Introduction
661 @item @rlearningnamed{Top,Learning}:
662 a @qq{must-read} gentle introduction to LilyPond.
664 @item @rglosnamed{Top,Glossary}:
665 @emph{(optional reading)}
666 explains musical terms and gives translations for users unfamiliar
667 with English musical terms.
669 @item @ressaynamed{Top,Essay}:
670 @emph{(optional reading)}
671 background information about the engraving process and the
672 aesthetics of 19th century music engraving.
678 @divClass{column-left-top}
679 @subheading Regular use
683 @item @rusernamed{Top,Notation}:
684 the main portion of the documentation; provides detailed
685 information about creating notation.
687 @item @rprogramnamed{Top,Usage}:
688 discusses the actual programs and operation system-specific
691 @item @rlsrnamed{Top,Snippets}:
692 short tricks, tips, and examples.
699 @divClass{column-right-top}
700 @subheading Infrequent Use
705 links to answers of Frequently Asked Questions.
707 @item @rchangesnamed{Top,Changes}:
708 updates since the last major version.
710 @item @rextendnamed{Top,Extend}:
711 programming fancy tweaks in LilyPond.
713 @item @rinternalsnamed{Top,Internals}:
714 information about LilyPond's internal structures, which is
715 required for constructing tweaks.
722 @divClass{column-center-bottom}
723 @subheading Downloadable versions
725 @help{compare tarball vs. zip size, ask about windows users
726 dealing with tarballs (both gz and bz2), etc.}
728 @help{on second thought, wait until the new doc build. write an
729 apology here for no tarballs}
731 @divClass{keep-bullets}
740 @item info zip maybe?!?!
746 @subheading Previous stable versions
748 @divClass{keep-bullets}
751 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
752 LilyPond 2.12 Documentation}
754 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
755 LilyPond 2.10 Documentation}
757 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
758 LilyPond 2.8 Documentation}
760 @help anybody want to write this stuff?
771 @divClass{column-center-top}
772 @subheading Documentation license
774 The documentation for GNU LilyPond is published under the GNU Free
775 Documentation License. An introduction to this license, and our
776 reasons for choosing it, is given in @ref{Freedom}.
780 @divClass{column-center-bottom}
781 @subheading GNU Free Documentation License 1.1