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. For details, see the Contributors'
7 Guide, node Updating translation committishes..
13 @macro details{reference}
15 (@ref{\reference\, details of \reference\})
19 @divClass{heading-center}
21 @heading Manuals for LilyPond @version
24 @heading Manuals for LilyPond @versionStable
29 @divClass{link-headings}
31 @divClass{column-center-top}
32 @subheading Introduction
38 LilyPond is a @strong{text-based} music engraver. Read this first!
41 @ifWebLinks{@manualStableLearningSplitNoName,@rlearningnamed{Top,Learning}}
42 a @qq{must-read} gentle introduction to LilyPond.
46 @ifWebLinks{@manualStableGlossarySplitNoName,@rglosnamed{Top,Glossary}}
47 @emph{(optional reading)} musical terms and translations.
51 @ifWebLinks{@manualStableEssaySplitNoName,@ressaynamed{Top,Essay}}
52 @emph{(optional reading)} background information about computer engraving.
59 @divClass{column-left-top}
60 @subheading Regular use
65 @ifWebLinks{@manualStableNotationSplitNoName,@rusernamed{Top,Notation}}
70 @ifWebLinks{@manualStableUsageSplitNoName,@rprogramnamed{Top,Usage}}
75 @ifWebLinks{@manualStableSnippetsSplitNoName,@rlsrnamed{Top,Snippets}}
76 short tricks and tips.
84 @divClass{column-right-top}
85 @subheading Infrequent Use
91 Frequently Asked Questions.
99 @ifWebLinks{@manualStableChangesSplitNoName,@rchangesnamed{Top,Changes}}
104 @ifWebLinks{@manualStableExtendingSplitNoName,@rextendnamed{Top,Extending}}
109 @ifWebLinks{@manualStableInternalsSplitNoName,@rinternalsnamed{Top,Internals}}
118 @divClass{column-center-bottom}
119 @subheading Other material
125 previous stable versions and current as a compressed archive.
129 translation status for non-English readers.
132 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}:
133 user-created examples, hints and tips.
137 manuals for the unstable version.
141 these manuals are published under the GNU Free Documentation License.
147 @divClass{column-center-bottom}
148 @subheading Manual formats
150 The LilyPond manuals generally come in three formats: split HTML, big HTML and
151 PDF. Split HTML is good for reading online. Big HTML (and some of these can be
152 very big) contains the whole manual in a single page. PDF is available for
153 downloading and using offline. To get to these 3 formats, follow the links
154 that read @code{details of} and then the manual name.
163 * Learning:: Learning.
164 * Glossary:: Glossary.
166 * Notation:: Reference.
168 * Snippets:: Snippets.
172 * Extending:: Programming.
173 * Internals:: Internals.
174 * Translated:: Translation.
182 @c TRANSLATORS, most of the text in this file came from
183 @c LM 1.1 About the documentation (before this section was
184 @c removed in July 2009).
187 @unnumberedsec Learning
189 @divClass{column-left-top}
190 @subheading Learning manual
192 This book explains how to begin learning LilyPond, as well as
193 explaining some key concepts in easy terms. You should read these
194 chapters in a linear fashion.
196 There is a paragraph @strong{See also} at the end of each section,
197 which contains cross-references to other sections: you should not
198 follow these cross-references at first reading. When you have
199 read all of the manual, you may want to read some sections again
200 and follow those cross-references for more information.
203 @divClass{column-right-bottom}
205 @docLinks{Learning, learning,
206 @rlearningnamed{Top,Learning},
207 @manualStableLearningSplit,
208 @manualStableLearningBig, 3 MB,
209 @manualStableLearningPdf, 5 MB}
215 @unnumberedsec Glossary
217 @divClass{column-left-top}
220 This explains musical terms, and includes translations to various
221 languages. If you are not familiar with music notation or music
222 terminology (especially if you are a non-native English speaker),
223 it is highly advisable to consult the glossary.
227 @divClass{column-right-bottom}
229 @docLinks{Music glossary, music-glossary,
230 @rglosnamed{Top,Music glossary},
231 @manualStableGlossarySplit,
232 @manualStableGlossaryBig, 1 MB,
233 @manualStableGlossaryPdf, 1.5 MB}
241 @divClass{column-left-top}
244 This book gives a brief history of music typography, followed by
245 an examination of LilyPond's engraving techniques. A comparison
246 between LilyPond and other music engraving systems is given.
248 @warning{the detailed typographical examples are easier to analyze
249 in the PDF version due to its higher resolution.}
253 @divClass{column-right-bottom}
255 @docLinks{Essay, essay,
256 @ressaynamed{Top,Essay},
257 @manualStableEssaySplit,
258 @manualStableEssayBig, 1 MB,
259 @manualStableEssayPdf, 2 MB}
265 @unnumberedsec Notation
267 @divClass{column-left-top}
268 @subheading Notation reference
270 This book explains all the LilyPond commands which produce
273 @warning{the Notation reference assumes that the reader knows
274 basic material covered in the Learning manual and is familiar with
275 the English musical terms presented in the glossary.}
279 @divClass{column-right-bottom}
281 @docLinks{Notation, notation,
282 @rusernamed{Top,Notation},
283 @manualStableNotationSplit,
284 @manualStableNotationBig, 9 MB,
285 @manualStableNotationPdf, 35 MB}
293 @divClass{column-left-top}
294 @subheading Usage manual
296 This book explains how to execute the programs, how to integrate
297 LilyPond notation with other programs, and suggests @qq{best
298 practices} for efficient use. It is recommended reading before
299 attempting any large projects.
303 @divClass{column-right-bottom}
305 @docLinks{Usage, usage,
306 @rprogramnamed{Top,Usage},
307 @manualStableUsageSplit,
308 @manualStableUsageBig, 400 KB,
309 @manualStableUsagePdf, 650 KB}
315 @unnumberedsec Snippets
317 @divClass{column-left-top}
320 This shows a selected set of LilyPond snippets from the
321 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
322 (LSR). All the snippets are in the public domain.
324 Please note that this document is not an exact subset of LSR. LSR
325 is running a stable LilyPond version, so any snippet which
326 demonstrates new features of a development version must be added
327 separately. These are stored in @file{Documentation/snippets/new/} in the LilyPond
330 The list of snippets for each subsection of the Notation are also
331 linked from the @strong{See also} portion.
334 @divClass{column-right-bottom}
336 @docLinks{Snippets, snippets,
337 @rlsrnamed{Top,Snippets},
338 @manualStableSnippetsSplit,
339 @manualStableSnippetsBig, 1.5 MB,
340 @manualStableSnippetsPdf, 12.5 MB}
348 @divClass{column-center-top}
349 @subheading Introductory questions
351 @subsubheading Where are the graphical canvas, menus, and toolbars?
353 LilyPond requires you to write music as text. Please read about
354 our @ref{Text input}.
357 @subsubheading There's a lot of documentation! Do I need to read it?
359 You need to read the @ref{Learning, Learning manual}. As for the
360 rest of documentation, you only need to read the sections which
361 discuss the notation that you wish to create.
364 @subsubheading That's still a lot of reading! Is it worth it?
366 Please decide for yourself; the reasons why you might want to use
367 LilyPond are given in the @ref{Introduction}.
371 @divClass{column-center-bottom}
372 @subheading Usage questions
374 @subsubheading Something isn't working! How do I fix it?
376 This is explained in @rprogram{Troubleshooting}.
379 @subsubheading Why do you change the syntax?
381 This is explained in @rprogram{Why does the syntax change?}.
389 @divClass{column-left-top}
392 This manual supplies general information about LilyPond. It also
393 contains information about various community forums, bug
394 reporting, and development.
398 @divClass{column-right-bottom}
401 @subsubheading Latest manual
403 @divClass{keep-bullets}
409 @subsubheading Web manual in @versionDevel
411 @docLinksBare{Web, web,
413 @manualDevelWebSplit,
414 @manualDevelWebBig, 2.5 MB,
415 @manualDevelWebPdf, 3.5 MB}
421 @unnumberedsec Changes
423 @divClass{column-left-top}
426 This is a summary of important changes and new features in
427 LilyPond since the previous stable version.
431 @divClass{column-right-bottom}
433 @docLinks{Changes, changes,
434 @rchangesnamed{Top,Changes},
435 @manualStableChangesSplit,
436 @manualStableChangesBig, 90 KB,
437 @manualStableChangesPdf, 80 KB}
443 @unnumberedsec Extending
445 @divClass{column-left-top}
446 @subheading Extending LilyPond
448 This manual explains how to write extensions to LilyPond.
452 @divClass{column-right-bottom}
454 @docLinks{Extending, extending,
455 @rextendnamed{Top,Extending},
456 @manualStableExtendingSplit,
457 @manualStableExtendingBig, 300 KB,
458 @manualStableExtendingPdf, 500 KB}
464 @unnumberedsec Internals
466 @divClass{column-left-top}
467 @subheading Internals reference
469 This is a set of heavily cross linked pages which document
470 the nitty-gritty details of each and every LilyPond class, object,
471 and function. It is produced directly from the formatting
472 definitions in the source code.
474 Almost all formatting functionality that is used internally is
475 available directly to the user. For example, most variables that
476 control thickness values, distances, etc., can be changed in input
477 files. There are a huge number of formatting options, and all of
478 them are described in this document. Each section of the Notation
479 Reference has a @b{See also} subsection, which refers to the
480 generated documentation.
484 @divClass{column-right-bottom}
486 @docLinks{Internals, internals,
487 @rinternalsnamed{Top,Internals},
488 @manualStableInternalsSplit,
489 @manualStableInternalsBig, 3 MB,
490 @manualStableInternalsPdf, 4 MB}
496 @unnumberedsec Translated
498 @divClass{column-center-bottom}
499 @subheading Translations status
501 @include translations.itexi
509 @divClass{column-left-top}
510 @subheading Downloadable versions
513 Downloadable tarballs only available at @uref{http://lilypond.org}
517 @divClass{keep-bullets}
520 @item @doctarballStable
529 @divClass{column-right-bottom}
530 @subheading Previous stable versions
532 @divClass{keep-bullets}
535 @item @uref{http://lilypond.org/doc/v2.14/Documentation/web/manuals,
536 LilyPond 2.14 Documentation}
538 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
539 LilyPond 2.12 Documentation}
541 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
542 LilyPond 2.10 Documentation}
544 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
545 LilyPond 2.8 Documentation}
547 @item @uref{http://lilypond.org/doc/v2.6/Documentation/,
548 LilyPond 2.6 Documentation}
550 @item @uref{http://lilypond.org/doc/v2.4/Documentation/out-www/,
551 LilyPond 2.4 Documentation}
553 @item @uref{http://lilypond.org/doc/v2.2/Documentation/out-www/,
554 LilyPond 2.2 Documentation}
556 @item @uref{http://lilypond.org/doc/v2.0/Documentation/out-www/,
557 LilyPond 2.0 Documentation}
559 @item @uref{http://lilypond.org/doc/v1.8/Documentation/out-www/,
560 LilyPond 1.8 Documentation}
562 @item @uref{http://lilypond.org/doc/v1.6/Documentation/out-www/,
563 LilyPond 1.6 Documentation}
574 @divClass{column-center-top}
575 @subheading Documentation license
577 The documentation for GNU LilyPond is published under the GNU Free
578 Documentation License. An introduction to this license, and our
579 reasons for choosing it, is given in @ref{Freedom}.
583 @divClass{column-center-bottom}
584 @subheading GNU Free Documentation License 1.1