X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fweb%2Fmanuals.itexi;h=a46ab720da6d11303708974ac47b2d4a3808a775;hb=382c446e7aa1d83e4c0bbc159a6a466b85e37435;hp=1b276d19ee3e46430f5f1c4b8bfcad07e007049a;hpb=fc41dbd0b6048fea62fa7251134fac350a59276f;p=lilypond.git diff --git a/Documentation/web/manuals.itexi b/Documentation/web/manuals.itexi index 1b276d19ee..a46ab720da 100644 --- a/Documentation/web/manuals.itexi +++ b/Documentation/web/manuals.itexi @@ -3,42 +3,54 @@ 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 +@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 @@ -49,16 +61,20 @@ aesthetics of 19th century music engraving. @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 @@ -70,18 +86,29 @@ short tricks, tips, and examples. @itemize -@item @ref{FAQ}: -links to the answers of Frequently Asked Questions. +@item +@ref{FAQ}: +Frequently Asked Questions. -@item @ref{changes}: -updates since the last major version. +@item +@ref{Top, Web}: +this document. +@details{Web} -@item @ref{extend}: -programming fancy tweaks in LilyPond. +@item +@ifWebLinks{@manualStableChangesSplitNoName,@rchangesnamed{Top,Changes}} +what's new? +@details{Changes} -@item @ref{internals}: -information about LilyPond's internal structures, which is -required for constructing tweaks. +@item +@ifWebLinks{@manualStableExtendingSplitNoName,@rextendnamed{Top,Extending}} +fancy tweaks. +@details{Extending} + +@item +@ifWebLinks{@manualStableInternalsSplitNoName,@rinternalsnamed{Top,Internals}} +tweaks reference. +@details{Internals} @end itemize @@ -93,49 +120,59 @@ required for constructing tweaks. @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@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}: +user-created examples, hints and tips. -@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 +@divEnd + @divClass{hide} @menu -* learning:: Learning. -* glossary:: Glossary. -* essay:: Essay. -* notation:: Reference. -* usage:: Usage. -* snippets:: Snippets. +* Learning:: Learning. +* Glossary:: Glossary. +* Essay:: Essay. +* Notation:: Reference. +* Usage:: Usage. +* Snippets:: Snippets. * FAQ:: FAQ. -* changes:: NEWS. -* extend:: Programming. -* internals:: Internals. -* translated:: Translation. -* all:: All manuals. +* Web:: Web. +* Changes:: NEWS. +* Extending:: Programming. +* Internals:: Internals. +* Translated:: Translation. +* All:: All manuals. * FDL:: Licence. @end menu @divEnd -@c TRANSLATORS: most of the text in this file came from +@c TRANSLATORS, most of the text in this file came from @c LM 1.1 About the documentation (before this section was @c removed in July 2009). -@node learning +@node Learning @unnumberedsec Learning @divClass{column-left-top} @@ -153,42 +190,17 @@ and follow those cross-references for more information. @divEnd @divClass{column-right-bottom} -@subheading Read it - -@itemize - -@item @rlearningnamed{Top,Learning}: -read this manual in the same format as this one. - -@end itemize - -@subheading All formats -@divClass{keep-bullets} -@itemize - -@item @uref{../learning/index.html, Learning (split HTML)}: -the manual is split between many HTML pages. -@emph{(small download for each page)} - -@item @uref{../learning-big-page.html, Learning (big HTML)}: -read this manual as one huge HTML page. -@emph{(large single download, around 10? Mb)} +@docLinks{Learning, learning, + @rlearningnamed{Top,Learning}, + @manualStableLearningSplit, + @manualStableLearningBig, 1.5 MB, + @manualStableLearningPdf, 3 MB} -@item @uref{../learning.pdf, learning.pdf}: -download as a PDF file. -@emph{(large single download, 2.8 Mb)} - -@c TODO: should make links to info? -@c @item @uref{../TODO, learning.info}: -@c GNU info format for documentation. link broken. - -@end itemize -@divEnd @divEnd -@node glossary +@node Glossary @unnumberedsec Glossary @divClass{column-left-top} @@ -202,41 +214,17 @@ it is highly advisable to consult the glossary. @divEnd @divClass{column-right-bottom} -@subheading Read it - -@itemize - -@item @rglosnamed{Top,Music glossary}: -read this manual in the same format as this one. - -@end itemize - -@subheading All formats - -@divClass{keep-bullets} -@itemize - -@item @uref{../music-glossary/index.html, Glossary (split HTML)}: -the manual is split between many HTML pages. -@emph{(small download for each page)} - -@item @uref{../music-glossary-big-page.html, Glossay (big HTML)}: -read this manual as one huge HTML page. -@emph{(large single download, around 10? Mb)} -@item @uref{../music-glossary.pdf, glossary.pdf}: -download as a PDF file. -@emph{(large single download, 2.8 Mb)} +@docLinks{Music glossary, music-glossary, + @rglosnamed{Top,Music glossary}, + @manualStableGlossarySplit, + @manualStableGlossaryBig, 1 MB, + @manualStableGlossaryPdf, 1.5 MB} -@c @item @uref{../TODO, glossary.info}: -@c GNU info format for documentation. TODO, link broken. - -@end itemize -@divEnd @divEnd -@node essay +@node Essay @unnumberedsec Essay @divClass{column-left-top} @@ -246,47 +234,23 @@ This book gives a brief history of music typography, followed by 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. +@docLinks{Essay, essay, + @ressaynamed{Top,Essay}, + @manualStableEssaySplit, + @manualStableEssayBig, 2 MB, + @manualStableEssayPdf, 2.5 MB} -@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, around ?? Mb)} - -@item @uref{../essay.pdf, essay.pdf}: -download as a PDF file. -@emph{(large single download, ?? Mb)} - -@c @item @uref{../TODO, essay.info}: -@c GNU info format for documentation. TODO, link broken. - -@end itemize -@divEnd @divEnd -@node notation +@node Notation @unnumberedsec Notation @divClass{column-left-top} @@ -295,48 +259,24 @@ download as a PDF file. 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 +@docLinks{Notation, notation, + @rusernamed{Top,Notation}, + @manualStableNotationSplit, + @manualStableNotationBig, 7 MB, + @manualStableNotationPdf, 18 MB} -@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, around 10? Mb)} - -@item @uref{../notation.pdf, notation.pdf}: -download as a PDF file. -@emph{(large single download, 2.8 Mb)} - -@c @item @uref{../TODO, notation.info}: -@c GNU info format for documentation. TODO, link broken. - -@end itemize -@divEnd @divEnd -@node usage +@node Usage @unnumberedsec Usage @divClass{column-left-top} @@ -346,44 +286,21 @@ This book explains how to execute the programs, how to integrate 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, around 10? Mb)} +@docLinks{Usage, usage, + @rprogramnamed{Top,Usage}, + @manualStableUsageSplit, + @manualStableUsageBig, 400 KB, + @manualStableUsagePdf, 600 KB} -@item @uref{../usage.pdf, usage.pdf}: -download as a PDF file. -@emph{(large single download, 2.8 Mb)} - -@c @item @uref{../TODO, lilypond-usage.info}: -@c GNU info format for documentation. TODO, link broken. - -@end itemize -@divEnd @divEnd -@node snippets +@node Snippets @unnumberedsec Snippets @divClass{column-left-top} @@ -396,7 +313,7 @@ This shows a selected set of LilyPond snippets from the 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 @@ -404,37 +321,13 @@ linked from the @strong{See also} portion. @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 +@docLinks{Snippets, snippets, + @rlsrnamed{Top,Snippets}, + @manualStableSnippetsSplit, + @manualStableSnippetsBig, 2.5 MB, + @manualStableSnippetsPdf, 8 MB} -@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, around 10? Mb)} - -@item @uref{../snippets.pdf, snippets.pdf}: -download as a PDF file. -@emph{(large single download, 2.8 Mb)} - -@c @item @uref{../TODO, snippets.info}: -@c GNU info format for documentation. TODO, link broken. - -@end itemize -@divEnd @divEnd @@ -447,12 +340,12 @@ download as a PDF file. @subsubheading Where are the graphical canvas, menus, and toolbars? LilyPond requires you to write music as text. Please read about -our @ref{text input}. +our @ref{Text input}. @subsubheading There's a lot of documentation! Do I need to read it? -You need to read the @ref{learning, Learning manual}. As for the +You need to read the @ref{Learning, Learning manual}. As for the rest of documentation, you only need to read the sections which discuss the notation that you wish to create. @@ -460,7 +353,7 @@ discuss the notation that you wish to create. @subsubheading That's still a lot of reading! Is it worth it? Please decide for yourself; the reasons why you might want to use -LilyPond are given in the @ref{introduction}. +LilyPond are given in the @ref{Introduction}. @divEnd @@ -479,104 +372,90 @@ This is explained in @rprogram{Why does the syntax change?}. @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, around 10? Mb)} - -@item @uref{../changes.pdf, changes.pdf}: -download as a PDF file. -@emph{(small single download, 0.5 ?? Mb)} +@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, 1 MB, + @manualDevelWebPdf, 2 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, 6 KB, + @manualStableChangesPdf, 200 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, around 10? Mb)} +@divEnd -@item @uref{../extending.pdf, extending.pdf}: -download as a PDF file. -@emph{(large single download, 2.8 Mb)} +@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, 200 KB, + @manualStableExtendingPdf, 400 KB} -@end itemize -@divEnd @divEnd -@node internals +@node Internals @unnumberedsec Internals @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. @@ -587,162 +466,56 @@ control thickness values, distances, etc., can be changed in input 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 - -@item @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, around 10? 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. +@docLinks{Internals, internals, + @rinternalsnamed{Top,Internals}, + @manualStableInternalsSplit, + @manualStableInternalsBig, 2.5 MB, + @manualStableInternalsPdf, 2.8 MB} -@end itemize -@divEnd @divEnd - -@node translated +@node Translated @unnumberedsec Translated @divClass{column-center-bottom} -@subheading Translation status - -TODO: clean up / prettify +@subheading Translations status -@uref{../translations.html}. +@include translations.itexi @divEnd -@node all +@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} @@ -751,13 +524,32 @@ apology here for no tarballs} @item @uref{http://lilypond.org/doc/v2.12/Documentation/, LilyPond 2.12 Documentation} +@item @uref{http://lilypond.org/doc/v2.11/Documentation/, +LilyPond 2.11 Documentation} + @item @uref{http://lilypond.org/doc/v2.10/Documentation/, LilyPond 2.10 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 @@ -773,7 +565,7 @@ LilyPond 2.8 Documentation} The documentation for GNU LilyPond is published under the GNU Free Documentation License. An introduction to this license, and our -reasons for choosing it, is given in @ref{freedom}. +reasons for choosing it, is given in @ref{Freedom}. @divEnd @@ -783,5 +575,3 @@ reasons for choosing it, is given in @ref{freedom}. @include fdl.itexi @divEnd - -