Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
When revising a translation, copy the HEAD committish of the
- version that you are working on. See TRANSLATION for details.
+ version that you are working on. For details, see the Contributors'
+ Guide, node Updating translation committishes..
@end ignore
@node Manuals
@unnumbered Manuals
+@macro details{reference}
+@spanClass{detail}
+(@ref{\reference\, details of \reference\})
+@spanEnd
+@end macro
+
@divClass{heading-center}
-@heading Documentation for LilyPond @version
+@ifclear web_version
+ @heading Manuals for LilyPond @version
+@end ifclear
+@ifset web_version
+ @heading Manuals for LilyPond @versionStable
+@end ifset
@divEnd
-@c TODO: do we want these links to be in larger text / bold ? CSS.
+@divClass{link-headings}
-@c if you change this page, also change All.
@divClass{column-center-top}
@subheading Introduction
@itemize
-@item @ref{Text input}:
-LilyPond is a @strong{text-based} music engraver. If you are not
-familiar with this concept, please read this now!
+@item
+@ref{Text input}:
+LilyPond is a @strong{text-based} music engraver. Read this first!
-@item @ref{Learning}:
+@item
+@ifWebLinks{@manualStableLearningSplitNoName,@rlearningnamed{Top,Learning}}
a @qq{must-read} gentle introduction to LilyPond.
+@details{Learning}
-@item @ref{Glossary}:
-@emph{(optional reading)}
-explains musical terms and gives translations for users unfamiliar
-with English musical terms.
-
-@item @ref{Essay}:
-@emph{(optional reading)}
-background information about the engraving process and the
-aesthetics of 19th century music engraving.
+@item
+@ifWebLinks{@manualStableGlossarySplitNoName,@rglosnamed{Top,Glossary}}
+@emph{(optional reading)} musical terms and translations.
+@details{Glossary}
+@item
+@ifWebLinks{@manualStableEssaySplitNoName,@ressaynamed{Top,Essay}}
+@emph{(optional reading)} background information about computer engraving.
+@details{Essay}
@end itemize
@itemize
-@item @ref{Notation}:
-the main portion of the documentation; provides detailed
-information about creating notation.
+@item
+@ifWebLinks{@manualStableNotationSplitNoName,@rusernamed{Top,Notation}}
+syntax reference.
+@details{Notation}
-@item @ref{Usage}:
-discusses the actual programs and operating system-specific
-issues.
+@item
+@ifWebLinks{@manualStableUsageSplitNoName,@rprogramnamed{Top,Usage}}
+running the programs.
+@details{Usage}
-@item @ref{Snippets}:
-short tricks, tips, and examples.
+@item
+@ifWebLinks{@manualStableSnippetsSplitNoName,@rlsrnamed{Top,Snippets}}
+short tricks and tips.
+@details{Snippets}
@end itemize
@itemize
-@item @ref{Web}:
-this document.
+@item
+@ref{FAQ}:
+Frequently Asked Questions.
-@item @ref{FAQ}:
-links to the answers of Frequently Asked Questions.
+@item
+@ref{Top, Web}:
+this document.
+@details{Web}
-@item @ref{Changes}:
-updates since the last major version.
+@item
+@ifWebLinks{@manualStableChangesSplitNoName,@rchangesnamed{Top,Changes}}
+what's new?
+@details{Changes}
-@item @ref{Extend}:
-programming fancy tweaks in LilyPond.
+@item
+@ifWebLinks{@manualStableExtendingSplitNoName,@rextendnamed{Top,Extending}}
+fancy tweaks.
+@details{Extending}
-@item @ref{Internals}:
-information about LilyPond's internal structures, which is
-required for constructing tweaks.
+@item
+@ifWebLinks{@manualStableInternalsSplitNoName,@rinternalsnamed{Top,Internals}}
+tweaks reference.
+@details{Internals}
@end itemize
@itemize
-@item @ref{Translated}:
+@item
+@ref{All}:
+previous stable versions and current as a compressed archive.
+
+@item
+@ref{Translated}:
translation status for non-English readers.
-@item @ref{All}:
-quick links, downloadable manuals, and old manuals.
+@item
+@uref{http://lsr@/.di@/.unimi@/.it,LilyPond Snippet Repository}:
+user-created examples, hints and tips.
+
+@item
+@uref{http://benlemon.me/blog/music/lilypond/operation-lilypond/,Video Tutorials}:
+Ben Lemon, a LilyPond user, has created a range of video tutorials on
+his blog and which are aimed at new users.
-@item @ref{Development}:
+@item
+@ref{Development}:
manuals for the unstable version.
-@item @ref{FDL}:
-these manuals are published under the GNU Free Documentation
-License.
+@item
+@ref{FDL}:
+these manuals are published under the GNU Free Documentation License.
@end itemize
@divEnd
+@divClass{column-center-bottom}
+@subheading Manual formats
+
+The LilyPond manuals generally come in three formats: split HTML, big HTML and
+PDF. Split HTML is good for reading online. Big HTML (and some of these can be
+very big) contains the whole manual in a single page. PDF is available for
+downloading and using offline. To get to these 3 formats, follow the links
+that read @code{details of} and then the manual name.
+
+@divEnd
+
+@divEnd
+
@divClass{hide}
@menu
* Notation:: Reference.
* Usage:: Usage.
* Snippets:: Snippets.
-* Web:: Web.
* FAQ:: FAQ.
+* Web:: Web.
* Changes:: NEWS.
-* Extend:: Programming.
+* Extending:: Programming.
* Internals:: Internals.
* Translated:: Translation.
* All:: All manuals.
@docLinks{Learning, learning,
@rlearningnamed{Top,Learning},
@manualStableLearningSplit,
- @manualStableLearningBig, 1.5 Mb,
- @manualStableLearningPdf, 3 Mb}
+ @manualStableLearningBig, 3 MB,
+ @manualStableLearningPdf, 5 MB}
@divEnd
@docLinks{Music glossary, music-glossary,
@rglosnamed{Top,Music glossary},
@manualStableGlossarySplit,
- @manualStableGlossaryBig, 1 Mb,
- @manualStableGlossaryPdf, 1.5 Mb}
+ @manualStableGlossaryBig, 1 MB,
+ @manualStableGlossaryPdf, 1.5 MB}
@divEnd
an examination of LilyPond's engraving techniques. A comparison
between LilyPond and other music engraving systems is given.
-@warning{The detailed typographical examples are easier to analyze
+@warning{the detailed typographical examples are easier to analyze
in the PDF version due to its higher resolution.}
@divEnd
@divClass{column-right-bottom}
-@subheading Read it
-
-@itemize
-
-@item @ressaynamed{Top,Essay}:
-read this manual in the same format as this one.
-
-@end itemize
-
-@subheading All formats
-@divClass{keep-bullets}
-@itemize
-
-@item @uref{../essay/index.html, Essay (split HTML)}:
-the manual is split between many HTML pages.
-@*@ @ @emph{(small download for each page)}
-
-@item @uref{../essay-big-page.html, Essay (big HTML)}:
-read this manual as one huge HTML page.
-@*@ @ @emph{(large single download, 2 Mb)}
+@docLinks{Essay, essay,
+ @ressaynamed{Top,Essay},
+ @manualStableEssaySplit,
+ @manualStableEssayBig, 1 MB,
+ @manualStableEssayPdf, 2 MB}
-@item @uref{../essay.pdf, essay.pdf}:
-download as a PDF file.
-@*@ @ @emph{(large single download, 2.5 Mb)}
-
-@c @item @uref{../TODO, essay.info}:
-@c GNU info format for documentation. TODO, link broken.
-
-@end itemize
-@divEnd
@divEnd
This book explains all the LilyPond commands which produce
notation.
-@warning{The Notation reference assumes that the reader knows
+@warning{the Notation reference assumes that the reader knows
basic material covered in the Learning manual and is familiar with
-the English musical terms presented in the Musical Glossary.}
+the English musical terms presented in the glossary.}
@divEnd
@divClass{column-right-bottom}
-@subheading Read it
-
-@itemize
-
-@item @rusernamed{Top,Notation}:
-read this manual in the same format as this one.
-
-@end itemize
-
-@subheading All formats
-
-@divClass{keep-bullets}
-@itemize
-
-@item @uref{../notation/index.html, Notation (split HTML)}:
-the manual is split between many HTML pages.
-@*@ @ @emph{(small download for each page)}
-
-@item @uref{../notation-big-page.html, Notation (big HTML)}:
-read this manual as one huge HTML page.
-@*@ @ @emph{(large single download, 7 Mb)}
-
-@item @uref{../notation.pdf, notation.pdf}:
-download as a PDF file.
-@*@ @ @emph{(large single download, 18 Mb)}
-@c @item @uref{../TODO, notation.info}:
-@c GNU info format for documentation. TODO, link broken.
+@docLinks{Notation, notation,
+ @rusernamed{Top,Notation},
+ @manualStableNotationSplit,
+ @manualStableNotationBig, 9 MB,
+ @manualStableNotationPdf, 35 MB}
-@end itemize
-@divEnd
@divEnd
LilyPond notation with other programs, and suggests @qq{best
practices} for efficient use. It is recommended reading before
attempting any large projects.
+
@divEnd
@divClass{column-right-bottom}
-@subheading Read it
-
-@itemize
-
-@item @rprogramnamed{Top,Usage}:
-read this manual in the same format as this one.
-
-@end itemize
-
-@subheading All formats
-
-@divClass{keep-bullets}
-@itemize
-
-@item @uref{../usage/index.html, Usage (split HTML)}:
-the manual is split between many HTML pages.
-@*@ @ @emph{(small download for each page)}
-@item @uref{../usage-big-page.html, Usage (big HTML)}:
-read this manual as one huge HTML page.
-@*@ @ @emph{(large single download, 300 kb)}
+@docLinks{Usage, usage,
+ @rprogramnamed{Top,Usage},
+ @manualStableUsageSplit,
+ @manualStableUsageBig, 400 KB,
+ @manualStableUsagePdf, 650 KB}
-@item @uref{../usage.pdf, usage.pdf}:
-download as a PDF file.
-@*@ @ @emph{(large single download, 400 kb)}
-
-@c @item @uref{../TODO, lilypond-usage.info}:
-@c GNU info format for documentation. TODO, link broken.
-
-@end itemize
-@divEnd
@divEnd
@subheading Snippets
This shows a selected set of LilyPond snippets from the
-@uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
+@uref{http://lsr@/.di@/.unimi@/.it,LilyPond Snippet Repository}
(LSR). All the snippets are in the public domain.
Please note that this document is not an exact subset of LSR. LSR
is running a stable LilyPond version, so any snippet which
demonstrates new features of a development version must be added
-separately. These are stored in @file{input/new/} in the LilyPond
+separately. These are stored in @file{Documentation/snippets/new/} in the LilyPond
source tree.
The list of snippets for each subsection of the Notation are also
@divEnd
@divClass{column-right-bottom}
-@subheading Read it
-
-@itemize
-
-@item @rlsrnamed{Top,Snippets}:
-read this manual in the same format as this one.
-
-@end itemize
-
-@subheading All formats
-
-@divClass{keep-bullets}
-@itemize
-
-@item @uref{../snippets/index.html, Snippets (split HTML)}:
-the manual is split between many HTML pages.
-@*@ @ @emph{(small download for each page)}
-@item @uref{../snippets-big-page.html, Snippets (big HTML)}:
-read this manual as one huge HTML page.
-@*@ @ @emph{(large single download, 2.5 Mb)}
+@docLinks{Snippets, snippets,
+ @rlsrnamed{Top,Snippets},
+ @manualStableSnippetsSplit,
+ @manualStableSnippetsBig, 1.5 MB,
+ @manualStableSnippetsPdf, 12.5 MB}
-@item @uref{../snippets.pdf, snippets.pdf}:
-download as a PDF file.
-@*@ @ @emph{(large single download, 8 Mb)}
-
-@c @item @uref{../TODO, snippets.info}:
-@c GNU info format for documentation. TODO, link broken.
-
-@end itemize
-@divEnd
@divEnd
-@node Web
-@unnumberedsec Web
-
-@divClass{column-left-top}
-@subheading Web
-
-This manual supplies general information about LilyPond. It also
-contains information about various community forums, bug
-reporting, and development.
-
-@divEnd
-
-@divClass{column-right-bottom}
-@subheading Read it
-
-@itemize
-
-@item @rweb{Top,Web}:
-read this manual in the same format as this one.
-
-@end itemize
-
-@subheading All formats
-
-@divClass{keep-bullets}
-@itemize
-
-@item @uref{../web/index.html, Web (split HTML)}:
-the manual is split between many HTML pages.
-@*@ @ @emph{(small download for each page)}
-
-@item @uref{../web-big-page.html, Web (big HTML)}:
-read this manual as one huge HTML page.
-@*@ @ @emph{(large single download, 1 Mb)}
-
-@item @uref{../web.pdf, web.pdf}:
-download as a PDF file.
-@*@ @ @emph{(large single download, 2 Mb)}
-
-@c @item @uref{../TODO, web.info}:
-@c GNU info format for documentation. TODO, link broken.
-
-@end itemize
-@divEnd
-@divEnd
-
-
-
@node FAQ
@unnumberedsec FAQ
@divEnd
-@node Changes
-@unnumberedsec Changes
+@node Web
+@unnumberedsec Web
@divClass{column-left-top}
-@subheading Changes
+@subheading Web
-This is a summary of important changes and new features in
-LilyPond since the previous stable version.
+This manual supplies general information about LilyPond. It also
+contains information about various community forums, bug
+reporting, and development.
@divEnd
@divClass{column-right-bottom}
@subheading Read it
-@itemize
-
-@item @rchangesnamed{Top,Changes}:
-read this manual in the same format as this one.
-
-@end itemize
-
-@subheading All formats
+@subsubheading Latest manual
@divClass{keep-bullets}
@itemize
+@ref{Top,Web}
+@end itemize
+@divEnd
-@item @uref{../changes/index.html, Changes (split HTML)}:
-the manual is split between many HTML pages.
-@*@ @ @emph{(small download for each page)}
-
-@item @uref{../changes-big-page.html, Changes (big HTML)}:
-read this manual as one huge HTML page.
-@*@ @ @emph{(large single download, 6 kb)}
-
-@item @uref{../changes.pdf, changes.pdf}:
-download as a PDF file.
-@*@ @ @emph{(small single download, 200 kb)}
+@subsubheading Web manual in @versionDevel
-@c @item @uref{../TODO, changes.info}:
-@c GNU info format for documentation. TODO, link broken.
+@docLinksBare{Web, web,
+ @ref{Top,Web},
+ @manualDevelWebSplit,
+ @manualDevelWebBig, 2.5 MB,
+ @manualDevelWebPdf, 3.5 MB}
-@end itemize
-@divEnd
@divEnd
-@node Extend
-@unnumberedsec Extend
+@node Changes
+@unnumberedsec Changes
@divClass{column-left-top}
-@subheading Extend LilyPond
+@subheading Changes
-This manual explains how to write extensions to LilyPond.
+This is a summary of important changes and new features in
+LilyPond since the previous stable version.
@divEnd
@divClass{column-right-bottom}
-@subheading Read it
-@itemize
+@docLinks{Changes, changes,
+ @rchangesnamed{Top,Changes},
+ @manualStableChangesSplit,
+ @manualStableChangesBig, 90 KB,
+ @manualStableChangesPdf, 80 KB}
-@item @rextendnamed{Top,Extend}:
-read this manual in the same format as this one.
+@divEnd
-@end itemize
-@subheading All formats
+@node Extending
+@unnumberedsec Extending
-@divClass{keep-bullets}
-@itemize
+@divClass{column-left-top}
+@subheading Extending LilyPond
-@item @uref{../extending/index.html, Extend (split HTML)}:
-the manual is split between many HTML pages.
-@*@ @ @emph{(small download for each page)}
+This manual explains how to write extensions to LilyPond.
-@item @uref{../extending-big-page.html, Extend (big HTML)}:
-read this manual as one huge HTML page.
-@*@ @ @emph{(large single download, 200 kb)}
+@divEnd
-@item @uref{../extending.pdf, extending.pdf}:
-download as a PDF file.
-@*@ @ @emph{(large single download, 400 kb)}
+@divClass{column-right-bottom}
-@c @item @uref{../TODO, extending.info}:
-@c GNU info format for documentation. TODO, link broken.
+@docLinks{Extending, extending,
+ @rextendnamed{Top,Extending},
+ @manualStableExtendingSplit,
+ @manualStableExtendingBig, 300 KB,
+ @manualStableExtendingPdf, 500 KB}
-@end itemize
-@divEnd
@divEnd
@divClass{column-left-top}
@subheading Internals reference
-This is a set of heavily cross linked HTML pages which document
+This is a set of heavily cross linked pages which document
the nitty-gritty details of each and every LilyPond class, object,
and function. It is produced directly from the formatting
definitions in the source code.
files. There are a huge number of formatting options, and all of
them are described in this document. Each section of the Notation
Reference has a @b{See also} subsection, which refers to the
-generated documentation. In the HTML document, these subsections
-have clickable links.
+generated documentation.
@divEnd
@divClass{column-right-bottom}
-@subheading Read it
-
-@itemize
-
- @rinternalsnamed{Top,Internals}:
-read this manual in the same format as this one.
-
-@end itemize
-
-@subheading All formats
-@divClass{keep-bullets}
-@itemize
-
-@item @uref{../internals/index.html, Internals (split HTML)}:
-the manual is split between many HTML pages.
-@*@ @ @emph{(small download for each page)}
-
-@item @uref{../internals-big-page.html, Internals (big HTML)}:
-read this manual as one huge HTML page.
-@*@ @ @emph{(large single download, 2.5 Mb)}
+@docLinks{Internals, internals,
+ @rinternalsnamed{Top,Internals},
+ @manualStableInternalsSplit,
+ @manualStableInternalsBig, 3 MB,
+ @manualStableInternalsPdf, 4 MB}
-@item @uref{../internals.pdf, internals.pdf}:
-download as a PDF file.
-@*@ @ @emph{(large single download, 2.8 Mb)}
-
-@c @item @uref{../TODO, internals.info}:
-@c GNU info format for documentation. TODO, link broken.
-
-@end itemize
@divEnd
-@divEnd
-
@node Translated
@unnumberedsec Translated
@divClass{column-center-bottom}
-@subheading Translation status
+@subheading Translations status
-TODO: clean up / prettify
-
-@uref{../translations.html}.
+@include translations.itexi
@divEnd
@node All
@unnumberedsec All
-@divClass{heading-center}
-@heading Documentation quick links
-
-Links to other formats of these manuals can be found in
-@ref{Manuals}.
-
-@divEnd
-
-@c this should match the (main) manual page.
-@divClass{column-center-top}
-@subheading Introduction
-
-@itemize
-
-@item @rlearningnamed{Top,Learning}:
-a @qq{must-read} gentle introduction to LilyPond.
-
-@item @rglosnamed{Top,Glossary}:
-@emph{(optional reading)}
-explains musical terms and gives translations for users unfamiliar
-with English musical terms.
-
-@item @ressaynamed{Top,Essay}:
-@emph{(optional reading)}
-background information about the engraving process and the
-aesthetics of 19th century music engraving.
-
-@end itemize
-
-@divEnd
-
@divClass{column-left-top}
-@subheading Regular use
-
-@itemize
-
-@item @rusernamed{Top,Notation}:
-the main portion of the documentation; provides detailed
-information about creating notation.
-
-@item @rprogramnamed{Top,Usage}:
-discusses the actual programs and operation system-specific
-issues.
-
-@item @rlsrnamed{Top,Snippets}:
-short tricks, tips, and examples.
-
-@end itemize
-
-@divEnd
-
-
-@divClass{column-right-top}
-@subheading Infrequent Use
-
-@itemize
-
-@item @ref{FAQ}:
-links to answers of Frequently Asked Questions.
-
-@item @rchangesnamed{Top,Changes}:
-updates since the last major version.
-
-@item @rextendnamed{Top,Extend}:
-programming fancy tweaks in LilyPond.
-
-@item @rinternalsnamed{Top,Internals}:
-information about LilyPond's internal structures, which is
-required for constructing tweaks.
-
-@end itemize
-
-@divEnd
-
-
-@divClass{column-center-bottom}
@subheading Downloadable versions
-@help{compare tarball vs. zip size, ask about windows users
-dealing with tarballs (both gz and bz2), etc.}
-
-@help{on second thought, wait until the new doc build. write an
-apology here for no tarballs}
+@ifclear web_version
+Downloadable tarballs only available at @uref{http://lilypond.org}
+@end ifclear
+@ifset web_version
@divClass{keep-bullets}
@itemize
-@item html-split zip
-
-@item html-big zip
-
-@item pdf zip
-
-@item info zip maybe?!?!
+@item @doctarballStable
@end itemize
+@divEnd
+@end ifset
+
@divEnd
+@divClass{column-right-bottom}
@subheading Previous stable versions
@divClass{keep-bullets}
@itemize
+@item @uref{http://lilypond.org/doc/v2.16/Documentation/web/manuals,
+LilyPond 2.16 Documentation}
+
+@item @uref{http://lilypond.org/doc/v2.14/Documentation/web/manuals,
+LilyPond 2.14 Documentation}
+
@item @uref{http://lilypond.org/doc/v2.12/Documentation/,
LilyPond 2.12 Documentation}
@item @uref{http://lilypond.org/doc/v2.8/Documentation/,
LilyPond 2.8 Documentation}
-@help anybody want to write this stuff?
+@item @uref{http://lilypond.org/doc/v2.6/Documentation/,
+LilyPond 2.6 Documentation}
+
+@item @uref{http://lilypond.org/doc/v2.4/Documentation/out-www/,
+LilyPond 2.4 Documentation}
+
+@item @uref{http://lilypond.org/doc/v2.2/Documentation/out-www/,
+LilyPond 2.2 Documentation}
+
+@item @uref{http://lilypond.org/doc/v2.0/Documentation/out-www/,
+LilyPond 2.0 Documentation}
+
+@item @uref{http://lilypond.org/doc/v1.8/Documentation/out-www/,
+LilyPond 1.8 Documentation}
+
+@item @uref{http://lilypond.org/doc/v1.6/Documentation/out-www/,
+LilyPond 1.6 Documentation}
@end itemize
@include fdl.itexi
@divEnd
-
-
projects / lilypond.git / blobdiff