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 @divClass{column-right-bottom}
157 @item @rlearningnamed{Top,Learning}:
158 read this manual in the same format as this one.
162 @subheading All formats
164 @divClass{keep-bullets}
167 @item @uref{learning/index.html, Learning (split HTML)}:
168 the manual is split between many HTML pages.
169 @emph{(small download for each page)}
171 @item @uref{learning-big-page.html, Learning (big HTML)}:
172 read this manual as one huge HTML page.
173 @emph{(large single download, around 10? Mb)}
175 @item @uref{learning.pdf, learning.pdf}:
176 download as a PDF file.
177 @emph{(large single download, 2.8 Mb)}
179 @c TODO: should make links to info?
180 @c @item @uref{TODO, learning.info}:
181 @c GNU info format for documentation. 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 @divClass{column-right-bottom}
206 @item @rglosnamed{Top,Music glossary}:
207 read this manual in the same format as this one.
211 @subheading All formats
213 @divClass{keep-bullets}
216 @item @uref{music-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{music-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{music-glossary.pdf, glossary.pdf}:
225 download as a PDF file.
226 @emph{(large single download, 2.8 Mb)}
228 @c @item @uref{TODO, glossary.info}:
229 @c GNU info format for documentation. TODO, 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.
246 @warning{The detailed typographical examples are easier to analyze
247 in the PDF version due to its higher resolution.}
251 @divClass{column-right-bottom}
256 @item @ressaynamed{Top,Essay}:
257 read this manual in the same format as this one.
261 @subheading All formats
263 @divClass{keep-bullets}
266 @item @uref{essay/index.html, Essay (split HTML)}:
267 the manual is split between many HTML pages.
268 @emph{(small download for each page)}
270 @item @uref{essay-big-page.html, Essay (big HTML)}:
271 read this manual as one huge HTML page.
272 @emph{(large single download, around ?? Mb)}
274 @item @uref{essay.pdf, essay.pdf}:
275 download as a PDF file.
276 @emph{(large single download, ?? Mb)}
278 @c @item @uref{TODO, essay.info}:
279 @c GNU info format for documentation. TODO, link broken.
287 @unnumberedsec Notation
289 @divClass{column-left-top}
290 @subheading Notation reference
292 This book explains all the LilyPond commands which produce
295 @warning{The Notation reference assumes that the reader knows
296 basic material covered in the Learning manual and is familiar with
297 the English musical terms presented in the Musical Glossary.}
301 @divClass{column-right-bottom}
306 @item @rusernamed{Top,Notation}:
307 read this manual in the same format as this one.
311 @subheading All formats
313 @divClass{keep-bullets}
316 @item @uref{notation/index.html, Notation (split HTML)}:
317 the manual is split between many HTML pages.
318 @emph{(small download for each page)}
320 @item @uref{notation-big-page.html, Notation (big HTML)}:
321 read this manual as one huge HTML page.
322 @emph{(large single download, around 10? Mb)}
324 @item @uref{notation.pdf, notation.pdf}:
325 download as a PDF file.
326 @emph{(large single download, 2.8 Mb)}
328 @c @item @uref{TODO, notation.info}:
329 @c GNU info format for documentation. TODO, link broken.
339 @divClass{column-left-top}
340 @subheading Usage manual
342 This book explains how to execute the programs, how to integrate
343 LilyPond notation with other programs, and suggests @qq{best
344 practices} for efficient use. It is recommended reading before
345 attempting any large projects.
348 @divClass{column-right-bottom}
353 @item @rprogramnamed{Top,Usage}:
354 read this manual in the same format as this one.
358 @subheading All formats
360 @divClass{keep-bullets}
363 @item @uref{usage/index.html, Usage (split HTML)}:
364 the manual is split between many HTML pages.
365 @emph{(small download for each page)}
367 @item @uref{usage-big-page.html, Usage (big HTML)}:
368 read this manual as one huge HTML page.
369 @emph{(large single download, around 10? Mb)}
371 @item @uref{usage.pdf, usage.pdf}:
372 download as a PDF file.
373 @emph{(large single download, 2.8 Mb)}
375 @c @item @uref{TODO, lilypond-usage.info}:
376 @c GNU info format for documentation. TODO, link broken.
384 @unnumberedsec Snippets
386 @divClass{column-left-top}
389 This shows a selected set of LilyPond snippets from the
390 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
391 (LSR). All the snippets are in the public domain.
393 Please note that this document is not an exact subset of LSR. LSR
394 is running a stable LilyPond version, so any snippet which
395 demonstrates new features of a development version must be added
396 separately. These are stored in @file{input/new/} in the LilyPond
399 The list of snippets for each subsection of the Notation are also
400 linked from the @strong{See also} portion.
403 @divClass{column-right-bottom}
408 @item @rlsrnamed{Top,Snippets}:
409 read this manual in the same format as this one.
413 @subheading All formats
415 @divClass{keep-bullets}
418 @item @uref{snippets/index.html, Snippets (split HTML)}:
419 the manual is split between many HTML pages.
420 @emph{(small download for each page)}
422 @item @uref{snippets-big-page.html, Snippets (big HTML)}:
423 read this manual as one huge HTML page.
424 @emph{(large single download, around 10? Mb)}
426 @item @uref{snippets.pdf, snippets.pdf}:
427 download as a PDF file.
428 @emph{(large single download, 2.8 Mb)}
430 @c @item @uref{TODO, snippets.info}:
431 @c GNU info format for documentation. TODO, link broken.
441 @divClass{column-center-top}
442 @subheading Introductory questions
444 @subsubheading Where are the graphical canvas, menus, and toolbars?
446 LilyPond requires you to write music as text. Please read about
447 our @ref{Text input}.
450 @subsubheading There's a lot of documentation! Do I need to read it?
452 You need to read the @ref{Learning, Learning manual}. As for the
453 rest of documentation, you only need to read the sections which
454 discuss the notation that you wish to create.
457 @subsubheading That's still a lot of reading! Is it worth it?
459 Please decide for yourself; the reasons why you might want to use
460 LilyPond are given in the @ref{Introduction}.
464 @divClass{column-center-bottom}
465 @subheading Usage questions
467 @subsubheading Something isn't working! How do I fix it?
469 This is explained in @rprogram{Troubleshooting}.
472 @subsubheading Why do you change the syntax?
474 This is explained in @rprogram{Why does the syntax change?}.
480 @unnumberedsec Changes
482 @divClass{column-left-top}
485 This is a summary of important changes and new features in
486 LilyPond since the previous stable version.
490 @divClass{column-right-bottom}
495 @item @rchangesnamed{Top,Changes}:
496 read this manual in the same format as this one.
500 @subheading All formats
502 @divClass{keep-bullets}
505 @c Changes isn't available as a split manual.
506 @c (maybe it should be, but it isn't so far)
507 @c @item @uref{changes/index.html, Changes (split HTML)}:
508 @c the manual is split between many HTML pages.
509 @c @emph{(small download for each page)}
511 @c @item @uref{changes-big-page.html, Changes (big HTML)}:
512 @c read this manual as one huge HTML page.
513 @c @emph{(large single download, around 10? Mb)}
515 @item @uref{changes.html, Changes}:
516 read this manual as a HTML page.
518 @item @uref{changes.pdf, changes.pdf}:
519 download as a PDF file.
520 @emph{(small single download, 0.5 ?? Mb)}
522 @c @item @uref{TODO, changes.info}:
523 @c GNU info format for documentation. TODO, link broken.
531 @unnumberedsec Extend
533 @divClass{column-left-top}
534 @subheading Extend LilyPond
536 This manual explains how to write extensions to LilyPond.
540 @divClass{column-right-bottom}
545 @item @rextendnamed{Top,Extend}:
546 read this manual in the same format as this one.
550 @subheading All formats
552 @divClass{keep-bullets}
555 @item @uref{extending/index.html, Extend (split HTML)}:
556 the manual is split between many HTML pages.
557 @emph{(small download for each page)}
559 @item @uref{extending-big-page.html, Extend (big HTML)}:
560 read this manual as one huge HTML page.
561 @emph{(large single download, around 10? Mb)}
563 @item @uref{extending.pdf, extending.pdf}:
564 download as a PDF file.
565 @emph{(large single download, 2.8 Mb)}
567 @c @item @uref{TODO, extending.info}:
568 @c GNU info format for documentation. TODO, link broken.
576 @unnumberedsec Internals
578 @divClass{column-left-top}
579 @subheading Internals reference
581 This is a set of heavily cross linked HTML pages which document
582 the nitty-gritty details of each and every LilyPond class, object,
583 and function. It is produced directly from the formatting
584 definitions in the source code.
586 Almost all formatting functionality that is used internally is
587 available directly to the user. For example, most variables that
588 control thickness values, distances, etc., can be changed in input
589 files. There are a huge number of formatting options, and all of
590 them are described in this document. Each section of the Notation
591 Reference has a @b{See also} subsection, which refers to the
592 generated documentation. In the HTML document, these subsections
593 have clickable links.
597 @divClass{column-right-bottom}
602 @item @rinternalsnamed{Top,Internals}:
603 read this manual in the same format as this one.
607 @subheading All formats
609 @divClass{keep-bullets}
612 @item @uref{internals/index.html, Internals (split HTML)}:
613 the manual is split between many HTML pages.
614 @emph{(small download for each page)}
616 @item @uref{internals-big-page.html, Internals (big HTML)}:
617 read this manual as one huge HTML page.
618 @emph{(large single download, around 10? Mb)}
620 @item @uref{internals.pdf, internals.pdf}:
621 download as a PDF file.
622 @emph{(large single download, 2.8 Mb)}
624 @c @item @uref{TODO, internals.info}:
625 @c GNU info format for documentation. TODO, link broken.
634 @unnumberedsec Translated
636 @divClass{column-center-bottom}
637 @subheading Translation status
639 TODO: clean up / prettify
641 @uref{translations.html}.
649 @divClass{column-left-top}
650 @subheading Downloadable versions
652 @help{compare tarball vs. zip size, ask about windows users
653 dealing with tarballs (both gz and bz2), etc.}
655 @help{on second thought, wait until the new doc build. write an
656 apology here for no tarballs}
658 @divClass{keep-bullets}
667 @item info zip maybe?!?!
674 @divClass{column-right-top}
675 @subheading Previous stable versions
677 @divClass{keep-bullets}
680 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
681 LilyPond 2.12 Documentation}
683 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
684 LilyPond 2.10 Documentation}
686 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
687 LilyPond 2.8 Documentation}
689 @help anybody want to write this stuff?
700 @divClass{column-center-top}
701 @subheading Documentation license
703 The documentation for GNU LilyPond is published under the GNU Free
704 Documentation License. An introduction to this license, and our
705 reasons for choosing it, is given in @ref{Freedom}.
709 @divClass{column-center-bottom}
710 @subheading GNU Free Documentation License 1.1