From 7fbe5d224d1061f14ff0650988cf372e7adfb340 Mon Sep 17 00:00:00 2001 From: John Mandereau Date: Sun, 3 Feb 2008 12:04:50 +0100 Subject: [PATCH] Document offline and online web targets in INSTALL --- Documentation/user/install.itely | 39 ++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 10 deletions(-) diff --git a/Documentation/user/install.itely b/Documentation/user/install.itely index 4821926c83..ca8c94902d 100644 --- a/Documentation/user/install.itely +++ b/Documentation/user/install.itely @@ -177,14 +177,8 @@ or lyrics. You can view the documentation online at @uref{http://lilypond.org/doc/}, but you can also build it locally. -This process requires a successful compile of lilypond. The -documentation is built by issuing - -@example -make web -@end example - -Building the website requires some additional tools and packages +This process requires a successful compile of lilypond, and some +additional tools and packages @itemize @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities} @@ -197,13 +191,38 @@ and the patch from @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}. @end itemize -The HTML files can be installed into the standard documentation path -by issuing +The documentation is built by issuing + +@example +make web +@end example + +After compilation, the HTML documentation tree is available in +@file{out-www/offline-root/}, and can be browsed locally. + +The HTML and PDF files can be installed into the standard documentation +path by issuing @example make out=www web-install @end example +It is also possible to build a documentation tree in +@file{out-www/online-root/}, with special processing, so it can be used +on a website with content negociation for automatic language selection; +this can be achieved by issuing + +@example +make WEB_TARGETS=online web +@end example + +@noindent +and both @q{offline} and @q{online} targets can be generated by issuing + +@example +make WEB_TARGETS="offline online" web +@end example + @node Building LilyPond @subsection Building LilyPond -- 2.39.2