]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/web.texi
Lilypond-book: regtest for .htmly as extension for html in lilypond-book
[lilypond.git] / Documentation / web.texi
index aaac6c5413204c18ee87694abd0b0420c9d4efd4..7881e70b4ca6019d74087efbbbeea9df804e203c 100644 (file)
@@ -3,7 +3,8 @@
     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
 
 @setfilename web.info
 @documentlanguage en
 @afourpaper
 
+@c `Web' was imported 2009-08-05 with git commit b938d71...
+@c @macro copyrightDeclare
+@c Copyright @copyright{} 2009--2010 by the authors.
+@c @end macro
+
 @set FDL
 @set web
 @include macros.itexi
-
-@ifset web_version
-foo foo foo foo foo foo foo foo foo foo foo foo foo foo foo foo foo
-@end ifset
+@include weblinks.itexi
 
 @afourpaper
 
@@ -31,17 +34,21 @@ foo foo foo foo foo foo foo foo foo foo foo foo foo foo foo foo foo
 @omflanguage English
 @end ignore
 
-@c `Web' was imported 2009-08-05 with git commit b938d71...
 @copying
-Copyright @copyright{} 2009 by the authors.
+Copyright @copyright{} 2009--2010 by the authors.
+
+@c next line is necessary for broken pre-4.13 texinfo's
+@c install-info, so leave it there until we officially
+@c bump the required version.  -gp
+This file documents the LilyPond website.
 
 @quotation
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1
-or any later version published by the Free Software Foundation;
-with no Invariant Sections.
-A copy of the license is included in the section entitled ``GNU
-Free Documentation License''.
+Permission is granted to copy, distribute and/or modify this
+document under the terms of the GNU Free Documentation License,
+Version 1.1 or any later version published by the Free Software
+Foundation; with no Invariant Sections.  A copy of the license is
+included in the section entitled ``GNU Free Documentation
+License''.
 @end quotation
 @end copying
 
@@ -67,7 +74,7 @@ Free Documentation License''.
 @vskip 0pt plus 1filll
 @c @vskip 20pt
 
-@insertcopying{}
+@insertcopying
 
 For LilyPond version @version{}
 @end titlepage
@@ -117,7 +124,11 @@ Read more in our @ref{Introduction}!
 
 @divEnd
 
-
+@ifclear web_version
+  @c do nothing
+@end ifclear
+@ifset web_version
+  @c make the box:
 @divId{latestVersion}
 @subheading Quick links
 
@@ -136,6 +147,7 @@ Read more in our @ref{Introduction}!
 @ref{Development, Manuals @versionDevel}
 
 @divEnd
+@end ifset
 
 
 @ifnottex
@@ -153,6 +165,7 @@ Read more in our @ref{Introduction}!
 
 @contents
 
+@allowcodebreaks false
 
 @c ****************** GENERAL STUFF FOR INFO ************
 @ignore
@@ -167,8 +180,6 @@ Distributions will want to install lilypond.info in postinstall, doing:
 
   * List all commands in direntry.
 
-@c  * lilypond: (lilypond-application)Running LilyPond.      Invoking the
-@c    LilyPond  program.
 @end ignore
 
 @c Info files are no longer installed in a subdirectory, images are
@@ -180,17 +191,92 @@ Distributions will want to install lilypond.info in postinstall, doing:
 * LilyPond: (lilypond-notation).                           LilyPond Notation Reference.
 * LilyPond Snippets: (lilypond-snippets).         Short tricks, tips, and examples.
 * LilyPond Internals Reference: (lilypond-internals).  Definitions for tweaking.
-* LilyPond Application Usage: (lilypond-application). Installing and running applications.
-* LilyPond Website: (lilypond-general).    Preview of new website.
-* abc2ly: (lilypond-application)Invoking abc2ly.      Importing ABC.      
-* convert-ly: (lilypond-application)Updating files with convert-ly. Older LilyPond versions.
-* etf2ly: (lilypond-application)Invoking etf2ly.      Importing Finale.
-* lilypond-book: (lilypond-application)LilyPond-book. Integrating text and music.
-* midi2ly: (lilypond-application)Invoking midi2ly.    Importing MIDI.
-* musicxml2ly: (lilypond-application)Invoking musicxml2ly.  Importing MusicXML.
+* LilyPond Application Usage: (lilypond-usage). Installing and running applications.
+* LilyPond Website: (lilypond-web).    Preview of new website.
+* lilypond: (lilypond-usage)Running LilyPond.      Invoking the LilyPond program.
+* abc2ly: (lilypond-usage)Invoking abc2ly.      Importing ABC.
+* convert-ly: (lilypond-usage)Updating files with convert-ly. Older LilyPond versions.
+* etf2ly: (lilypond-usage)Invoking etf2ly.      Importing Finale.
+* lilypond-book: (lilypond-usage)LilyPond-book. Integrating text and music.
+* midi2ly: (lilypond-usage)Invoking midi2ly.    Importing MIDI.
+* musicxml2ly: (lilypond-usage)Invoking musicxml2ly.  Importing MusicXML.
 @end direntry
 
 
+@c FIXME: this still doesn't solve the broken links in pdf and big
+@c        html; we'll need a bunch of @iftext and stuff in here. -gp
+@c ****************** SPECIAL MACROS FOR WEB MANUAL ************
+@macro docLinks{name,base,refLink,split,big,bigsize,pdf,pdfsize}
+@subheading Read it
+
+@docLinksBare{\name\,\base\,\refLink\,\split\,\big\,\bigsize\,\pdf\,\pdfsize\}
+
+@end macro
+
+
+@macro docLinkSplit{name,base,webLink}
+@ifclear web_version
+  @uref{../\base\/index.html, \name\ (split HTML)}
+@end ifclear
+@ifset web_version
+  \webLink\
+@end ifset
+@end macro
+
+@macro docLinkBig{name,base,webLink}
+@ifclear web_version
+  @uref{../\base\-big-page.html, \name\ (big HTML)}
+@end ifclear
+@ifset web_version
+  \webLink\
+@end ifset
+@end macro
+
+@macro docLinkPdf{name,base,webLink}
+@ifclear web_version
+  @uref{../\base\.pdf, \base\.pdf}
+@end ifclear
+@ifset web_version
+  \webLink\
+@end ifset
+@end macro
+
+
+@macro docLinksBare{name,base,refLink,split,big,bigsize,pdf,pdfsize}
+
+@divClass{keep-bullets}
+@itemize
+
+@item @docLinkSplit{\name\,\base\,\split\} @minus{}
+  the manual is split between many HTML pages.
+  @*@ @ @emph{(small download for each page)}
+
+@item @docLinkBig{\name\,\base\,\big\} @minus{}
+  read this manual as one huge HTML page.
+  @*@ @ @emph{(large single download, \bigsize\)}
+
+@item @docLinkPdf{\name\,\base\,\pdf\} @minus{}
+  download as a PDF file.
+  @*@ @ @emph{(large single download, \pdfsize\)}
+
+@end itemize
+
+@divEnd
+
+@end macro
+
+
+@c don't add any extra spaces in this macro -gp
+@macro ifWebLinks{webLink,normalLink}
+@ifclear web_version
+  \normalLink\:
+@end ifclear
+@ifset web_version
+  \webLink\:
+@end ifset
+@end macro
+
+
 @include web/introduction.itexi
 @include web/download.itexi
 @include web/manuals.itexi