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
77 links to the answers of Frequently Asked Questions.
80 updates since the last major version.
83 programming fancy tweaks in LilyPond.
85 @item @ref{Internals}:
86 information about LilyPond's internal structures, which is
87 required for constructing tweaks.
94 @divClass{column-center-bottom}
95 @subheading Other material
99 @item @ref{Translated}:
100 translation status for non-English readers.
103 quick links, downloadable manuals, and old manuals.
105 @item @ref{Development}:
106 manuals for the unstable version.
109 these manuals are published under the GNU Free Documentation
119 * Learning:: Learning.
120 * Glossary:: Glossary.
122 * Notation:: Reference.
124 * Snippets:: Snippets.
128 * Extend:: Programming.
129 * Internals:: Internals.
130 * Translated:: Translation.
138 @c TRANSLATORS: most of the text in this file came from
139 @c LM 1.1 About the documentation (before this section was
140 @c removed in July 2009).
143 @unnumberedsec Learning
145 @divClass{column-left-top}
146 @subheading Learning manual
148 This book explains how to begin learning LilyPond, as well as
149 explaining some key concepts in easy terms. You should read these
150 chapters in a linear fashion.
152 There is a paragraph @strong{See also} at the end of each section,
153 which contains cross-references to other sections: you should not
154 follow these cross-references at first reading. When you have
155 read all of the manual, you may want to read some sections again
156 and follow those cross-references for more information.
159 @divClass{column-right-bottom}
164 @item @rlearningnamed{Top,Learning}:
165 read this manual in the same format as this one.
169 @subheading All formats
171 @divClass{keep-bullets}
174 @item @uref{../learning/index.html, Learning (split HTML)}:
175 the manual is split between many HTML pages.
176 @*@ @ @emph{(small download for each page)}
178 @item @uref{../learning-big-page.html, Learning (big HTML)}:
179 read this manual as one huge HTML page.
180 @*@ @ @emph{(large single download, 1.5 Mb)}
182 @item @uref{../learning.pdf, learning.pdf}:
183 download as a PDF file.
184 @*@ @ @emph{(large single download, 3 Mb)}
186 @c TODO: should make links to info?
187 @c @item @uref{../TODO, learning.info}:
188 @c GNU info format for documentation. link broken.
196 @unnumberedsec Glossary
198 @divClass{column-left-top}
201 This explains musical terms, and includes translations to various
202 languages. If you are not familiar with music notation or music
203 terminology (especially if you are a non-native English speaker),
204 it is highly advisable to consult the glossary.
208 @divClass{column-right-bottom}
213 @item @rglosnamed{Top,Music glossary}:
214 read this manual in the same format as this one.
218 @subheading All formats
220 @divClass{keep-bullets}
223 @item @uref{../music-glossary/index.html, Glossary (split HTML)}:
224 the manual is split between many HTML pages.
225 @*@ @ @emph{(small download for each page)}
227 @item @uref{../music-glossary-big-page.html, Glossay (big HTML)}:
228 read this manual as one huge HTML page.
229 @*@ @ @emph{(large single download, 1 mb)}
231 @item @uref{../music-glossary.pdf, glossary.pdf}:
232 download as a PDF file.
233 @*@ @ @emph{(large single download, 1.5 Mb)}
235 @c @item @uref{../TODO, glossary.info}:
236 @c GNU info format for documentation. TODO, link broken.
246 @divClass{column-left-top}
249 This book gives a brief history of music typography, followed by
250 an examination of LilyPond's engraving techniques. A comparison
251 between LilyPond and other music engraving systems is given.
253 @warning{The detailed typographical examples are easier to analyze
254 in the PDF version due to its higher resolution.}
258 @divClass{column-right-bottom}
263 @item @ressaynamed{Top,Essay}:
264 read this manual in the same format as this one.
268 @subheading All formats
270 @divClass{keep-bullets}
273 @item @uref{../essay/index.html, Essay (split HTML)}:
274 the manual is split between many HTML pages.
275 @*@ @ @emph{(small download for each page)}
277 @item @uref{../essay-big-page.html, Essay (big HTML)}:
278 read this manual as one huge HTML page.
279 @*@ @ @emph{(large single download, 2 Mb)}
281 @item @uref{../essay.pdf, essay.pdf}:
282 download as a PDF file.
283 @*@ @ @emph{(large single download, 2.5 Mb)}
285 @c @item @uref{../TODO, essay.info}:
286 @c GNU info format for documentation. TODO, link broken.
294 @unnumberedsec Notation
296 @divClass{column-left-top}
297 @subheading Notation reference
299 This book explains all the LilyPond commands which produce
302 @warning{The Notation reference assumes that the reader knows
303 basic material covered in the Learning manual and is familiar with
304 the English musical terms presented in the Musical Glossary.}
308 @divClass{column-right-bottom}
313 @item @rusernamed{Top,Notation}:
314 read this manual in the same format as this one.
318 @subheading All formats
320 @divClass{keep-bullets}
323 @item @uref{../notation/index.html, Notation (split HTML)}:
324 the manual is split between many HTML pages.
325 @*@ @ @emph{(small download for each page)}
327 @item @uref{../notation-big-page.html, Notation (big HTML)}:
328 read this manual as one huge HTML page.
329 @*@ @ @emph{(large single download, 7 Mb)}
331 @item @uref{../notation.pdf, notation.pdf}:
332 download as a PDF file.
333 @*@ @ @emph{(large single download, 18 Mb)}
335 @c @item @uref{../TODO, notation.info}:
336 @c GNU info format for documentation. TODO, link broken.
346 @divClass{column-left-top}
347 @subheading Usage manual
349 This book explains how to execute the programs, how to integrate
350 LilyPond notation with other programs, and suggests @qq{best
351 practices} for efficient use. It is recommended reading before
352 attempting any large projects.
355 @divClass{column-right-bottom}
360 @item @rprogramnamed{Top,Usage}:
361 read this manual in the same format as this one.
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, 300 kb)}
378 @item @uref{../usage.pdf, usage.pdf}:
379 download as a PDF file.
380 @*@ @ @emph{(large single download, 400 kb)}
382 @c @item @uref{../TODO, lilypond-usage.info}:
383 @c GNU info format for documentation. TODO, 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-bottom}
415 @item @rlsrnamed{Top,Snippets}:
416 read this manual in the same format as this one.
420 @subheading All formats
422 @divClass{keep-bullets}
425 @item @uref{../snippets/index.html, Snippets (split HTML)}:
426 the manual is split between many HTML pages.
427 @*@ @ @emph{(small download for each page)}
429 @item @uref{../snippets-big-page.html, Snippets (big HTML)}:
430 read this manual as one huge HTML page.
431 @*@ @ @emph{(large single download, 2.5 Mb)}
433 @item @uref{../snippets.pdf, snippets.pdf}:
434 download as a PDF file.
435 @*@ @ @emph{(large single download, 8 Mb)}
437 @c @item @uref{../TODO, snippets.info}:
438 @c GNU info format for documentation. TODO, link broken.
448 @divClass{column-left-top}
451 This manual supplies general information about LilyPond. It also
452 contains information about various community forums, bug
453 reporting, and development.
457 @divClass{column-right-bottom}
462 @item @rweb{Top,Web}:
463 read this manual in the same format as this one.
467 @subheading All formats
469 @divClass{keep-bullets}
472 @item @uref{../web/index.html, Web (split HTML)}:
473 the manual is split between many HTML pages.
474 @*@ @ @emph{(small download for each page)}
476 @item @uref{../web-big-page.html, Web (big HTML)}:
477 read this manual as one huge HTML page.
478 @*@ @ @emph{(large single download, 1 Mb)}
480 @item @uref{../web.pdf, web.pdf}:
481 download as a PDF file.
482 @*@ @ @emph{(large single download, 2 Mb)}
484 @c @item @uref{../TODO, web.info}:
485 @c GNU info format for documentation. TODO, link broken.
496 @divClass{column-center-top}
497 @subheading Introductory questions
499 @subsubheading Where are the graphical canvas, menus, and toolbars?
501 LilyPond requires you to write music as text. Please read about
502 our @ref{Text input}.
505 @subsubheading There's a lot of documentation! Do I need to read it?
507 You need to read the @ref{Learning, Learning manual}. As for the
508 rest of documentation, you only need to read the sections which
509 discuss the notation that you wish to create.
512 @subsubheading That's still a lot of reading! Is it worth it?
514 Please decide for yourself; the reasons why you might want to use
515 LilyPond are given in the @ref{Introduction}.
519 @divClass{column-center-bottom}
520 @subheading Usage questions
522 @subsubheading Something isn't working! How do I fix it?
524 This is explained in @rprogram{Troubleshooting}.
527 @subsubheading Why do you change the syntax?
529 This is explained in @rprogram{Why does the syntax change?}.
535 @unnumberedsec Changes
537 @divClass{column-left-top}
540 This is a summary of important changes and new features in
541 LilyPond since the previous stable version.
545 @divClass{column-right-bottom}
550 @item @rchangesnamed{Top,Changes}:
551 read this manual in the same format as this one.
555 @subheading All formats
557 @divClass{keep-bullets}
560 @item @uref{../changes/index.html, Changes (split HTML)}:
561 the manual is split between many HTML pages.
562 @*@ @ @emph{(small download for each page)}
564 @item @uref{../changes-big-page.html, Changes (big HTML)}:
565 read this manual as one huge HTML page.
566 @*@ @ @emph{(large single download, 6 kb)}
568 @item @uref{../changes.pdf, changes.pdf}:
569 download as a PDF file.
570 @*@ @ @emph{(small single download, 200 kb)}
572 @c @item @uref{../TODO, changes.info}:
573 @c GNU info format for documentation. TODO, link broken.
581 @unnumberedsec Extend
583 @divClass{column-left-top}
584 @subheading Extend LilyPond
586 This manual explains how to write extensions to LilyPond.
590 @divClass{column-right-bottom}
595 @item @rextendnamed{Top,Extend}:
596 read this manual in the same format as this one.
600 @subheading All formats
602 @divClass{keep-bullets}
605 @item @uref{../extending/index.html, Extend (split HTML)}:
606 the manual is split between many HTML pages.
607 @*@ @ @emph{(small download for each page)}
609 @item @uref{../extending-big-page.html, Extend (big HTML)}:
610 read this manual as one huge HTML page.
611 @*@ @ @emph{(large single download, 200 kb)}
613 @item @uref{../extending.pdf, extending.pdf}:
614 download as a PDF file.
615 @*@ @ @emph{(large single download, 400 kb)}
617 @c @item @uref{../TODO, extending.info}:
618 @c GNU info format for documentation. TODO, link broken.
626 @unnumberedsec Internals
628 @divClass{column-left-top}
629 @subheading Internals reference
631 This is a set of heavily cross linked HTML pages which document
632 the nitty-gritty details of each and every LilyPond class, object,
633 and function. It is produced directly from the formatting
634 definitions in the source code.
636 Almost all formatting functionality that is used internally is
637 available directly to the user. For example, most variables that
638 control thickness values, distances, etc., can be changed in input
639 files. There are a huge number of formatting options, and all of
640 them are described in this document. Each section of the Notation
641 Reference has a @b{See also} subsection, which refers to the
642 generated documentation. In the HTML document, these subsections
643 have clickable links.
647 @divClass{column-right-bottom}
652 @rinternalsnamed{Top,Internals}:
653 read this manual in the same format as this one.
657 @subheading All formats
659 @divClass{keep-bullets}
662 @item @uref{../internals/index.html, Internals (split HTML)}:
663 the manual is split between many HTML pages.
664 @*@ @ @emph{(small download for each page)}
666 @item @uref{../internals-big-page.html, Internals (big HTML)}:
667 read this manual as one huge HTML page.
668 @*@ @ @emph{(large single download, 2.5 Mb)}
670 @item @uref{../internals.pdf, internals.pdf}:
671 download as a PDF file.
672 @*@ @ @emph{(large single download, 2.8 Mb)}
674 @c @item @uref{../TODO, internals.info}:
675 @c GNU info format for documentation. TODO, link broken.
684 @unnumberedsec Translated
686 @divClass{column-center-bottom}
687 @subheading Translation status
689 TODO: clean up / prettify
691 @uref{../translations.html}.
699 @divClass{heading-center}
700 @heading Documentation quick links
702 Links to other formats of these manuals can be found in
707 @c this should match the (main) manual page.
708 @divClass{column-center-top}
709 @subheading Introduction
713 @item @rlearningnamed{Top,Learning}:
714 a @qq{must-read} gentle introduction to LilyPond.
716 @item @rglosnamed{Top,Glossary}:
717 @emph{(optional reading)}
718 explains musical terms and gives translations for users unfamiliar
719 with English musical terms.
721 @item @ressaynamed{Top,Essay}:
722 @emph{(optional reading)}
723 background information about the engraving process and the
724 aesthetics of 19th century music engraving.
730 @divClass{column-left-top}
731 @subheading Regular use
735 @item @rusernamed{Top,Notation}:
736 the main portion of the documentation; provides detailed
737 information about creating notation.
739 @item @rprogramnamed{Top,Usage}:
740 discusses the actual programs and operation system-specific
743 @item @rlsrnamed{Top,Snippets}:
744 short tricks, tips, and examples.
751 @divClass{column-right-top}
752 @subheading Infrequent Use
757 links to answers of Frequently Asked Questions.
759 @item @rchangesnamed{Top,Changes}:
760 updates since the last major version.
762 @item @rextendnamed{Top,Extend}:
763 programming fancy tweaks in LilyPond.
765 @item @rinternalsnamed{Top,Internals}:
766 information about LilyPond's internal structures, which is
767 required for constructing tweaks.
774 @divClass{column-center-bottom}
775 @subheading Downloadable versions
777 @help{compare tarball vs. zip size, ask about windows users
778 dealing with tarballs (both gz and bz2), etc.}
780 @help{on second thought, wait until the new doc build. write an
781 apology here for no tarballs}
783 @divClass{keep-bullets}
792 @item info zip maybe?!?!
798 @subheading Previous stable versions
800 @divClass{keep-bullets}
803 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
804 LilyPond 2.12 Documentation}
806 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
807 LilyPond 2.10 Documentation}
809 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
810 LilyPond 2.8 Documentation}
812 @help anybody want to write this stuff?
823 @divClass{column-center-top}
824 @subheading Documentation license
826 The documentation for GNU LilyPond is published under the GNU Free
827 Documentation License. An introduction to this license, and our
828 reasons for choosing it, is given in @ref{Freedom}.
832 @divClass{column-center-bottom}
833 @subheading GNU Free Documentation License 1.1