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 @versionStable
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}
161 @docLinks{Learning, learning,
162 @rlearningnamed{Top,Learning},
163 @manualStableLearningSplit,
164 @manualStableLearningBig, 1.5 MB,
165 @manualStableLearningPdf, 3 MB}
171 @unnumberedsec Glossary
173 @divClass{column-left-top}
176 This explains musical terms, and includes translations to various
177 languages. If you are not familiar with music notation or music
178 terminology (especially if you are a non-native English speaker),
179 it is highly advisable to consult the glossary.
183 @divClass{column-right-bottom}
185 @docLinks{Music glossary, music-glossary,
186 @rglosnamed{Top,Music glossary},
187 @manualStableGlossarySplit,
188 @manualStableGlossaryBig, 1 MB,
189 @manualStableGlossaryPdf, 1.5 MB}
197 @divClass{column-left-top}
200 This book gives a brief history of music typography, followed by
201 an examination of LilyPond's engraving techniques. A comparison
202 between LilyPond and other music engraving systems is given.
204 @warning{The detailed typographical examples are easier to analyze
205 in the PDF version due to its higher resolution.}
209 @divClass{column-right-bottom}
211 @docLinks{Essay, essay,
212 @rglosnamed{Top,Essay},
213 @manualStableEssaySplit,
214 @manualStableEssayBig, 2 MB,
215 @manualStableEssayPdf, 2.5 MB}
221 @unnumberedsec Notation
223 @divClass{column-left-top}
224 @subheading Notation reference
226 This book explains all the LilyPond commands which produce
229 @warning{The Notation reference assumes that the reader knows
230 basic material covered in the Learning manual and is familiar with
231 the English musical terms presented in the glossary.}
235 @divClass{column-right-bottom}
237 @docLinks{Notation, notation,
238 @rglosnamed{Top,Notation},
239 @manualStableNotationSplit,
240 @manualStableNotationBig, 7 MB,
241 @manualStableNotationPdf, 18 MB}
249 @divClass{column-left-top}
250 @subheading Usage manual
252 This book explains how to execute the programs, how to integrate
253 LilyPond notation with other programs, and suggests @qq{best
254 practices} for efficient use. It is recommended reading before
255 attempting any large projects.
259 @divClass{column-right-bottom}
261 @docLinks{Usage, usage,
262 @rglosnamed{Top,Usage},
263 @manualStableUsageSplit,
264 @manualStableUsageBig, 300 KB,
265 @manualStableUsagePdf, 400 KB}
271 @unnumberedsec Snippets
273 @divClass{column-left-top}
276 This shows a selected set of LilyPond snippets from the
277 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
278 (LSR). All the snippets are in the public domain.
280 Please note that this document is not an exact subset of LSR. LSR
281 is running a stable LilyPond version, so any snippet which
282 demonstrates new features of a development version must be added
283 separately. These are stored in @file{input/new/} in the LilyPond
286 The list of snippets for each subsection of the Notation are also
287 linked from the @strong{See also} portion.
290 @divClass{column-right-bottom}
292 @docLinks{Snippets, snippets,
293 @rglosnamed{Top,Snippets},
294 @manualStableSnippetsSplit,
295 @manualStableSnippetsBig, 2.5 MB,
296 @manualStableSnippetsPdf, 8 MB}
304 @divClass{column-left-top}
307 This manual supplies general information about LilyPond. It also
308 contains information about various community forums, bug
309 reporting, and development.
313 @divClass{column-right-bottom}
316 @rglosnamed{Top,Web},
317 @manualStableWebSplit,
318 @manualStableWebBig, 1 MB,
319 @manualStableWebPdf, 2 MB}
327 @divClass{column-center-top}
328 @subheading Introductory questions
330 @subsubheading Where are the graphical canvas, menus, and toolbars?
332 LilyPond requires you to write music as text. Please read about
333 our @ref{Text input}.
336 @subsubheading There's a lot of documentation! Do I need to read it?
338 You need to read the @ref{Learning, Learning manual}. As for the
339 rest of documentation, you only need to read the sections which
340 discuss the notation that you wish to create.
343 @subsubheading That's still a lot of reading! Is it worth it?
345 Please decide for yourself; the reasons why you might want to use
346 LilyPond are given in the @ref{Introduction}.
350 @divClass{column-center-bottom}
351 @subheading Usage questions
353 @subsubheading Something isn't working! How do I fix it?
355 This is explained in @rprogram{Troubleshooting}.
358 @subsubheading Why do you change the syntax?
360 This is explained in @rprogram{Why does the syntax change?}.
366 @unnumberedsec Changes
368 @divClass{column-left-top}
371 This is a summary of important changes and new features in
372 LilyPond since the previous stable version.
376 @divClass{column-right-bottom}
378 @docLinks{Changes, changes,
379 @rglosnamed{Top,Changes},
380 @manualStableChangesSplit,
381 @manualStableChangesBig, 6 KB,
382 @manualStableChangesPdf, 200 KB}
388 @unnumberedsec Extend
390 @divClass{column-left-top}
391 @subheading Extend LilyPond
393 This manual explains how to write extensions to LilyPond.
397 @divClass{column-right-bottom}
399 @docLinks{Extend, extend,
400 @rglosnamed{Top,Extend},
401 @manualStableExtendingSplit,
402 @manualStableExtendingBig, 200 KB,
403 @manualStableExtendingPdf, 400 KB}
409 @unnumberedsec Internals
411 @divClass{column-left-top}
412 @subheading Internals reference
414 This is a set of heavily cross linked HTML pages which document
415 the nitty-gritty details of each and every LilyPond class, object,
416 and function. It is produced directly from the formatting
417 definitions in the source code.
419 Almost all formatting functionality that is used internally is
420 available directly to the user. For example, most variables that
421 control thickness values, distances, etc., can be changed in input
422 files. There are a huge number of formatting options, and all of
423 them are described in this document. Each section of the Notation
424 Reference has a @b{See also} subsection, which refers to the
425 generated documentation. In the HTML document, these subsections
426 have clickable links.
430 @divClass{column-right-bottom}
432 @docLinks{Internals, internals,
433 @rglosnamed{Top,Internals},
434 @manualStableInternalsSplit,
435 @manualStableInternalsBig, 2.5 MB,
436 @manualStableInternalsPdf, 2.8 MB}
442 @unnumberedsec Translated
444 @divClass{column-center-bottom}
445 @subheading Translation status
447 TODO: clean up / prettify
449 @uref{../translations.html}.
457 @divClass{heading-center}
458 @heading Documentation quick links
460 Links to other formats of these manuals can be found in
465 @c this should match the (main) manual page.
466 @divClass{column-center-top}
467 @subheading Introduction
471 @item @rlearningnamed{Top,Learning}:
472 a @qq{must-read} gentle introduction to LilyPond.
474 @item @rglosnamed{Top,Glossary}:
475 @emph{(optional reading)}
476 explains musical terms and gives translations for users unfamiliar
477 with English musical terms.
479 @item @ressaynamed{Top,Essay}:
480 @emph{(optional reading)}
481 background information about the engraving process and the
482 aesthetics of 19th century music engraving.
488 @divClass{column-left-top}
489 @subheading Regular use
493 @item @rusernamed{Top,Notation}:
494 the main portion of the documentation; provides detailed
495 information about creating notation.
497 @item @rprogramnamed{Top,Usage}:
498 discusses the actual programs and operation system-specific
501 @item @rlsrnamed{Top,Snippets}:
502 short tricks, tips, and examples.
509 @divClass{column-right-top}
510 @subheading Infrequent Use
515 links to answers of Frequently Asked Questions.
517 @item @rchangesnamed{Top,Changes}:
518 updates since the last major version.
520 @item @rextendnamed{Top,Extend}:
521 programming fancy tweaks in LilyPond.
523 @item @rinternalsnamed{Top,Internals}:
524 information about LilyPond's internal structures, which is
525 required for constructing tweaks.
532 @divClass{column-center-bottom}
533 @subheading Downloadable versions
535 @help{compare tarball vs. zip size, ask about windows users
536 dealing with tarballs (both gz and bz2), etc.}
538 @help{on second thought, wait until the new doc build. write an
539 apology here for no tarballs}
541 @divClass{keep-bullets}
550 @item info zip maybe?!?!
556 @subheading Previous stable versions
558 @divClass{keep-bullets}
561 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
562 LilyPond 2.12 Documentation}
564 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
565 LilyPond 2.10 Documentation}
567 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
568 LilyPond 2.8 Documentation}
570 @help anybody want to write this stuff?
581 @divClass{column-center-top}
582 @subheading Documentation license
584 The documentation for GNU LilyPond is published under the GNU Free
585 Documentation License. An introduction to this license, and our
586 reasons for choosing it, is given in @ref{Freedom}.
590 @divClass{column-center-bottom}
591 @subheading GNU Free Documentation License 1.1