Doc: make Changes a split manual.

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

diff --git a/Documentation/general/manuals.itexi b/Documentation/general/manuals.itexi
index d85ede82e113cb7962675cb78c686c206dc7b2b4..ed3b93d54e9a3f54efe22dc915596cd5e6dbe9dd 100644 (file)
--- a/Documentation/general/manuals.itexi
+++ b/Documentation/general/manuals.itexi
@@ -50,13 +50,13 @@ aesthetics of 19th century music engraving.
 the main portion of the documentation; provides detailed
 information about creating notation.
 
-@item @ref{Snippets}:
-short tricks, tips, and examples.
-
 @item @ref{Usage}:
 discusses the actual programs and operating system-specific
 issues.
 
+@item @ref{Snippets}:
+short tricks, tips, and examples.
+
 @end itemize
 
 @divEnd
@@ -73,6 +73,9 @@ links to the answers of Frequently Asked Questions.
 @item @ref{Changes}:
 updates since the last major version.
 
+@item @ref{Extend}:
+programming fancy tweaks in lilypond.
+
 @item @ref{Internals}:
 information about LilyPond's internal structures, which is
 required for constructing tweaks.
@@ -115,6 +118,7 @@ License.
 * Snippets::                Snippets.
 * FAQ::                         FAQ.
 * Changes::                     NEWS.
+* Extend::         Programming.
 * Internals::         Internals.
 * Translated::          Translation.
 * All::                 All manuals.
@@ -145,8 +149,8 @@ read all of the manual, you may want to read some sections again
 and follow those cross-references for more information.
 @divEnd
 
-@divClass{column-right-top}
-@subheading Read it now
+@divClass{column-right-bottom}
+@subheading Read it
 
 @itemize
 
@@ -154,28 +158,27 @@ and follow those cross-references for more information.
 read this manual in the same format as this one.
 
 @end itemize
-@divEnd
 
-@divClass{column-center-bottom}
-@subheading Other formats
+@subheading All formats
 
 @divClass{keep-bullets}
 @itemize
 
-@item @uref{../learning/index.html, Learning (split HTML)}:
+@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)}:
+@item @uref{learning-big-page.html, Learning (big HTML)}:
 read this manual as one huge HTML page.
 @emph{(large single download, around 10? Mb)}
 
-@item @uref{../learning.pdf, learning.pdf}:
+@item @uref{learning.pdf, learning.pdf}:
 download as a PDF file.
 @emph{(large single download, 2.8 Mb)}
 
-@item @uref{FIXME, learning.info}:
-GNU info format for documentation.  FIXME, link broken.
+@c TODO: should make links to info?
+@c @item @uref{TODO, learning.info}:
+@c GNU info format for documentation.  link broken.
 
 @end itemize
 @divEnd
@@ -186,7 +189,7 @@ GNU info format for documentation.  FIXME, link broken.
 @unnumberedsec Glossary
 
 @divClass{column-left-top}
-@subheading Glossay
+@subheading Glossary
 
 This explains musical terms, and includes translations to various
 languages.  If you are not familiar with music notation or music
@@ -195,38 +198,35 @@ it is highly advisable to consult the glossary.
 
 @divEnd
 
-@divClass{column-right-top}
-@subheading Read it now
+@divClass{column-right-bottom}
+@subheading Read it
 
 @itemize
 
-@item
-@rglosnamed{Top,Music glossary}:
+@item @rglosnamed{Top,Music glossary}:
 read this manual in the same format as this one.
 
 @end itemize
-@divEnd
 
-@divClass{column-center-bottom}
-@subheading Other formats
+@subheading All formats
 
 @divClass{keep-bullets}
 @itemize
 
-@item @uref{../glossary/index.html, Glossary (split HTML)}:
+@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{../glossary-big-page.html, Glossay (big HTML)}:
+@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{../glossary.pdf, glossary.pdf}:
+@item @uref{music-glossary.pdf, glossary.pdf}:
 download as a PDF file.
 @emph{(large single download, 2.8 Mb)}
 
-@item @uref{FIXME, glossary.info}:
-GNU info format for documentation.  FIXME, link broken.
+@c @item @uref{TODO, glossary.info}:
+@c GNU info format for documentation.  TODO, link broken.
 
 @end itemize
 @divEnd
@@ -243,10 +243,13 @@ 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
+in the PDF version due to its higher resolution.}
+
 @divEnd
 
-@divClass{column-right-top}
-@subheading Read it now
+@divClass{column-right-bottom}
+@subheading Read it
 
 @itemize
 
@@ -254,28 +257,26 @@ between LilyPond and other music engraving systems is given.
 read this manual in the same format as this one.
 
 @end itemize
-@divEnd
 
-@divClass{column-center-bottom}
-@subheading Other formats
+@subheading All formats
 
 @divClass{keep-bullets}
 @itemize
 
-@item @uref{../essay/index.html, Essay (split HTML)}:
+@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)}:
+@item @uref{essay-big-page.html, Essay (big HTML)}:
 read this manual as one huge HTML page.
-@emph{(large single download, around FIXME? Mb)}
+@emph{(large single download, around ?? Mb)}
 
-@item @uref{../essay.pdf, essay.pdf}:
+@item @uref{essay.pdf, essay.pdf}:
 download as a PDF file.
-@emph{(large single download, FIXME? Mb)}
+@emph{(large single download, ?? Mb)}
 
-@item @uref{FIXME, essay.info}:
-GNU info format for documentation.  FIXME, link broken.
+@c @item @uref{TODO, essay.info}:
+@c GNU info format for documentation.  TODO, link broken.
 
 @end itemize
 @divEnd
@@ -291,14 +292,14 @@ GNU info format for documentation.  FIXME, link broken.
 This book explains all the LilyPond commands which produce
 notation.
 
-@warning{The Notation 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.}
+@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.}
 
 @divEnd
 
-@divClass{column-right-top}
-@subheading Read it now
+@divClass{column-right-bottom}
+@subheading Read it
 
 @itemize
 
@@ -306,28 +307,26 @@ terms presented in the Musical Glossary.}
 read this manual in the same format as this one.
 
 @end itemize
-@divEnd
 
-@divClass{column-center-bottom}
-@subheading Other formats
+@subheading All formats
 
 @divClass{keep-bullets}
 @itemize
 
-@item @uref{../notation/index.html, Notation (split HTML)}:
+@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)}:
+@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}:
+@item @uref{notation.pdf, notation.pdf}:
 download as a PDF file.
 @emph{(large single download, 2.8 Mb)}
 
-@item @uref{FIXME, notation.info}:
-GNU info format for documentation.  FIXME, link broken.
+@c @item @uref{TODO, notation.info}:
+@c GNU info format for documentation.  TODO, link broken.
 
 @end itemize
 @divEnd
@@ -346,8 +345,8 @@ practices} for efficient use.  It is recommended reading before
 attempting any large projects.
 @divEnd
 
-@divClass{column-right-top}
-@subheading Read it now
+@divClass{column-right-bottom}
+@subheading Read it
 
 @itemize
 
@@ -355,28 +354,26 @@ attempting any large projects.
 read this manual in the same format as this one.
 
 @end itemize
-@divEnd
 
-@divClass{column-center-bottom}
-@subheading Other formats
+@subheading All formats
 
 @divClass{keep-bullets}
 @itemize
 
-@item @uref{../usage/index.html, Usage (split HTML)}:
+@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)}:
+@item @uref{usage-big-page.html, Usage (big HTML)}:
 read this manual as one huge HTML page.
 @emph{(large single download, around 10? Mb)}
 
-@item @uref{../usage.pdf, usage.pdf}:
+@item @uref{usage.pdf, usage.pdf}:
 download as a PDF file.
 @emph{(large single download, 2.8 Mb)}
 
-@item @uref{FIXME, lilypond-usage.info}:
-GNU info format for documentation.  FIXME, link broken.
+@c @item @uref{TODO, lilypond-usage.info}:
+@c GNU info format for documentation.  TODO, link broken.
 
 @end itemize
 @divEnd
@@ -403,8 +400,8 @@ The list of snippets for each subsection of the Notation are also
 linked from the @strong{See also} portion.
 @divEnd
 
-@divClass{column-right-top}
-@subheading Read it now
+@divClass{column-right-bottom}
+@subheading Read it
 
 @itemize
 
@@ -412,28 +409,26 @@ linked from the @strong{See also} portion.
 read this manual in the same format as this one.
 
 @end itemize
-@divEnd
 
-@divClass{column-center-bottom}
-@subheading Other formats
+@subheading All formats
 
 @divClass{keep-bullets}
 @itemize
 
-@item @uref{../snippets/index.html, Snippets (split HTML)}:
+@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)}:
+@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}:
+@item @uref{snippets.pdf, snippets.pdf}:
 download as a PDF file.
 @emph{(large single download, 2.8 Mb)}
 
-@item @uref{FIXME, snippets.info}:
-GNU info format for documentation.  FIXME, link broken.
+@c @item @uref{TODO, snippets.info}:
+@c GNU info format for documentation.  TODO, link broken.
 
 @end itemize
 @divEnd
@@ -492,8 +487,8 @@ LilyPond since the previous stable version.
 
 @divEnd
 
-@divClass{column-right-top}
-@subheading Read it now
+@divClass{column-right-bottom}
+@subheading Read it
 
 @itemize
 
@@ -501,39 +496,76 @@ LilyPond since the previous stable version.
 read this manual in the same format as this one.
 
 @end itemize
-@divEnd
 
-@divClass{column-center-bottom}
-@subheading Other formats
+@subheading All formats
 
 @divClass{keep-bullets}
 @itemize
 
-@c Changes isn't available as a split manual.
-@c  (maybe it should be, but it isn't so far)
-@c @item @uref{../changes/index.html, Changes (split HTML)}:
-@c the manual is split between many HTML pages.
-@c @emph{(small download for each page)}
-
-@c @item @uref{../changes-big-page.html, Changes (big HTML)}:
-@c read this manual as one huge HTML page.
-@c @emph{(large single download, around 10? Mb)}
+@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.html, Changes}:
-read this manual as a HTML 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}:
+@item @uref{changes.pdf, changes.pdf}:
 download as a PDF file.
 @emph{(small single download, 0.5 ?? Mb)}
 
-@item @uref{FIXME, changes.info}:
-GNU info format for documentation.  FIXME, link broken.
+@c @item @uref{TODO, changes.info}:
+@c GNU info format for documentation.  TODO, link broken.
 
 @end itemize
 @divEnd
 @divEnd
 
 
+@node Extend
+@unnumberedsec Extend
+
+@divClass{column-left-top}
+@subheading Extend LilyPond
+
+This manual explains how to write extensions to LilyPond.
+
+@divEnd
+
+@divClass{column-right-bottom}
+@subheading Read it
+
+@itemize
+
+@item @rextendnamed{Top,Extend}: 
+read this manual in the same format as this one.
+
+@end itemize
+
+@subheading All formats
+
+@divClass{keep-bullets}
+@itemize
+
+@item @uref{extending/index.html, Extend (split HTML)}:
+the manual is split between many HTML pages.
+@emph{(small download for each page)}
+
+@item @uref{extending-big-page.html, Extend (big HTML)}:
+read this manual as one huge HTML page.
+@emph{(large single download, around 10? Mb)}
+
+@item @uref{extending.pdf, extending.pdf}:
+download as a PDF file.
+@emph{(large single download, 2.8 Mb)}
+
+@c @item @uref{TODO, extending.info}:
+@c GNU info format for documentation.  TODO, link broken.
+
+@end itemize
+@divEnd
+@divEnd
+
 
 @node Internals
 @unnumberedsec Internals
@@ -557,8 +589,8 @@ have clickable links.
 
 @divEnd
 
-@divClass{column-right-top}
-@subheading Read it now
+@divClass{column-right-bottom}
+@subheading Read it
 
 @itemize
 
@@ -566,28 +598,26 @@ have clickable links.
 read this manual in the same format as this one.
 
 @end itemize
-@divEnd
 
-@divClass{column-center-bottom}
-@subheading Other formats
+@subheading All formats
 
 @divClass{keep-bullets}
 @itemize
 
-@item @uref{../internals/index.html, Internals (split HTML)}:
+@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)}:
+@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}:
+@item @uref{internals.pdf, internals.pdf}:
 download as a PDF file.
 @emph{(large single download, 2.8 Mb)}
 
-@item @uref{FIXME, internals.info}:
-GNU info format for documentation.  FIXME, link broken.
+@c @item @uref{TODO, internals.info}:
+@c GNU info format for documentation.  TODO, link broken.
 
 @end itemize
 @divEnd
@@ -603,7 +633,7 @@ GNU info format for documentation.  FIXME, link broken.
 
 TODO: clean up / prettify
 
-@uref{../translations.html}.
+@uref{translations.html}.
 
 @divEnd
 
@@ -614,8 +644,11 @@ TODO: clean up / prettify
 @divClass{column-left-top}
 @subheading Downloadable versions
 
-FIXME: compare tarball vs. zip size, ask about windows users
-dealing with tarballs (both gz and bz2), etc.
+@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}
 
 @divClass{keep-bullets}
 @itemize
@@ -648,7 +681,7 @@ LilyPond 2.10 Documentation}
 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
 LilyPond 2.8 Documentation}
 
-@item FIXME etc.
+@help anybody want to write this stuff?
 
 @end itemize