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 @c normal case, special online case
166 @item @rlearningnamed{Top,Learning}:
169 @c we assume that the online web version will be split html
170 @item @manualStableLearningSplit
172 read this manual in the same format as this one.
176 @subheading All formats
178 @divClass{keep-bullets}
182 @item @uref{../learning/index.html, Learning (split HTML)}:
185 @item @manualStableLearningSplit
187 the manual is split between many HTML pages.
188 @*@ @ @emph{(small download for each page)}
191 @item @uref{../learning-big-page.html, Learning (big HTML)}:
194 @item @manualStableLearningBig
196 read this manual as one huge HTML page.
197 @*@ @ @emph{(large single download, 1.5 Mb)}
200 @item @uref{../learning.pdf, learning.pdf}:
203 @item @manualStableLearningPdf
205 download as a PDF file.
206 @*@ @ @emph{(large single download, 3 Mb)}
208 @c TODO: should make links to info?
209 @c @item @uref{../TODO, learning.info}:
210 @c GNU info format for documentation. link broken.
218 @unnumberedsec Glossary
220 @divClass{column-left-top}
223 This explains musical terms, and includes translations to various
224 languages. If you are not familiar with music notation or music
225 terminology (especially if you are a non-native English speaker),
226 it is highly advisable to consult the glossary.
230 @divClass{column-right-bottom}
235 @item @rglosnamed{Top,Music glossary}:
236 read this manual in the same format as this one.
240 @subheading All formats
242 @divClass{keep-bullets}
245 @item @uref{../music-glossary/index.html, Glossary (split HTML)}:
246 the manual is split between many HTML pages.
247 @*@ @ @emph{(small download for each page)}
249 @item @uref{../music-glossary-big-page.html, Glossay (big HTML)}:
250 read this manual as one huge HTML page.
251 @*@ @ @emph{(large single download, 1 mb)}
253 @item @uref{../music-glossary.pdf, glossary.pdf}:
254 download as a PDF file.
255 @*@ @ @emph{(large single download, 1.5 Mb)}
257 @c @item @uref{../TODO, glossary.info}:
258 @c GNU info format for documentation. TODO, link broken.
268 @divClass{column-left-top}
271 This book gives a brief history of music typography, followed by
272 an examination of LilyPond's engraving techniques. A comparison
273 between LilyPond and other music engraving systems is given.
275 @warning{The detailed typographical examples are easier to analyze
276 in the PDF version due to its higher resolution.}
280 @divClass{column-right-bottom}
285 @item @ressaynamed{Top,Essay}:
286 read this manual in the same format as this one.
290 @subheading All formats
292 @divClass{keep-bullets}
295 @item @uref{../essay/index.html, Essay (split HTML)}:
296 the manual is split between many HTML pages.
297 @*@ @ @emph{(small download for each page)}
299 @item @uref{../essay-big-page.html, Essay (big HTML)}:
300 read this manual as one huge HTML page.
301 @*@ @ @emph{(large single download, 2 Mb)}
303 @item @uref{../essay.pdf, essay.pdf}:
304 download as a PDF file.
305 @*@ @ @emph{(large single download, 2.5 Mb)}
307 @c @item @uref{../TODO, essay.info}:
308 @c GNU info format for documentation. TODO, link broken.
316 @unnumberedsec Notation
318 @divClass{column-left-top}
319 @subheading Notation reference
321 This book explains all the LilyPond commands which produce
324 @warning{The Notation reference assumes that the reader knows
325 basic material covered in the Learning manual and is familiar with
326 the English musical terms presented in the Musical Glossary.}
330 @divClass{column-right-bottom}
335 @item @rusernamed{Top,Notation}:
336 read this manual in the same format as this one.
340 @subheading All formats
342 @divClass{keep-bullets}
345 @item @uref{../notation/index.html, Notation (split HTML)}:
346 the manual is split between many HTML pages.
347 @*@ @ @emph{(small download for each page)}
349 @item @uref{../notation-big-page.html, Notation (big HTML)}:
350 read this manual as one huge HTML page.
351 @*@ @ @emph{(large single download, 7 Mb)}
353 @item @uref{../notation.pdf, notation.pdf}:
354 download as a PDF file.
355 @*@ @ @emph{(large single download, 18 Mb)}
357 @c @item @uref{../TODO, notation.info}:
358 @c GNU info format for documentation. TODO, link broken.
368 @divClass{column-left-top}
369 @subheading Usage manual
371 This book explains how to execute the programs, how to integrate
372 LilyPond notation with other programs, and suggests @qq{best
373 practices} for efficient use. It is recommended reading before
374 attempting any large projects.
377 @divClass{column-right-bottom}
382 @item @rprogramnamed{Top,Usage}:
383 read this manual in the same format as this one.
387 @subheading All formats
389 @divClass{keep-bullets}
392 @item @uref{../usage/index.html, Usage (split HTML)}:
393 the manual is split between many HTML pages.
394 @*@ @ @emph{(small download for each page)}
396 @item @uref{../usage-big-page.html, Usage (big HTML)}:
397 read this manual as one huge HTML page.
398 @*@ @ @emph{(large single download, 300 kb)}
400 @item @uref{../usage.pdf, usage.pdf}:
401 download as a PDF file.
402 @*@ @ @emph{(large single download, 400 kb)}
404 @c @item @uref{../TODO, lilypond-usage.info}:
405 @c GNU info format for documentation. TODO, link broken.
413 @unnumberedsec Snippets
415 @divClass{column-left-top}
418 This shows a selected set of LilyPond snippets from the
419 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
420 (LSR). All the snippets are in the public domain.
422 Please note that this document is not an exact subset of LSR. LSR
423 is running a stable LilyPond version, so any snippet which
424 demonstrates new features of a development version must be added
425 separately. These are stored in @file{input/new/} in the LilyPond
428 The list of snippets for each subsection of the Notation are also
429 linked from the @strong{See also} portion.
432 @divClass{column-right-bottom}
437 @item @rlsrnamed{Top,Snippets}:
438 read this manual in the same format as this one.
442 @subheading All formats
444 @divClass{keep-bullets}
447 @item @uref{../snippets/index.html, Snippets (split HTML)}:
448 the manual is split between many HTML pages.
449 @*@ @ @emph{(small download for each page)}
451 @item @uref{../snippets-big-page.html, Snippets (big HTML)}:
452 read this manual as one huge HTML page.
453 @*@ @ @emph{(large single download, 2.5 Mb)}
455 @item @uref{../snippets.pdf, snippets.pdf}:
456 download as a PDF file.
457 @*@ @ @emph{(large single download, 8 Mb)}
459 @c @item @uref{../TODO, snippets.info}:
460 @c GNU info format for documentation. TODO, link broken.
470 @divClass{column-left-top}
473 This manual supplies general information about LilyPond. It also
474 contains information about various community forums, bug
475 reporting, and development.
479 @divClass{column-right-bottom}
484 @item @rweb{Top,Web}:
485 read this manual in the same format as this one.
489 @subheading All formats
491 @divClass{keep-bullets}
494 @item @uref{../web/index.html, Web (split HTML)}:
495 the manual is split between many HTML pages.
496 @*@ @ @emph{(small download for each page)}
498 @item @uref{../web-big-page.html, Web (big HTML)}:
499 read this manual as one huge HTML page.
500 @*@ @ @emph{(large single download, 1 Mb)}
502 @item @uref{../web.pdf, web.pdf}:
503 download as a PDF file.
504 @*@ @ @emph{(large single download, 2 Mb)}
506 @c @item @uref{../TODO, web.info}:
507 @c GNU info format for documentation. TODO, link broken.
518 @divClass{column-center-top}
519 @subheading Introductory questions
521 @subsubheading Where are the graphical canvas, menus, and toolbars?
523 LilyPond requires you to write music as text. Please read about
524 our @ref{Text input}.
527 @subsubheading There's a lot of documentation! Do I need to read it?
529 You need to read the @ref{Learning, Learning manual}. As for the
530 rest of documentation, you only need to read the sections which
531 discuss the notation that you wish to create.
534 @subsubheading That's still a lot of reading! Is it worth it?
536 Please decide for yourself; the reasons why you might want to use
537 LilyPond are given in the @ref{Introduction}.
541 @divClass{column-center-bottom}
542 @subheading Usage questions
544 @subsubheading Something isn't working! How do I fix it?
546 This is explained in @rprogram{Troubleshooting}.
549 @subsubheading Why do you change the syntax?
551 This is explained in @rprogram{Why does the syntax change?}.
557 @unnumberedsec Changes
559 @divClass{column-left-top}
562 This is a summary of important changes and new features in
563 LilyPond since the previous stable version.
567 @divClass{column-right-bottom}
572 @item @rchangesnamed{Top,Changes}:
573 read this manual in the same format as this one.
577 @subheading All formats
579 @divClass{keep-bullets}
582 @item @uref{../changes/index.html, Changes (split HTML)}:
583 the manual is split between many HTML pages.
584 @*@ @ @emph{(small download for each page)}
586 @item @uref{../changes-big-page.html, Changes (big HTML)}:
587 read this manual as one huge HTML page.
588 @*@ @ @emph{(large single download, 6 kb)}
590 @item @uref{../changes.pdf, changes.pdf}:
591 download as a PDF file.
592 @*@ @ @emph{(small single download, 200 kb)}
594 @c @item @uref{../TODO, changes.info}:
595 @c GNU info format for documentation. TODO, link broken.
603 @unnumberedsec Extend
605 @divClass{column-left-top}
606 @subheading Extend LilyPond
608 This manual explains how to write extensions to LilyPond.
612 @divClass{column-right-bottom}
617 @item @rextendnamed{Top,Extend}:
618 read this manual in the same format as this one.
622 @subheading All formats
624 @divClass{keep-bullets}
627 @item @uref{../extending/index.html, Extend (split HTML)}:
628 the manual is split between many HTML pages.
629 @*@ @ @emph{(small download for each page)}
631 @item @uref{../extending-big-page.html, Extend (big HTML)}:
632 read this manual as one huge HTML page.
633 @*@ @ @emph{(large single download, 200 kb)}
635 @item @uref{../extending.pdf, extending.pdf}:
636 download as a PDF file.
637 @*@ @ @emph{(large single download, 400 kb)}
639 @c @item @uref{../TODO, extending.info}:
640 @c GNU info format for documentation. TODO, link broken.
648 @unnumberedsec Internals
650 @divClass{column-left-top}
651 @subheading Internals reference
653 This is a set of heavily cross linked HTML pages which document
654 the nitty-gritty details of each and every LilyPond class, object,
655 and function. It is produced directly from the formatting
656 definitions in the source code.
658 Almost all formatting functionality that is used internally is
659 available directly to the user. For example, most variables that
660 control thickness values, distances, etc., can be changed in input
661 files. There are a huge number of formatting options, and all of
662 them are described in this document. Each section of the Notation
663 Reference has a @b{See also} subsection, which refers to the
664 generated documentation. In the HTML document, these subsections
665 have clickable links.
669 @divClass{column-right-bottom}
674 @rinternalsnamed{Top,Internals}:
675 read this manual in the same format as this one.
679 @subheading All formats
681 @divClass{keep-bullets}
684 @item @uref{../internals/index.html, Internals (split HTML)}:
685 the manual is split between many HTML pages.
686 @*@ @ @emph{(small download for each page)}
688 @item @uref{../internals-big-page.html, Internals (big HTML)}:
689 read this manual as one huge HTML page.
690 @*@ @ @emph{(large single download, 2.5 Mb)}
692 @item @uref{../internals.pdf, internals.pdf}:
693 download as a PDF file.
694 @*@ @ @emph{(large single download, 2.8 Mb)}
696 @c @item @uref{../TODO, internals.info}:
697 @c GNU info format for documentation. TODO, link broken.
706 @unnumberedsec Translated
708 @divClass{column-center-bottom}
709 @subheading Translation status
711 TODO: clean up / prettify
713 @uref{../translations.html}.
721 @divClass{heading-center}
722 @heading Documentation quick links
724 Links to other formats of these manuals can be found in
729 @c this should match the (main) manual page.
730 @divClass{column-center-top}
731 @subheading Introduction
735 @item @rlearningnamed{Top,Learning}:
736 a @qq{must-read} gentle introduction to LilyPond.
738 @item @rglosnamed{Top,Glossary}:
739 @emph{(optional reading)}
740 explains musical terms and gives translations for users unfamiliar
741 with English musical terms.
743 @item @ressaynamed{Top,Essay}:
744 @emph{(optional reading)}
745 background information about the engraving process and the
746 aesthetics of 19th century music engraving.
752 @divClass{column-left-top}
753 @subheading Regular use
757 @item @rusernamed{Top,Notation}:
758 the main portion of the documentation; provides detailed
759 information about creating notation.
761 @item @rprogramnamed{Top,Usage}:
762 discusses the actual programs and operation system-specific
765 @item @rlsrnamed{Top,Snippets}:
766 short tricks, tips, and examples.
773 @divClass{column-right-top}
774 @subheading Infrequent Use
779 links to answers of Frequently Asked Questions.
781 @item @rchangesnamed{Top,Changes}:
782 updates since the last major version.
784 @item @rextendnamed{Top,Extend}:
785 programming fancy tweaks in LilyPond.
787 @item @rinternalsnamed{Top,Internals}:
788 information about LilyPond's internal structures, which is
789 required for constructing tweaks.
796 @divClass{column-center-bottom}
797 @subheading Downloadable versions
799 @help{compare tarball vs. zip size, ask about windows users
800 dealing with tarballs (both gz and bz2), etc.}
802 @help{on second thought, wait until the new doc build. write an
803 apology here for no tarballs}
805 @divClass{keep-bullets}
814 @item info zip maybe?!?!
820 @subheading Previous stable versions
822 @divClass{keep-bullets}
825 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
826 LilyPond 2.12 Documentation}
828 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
829 LilyPond 2.10 Documentation}
831 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
832 LilyPond 2.8 Documentation}
834 @help anybody want to write this stuff?
845 @divClass{column-center-top}
846 @subheading Documentation license
848 The documentation for GNU LilyPond is published under the GNU Free
849 Documentation License. An introduction to this license, and our
850 reasons for choosing it, is given in @ref{Freedom}.
854 @divClass{column-center-bottom}
855 @subheading GNU Free Documentation License 1.1