Patch: src/en/README

Jonathon Mah me at JonathonMah.com
Thu Apr 21 21:31:09 CDT 2005


Hi,

I just clarified some things in the README file, and made some things 
more consistent. The main change is that the make commands must be run 
from the src/en/ directory, _not_ the book/ directory.

I also added a command to validate using OpenSP. This command works for 
me; can others please confirm?

All changes:
* Fixed reference to directory where make commands must be run.
* Added reference to HACKING file in "Hacking on the docs" section.
* Added command to validate docs using OpenSP.
* Consistently capitalizing Misc Docs.
* Consistently adding periods after numbered list items.


Jonathon Mah
me at JonathonMah.com


Patch follows:


Index: src/en/README
===================================================================
--- src/en/README	(revision 1227)
+++ src/en/README	(working copy)
@@ -25,9 +25,9 @@
    It's very short and clears up many things.

    Note that there are actually two DocBook documents here: The book
-  itself, "Version Control with Subversion", and a miscellaneous
-  holding area known only as the "misc docs" (e.g., misc-docs.pdf,
-  etc).  The Misc Docs hold material that either isn't yet ready to go
+  itself, "Version Control with Subversion"; and a miscellaneous
+  holding area known only as the "Misc Docs" (misc-docs.pdf, etc).
+  The Misc Docs hold material that either isn't yet ready to go
    into the book itself, or which may never go into the book but
    instead into companion documents that will also be available from
    the Subversion site.  Think of Misc Docs as a temporary, but
@@ -37,7 +37,7 @@
  II. COMPILING THE DOCS


-1. Fetch XSL stylesheets for Docbook and place them in src/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
@@ -78,7 +78,7 @@
       If you don't want to compile libxslt, you can just fetch the
       appropriate OS binary package.

-   * From the book directory, do
+   * From this directory (en, or another language directory)

          make all-html

@@ -100,7 +100,7 @@
       installed FOP some other way, that's fine, then you can ignore
       the following recipe:

-        1. Download the latest from
+        1. Download the latest version from
             http://www.apache.org/dyn/closer.cgi/xml/fop, for example,
             fop-0.20.4-bin.tar.gz.  Just get a binary distribution,
             there's no need for the Java source.
@@ -142,7 +142,7 @@

       Poof!  You now have PNG support.

-   * From the book directory, do
+   * From this directory (en, or another language directory), do

          make all-pdf

@@ -151,7 +151,7 @@

  III. HACKING ON THE DOCS

-In addition to everything in section II:
+In addition to everything in section II and the HACKING file:


  1. Get a nice editing environment for SGML/XML.
@@ -176,14 +176,19 @@
     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:
+   Here is one command you can use to validate your XML:

     $ SP_CHARSET_FIXED=YES SP_ENCODING=XML nsgmls -wxml \
         -mdeclaration/xml.soc -ges                      \
         /path/to/your/declaration/xml.dcl book.xml

+   It's also possible to use OpenSP: http://openjade.sourceforge.net/.
+   This command can be used to validate the XML:

+   $ SP_CHARSET_FIXED=YES SP_ENCODING=XML onsgmls -wxml \
+       -m/path/to/your/xml.soc -ges book.xml

+
  3. Read about the DocBook lite tags.

     The tools area contains the readme-dblite.html file which describes




More information about the svnbook-dev mailing list