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 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 basic material
295 covered in the Learning manual and is familiar with the English musical
296 terms presented in the Musical Glossary.}
300 @divClass{column-right-top}
301 @subheading Read it now
305 @item @rusernamed{Top,Notation}:
306 read this manual in the same format as this one.
311 @divClass{column-center-bottom}
312 @subheading Other formats
314 @divClass{keep-bullets}
317 @item @uref{../notation/index.html, Notation (split HTML)}:
318 the manual is split between many HTML pages.
319 @emph{(small download for each page)}
321 @item @uref{../notation-big-page.html, Notation (big HTML)}:
322 read this manual as one huge HTML page.
323 @emph{(large single download, around 10? Mb)}
325 @item @uref{../notation.pdf, notation.pdf}:
326 download as a PDF file.
327 @emph{(large single download, 2.8 Mb)}
329 @item @uref{FIXME, notation.info}:
330 GNU info format for documentation. FIXME, link broken.
340 @divClass{column-left-top}
341 @subheading Usage manual
343 This book explains how to execute the programs, how to integrate
344 LilyPond notation with other programs, and suggests @qq{best
345 practices} for efficient use. It is recommended reading before
346 attempting any large projects.
349 @divClass{column-right-top}
350 @subheading Read it now
354 @item @rprogramnamed{Top,Usage}:
355 read this manual in the same format as this one.
360 @divClass{column-center-bottom}
361 @subheading Other formats
363 @divClass{keep-bullets}
366 @item @uref{../application/index.html, Usage (split HTML)}:
367 the manual is split between many HTML pages.
368 @emph{(small download for each page)}
370 @item @uref{../application-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{../application.pdf, application.pdf}:
375 download as a PDF file.
376 @emph{(large single download, 2.8 Mb)}
378 @item @uref{FIXME, application.info}:
379 GNU info format for documentation. FIXME, 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-top}
407 @subheading Read it now
411 @item @rlsrnamed{Top,Snippets}:
412 read this manual in the same format as this one.
417 @divClass{column-center-bottom}
418 @subheading Other formats
420 @divClass{keep-bullets}
423 @item @uref{../snippets/index.html, Snippets (split HTML)}:
424 the manual is split between many HTML pages.
425 @emph{(small download for each page)}
427 @item @uref{../snippets-big-page.html, Snippets (big HTML)}:
428 read this manual as one huge HTML page.
429 @emph{(large single download, around 10? Mb)}
431 @item @uref{../snippets.pdf, snippets.pdf}:
432 download as a PDF file.
433 @emph{(large single download, 2.8 Mb)}
435 @item @uref{FIXME, snippets.info}:
436 GNU info format for documentation. FIXME, link broken.
446 @divClass{column-center-top}
447 @subheading Introductory questions
449 @subsubheading Where are the graphical canvas, menus, and toolbars?
451 LilyPond requires you to write music as text. Please read about
452 our @ref{Text input}.
455 @subsubheading There's a lot of documentation! Do I need to read it?
457 You need to read the @ref{Learning, Learning manual}. As for the
458 rest of documentation, you only need to read the sections which
459 discuss the notation that you wish to create.
462 @subsubheading That's still a lot of reading! Is it worth it?
464 Please decide for yourself; the reasons why you might want to use
465 LilyPond are given in the @ref{Introduction}.
469 @divClass{column-center-bottom}
470 @subheading Usage questions
472 @subsubheading Something isn't working! How do I fix it?
474 This is explained in @rprogram{Troubleshooting}.
477 @subsubheading Why do you change the syntax?
479 This is explained in @rprogram{Why does the syntax change?}.
485 @unnumberedsec Changes
487 @divClass{column-left-top}
490 This is a summary of important changes and new features in
491 LilyPond since the previous stable version.
495 @divClass{column-right-top}
496 @subheading Read it now
500 @item @rchangesnamed{Top,Changes}:
501 read this manual in the same format as this one.
506 @divClass{column-center-bottom}
507 @subheading Other formats
509 @divClass{keep-bullets}
512 @c Changes isn't available as a split manual.
513 @c (maybe it should be, but it isn't so far)
514 @c @item @uref{../changes/index.html, Changes (split HTML)}:
515 @c the manual is split between many HTML pages.
516 @c @emph{(small download for each page)}
518 @c @item @uref{../changes-big-page.html, Changes (big HTML)}:
519 @c read this manual as one huge HTML page.
520 @c @emph{(large single download, around 10? Mb)}
522 @item @uref{../changes.html, Changes}:
523 read this manual as a HTML page.
525 @item @uref{../changes.pdf, changes.pdf}:
526 download as a PDF file.
527 @emph{(small single download, 0.5 ?? Mb)}
529 @item @uref{FIXME, changes.info}:
530 GNU info format for documentation. FIXME, link broken.
539 @unnumberedsec Internals
541 @divClass{column-left-top}
542 @subheading Internals reference
544 This is a set of heavily cross linked HTML pages which document
545 the nitty-gritty details of each and every LilyPond class, object,
546 and function. It is produced directly from the formatting
547 definitions in the source code.
549 Almost all formatting functionality that is used internally is
550 available directly to the user. For example, most variables that
551 control thickness values, distances, etc., can be changed in input
552 files. There are a huge number of formatting options, and all of
553 them are described in this document. Each section of the Notation
554 Reference has a @b{See also} subsection, which refers to the
555 generated documentation. In the HTML document, these subsections
556 have clickable links.
560 @divClass{column-right-top}
561 @subheading Read it now
565 @item @rinternalsnamed{Top,Internals}:
566 read this manual in the same format as this one.
571 @divClass{column-center-bottom}
572 @subheading Other formats
574 @divClass{keep-bullets}
577 @item @uref{../internals/index.html, Internals (split HTML)}:
578 the manual is split between many HTML pages.
579 @emph{(small download for each page)}
581 @item @uref{../internals-big-page.html, Internals (big HTML)}:
582 read this manual as one huge HTML page.
583 @emph{(large single download, around 10? Mb)}
585 @item @uref{../internals.pdf, internals.pdf}:
586 download as a PDF file.
587 @emph{(large single download, 2.8 Mb)}
589 @item @uref{FIXME, internals.info}:
590 GNU info format for documentation. FIXME, link broken.
599 @unnumberedsec Translated
601 @divClass{column-center-bottom}
602 @subheading Translation status
604 TODO: clean up / prettify
606 @uref{../translations.html}.
614 @divClass{column-left-top}
615 @subheading Downloadable versions
617 FIXME: compare tarball vs. zip size, ask about windows users
618 dealing with tarballs (both gz and bz2), etc.
620 @divClass{keep-bullets}
629 @item info zip maybe?!?!
636 @divClass{column-right-top}
637 @subheading Previous stable versions
639 @divClass{keep-bullets}
642 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
643 LilyPond 2.12 Documentation}
645 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
646 LilyPond 2.10 Documentation}
648 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
649 LilyPond 2.8 Documentation}
662 @divClass{column-center-top}
663 @subheading Documentation license
665 The documentation for GNU LilyPond is published under the GNU Free
666 Documentation License. An introduction to this license, and our
667 reasons for choosing it, is given in @ref{Freedom}.
671 @divClass{column-center-bottom}
672 @subheading GNU Free Documentation License 1.1