[Scummvm-cvs-logs] SF.net SVN: scummvm: [25341] docs/trunk/docbook/README

[fingolfin at users.sourceforge.net]

Revision: 25341
          http://scummvm.svn.sourceforge.net/scummvm/?rev=25341&view=rev
Author:   fingolfin
Date:     2007-02-02 16:38:03 -0800 (Fri, 02 Feb 2007)

Log Message:
-----------
Updated the docs README a bit

Modified Paths:
--------------
    docs/trunk/docbook/README

Modified: docs/trunk/docbook/README
===================================================================
--- docs/trunk/docbook/README	2007-02-02 23:43:39 UTC (rev 25340)
+++ docs/trunk/docbook/README	2007-02-03 00:38:03 UTC (rev 25341)
@@ -23,11 +23,8 @@
 to HTML, PDF, etc., and also tells you which packages you need for that
 (on a unix system).
 
-Both toolchains can be used for our purposes; the Makefile by default
-uses the "old" docbook-utils / jadetex chain. But there is also a Makefile
-for using the newer XSLT+FOP chain: Just invoke
-  make -f Makefile.xsltproc
-to use xsltproc + fop.
+Several toolchains can be used for our purposes; see below for a list.
+Right now, the Makefile by default uses the "dblatex" chain. 
 
 I have no idea how to proceed on Windows; probably your best bet is using
 CygWin. I added a link that seems helpful to the link section below.
@@ -42,35 +39,50 @@
 you will have to edit the Makefile slightly.
 Finally note that more ways exist, e.g. you could use 4suite.
 
-1) Classic tool chain
+(1) Classic tool chain
 You need to install the
   docbook-bundle
   docbook-utils
   tidy (for post-processing)
 packages (which in turn will install, amongst others, the "docbook-dtd"
-and "openjade" packages). Then, simply type "make" to invoke the Makefile.
+and "openjade" packages).
 
-2) Modern (XSLT+FOP) tool chain
+This chain is implemented by "Makefile.openjade", so type
+  make -f Makefile.openjade
+in order to use it, or rename "Makefile.openjade" to "Makefile".
+
+
+(2) Modern (XSLT+FOP) tool chain
 Install
   libxslt-bin (for xsltproc)
   fop
   docbook-dtd
   docbook-xsl
-Then, invoke "make manual.xsl.html", "make manual.xsl.pdf" etc. to create output
-(this is admittedly not the nicest way to handle this).
 
-3) xmlto
+This chain is implemented by "Makefile.fop", so type
+  make -f Makefile.fop
+in order to use it, or rename "Makefile.fop" to "Makefile".
+
+
+(3) xmlto
 Install the "xmlto" package (which will also install most of the packages from
 the modern tool chain). Then, you can convert the DocBook sources via commands
 like this:
   xmlto html-nochunks manual.xml
   xmlto pdf faq.xml
 
-4) dblatex (only for DVI, PDF and Postscript output)
+No Makefile is needed if you use this approach.
+
+
+(4) dblatex (only for DVI, PDF and Postscript output)
 Install the "dblatex" package. Then a typical command to invoke is
   dblatex --pdf manual.xml
 
+This chain is implemented by "Makefile.dblatex", so type
+  make -f Makefile.dblatex
+in order to use it, or rename "Makefile.dblatex" to "Makefile".
 
+
 What needs to be done?
 ======================
 * Make the build system work on more systems (i.e. not just mine)


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.