X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fweb%2Fmanuals.itexi;h=07ccb42aa963ae2b0490ede8a34cb9c6bf6e0c91;hb=5d63dfcc4b09f0adb7564952ed585fe89d4a961a;hp=c8482feee1d32ff528be9ab549d88499a909271d;hpb=e343a09657b87891893a4cca13e6c1a3d775f34f;p=lilypond.git diff --git a/Documentation/web/manuals.itexi b/Documentation/web/manuals.itexi index c8482feee1..07ccb42aa9 100644 --- a/Documentation/web/manuals.itexi +++ b/Documentation/web/manuals.itexi @@ -3,12 +3,19 @@ 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} @ifclear web_version @heading Manuals for LilyPond @version @@ -17,34 +24,33 @@ @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 @@ -55,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 @@ -76,21 +86,29 @@ short tricks, tips, and examples. @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 @@ -102,23 +120,48 @@ 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@/.di@/.unimi@/.it,LilyPond Snippet Repository}: +user-created examples, hints and tips. -@item @ref{Development}: +@item +@uref{http://bit.ly/LilyPondBeginners,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}: 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 @@ -128,10 +171,10 @@ License. * 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. @@ -167,8 +210,8 @@ and follow those cross-references for more information. @docLinks{Learning, learning, @rlearningnamed{Top,Learning}, @manualStableLearningSplit, - @manualStableLearningBig, 1.5 MB, - @manualStableLearningPdf, 3 MB} + @manualStableLearningBig, 3 MB, + @manualStableLearningPdf, 5 MB} @divEnd @@ -207,7 +250,7 @@ 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 @@ -215,10 +258,10 @@ in the PDF version due to its higher resolution.} @divClass{column-right-bottom} @docLinks{Essay, essay, - @rglosnamed{Top,Essay}, + @ressaynamed{Top,Essay}, @manualStableEssaySplit, - @manualStableEssayBig, 2 MB, - @manualStableEssayPdf, 2.5 MB} + @manualStableEssayBig, 1 MB, + @manualStableEssayPdf, 2 MB} @divEnd @@ -232,7 +275,7 @@ in the PDF version due to its higher resolution.} 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 glossary.} @@ -241,10 +284,10 @@ the English musical terms presented in the glossary.} @divClass{column-right-bottom} @docLinks{Notation, notation, - @rglosnamed{Top,Notation}, + @rusernamed{Top,Notation}, @manualStableNotationSplit, - @manualStableNotationBig, 7 MB, - @manualStableNotationPdf, 18 MB} + @manualStableNotationBig, 9 MB, + @manualStableNotationPdf, 35 MB} @divEnd @@ -265,10 +308,10 @@ attempting any large projects. @divClass{column-right-bottom} @docLinks{Usage, usage, - @rglosnamed{Top,Usage}, + @rprogramnamed{Top,Usage}, @manualStableUsageSplit, - @manualStableUsageBig, 300 KB, - @manualStableUsagePdf, 400 KB} + @manualStableUsageBig, 400 KB, + @manualStableUsagePdf, 650 KB} @divEnd @@ -280,13 +323,13 @@ attempting any large projects. @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 @@ -296,33 +339,10 @@ linked from the @strong{See also} portion. @divClass{column-right-bottom} @docLinks{Snippets, snippets, - @rglosnamed{Top,Snippets}, + @rlsrnamed{Top,Snippets}, @manualStableSnippetsSplit, - @manualStableSnippetsBig, 2.5 MB, - @manualStableSnippetsPdf, 8 MB} - -@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} - -@docLinks{Web, web, - @rglosnamed{Top,Web}, - @manualStableWebSplit, - @manualStableWebBig, 1 MB, - @manualStableWebPdf, 2 MB} + @manualStableSnippetsBig, 1.5 MB, + @manualStableSnippetsPdf, 12.5 MB} @divEnd @@ -368,6 +388,40 @@ This is explained in @rprogram{Why does the syntax change?}. @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 + +@subsubheading Latest manual + +@divClass{keep-bullets} +@itemize +@ref{Top,Web} +@end itemize +@divEnd + +@subsubheading Web manual in @versionDevel + +@docLinksBare{Web, web, + @ref{Top,Web}, + @manualDevelWebSplit, + @manualDevelWebBig, 2.5 MB, + @manualDevelWebPdf, 3.5 MB} + +@divEnd + + @node Changes @unnumberedsec Changes @@ -382,19 +436,19 @@ LilyPond since the previous stable version. @divClass{column-right-bottom} @docLinks{Changes, changes, - @rglosnamed{Top,Changes}, + @rchangesnamed{Top,Changes}, @manualStableChangesSplit, - @manualStableChangesBig, 6 KB, - @manualStableChangesPdf, 200 KB} + @manualStableChangesBig, 90 KB, + @manualStableChangesPdf, 80 KB} @divEnd -@node Extend -@unnumberedsec Extend +@node Extending +@unnumberedsec Extending @divClass{column-left-top} -@subheading Extend LilyPond +@subheading Extending LilyPond This manual explains how to write extensions to LilyPond. @@ -402,11 +456,11 @@ This manual explains how to write extensions to LilyPond. @divClass{column-right-bottom} -@docLinks{Extend, extend, - @rglosnamed{Top,Extend}, +@docLinks{Extending, extending, + @rextendnamed{Top,Extending}, @manualStableExtendingSplit, - @manualStableExtendingBig, 200 KB, - @manualStableExtendingPdf, 400 KB} + @manualStableExtendingBig, 300 KB, + @manualStableExtendingPdf, 500 KB} @divEnd @@ -417,7 +471,7 @@ This manual explains how to write extensions to LilyPond. @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. @@ -428,18 +482,17 @@ 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} @docLinks{Internals, internals, - @rglosnamed{Top,Internals}, + @rinternalsnamed{Top,Internals}, @manualStableInternalsSplit, - @manualStableInternalsBig, 2.5 MB, - @manualStableInternalsPdf, 2.8 MB} + @manualStableInternalsBig, 3 MB, + @manualStableInternalsPdf, 4 MB} @divEnd @@ -448,11 +501,9 @@ have clickable links. @unnumberedsec Translated @divClass{column-center-bottom} -@subheading Translation status - -TODO: clean up / prettify +@subheading Translations status -@uref{../translations.html}. +@include translations.itexi @divEnd @@ -460,110 +511,38 @@ TODO: clean up / prettify @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} @@ -573,7 +552,23 @@ 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 @@ -599,5 +594,3 @@ reasons for choosing it, is given in @ref{Freedom}. @include fdl.itexi @divEnd - -