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.
152 * Learning:: Learning.
153 * Glossary:: Glossary.
155 * Notation:: Reference.
157 * Snippets:: Snippets.
161 * Extending:: Programming.
162 * Internals:: Internals.
163 * Translated:: Translation.
171 @c TRANSLATORS, most of the text in this file came from
172 @c LM 1.1 About the documentation (before this section was
173 @c removed in July 2009).
176 @unnumberedsec Learning
178 @divClass{column-left-top}
179 @subheading Learning manual
181 This book explains how to begin learning LilyPond, as well as
182 explaining some key concepts in easy terms. You should read these
183 chapters in a linear fashion.
185 There is a paragraph @strong{See also} at the end of each section,
186 which contains cross-references to other sections: you should not
187 follow these cross-references at first reading. When you have
188 read all of the manual, you may want to read some sections again
189 and follow those cross-references for more information.
192 @divClass{column-right-bottom}
194 @docLinks{Learning, learning,
195 @rlearningnamed{Top,Learning},
196 @manualStableLearningSplit,
197 @manualStableLearningBig, 1.5 MB,
198 @manualStableLearningPdf, 3 MB}
204 @unnumberedsec Glossary
206 @divClass{column-left-top}
209 This explains musical terms, and includes translations to various
210 languages. If you are not familiar with music notation or music
211 terminology (especially if you are a non-native English speaker),
212 it is highly advisable to consult the glossary.
216 @divClass{column-right-bottom}
218 @docLinks{Music glossary, music-glossary,
219 @rglosnamed{Top,Music glossary},
220 @manualStableGlossarySplit,
221 @manualStableGlossaryBig, 1 MB,
222 @manualStableGlossaryPdf, 1.5 MB}
230 @divClass{column-left-top}
233 This book gives a brief history of music typography, followed by
234 an examination of LilyPond's engraving techniques. A comparison
235 between LilyPond and other music engraving systems is given.
237 @warning{the detailed typographical examples are easier to analyze
238 in the PDF version due to its higher resolution.}
242 @divClass{column-right-bottom}
244 @docLinks{Essay, essay,
245 @ressaynamed{Top,Essay},
246 @manualStableEssaySplit,
247 @manualStableEssayBig, 2 MB,
248 @manualStableEssayPdf, 2.5 MB}
254 @unnumberedsec Notation
256 @divClass{column-left-top}
257 @subheading Notation reference
259 This book explains all the LilyPond commands which produce
262 @warning{the Notation reference assumes that the reader knows
263 basic material covered in the Learning manual and is familiar with
264 the English musical terms presented in the glossary.}
268 @divClass{column-right-bottom}
270 @docLinks{Notation, notation,
271 @rusernamed{Top,Notation},
272 @manualStableNotationSplit,
273 @manualStableNotationBig, 7 MB,
274 @manualStableNotationPdf, 18 MB}
282 @divClass{column-left-top}
283 @subheading Usage manual
285 This book explains how to execute the programs, how to integrate
286 LilyPond notation with other programs, and suggests @qq{best
287 practices} for efficient use. It is recommended reading before
288 attempting any large projects.
292 @divClass{column-right-bottom}
294 @docLinks{Usage, usage,
295 @rprogramnamed{Top,Usage},
296 @manualStableUsageSplit,
297 @manualStableUsageBig, 400 KB,
298 @manualStableUsagePdf, 600 KB}
304 @unnumberedsec Snippets
306 @divClass{column-left-top}
309 This shows a selected set of LilyPond snippets from the
310 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
311 (LSR). All the snippets are in the public domain.
313 Please note that this document is not an exact subset of LSR. LSR
314 is running a stable LilyPond version, so any snippet which
315 demonstrates new features of a development version must be added
316 separately. These are stored in @file{Documentation/snippets/new/} in the LilyPond
319 The list of snippets for each subsection of the Notation are also
320 linked from the @strong{See also} portion.
323 @divClass{column-right-bottom}
325 @docLinks{Snippets, snippets,
326 @rlsrnamed{Top,Snippets},
327 @manualStableSnippetsSplit,
328 @manualStableSnippetsBig, 2.5 MB,
329 @manualStableSnippetsPdf, 8 MB}
337 @divClass{column-center-top}
338 @subheading Introductory questions
340 @subsubheading Where are the graphical canvas, menus, and toolbars?
342 LilyPond requires you to write music as text. Please read about
343 our @ref{Text input}.
346 @subsubheading There's a lot of documentation! Do I need to read it?
348 You need to read the @ref{Learning, Learning manual}. As for the
349 rest of documentation, you only need to read the sections which
350 discuss the notation that you wish to create.
353 @subsubheading That's still a lot of reading! Is it worth it?
355 Please decide for yourself; the reasons why you might want to use
356 LilyPond are given in the @ref{Introduction}.
360 @divClass{column-center-bottom}
361 @subheading Usage questions
363 @subsubheading Something isn't working! How do I fix it?
365 This is explained in @rprogram{Troubleshooting}.
368 @subsubheading Why do you change the syntax?
370 This is explained in @rprogram{Why does the syntax change?}.
378 @divClass{column-left-top}
381 This manual supplies general information about LilyPond. It also
382 contains information about various community forums, bug
383 reporting, and development.
387 @divClass{column-right-bottom}
390 @subsubheading Latest manual
392 @divClass{keep-bullets}
398 @subsubheading Web manual in @versionDevel
400 @docLinksBare{Web, web,
402 @manualDevelWebSplit,
403 @manualDevelWebBig, 1 MB,
404 @manualDevelWebPdf, 2 MB}
410 @unnumberedsec Changes
412 @divClass{column-left-top}
415 This is a summary of important changes and new features in
416 LilyPond since the previous stable version.
420 @divClass{column-right-bottom}
422 @docLinks{Changes, changes,
423 @rchangesnamed{Top,Changes},
424 @manualStableChangesSplit,
425 @manualStableChangesBig, 6 KB,
426 @manualStableChangesPdf, 200 KB}
432 @unnumberedsec Extending
434 @divClass{column-left-top}
435 @subheading Extending LilyPond
437 This manual explains how to write extensions to LilyPond.
441 @divClass{column-right-bottom}
443 @docLinks{Extending, extending,
444 @rextendnamed{Top,Extending},
445 @manualStableExtendingSplit,
446 @manualStableExtendingBig, 200 KB,
447 @manualStableExtendingPdf, 400 KB}
453 @unnumberedsec Internals
455 @divClass{column-left-top}
456 @subheading Internals reference
458 This is a set of heavily cross linked pages which document
459 the nitty-gritty details of each and every LilyPond class, object,
460 and function. It is produced directly from the formatting
461 definitions in the source code.
463 Almost all formatting functionality that is used internally is
464 available directly to the user. For example, most variables that
465 control thickness values, distances, etc., can be changed in input
466 files. There are a huge number of formatting options, and all of
467 them are described in this document. Each section of the Notation
468 Reference has a @b{See also} subsection, which refers to the
469 generated documentation.
473 @divClass{column-right-bottom}
475 @docLinks{Internals, internals,
476 @rinternalsnamed{Top,Internals},
477 @manualStableInternalsSplit,
478 @manualStableInternalsBig, 2.5 MB,
479 @manualStableInternalsPdf, 2.8 MB}
485 @unnumberedsec Translated
487 @divClass{column-center-bottom}
488 @subheading Translations status
490 @include translations.itexi
498 @divClass{column-left-top}
499 @subheading Downloadable versions
502 Downloadable tarballs only available at @uref{http://lilypond.org}
506 @divClass{keep-bullets}
509 @item @doctarballStable
518 @divClass{column-right-bottom}
519 @subheading Previous stable versions
521 @divClass{keep-bullets}
524 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
525 LilyPond 2.12 Documentation}
527 @item @uref{http://lilypond.org/doc/v2.11/Documentation/,
528 LilyPond 2.11 Documentation}
530 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
531 LilyPond 2.10 Documentation}
533 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
534 LilyPond 2.8 Documentation}
536 @item @uref{http://lilypond.org/doc/v2.6/Documentation/,
537 LilyPond 2.6 Documentation}
539 @item @uref{http://lilypond.org/doc/v2.4/Documentation/out-www/,
540 LilyPond 2.4 Documentation}
542 @item @uref{http://lilypond.org/doc/v2.2/Documentation/out-www/,
543 LilyPond 2.2 Documentation}
545 @item @uref{http://lilypond.org/doc/v2.0/Documentation/out-www/,
546 LilyPond 2.0 Documentation}
548 @item @uref{http://lilypond.org/doc/v1.8/Documentation/out-www/,
549 LilyPond 1.8 Documentation}
551 @item @uref{http://lilypond.org/doc/v1.6/Documentation/out-www/,
552 LilyPond 1.6 Documentation}
563 @divClass{column-center-top}
564 @subheading Documentation license
566 The documentation for GNU LilyPond is published under the GNU Free
567 Documentation License. An introduction to this license, and our
568 reasons for choosing it, is given in @ref{Freedom}.
572 @divClass{column-center-bottom}
573 @subheading GNU Free Documentation License 1.1