[svnbook commit] r1148 - trunk/src/en

sunny256 at red-bean.com sunny256 at red-bean.com
Sat Mar 5 04:35:11 CST 2005


Author: sunny256
Date: Sat Mar  5 04:35:08 2005
New Revision: 1148

Modified:
   trunk/src/en/README
Log:
Update of the English README file after the tools/ directory was moved + 
minor tweaks.

* src/en/README
  Update paths to the tools/ directory and make them relative to trunk.
  (Use XSLT to transform the book): Remove sentence about the misc-docs 
    and mention the multi-page HTML version instead.
  (Make a PDF file): Remove sentence about misc-docs.
  (Get a validating parser): Update broken link to nsgmls homepage.


Modified: trunk/src/en/README
==============================================================================
--- trunk/src/en/README	(original)
+++ trunk/src/en/README	Sat Mar  5 04:35:08 2005
@@ -37,7 +37,7 @@
 II. COMPILING THE DOCS
 
 
-1. Fetch XSL stylesheets for Docbook and place them in tools/xsl
+1. Fetch XSL stylesheets for Docbook and place them in src/tools/xsl
 
    The "Docbook Open Repository" on Sourceforge has a large collection
    of XSL stylesheets that specifically operate on Docbook.  Download
@@ -45,15 +45,15 @@
   
       http://sourceforge.net/project/showfiles.php?group_id=21935
 
-   Download the latest version of docbook-xsl, unpack it, then
-   rename the unpacked directory to tools/xsl, something like this:
+   Download the latest version of docbook-xsl, unpack it, then rename
+   the unpacked directory to src/tools/xsl, something like this:
 
-      $ cd doc/book/tools
+      $ cd src/tools
       $ tar zxvf docbook-xsl-X.YY.Z.tar.gz
       $ mv docbook-xsl-X.YY.Z xsl
 
    The default build process expects to the stylesheets to be in
-   tools/xsl/.
+   src/tools/xsl/.
 
 
 2. Use XSLT to transform the book.
@@ -82,8 +82,8 @@
 
         make all-html
 
-     This produces an HTML version of the book in book/book.html, and
-     HTML for the miscellaneous docs in misc-docs/misc-docs.html.
+     This produces a single-page HTML version of the book in
+     book/book.html, and a multi-page version in book/html-chunk/.
 
          
 3. Make a PDF file.
@@ -105,16 +105,16 @@
            fop-0.20.4-bin.tar.gz.  Just get a binary distribution,
            there's no need for the Java source.
 
-        2. Unpack it into tools/fop/
+        2. Unpack it into src/tools/fop/
 
-           $ cd doc/book/tools
+           $ cd src/tools
            $ tar zxvf fop-0.20.4-bin.tar.gz
            $ mv fop-0.20.4 fop
 
      That should be enough.  The Makefile will actually invoke
-     tools/bin/run-fop.sh.  That script attempts to find FOP already
+     src/tools/bin/run-fop.sh.  That script attempts to find FOP already
      installed on your system, but falls back to the FOP unpacked into
-     tools/fop/ if there's no other FOP available.
+     src/tools/fop/ if there's no other FOP available.
 
      Of course, to run FOP at all, you also need a Java runtime
      environment.  Try java.sun.com or www.blackdown.org if you don't
@@ -136,7 +136,7 @@
      http://java.sun.com/products/jimi/, then cp the jar file into the
      same place as the FOP jar files:
 
-        $ cd doc/book/tools/
+        $ cd src/tools
         $ tar zxvf jimi1_0.tar.Z
         $ cp Jimi/examples/AppletDemo/JimiProClasses.jar fop/lib/
 
@@ -146,8 +146,7 @@
 
         make all-pdf
 
-     This produces PDF for the book in book/book.pdf, and
-     PDF for the miscellaneous docs in misc-docs/misc-docs.pdf.
+     This produces PDF for the book in book/book.pdf.
 
 
 III. HACKING ON THE DOCS
@@ -174,7 +173,7 @@
 2. Get a validating parser.
 
    We recommend nsgmls, a parser written by James Clark:
-   http://www.jclark.com/sp/nsgmls.  It's nice to check that the XML
+   http://www.jclark.com/sp/.  It's nice to check that the XML
    you write has matching tags, and follows the DTD correctly.
 
    Here is one command you can use to validate your xml:



More information about the svnbook-dev mailing list