For simplicity, the instructions assume that you are working with Jade on a Microsoft Windows machine. These instructions should be just as useful if you are working on another platform, except for the normal cross-platform idiosyncracies (path and filename separator characters, use of drive letters, etc.).
Download and unpack the Jade distribution. Binary distributions are available for some platforms, which makes installation a simple matter of unpacking the distribution. Or you can build Jade from the source (consult the documentation that comes with Jade for more detail about building it from source).
You may wish to add the directory where you installed Jade to
your
PATH
. If not, make sure that
you use the fully qualified name of the executable when you run the
commands below.
First, the catalog needs
to be set up as described in the Section called The DocBook
Catalog in order for Jade to be able to parse your DocBook
documents. In addition, Jade comes with its own catalog file that you must add to the SGML_CATALOG_FILES
environment variable or otherwise
make available to Jade.
Download jtest.sgm and jtest.dsl. (Or get them off the CD-ROM in FIXME.) These are self-contained test documents. Test Jade by running:
jade -t rtf -d jtest.dsl jtest.sgm |
This command should silently produce jtest.rtf. If you encounter warnings or errors here, Jade is not installed correctly. One possible culprit is your catalog setup. See the Section called Dealing with Multiple Declarations in Chapter 4.
One annoying shortcoming in Jade is that it does not support the DTDDECL catalog directive and it complains loudly if it encounters one. In Jade, it's almost always possible to work around the problems that DTDDECL would solve, so you can generally ignore the warnings.
If you also use applications that do understand DTDDECL, and find the warnings too distracting to
bear, setup alternate catalogs for SP applications, catalog.jade, that are identical to your normal
catalogs but do not contain any
DTDDECL entries. You can then avoid the
warnings by putting catalog.jade in your
SGML_CATALOG_FILES
path, instead of
catalog.