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@/.di@/.unimi@/.it,LilyPond Snippet Repository}:
133 user-created examples, hints and tips.
136 @uref{http://bit.ly/LilyPondBeginners,Video Tutorials}:
137 Ben Lemon, a LilyPond user, has created a range of video tutorials on
138 his blog and which are aimed at new users.
142 manuals for the unstable version.
146 these manuals are published under the GNU Free Documentation License.
152 @divClass{column-center-bottom}
153 @subheading Manual formats
155 The LilyPond manuals generally come in three formats: split HTML, big HTML and
156 PDF. Split HTML is good for reading online. Big HTML (and some of these can be
157 very big) contains the whole manual in a single page. PDF is available for
158 downloading and using offline. To get to these 3 formats, follow the links
159 that read @code{details of} and then the manual name.
168 * Learning:: Learning.
169 * Glossary:: Glossary.
171 * Notation:: Reference.
173 * Snippets:: Snippets.
177 * Extending:: Programming.
178 * Internals:: Internals.
179 * Translated:: Translation.
187 @c TRANSLATORS, most of the text in this file came from
188 @c LM 1.1 About the documentation (before this section was
189 @c removed in July 2009).
192 @unnumberedsec Learning
194 @divClass{column-left-top}
195 @subheading Learning manual
197 This book explains how to begin learning LilyPond, as well as
198 explaining some key concepts in easy terms. You should read these
199 chapters in a linear fashion.
201 There is a paragraph @strong{See also} at the end of each section,
202 which contains cross-references to other sections: you should not
203 follow these cross-references at first reading. When you have
204 read all of the manual, you may want to read some sections again
205 and follow those cross-references for more information.
208 @divClass{column-right-bottom}
210 @docLinks{Learning, learning,
211 @rlearningnamed{Top,Learning},
212 @manualStableLearningSplit,
213 @manualStableLearningBig, 3 MB,
214 @manualStableLearningPdf, 5 MB}
220 @unnumberedsec Glossary
222 @divClass{column-left-top}
225 This explains musical terms, and includes translations to various
226 languages. If you are not familiar with music notation or music
227 terminology (especially if you are a non-native English speaker),
228 it is highly advisable to consult the glossary.
232 @divClass{column-right-bottom}
234 @docLinks{Music glossary, music-glossary,
235 @rglosnamed{Top,Music glossary},
236 @manualStableGlossarySplit,
237 @manualStableGlossaryBig, 1 MB,
238 @manualStableGlossaryPdf, 1.5 MB}
246 @divClass{column-left-top}
249 This book gives a brief history of music typography, followed by
250 an examination of LilyPond's engraving techniques. A comparison
251 between LilyPond and other music engraving systems is given.
253 @warning{the detailed typographical examples are easier to analyze
254 in the PDF version due to its higher resolution.}
258 @divClass{column-right-bottom}
260 @docLinks{Essay, essay,
261 @ressaynamed{Top,Essay},
262 @manualStableEssaySplit,
263 @manualStableEssayBig, 1 MB,
264 @manualStableEssayPdf, 2 MB}
270 @unnumberedsec Notation
272 @divClass{column-left-top}
273 @subheading Notation reference
275 This book explains all the LilyPond commands which produce
278 @warning{the Notation reference assumes that the reader knows
279 basic material covered in the Learning manual and is familiar with
280 the English musical terms presented in the glossary.}
284 @divClass{column-right-bottom}
286 @docLinks{Notation, notation,
287 @rusernamed{Top,Notation},
288 @manualStableNotationSplit,
289 @manualStableNotationBig, 9 MB,
290 @manualStableNotationPdf, 35 MB}
298 @divClass{column-left-top}
299 @subheading Usage manual
301 This book explains how to execute the programs, how to integrate
302 LilyPond notation with other programs, and suggests @qq{best
303 practices} for efficient use. It is recommended reading before
304 attempting any large projects.
308 @divClass{column-right-bottom}
310 @docLinks{Usage, usage,
311 @rprogramnamed{Top,Usage},
312 @manualStableUsageSplit,
313 @manualStableUsageBig, 400 KB,
314 @manualStableUsagePdf, 650 KB}
320 @unnumberedsec Snippets
322 @divClass{column-left-top}
325 This shows a selected set of LilyPond snippets from the
326 @uref{http://lsr@/.di@/.unimi@/.it,LilyPond Snippet Repository}
327 (LSR). All the snippets are in the public domain.
329 Please note that this document is not an exact subset of LSR. LSR
330 is running a stable LilyPond version, so any snippet which
331 demonstrates new features of a development version must be added
332 separately. These are stored in @file{Documentation/snippets/new/} in the LilyPond
335 The list of snippets for each subsection of the Notation are also
336 linked from the @strong{See also} portion.
339 @divClass{column-right-bottom}
341 @docLinks{Snippets, snippets,
342 @rlsrnamed{Top,Snippets},
343 @manualStableSnippetsSplit,
344 @manualStableSnippetsBig, 1.5 MB,
345 @manualStableSnippetsPdf, 12.5 MB}
353 @divClass{column-center-top}
354 @subheading Introductory questions
356 @subsubheading Where are the graphical canvas, menus, and toolbars?
358 LilyPond requires you to write music as text. Please read about
359 our @ref{Text input}.
362 @subsubheading There's a lot of documentation! Do I need to read it?
364 You need to read the @ref{Learning, Learning manual}. As for the
365 rest of documentation, you only need to read the sections which
366 discuss the notation that you wish to create.
369 @subsubheading That's still a lot of reading! Is it worth it?
371 Please decide for yourself; the reasons why you might want to use
372 LilyPond are given in the @ref{Introduction}.
376 @divClass{column-center-bottom}
377 @subheading Usage questions
379 @subsubheading Something isn't working! How do I fix it?
381 This is explained in @rprogram{Troubleshooting}.
384 @subsubheading Why do you change the syntax?
386 This is explained in @rprogram{Why does the syntax change?}.
394 @divClass{column-left-top}
397 This manual supplies general information about LilyPond. It also
398 contains information about various community forums, bug
399 reporting, and development.
403 @divClass{column-right-bottom}
406 @subsubheading Latest manual
408 @divClass{keep-bullets}
414 @subsubheading Web manual in @versionDevel
416 @docLinksBare{Web, web,
418 @manualDevelWebSplit,
419 @manualDevelWebBig, 2.5 MB,
420 @manualDevelWebPdf, 3.5 MB}
426 @unnumberedsec Changes
428 @divClass{column-left-top}
431 This is a summary of important changes and new features in
432 LilyPond since the previous stable version.
436 @divClass{column-right-bottom}
438 @docLinks{Changes, changes,
439 @rchangesnamed{Top,Changes},
440 @manualStableChangesSplit,
441 @manualStableChangesBig, 90 KB,
442 @manualStableChangesPdf, 80 KB}
448 @unnumberedsec Extending
450 @divClass{column-left-top}
451 @subheading Extending LilyPond
453 This manual explains how to write extensions to LilyPond.
457 @divClass{column-right-bottom}
459 @docLinks{Extending, extending,
460 @rextendnamed{Top,Extending},
461 @manualStableExtendingSplit,
462 @manualStableExtendingBig, 300 KB,
463 @manualStableExtendingPdf, 500 KB}
469 @unnumberedsec Internals
471 @divClass{column-left-top}
472 @subheading Internals reference
474 This is a set of heavily cross linked pages which document
475 the nitty-gritty details of each and every LilyPond class, object,
476 and function. It is produced directly from the formatting
477 definitions in the source code.
479 Almost all formatting functionality that is used internally is
480 available directly to the user. For example, most variables that
481 control thickness values, distances, etc., can be changed in input
482 files. There are a huge number of formatting options, and all of
483 them are described in this document. Each section of the Notation
484 Reference has a @b{See also} subsection, which refers to the
485 generated documentation.
489 @divClass{column-right-bottom}
491 @docLinks{Internals, internals,
492 @rinternalsnamed{Top,Internals},
493 @manualStableInternalsSplit,
494 @manualStableInternalsBig, 3 MB,
495 @manualStableInternalsPdf, 4 MB}
501 @unnumberedsec Translated
503 @divClass{column-center-bottom}
504 @subheading Translations status
506 @include translations.itexi
514 @divClass{column-left-top}
515 @subheading Downloadable versions
518 Downloadable tarballs only available at @uref{http://lilypond.org}
522 @divClass{keep-bullets}
525 @item @doctarballStable
534 @divClass{column-right-bottom}
535 @subheading Previous stable versions
537 @divClass{keep-bullets}
540 @item @uref{http://lilypond.org/doc/v2.16/Documentation/web/manuals,
541 LilyPond 2.16 Documentation}
543 @item @uref{http://lilypond.org/doc/v2.14/Documentation/web/manuals,
544 LilyPond 2.14 Documentation}
546 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
547 LilyPond 2.12 Documentation}
549 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
550 LilyPond 2.10 Documentation}
552 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
553 LilyPond 2.8 Documentation}
555 @item @uref{http://lilypond.org/doc/v2.6/Documentation/,
556 LilyPond 2.6 Documentation}
558 @item @uref{http://lilypond.org/doc/v2.4/Documentation/out-www/,
559 LilyPond 2.4 Documentation}
561 @item @uref{http://lilypond.org/doc/v2.2/Documentation/out-www/,
562 LilyPond 2.2 Documentation}
564 @item @uref{http://lilypond.org/doc/v2.0/Documentation/out-www/,
565 LilyPond 2.0 Documentation}
567 @item @uref{http://lilypond.org/doc/v1.8/Documentation/out-www/,
568 LilyPond 1.8 Documentation}
570 @item @uref{http://lilypond.org/doc/v1.6/Documentation/out-www/,
571 LilyPond 1.6 Documentation}
582 @divClass{column-center-top}
583 @subheading Documentation license
585 The documentation for GNU LilyPond is published under the GNU Free
586 Documentation License. An introduction to this license, and our
587 reasons for choosing it, is given in @ref{Freedom}.
591 @divClass{column-center-bottom}
592 @subheading GNU Free Documentation License 1.1