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 @divClass{heading-center}
14 @heading Manuals for LilyPond @version
17 @heading Manuals for LilyPond @versionStable
23 @c TODO: do we want these links to be in larger text / bold ? CSS.
25 @c if you change this page, also change All.
26 @divClass{column-center-top}
27 @subheading Introduction
31 @item @ref{Text input}:
32 LilyPond is a @strong{text-based} music engraver. If you are not
33 familiar with this concept, please read this now!
36 a @qq{must-read} gentle introduction to LilyPond.
39 @emph{(optional reading)}
40 explains musical terms and gives translations for users unfamiliar
41 with English musical terms.
44 @emph{(optional reading)}
45 background information about the engraving process and the
46 aesthetics of 19th century music engraving.
53 @divClass{column-left-top}
54 @subheading Regular use
59 the main portion of the documentation; provides detailed
60 information about creating notation.
63 discusses the actual programs and operating system-specific
67 short tricks, tips, and examples.
74 @divClass{column-right-top}
75 @subheading Infrequent Use
83 links to the answers of Frequently Asked Questions.
86 updates since the last major version.
89 programming fancy tweaks in LilyPond.
91 @item @ref{Internals}:
92 information about LilyPond's internal structures, which is
93 required for constructing tweaks.
100 @divClass{column-center-bottom}
101 @subheading Other material
105 @item @ref{Translated}:
106 translation status for non-English readers.
109 quick links, downloadable manuals, and old manuals.
111 @item @ref{Development}:
112 manuals for the unstable version.
115 these manuals are published under the GNU Free Documentation
125 * Learning:: Learning.
126 * Glossary:: Glossary.
128 * Notation:: Reference.
130 * Snippets:: Snippets.
134 * Extend:: Programming.
135 * Internals:: Internals.
136 * Translated:: Translation.
144 @c TRANSLATORS, most of the text in this file came from
145 @c LM 1.1 About the documentation (before this section was
146 @c removed in July 2009).
149 @unnumberedsec Learning
151 @divClass{column-left-top}
152 @subheading Learning manual
154 This book explains how to begin learning LilyPond, as well as
155 explaining some key concepts in easy terms. You should read these
156 chapters in a linear fashion.
158 There is a paragraph @strong{See also} at the end of each section,
159 which contains cross-references to other sections: you should not
160 follow these cross-references at first reading. When you have
161 read all of the manual, you may want to read some sections again
162 and follow those cross-references for more information.
165 @divClass{column-right-bottom}
167 @docLinks{Learning, learning,
168 @rlearningnamed{Top,Learning},
169 @manualStableLearningSplit,
170 @manualStableLearningBig, 1.5 MB,
171 @manualStableLearningPdf, 3 MB}
177 @unnumberedsec Glossary
179 @divClass{column-left-top}
182 This explains musical terms, and includes translations to various
183 languages. If you are not familiar with music notation or music
184 terminology (especially if you are a non-native English speaker),
185 it is highly advisable to consult the glossary.
189 @divClass{column-right-bottom}
191 @docLinks{Music glossary, music-glossary,
192 @rglosnamed{Top,Music glossary},
193 @manualStableGlossarySplit,
194 @manualStableGlossaryBig, 1 MB,
195 @manualStableGlossaryPdf, 1.5 MB}
203 @divClass{column-left-top}
206 This book gives a brief history of music typography, followed by
207 an examination of LilyPond's engraving techniques. A comparison
208 between LilyPond and other music engraving systems is given.
210 @warning{The detailed typographical examples are easier to analyze
211 in the PDF version due to its higher resolution.}
215 @divClass{column-right-bottom}
217 @docLinks{Essay, essay,
218 @rglosnamed{Top,Essay},
219 @manualStableEssaySplit,
220 @manualStableEssayBig, 2 MB,
221 @manualStableEssayPdf, 2.5 MB}
227 @unnumberedsec Notation
229 @divClass{column-left-top}
230 @subheading Notation reference
232 This book explains all the LilyPond commands which produce
235 @warning{The Notation reference assumes that the reader knows
236 basic material covered in the Learning manual and is familiar with
237 the English musical terms presented in the glossary.}
241 @divClass{column-right-bottom}
243 @docLinks{Notation, notation,
244 @rglosnamed{Top,Notation},
245 @manualStableNotationSplit,
246 @manualStableNotationBig, 7 MB,
247 @manualStableNotationPdf, 18 MB}
255 @divClass{column-left-top}
256 @subheading Usage manual
258 This book explains how to execute the programs, how to integrate
259 LilyPond notation with other programs, and suggests @qq{best
260 practices} for efficient use. It is recommended reading before
261 attempting any large projects.
265 @divClass{column-right-bottom}
267 @docLinks{Usage, usage,
268 @rglosnamed{Top,Usage},
269 @manualStableUsageSplit,
270 @manualStableUsageBig, 300 KB,
271 @manualStableUsagePdf, 400 KB}
277 @unnumberedsec Snippets
279 @divClass{column-left-top}
282 This shows a selected set of LilyPond snippets from the
283 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
284 (LSR). All the snippets are in the public domain.
286 Please note that this document is not an exact subset of LSR. LSR
287 is running a stable LilyPond version, so any snippet which
288 demonstrates new features of a development version must be added
289 separately. These are stored in @file{input/new/} in the LilyPond
292 The list of snippets for each subsection of the Notation are also
293 linked from the @strong{See also} portion.
296 @divClass{column-right-bottom}
298 @docLinks{Snippets, snippets,
299 @rglosnamed{Top,Snippets},
300 @manualStableSnippetsSplit,
301 @manualStableSnippetsBig, 2.5 MB,
302 @manualStableSnippetsPdf, 8 MB}
310 @divClass{column-left-top}
313 This manual supplies general information about LilyPond. It also
314 contains information about various community forums, bug
315 reporting, and development.
319 @divClass{column-right-bottom}
322 @rglosnamed{Top,Web},
323 @manualStableWebSplit,
324 @manualStableWebBig, 1 MB,
325 @manualStableWebPdf, 2 MB}
333 @divClass{column-center-top}
334 @subheading Introductory questions
336 @subsubheading Where are the graphical canvas, menus, and toolbars?
338 LilyPond requires you to write music as text. Please read about
339 our @ref{Text input}.
342 @subsubheading There's a lot of documentation! Do I need to read it?
344 You need to read the @ref{Learning, Learning manual}. As for the
345 rest of documentation, you only need to read the sections which
346 discuss the notation that you wish to create.
349 @subsubheading That's still a lot of reading! Is it worth it?
351 Please decide for yourself; the reasons why you might want to use
352 LilyPond are given in the @ref{Introduction}.
356 @divClass{column-center-bottom}
357 @subheading Usage questions
359 @subsubheading Something isn't working! How do I fix it?
361 This is explained in @rprogram{Troubleshooting}.
364 @subsubheading Why do you change the syntax?
366 This is explained in @rprogram{Why does the syntax change?}.
372 @unnumberedsec Changes
374 @divClass{column-left-top}
377 This is a summary of important changes and new features in
378 LilyPond since the previous stable version.
382 @divClass{column-right-bottom}
384 @docLinks{Changes, changes,
385 @rglosnamed{Top,Changes},
386 @manualStableChangesSplit,
387 @manualStableChangesBig, 6 KB,
388 @manualStableChangesPdf, 200 KB}
394 @unnumberedsec Extend
396 @divClass{column-left-top}
397 @subheading Extend LilyPond
399 This manual explains how to write extensions to LilyPond.
403 @divClass{column-right-bottom}
405 @docLinks{Extend, extend,
406 @rglosnamed{Top,Extend},
407 @manualStableExtendingSplit,
408 @manualStableExtendingBig, 200 KB,
409 @manualStableExtendingPdf, 400 KB}
415 @unnumberedsec Internals
417 @divClass{column-left-top}
418 @subheading Internals reference
420 This is a set of heavily cross linked HTML pages which document
421 the nitty-gritty details of each and every LilyPond class, object,
422 and function. It is produced directly from the formatting
423 definitions in the source code.
425 Almost all formatting functionality that is used internally is
426 available directly to the user. For example, most variables that
427 control thickness values, distances, etc., can be changed in input
428 files. There are a huge number of formatting options, and all of
429 them are described in this document. Each section of the Notation
430 Reference has a @b{See also} subsection, which refers to the
431 generated documentation. In the HTML document, these subsections
432 have clickable links.
436 @divClass{column-right-bottom}
438 @docLinks{Internals, internals,
439 @rglosnamed{Top,Internals},
440 @manualStableInternalsSplit,
441 @manualStableInternalsBig, 2.5 MB,
442 @manualStableInternalsPdf, 2.8 MB}
448 @unnumberedsec Translated
450 @divClass{column-center-bottom}
451 @subheading Translation status
453 TODO: clean up / prettify
455 @uref{../translations.html}.
463 @divClass{heading-center}
464 @heading Documentation quick links
466 Links to other formats of these manuals can be found in
471 @c this should match the (main) manual page.
472 @divClass{column-center-top}
473 @subheading Introduction
477 @c no colon : needed in this section
478 @item @ifWebLinks{@manualStableLearningSplit,@rlearningnamed{Top,Learning}}
479 a @qq{must-read} gentle introduction to LilyPond.
481 @item @ifWebLinks{@manualStableGlossarySplit,@rglosnamed{Top,Glossary}}
482 @emph{(optional reading)}
483 explains musical terms and gives translations for users unfamiliar
484 with English musical terms.
486 @item @ifWebLinks{@manualStableEssaySplit,@ressaynamed{Top,Essay}}
487 @emph{(optional reading)}
488 background information about the engraving process and the
489 aesthetics of 19th century music engraving.
495 @divClass{column-left-top}
496 @subheading Regular use
500 @item @ifWebLinks{@manualStableNotationSplit,@rusernamed{Top,Notation}}
501 the main portion of the documentation; provides detailed
502 information about creating notation.
504 @item @ifWebLinks{@manualStableUsageSplit,@rprogramnamed{Top,Usage}}
505 discusses the actual programs and operation system-specific
508 @item @ifWebLinks{@manualStableSnippetsSplit,@rlsrnamed{Top,Snippets}}
509 short tricks, tips, and examples.
516 @divClass{column-right-top}
517 @subheading Infrequent Use
522 links to answers of Frequently Asked Questions.
524 @item @ifWebLinks{@manualStableChangesSplit,@rchangesnamed{Top,Changes}}
525 updates since the last major version.
527 @item @ifWebLinks{@manualStableExtendingSplit,@rextendnamed{Top,Extend}}
528 programming fancy tweaks in LilyPond.
530 @item @ifWebLinks{@manualStableInternalsSplit,@rinternalsnamed{Top,Internals}}
531 information about LilyPond's internal structures, which is
532 required for constructing tweaks.
539 @divClass{column-center-bottom}
540 @subheading Downloadable versions
542 @help{compare tarball vs. zip size, ask about windows users
543 dealing with tarballs (both gz and bz2), etc.}
545 @help{on second thought, wait until the new doc build. write an
546 apology here for no tarballs}
548 @divClass{keep-bullets}
557 @item info zip maybe?!?!
563 @subheading Previous stable versions
565 @divClass{keep-bullets}
568 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
569 LilyPond 2.12 Documentation}
571 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
572 LilyPond 2.10 Documentation}
574 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
575 LilyPond 2.8 Documentation}
577 @help anybody want to write this stuff?
588 @divClass{column-center-top}
589 @subheading Documentation license
591 The documentation for GNU LilyPond is published under the GNU Free
592 Documentation License. An introduction to this license, and our
593 reasons for choosing it, is given in @ref{Freedom}.
597 @divClass{column-center-bottom}
598 @subheading GNU Free Documentation License 1.1