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 @macro details{reference}
14 (@ref{\reference\, details of \reference\})
19 @divClass{heading-center}
21 @heading Manuals for LilyPond @version
24 @heading Manuals for LilyPond @versionStable
29 @c TODO: do we want these links to be in larger text / bold ? CSS.
31 @divClass{column-center-top}
32 @subheading Introduction
36 @item @ref{Text input}:
37 LilyPond is a @strong{text-based} music engraver. Read this
40 @item @ifWebLinks{@manualStableLearningSplitNoName,@rlearningnamed{Top,Learning}}
41 a @qq{must-read} gentle introduction to LilyPond.
44 @item @ifWebLinks{@manualStableGlossarySplitNoName,@rglosnamed{Top,Glossary}}
45 @emph{(optional reading)}
46 musical terms and translations.
49 @item @ifWebLinks{@manualStableEssaySplitNoName,@ressaynamed{Top,Essay}}
50 @emph{(optional reading)}
51 background information about computer engraving.
59 @divClass{column-left-top}
60 @subheading Regular use
64 @item @ifWebLinks{@manualStableNotationSplitNoName,@rusernamed{Top,Notation}}
68 @item @ifWebLinks{@manualStableUsageSplitNoName,@rprogramnamed{Top,Usage}}
72 @item @ifWebLinks{@manualStableSnippetsSplitNoName,@rlsrnamed{Top,Snippets}}
73 short tricks and tips.
81 @divClass{column-right-top}
82 @subheading Infrequent Use
87 Frequently Asked Questions.
93 @item @ifWebLinks{@manualStableChangesSplitNoName,@rchangesnamed{Top,Changes}}
97 @item @ifWebLinks{@manualStableExtendingSplitNoName,@rextendnamed{Top,Extending}}
101 @item @ifWebLinks{@manualStableInternalsSplitNoName,@rinternalsnamed{Top,Internals}}
110 @divClass{column-center-bottom}
111 @subheading Other material
115 @item @ref{Translated}:
116 translation status for non-English readers.
119 downloadable and old manuals.
121 @item @ref{Development}:
122 manuals for the unstable version.
125 these manuals are published under the GNU Free Documentation
135 * Learning:: Learning.
136 * Glossary:: Glossary.
138 * Notation:: Reference.
140 * Snippets:: Snippets.
144 * Extending:: Programming.
145 * Internals:: Internals.
146 * Translated:: Translation.
154 @c TRANSLATORS, most of the text in this file came from
155 @c LM 1.1 About the documentation (before this section was
156 @c removed in July 2009).
159 @unnumberedsec Learning
161 @divClass{column-left-top}
162 @subheading Learning manual
164 This book explains how to begin learning LilyPond, as well as
165 explaining some key concepts in easy terms. You should read these
166 chapters in a linear fashion.
168 There is a paragraph @strong{See also} at the end of each section,
169 which contains cross-references to other sections: you should not
170 follow these cross-references at first reading. When you have
171 read all of the manual, you may want to read some sections again
172 and follow those cross-references for more information.
175 @divClass{column-right-bottom}
177 @docLinks{Learning, learning,
178 @rlearningnamed{Top,Learning},
179 @manualStableLearningSplit,
180 @manualStableLearningBig, 1.5 MB,
181 @manualStableLearningPdf, 3 MB}
187 @unnumberedsec Glossary
189 @divClass{column-left-top}
192 This explains musical terms, and includes translations to various
193 languages. If you are not familiar with music notation or music
194 terminology (especially if you are a non-native English speaker),
195 it is highly advisable to consult the glossary.
199 @divClass{column-right-bottom}
201 @docLinks{Music glossary, music-glossary,
202 @rglosnamed{Top,Music glossary},
203 @manualStableGlossarySplit,
204 @manualStableGlossaryBig, 1 MB,
205 @manualStableGlossaryPdf, 1.5 MB}
213 @divClass{column-left-top}
216 This book gives a brief history of music typography, followed by
217 an examination of LilyPond's engraving techniques. A comparison
218 between LilyPond and other music engraving systems is given.
220 @warning{the detailed typographical examples are easier to analyze
221 in the PDF version due to its higher resolution.}
225 @divClass{column-right-bottom}
227 @docLinks{Essay, essay,
228 @ressaynamed{Top,Essay},
229 @manualStableEssaySplit,
230 @manualStableEssayBig, 2 MB,
231 @manualStableEssayPdf, 2.5 MB}
237 @unnumberedsec Notation
239 @divClass{column-left-top}
240 @subheading Notation reference
242 This book explains all the LilyPond commands which produce
245 @warning{the Notation reference assumes that the reader knows
246 basic material covered in the Learning manual and is familiar with
247 the English musical terms presented in the glossary.}
251 @divClass{column-right-bottom}
253 @docLinks{Notation, notation,
254 @rusernamed{Top,Notation},
255 @manualStableNotationSplit,
256 @manualStableNotationBig, 7 MB,
257 @manualStableNotationPdf, 18 MB}
265 @divClass{column-left-top}
266 @subheading Usage manual
268 This book explains how to execute the programs, how to integrate
269 LilyPond notation with other programs, and suggests @qq{best
270 practices} for efficient use. It is recommended reading before
271 attempting any large projects.
275 @divClass{column-right-bottom}
277 @docLinks{Usage, usage,
278 @rprogramnamed{Top,Usage},
279 @manualStableUsageSplit,
280 @manualStableUsageBig, 300 KB,
281 @manualStableUsagePdf, 400 KB}
287 @unnumberedsec Snippets
289 @divClass{column-left-top}
292 This shows a selected set of LilyPond snippets from the
293 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
294 (LSR). All the snippets are in the public domain.
296 Please note that this document is not an exact subset of LSR. LSR
297 is running a stable LilyPond version, so any snippet which
298 demonstrates new features of a development version must be added
299 separately. These are stored in @file{Documentation/snippets/new/} in the LilyPond
302 The list of snippets for each subsection of the Notation are also
303 linked from the @strong{See also} portion.
306 @divClass{column-right-bottom}
308 @docLinks{Snippets, snippets,
309 @rlsrnamed{Top,Snippets},
310 @manualStableSnippetsSplit,
311 @manualStableSnippetsBig, 2.5 MB,
312 @manualStableSnippetsPdf, 8 MB}
320 @divClass{column-center-top}
321 @subheading Introductory questions
323 @subsubheading Where are the graphical canvas, menus, and toolbars?
325 LilyPond requires you to write music as text. Please read about
326 our @ref{Text input}.
329 @subsubheading There's a lot of documentation! Do I need to read it?
331 You need to read the @ref{Learning, Learning manual}. As for the
332 rest of documentation, you only need to read the sections which
333 discuss the notation that you wish to create.
336 @subsubheading That's still a lot of reading! Is it worth it?
338 Please decide for yourself; the reasons why you might want to use
339 LilyPond are given in the @ref{Introduction}.
343 @divClass{column-center-bottom}
344 @subheading Usage questions
346 @subsubheading Something isn't working! How do I fix it?
348 This is explained in @rprogram{Troubleshooting}.
351 @subsubheading Why do you change the syntax?
353 This is explained in @rprogram{Why does the syntax change?}.
361 @divClass{column-left-top}
364 This manual supplies general information about LilyPond. It also
365 contains information about various community forums, bug
366 reporting, and development.
370 @divClass{column-right-bottom}
373 @subsubheading Lastest manual
375 @divClass{keep-bullets}
381 @subsubheading Web manual in @versionDevel
383 @docLinksBare{Web, web,
385 @manualDevelWebSplit,
386 @manualDevelWebBig, 1 MB,
387 @manualDevelWebPdf, 2 MB}
393 @unnumberedsec Changes
395 @divClass{column-left-top}
398 This is a summary of important changes and new features in
399 LilyPond since the previous stable version.
403 @divClass{column-right-bottom}
405 @docLinks{Changes, changes,
406 @rchangesnamed{Top,Changes},
407 @manualStableChangesSplit,
408 @manualStableChangesBig, 6 KB,
409 @manualStableChangesPdf, 200 KB}
415 @unnumberedsec Extending
417 @divClass{column-left-top}
418 @subheading Extending LilyPond
420 This manual explains how to write extensions to LilyPond.
424 @divClass{column-right-bottom}
426 @docLinks{Extending, extending,
427 @rextendnamed{Top,Extending},
428 @manualStableExtendingSplit,
429 @manualStableExtendingBig, 200 KB,
430 @manualStableExtendingPdf, 400 KB}
436 @unnumberedsec Internals
438 @divClass{column-left-top}
439 @subheading Internals reference
441 This is a set of heavily cross linked pages which document
442 the nitty-gritty details of each and every LilyPond class, object,
443 and function. It is produced directly from the formatting
444 definitions in the source code.
446 Almost all formatting functionality that is used internally is
447 available directly to the user. For example, most variables that
448 control thickness values, distances, etc., can be changed in input
449 files. There are a huge number of formatting options, and all of
450 them are described in this document. Each section of the Notation
451 Reference has a @b{See also} subsection, which refers to the
452 generated documentation.
456 @divClass{column-right-bottom}
458 @docLinks{Internals, internals,
459 @rinternalsnamed{Top,Internals},
460 @manualStableInternalsSplit,
461 @manualStableInternalsBig, 2.5 MB,
462 @manualStableInternalsPdf, 2.8 MB}
468 @unnumberedsec Translated
470 @divClass{column-center-bottom}
471 @subheading Translations status
473 TODO: fix and generate in Texinfo.
474 @c http://code.google.com/p/lilypond/issues/detail?id=857
482 @divClass{column-left-top}
483 @subheading Downloadable versions
486 Downloadable tarballs only available at @uref{http://lilypond.org}
490 @divClass{keep-bullets}
493 @item @doctarballStable
502 @divClass{column-right-bottom}
503 @subheading Previous stable versions
505 @divClass{keep-bullets}
508 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
509 LilyPond 2.12 Documentation}
511 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
512 LilyPond 2.10 Documentation}
514 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
515 LilyPond 2.8 Documentation}
517 @help anybody want to write this stuff?
528 @divClass{column-center-top}
529 @subheading Documentation license
531 The documentation for GNU LilyPond is published under the GNU Free
532 Documentation License. An introduction to this license, and our
533 reasons for choosing it, is given in @ref{Freedom}.
537 @divClass{column-center-bottom}
538 @subheading GNU Free Documentation License 1.1