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\})
20 @divClass{heading-center}
22 @heading Manuals for LilyPond @version
25 @heading Manuals for LilyPond @versionStable
30 @c TODO: do we want these links to be in larger text / bold ? CSS.
32 @divClass{column-center-top}
33 @subheading Introduction
37 @item @ref{Text input}:
38 LilyPond is a @strong{text-based} music engraver. Read this
41 @item @ifWebLinks{@manualStableLearningSplitNoName,@rlearningnamed{Top,Learning}}
42 a @qq{must-read} gentle introduction to LilyPond.
45 @item @ifWebLinks{@manualStableGlossarySplitNoName,@rglosnamed{Top,Glossary}}
46 @emph{(optional reading)}
47 musical terms and translations.
50 @item @ifWebLinks{@manualStableEssaySplitNoName,@ressaynamed{Top,Essay}}
51 @emph{(optional reading)}
52 background information about computer engraving.
60 @divClass{column-left-top}
61 @subheading Regular use
65 @item @ifWebLinks{@manualStableNotationSplitNoName,@rusernamed{Top,Notation}}
69 @item @ifWebLinks{@manualStableUsageSplitNoName,@rprogramnamed{Top,Usage}}
73 @item @ifWebLinks{@manualStableSnippetsSplitNoName,@rlsrnamed{Top,Snippets}}
74 short tricks and tips.
82 @divClass{column-right-top}
83 @subheading Infrequent Use
88 Frequently Asked Questions.
94 @item @ifWebLinks{@manualStableChangesSplitNoName,@rchangesnamed{Top,Changes}}
98 @item @ifWebLinks{@manualStableExtendingSplitNoName,@rextendnamed{Top,Extending}}
102 @item @ifWebLinks{@manualStableInternalsSplitNoName,@rinternalsnamed{Top,Internals}}
111 @divClass{column-center-bottom}
112 @subheading Other material
116 @item @ref{Translated}:
117 translation status for non-English readers.
120 downloadable and old manuals.
122 @item @ref{Development}:
123 manuals for the unstable version.
126 these manuals are published under the GNU Free Documentation
136 * Learning:: Learning.
137 * Glossary:: Glossary.
139 * Notation:: Reference.
141 * Snippets:: Snippets.
145 * Extending:: Programming.
146 * Internals:: Internals.
147 * Translated:: Translation.
155 @c TRANSLATORS, most of the text in this file came from
156 @c LM 1.1 About the documentation (before this section was
157 @c removed in July 2009).
160 @unnumberedsec Learning
162 @divClass{column-left-top}
163 @subheading Learning manual
165 This book explains how to begin learning LilyPond, as well as
166 explaining some key concepts in easy terms. You should read these
167 chapters in a linear fashion.
169 There is a paragraph @strong{See also} at the end of each section,
170 which contains cross-references to other sections: you should not
171 follow these cross-references at first reading. When you have
172 read all of the manual, you may want to read some sections again
173 and follow those cross-references for more information.
176 @divClass{column-right-bottom}
178 @docLinks{Learning, learning,
179 @rlearningnamed{Top,Learning},
180 @manualStableLearningSplit,
181 @manualStableLearningBig, 1.5 MB,
182 @manualStableLearningPdf, 3 MB}
188 @unnumberedsec Glossary
190 @divClass{column-left-top}
193 This explains musical terms, and includes translations to various
194 languages. If you are not familiar with music notation or music
195 terminology (especially if you are a non-native English speaker),
196 it is highly advisable to consult the glossary.
200 @divClass{column-right-bottom}
202 @docLinks{Music glossary, music-glossary,
203 @rglosnamed{Top,Music glossary},
204 @manualStableGlossarySplit,
205 @manualStableGlossaryBig, 1 MB,
206 @manualStableGlossaryPdf, 1.5 MB}
214 @divClass{column-left-top}
217 This book gives a brief history of music typography, followed by
218 an examination of LilyPond's engraving techniques. A comparison
219 between LilyPond and other music engraving systems is given.
221 @warning{the detailed typographical examples are easier to analyze
222 in the PDF version due to its higher resolution.}
226 @divClass{column-right-bottom}
228 @docLinks{Essay, essay,
229 @ressaynamed{Top,Essay},
230 @manualStableEssaySplit,
231 @manualStableEssayBig, 2 MB,
232 @manualStableEssayPdf, 2.5 MB}
238 @unnumberedsec Notation
240 @divClass{column-left-top}
241 @subheading Notation reference
243 This book explains all the LilyPond commands which produce
246 @warning{the Notation reference assumes that the reader knows
247 basic material covered in the Learning manual and is familiar with
248 the English musical terms presented in the glossary.}
252 @divClass{column-right-bottom}
254 @docLinks{Notation, notation,
255 @rusernamed{Top,Notation},
256 @manualStableNotationSplit,
257 @manualStableNotationBig, 7 MB,
258 @manualStableNotationPdf, 18 MB}
266 @divClass{column-left-top}
267 @subheading Usage manual
269 This book explains how to execute the programs, how to integrate
270 LilyPond notation with other programs, and suggests @qq{best
271 practices} for efficient use. It is recommended reading before
272 attempting any large projects.
276 @divClass{column-right-bottom}
278 @docLinks{Usage, usage,
279 @rprogramnamed{Top,Usage},
280 @manualStableUsageSplit,
281 @manualStableUsageBig, 300 KB,
282 @manualStableUsagePdf, 400 KB}
288 @unnumberedsec Snippets
290 @divClass{column-left-top}
293 This shows a selected set of LilyPond snippets from the
294 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
295 (LSR). All the snippets are in the public domain.
297 Please note that this document is not an exact subset of LSR. LSR
298 is running a stable LilyPond version, so any snippet which
299 demonstrates new features of a development version must be added
300 separately. These are stored in @file{Documentation/snippets/new/} in the LilyPond
303 The list of snippets for each subsection of the Notation are also
304 linked from the @strong{See also} portion.
307 @divClass{column-right-bottom}
309 @docLinks{Snippets, snippets,
310 @rlsrnamed{Top,Snippets},
311 @manualStableSnippetsSplit,
312 @manualStableSnippetsBig, 2.5 MB,
313 @manualStableSnippetsPdf, 8 MB}
321 @divClass{column-center-top}
322 @subheading Introductory questions
324 @subsubheading Where are the graphical canvas, menus, and toolbars?
326 LilyPond requires you to write music as text. Please read about
327 our @ref{Text input}.
330 @subsubheading There's a lot of documentation! Do I need to read it?
332 You need to read the @ref{Learning, Learning manual}. As for the
333 rest of documentation, you only need to read the sections which
334 discuss the notation that you wish to create.
337 @subsubheading That's still a lot of reading! Is it worth it?
339 Please decide for yourself; the reasons why you might want to use
340 LilyPond are given in the @ref{Introduction}.
344 @divClass{column-center-bottom}
345 @subheading Usage questions
347 @subsubheading Something isn't working! How do I fix it?
349 This is explained in @rprogram{Troubleshooting}.
352 @subsubheading Why do you change the syntax?
354 This is explained in @rprogram{Why does the syntax change?}.
362 @divClass{column-left-top}
365 This manual supplies general information about LilyPond. It also
366 contains information about various community forums, bug
367 reporting, and development.
371 @divClass{column-right-bottom}
374 @subsubheading Lastest manual
376 @divClass{keep-bullets}
382 @subsubheading Web manual in @versionDevel
384 @docLinksBare{Web, web,
386 @manualDevelWebSplit,
387 @manualDevelWebBig, 1 MB,
388 @manualDevelWebPdf, 2 MB}
394 @unnumberedsec Changes
396 @divClass{column-left-top}
399 This is a summary of important changes and new features in
400 LilyPond since the previous stable version.
404 @divClass{column-right-bottom}
406 @docLinks{Changes, changes,
407 @rchangesnamed{Top,Changes},
408 @manualStableChangesSplit,
409 @manualStableChangesBig, 6 KB,
410 @manualStableChangesPdf, 200 KB}
416 @unnumberedsec Extending
418 @divClass{column-left-top}
419 @subheading Extending LilyPond
421 This manual explains how to write extensions to LilyPond.
425 @divClass{column-right-bottom}
427 @docLinks{Extending, extending,
428 @rextendnamed{Top,Extending},
429 @manualStableExtendingSplit,
430 @manualStableExtendingBig, 200 KB,
431 @manualStableExtendingPdf, 400 KB}
437 @unnumberedsec Internals
439 @divClass{column-left-top}
440 @subheading Internals reference
442 This is a set of heavily cross linked pages which document
443 the nitty-gritty details of each and every LilyPond class, object,
444 and function. It is produced directly from the formatting
445 definitions in the source code.
447 Almost all formatting functionality that is used internally is
448 available directly to the user. For example, most variables that
449 control thickness values, distances, etc., can be changed in input
450 files. There are a huge number of formatting options, and all of
451 them are described in this document. Each section of the Notation
452 Reference has a @b{See also} subsection, which refers to the
453 generated documentation.
457 @divClass{column-right-bottom}
459 @docLinks{Internals, internals,
460 @rinternalsnamed{Top,Internals},
461 @manualStableInternalsSplit,
462 @manualStableInternalsBig, 2.5 MB,
463 @manualStableInternalsPdf, 2.8 MB}
469 @unnumberedsec Translated
471 @divClass{column-center-bottom}
472 @subheading Translations status
474 TODO: fix and generate in Texinfo.
475 @c http://code.google.com/p/lilypond/issues/detail?id=857
483 @divClass{column-left-top}
484 @subheading Downloadable versions
487 Downloadable tarballs only available at @uref{http://lilypond.org}
491 @divClass{keep-bullets}
494 @item @doctarballStable
503 @divClass{column-right-bottom}
504 @subheading Previous stable versions
506 @divClass{keep-bullets}
509 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
510 LilyPond 2.12 Documentation}
512 @item @uref{http://lilypond.org/doc/v2.11/Documentation/,
513 LilyPond 2.11 Documentation}
515 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
516 LilyPond 2.10 Documentation}
518 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
519 LilyPond 2.8 Documentation}
521 @item @uref{http://lilypond.org/doc/v2.6/Documentation/,
522 LilyPond 2.6 Documentation}
524 @item @uref{http://lilypond.org/doc/v2.4/Documentation/out-www/,
525 LilyPond 2.4 Documentation}
527 @item @uref{http://lilypond.org/doc/v2.2/Documentation/out-www/,
528 LilyPond 2.2 Documentation}
530 @item @uref{http://lilypond.org/doc/v2.0/Documentation/out-www/,
531 LilyPond 2.0 Documentation}
533 @item @uref{http://lilypond.org/doc/v1.8/Documentation/out-www/,
534 LilyPond 1.8 Documentation}
536 @item @uref{http://lilypond.org/doc/v1.6/Documentation/out-www/,
537 LilyPond 1.6 Documentation}
548 @divClass{column-center-top}
549 @subheading Documentation license
551 The documentation for GNU LilyPond is published under the GNU Free
552 Documentation License. An introduction to this license, and our
553 reasons for choosing it, is given in @ref{Freedom}.
557 @divClass{column-center-bottom}
558 @subheading GNU Free Documentation License 1.1