# HG changeset patch # User Dongsheng Song # Date 1256110996 -28800 # Node ID 4688f8ac941d1bcde6a1a9b059f88c966ee45e66 # Parent 7037e4bcb90c3bc29111346f668428de0195c10c User should use nxml-mode for emacs diff -r 7037e4bcb90c -r 4688f8ac941d README.BUILD --- a/README.BUILD Wed Oct 21 14:26:58 2009 +0800 +++ b/README.BUILD Wed Oct 21 15:43:16 2009 +0800 @@ -16,17 +16,13 @@ I. PRIMER - DocBook has a tortured, confusing history. Before you do anything, - take a look at Eric Raymond's excellent "DocBook Demystification HOWTO": + DocBook has a tortured, confusing history. Before you do anything, + take a look at: - http://tldp.org/HOWTO/DocBook-Demystification-HOWTO/ - - It's very short and clears up many things. - + http://wiki.docbook.org/topic/DocBookTutorials II. COMPILING THE DOCS - 1. Install XML DTD and XSL stylesheets for DocBook % sudo apt-get install docbook-xml docbook-xsl @@ -47,7 +43,7 @@ some trick, let fop's CLASSPATH include saxon.jar and docbook-xsl-saxon.jar . 5. Configure XML Catalogs - For non pdf output, we use xsltproc for XSLT process, which use system + For non pdf output, we use xsltproc for XSLT process, xsltproc use system catalog files automatically, usually /etc/xml/catalog. Users do not need to care about it. @@ -82,24 +78,22 @@ In addition to everything in section II: - -1. Get a nice editing environment for SGML/XML. +1. Get a nice editing environment for XML This isn't strictly required, but it's nice when your editor colorizes things, understands the DTD, tells you what tags you can insert, etc. - If you use emacs, we recommend the PSGML major-mode. Most free + If you use emacs, we recommend the nxml-mode. Most free operating systems package it, or its home page is here: - http://www.lysator.liu.se/projects/about_psgml.html + http://www.emacswiki.org/emacs/NxmlMode If you use vim, you might check out xmledit, at: http://www.vim.org/scripts/script.php?script_id=301 - -2. Get a validating parser. +2. Get a validating parser Actually, if you have what you need to compile the documentation, then you almost certainly have an XML validator installed already - @@ -110,7 +104,7 @@ $ make validate -3. Read about DocBook. +3. Read about DocBook You'll want to get real intimate with a DocBook reference, such as can be found at: http://www.docbook.org/tdg/en/html/