Issue 4425: Fix some CG musing about music functions

[lilypond.git] / Documentation / web / manuals.itexi

diff --git a/Documentation/web/manuals.itexi b/Documentation/web/manuals.itexi
index 8ff1d8dbb946a61f8aeffdf3cea23df5b9fb94d6..e741a960eaa3831bdd43d9fe184ab9ac987537ba 100644 (file)
--- 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
     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
 
 @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
 @divClass{heading-center}
 @ifclear web_version
   @heading Manuals for LilyPond @version


@@ -17,34 +24,33 @@
   @heading Manuals for LilyPond @versionStable
 @end ifset
 
   @heading Manuals for LilyPond @versionStable
 @end ifset
 

-

 @divEnd
 
 @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
 
 @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.
 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
 
 
 @end itemize
 


@@ -55,16 +61,20 @@ aesthetics of 19th century music engraving.
 
 @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
 
 
 @end itemize
 


@@ -76,21 +86,29 @@ short tricks, tips, and examples.
 
 @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
 
 
 @end itemize
 


@@ -102,23 +120,48 @@ required for constructing tweaks.
 
 @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.
 
 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://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}:

 manuals for the unstable version.
 
 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
 
 
 @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
 
 @divClass{hide}
 @menu


@@ -128,10 +171,10 @@ License.
 * Notation::          Reference.
 * Usage::           Usage.
 * Snippets::                Snippets.
 * Notation::          Reference.
 * Usage::           Usage.
 * Snippets::                Snippets.

-* Web::                      Web.

 * FAQ::                         FAQ.
 * FAQ::                         FAQ.

+* Web::                      Web.

 * Changes::                     NEWS.
 * Changes::                     NEWS.

-* Extend::         Programming.
+* Extending::         Programming.

 * Internals::         Internals.
 * Translated::          Translation.
 * All::                 All manuals.
 * 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,
 @docLinks{Learning, learning,
   @rlearningnamed{Top,Learning},
   @manualStableLearningSplit,

-  @manualStableLearningBig, 1.5 MB,
-  @manualStableLearningPdf, 3 MB}
+  @manualStableLearningBig, 3 MB,
+  @manualStableLearningPdf, 5 MB}

 
 @divEnd
 
 
 @divEnd
 


@@ -217,8 +260,8 @@ in the PDF version due to its higher resolution.}
 @docLinks{Essay, essay,
   @ressaynamed{Top,Essay},
   @manualStableEssaySplit,
 @docLinks{Essay, essay,
   @ressaynamed{Top,Essay},
   @manualStableEssaySplit,

-  @manualStableEssayBig, 2 MB,
-  @manualStableEssayPdf, 2.5 MB}
+  @manualStableEssayBig, 1 MB,
+  @manualStableEssayPdf, 2 MB}

 
 @divEnd
 
 
 @divEnd
 


@@ -243,8 +286,8 @@ the English musical terms presented in the glossary.}
 @docLinks{Notation, notation,
   @rusernamed{Top,Notation},
   @manualStableNotationSplit,
 @docLinks{Notation, notation,
   @rusernamed{Top,Notation},
   @manualStableNotationSplit,

-  @manualStableNotationBig, 7 MB,
-  @manualStableNotationPdf, 18 MB}
+  @manualStableNotationBig, 9 MB,
+  @manualStableNotationPdf, 35 MB}

 
 @divEnd
 
 
 @divEnd
 


@@ -267,8 +310,8 @@ attempting any large projects.
 @docLinks{Usage, usage,
   @rprogramnamed{Top,Usage},
   @manualStableUsageSplit,
 @docLinks{Usage, usage,
   @rprogramnamed{Top,Usage},
   @manualStableUsageSplit,

-  @manualStableUsageBig, 300 KB,
-  @manualStableUsagePdf, 400 KB}
+  @manualStableUsageBig, 400 KB,
+  @manualStableUsagePdf, 650 KB}

 
 @divEnd
 
 
 @divEnd
 


@@ -280,7 +323,7 @@ attempting any large projects.
 @subheading Snippets
 
 This shows a selected set of LilyPond snippets from the
 @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
 (LSR).  All the snippets are in the public domain.
 
 Please note that this document is not an exact subset of LSR.  LSR


@@ -298,31 +341,8 @@ linked from the @strong{See also} portion.
 @docLinks{Snippets, snippets,
   @rlsrnamed{Top,Snippets},
   @manualStableSnippetsSplit,
 @docLinks{Snippets, 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,
-  @ref{Top,,,,Web},
-  @manualStableWebSplit,
-  @manualStableWebBig, 1 MB,
-  @manualStableWebPdf, 2 MB}
+  @manualStableSnippetsBig, 1.5 MB,
+  @manualStableSnippetsPdf, 12.5 MB}

 
 @divEnd
 
 
 @divEnd
 


@@ -368,6 +388,40 @@ This is explained in @rprogram{Why does the syntax change?}.
 @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
+
+@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
 
 @node Changes
 @unnumberedsec Changes
 


@@ -384,17 +438,17 @@ LilyPond since the previous stable version.
 @docLinks{Changes, changes,
   @rchangesnamed{Top,Changes},
   @manualStableChangesSplit,
 @docLinks{Changes, changes,
   @rchangesnamed{Top,Changes},
   @manualStableChangesSplit,

-  @manualStableChangesBig, 6 KB,
-  @manualStableChangesPdf, 200 KB}
+  @manualStableChangesBig, 90 KB,
+  @manualStableChangesPdf, 80 KB}

 
 @divEnd
 
 
 
 @divEnd
 
 

-@node Extend
-@unnumberedsec Extend
+@node Extending
+@unnumberedsec Extending

 
 @divClass{column-left-top}
 
 @divClass{column-left-top}

-@subheading Extend LilyPond
+@subheading Extending LilyPond

 
 This manual explains how to write extensions to 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}
 
 
 @divClass{column-right-bottom}
 

-@docLinks{Extend, extend,
-  @rextendnamed{Top,Extend},
+@docLinks{Extending, extending,
+  @rextendnamed{Top,Extending},

   @manualStableExtendingSplit,
   @manualStableExtendingSplit,

-  @manualStableExtendingBig, 200 KB,
-  @manualStableExtendingPdf, 400 KB}
+  @manualStableExtendingBig, 300 KB,
+  @manualStableExtendingPdf, 500 KB}

 
 @divEnd
 
 
 @divEnd
 


@@ -437,8 +491,8 @@ generated documentation.
 @docLinks{Internals, internals,
   @rinternalsnamed{Top,Internals},
   @manualStableInternalsSplit,
 @docLinks{Internals, internals,
   @rinternalsnamed{Top,Internals},
   @manualStableInternalsSplit,

-  @manualStableInternalsBig, 2.5 MB,
-  @manualStableInternalsPdf, 2.8 MB}
+  @manualStableInternalsBig, 3 MB,
+  @manualStableInternalsPdf, 4 MB}

 
 @divEnd
 
 
 @divEnd
 


@@ -449,10 +503,7 @@ generated documentation.
 @divClass{column-center-bottom}
 @subheading Translations status
 
 @divClass{column-center-bottom}
 @subheading Translations status
 

-TODO: prettify and generate in Texinfo.
-@c http://code.google.com/p/lilypond/issues/detail?id=857
-
-@uref{../translations.html}.
+@include translations.itexi

 
 @divEnd
 
 
 @divEnd
 


@@ -460,111 +511,38 @@ TODO: prettify and generate in Texinfo.
 @node All
 @unnumberedsec 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
-
-@c no colon : needed in this section
-@item @ifWebLinks{@manualStableLearningSplit,@rlearningnamed{Top,Learning}}
-a @qq{must-read} gentle introduction to LilyPond.
-
-@item @ifWebLinks{@manualStableGlossarySplit,@rglosnamed{Top,Glossary}}
-@emph{(optional reading)}
-explains musical terms and gives translations for users unfamiliar
-with English musical terms.
-
-@item @ifWebLinks{@manualStableEssaySplit,@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}
 @divClass{column-left-top}

-@subheading Regular use
-
-@itemize
-
-@item @ifWebLinks{@manualStableNotationSplit,@rusernamed{Top,Notation}}
-the main portion of the documentation; provides detailed
-information about creating notation.
-
-@item @ifWebLinks{@manualStableUsageSplit,@rprogramnamed{Top,Usage}}
-discusses the actual programs and operation system-specific
-issues.
-
-@item @ifWebLinks{@manualStableSnippetsSplit,@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 @ifWebLinks{@manualStableChangesSplit,@rchangesnamed{Top,Changes}}
-updates since the last major version.
-
-@item @ifWebLinks{@manualStableExtendingSplit,@rextendnamed{Top,Extend}}
-programming fancy tweaks in LilyPond.
-
-@item @ifWebLinks{@manualStableInternalsSplit,@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
 
 @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
 
 
 @divClass{keep-bullets}
 @itemize
 

-@item html-split zip
-
-@item html-big zip
-
-@item pdf zip
-
-@item info zip maybe?!?!
+@item @doctarballStable

 
 @end itemize
 
 
 @end itemize
 

+@divEnd
+@end ifset
+

 @divEnd
 
 @divEnd
 

+@divClass{column-right-bottom}

 @subheading Previous stable versions
 
 @divClass{keep-bullets}
 @itemize
 
 @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.12/Documentation/,
 LilyPond 2.12 Documentation}
 


@@ -574,7 +552,23 @@ LilyPond 2.10 Documentation}
 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
 LilyPond 2.8 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
 
 
 @end itemize
 


@@ -600,5 +594,3 @@ reasons for choosing it, is given in @ref{Freedom}.
 @include fdl.itexi
 
 @divEnd
 @include fdl.itexi
 
 @divEnd

-
-