This is the base package of SGML processing.
It contains an SGML parser, a
DSSSL processor (that is, a program to
convert SGML to other formats using
DSSSL stylesheets), as well as a number of
related tools. Jade is now being
maintained by the OpenJade group, no longer by James Clark.
If you want to, you can also install
JadeTeX to use
TeX as a formatting backend for
JadeTeX can create Postscript or
PDF files (the latter with bookmarks).
However, the output from JadeTeX is
inferior to what you get from the RTF
backend. Particular problem areas are tables and various
artifacts of vertical and horizontal spacing. Also, there is
no opportunity to manually polish the results.
We have documented experience with several installation methods for
the various tools that are needed to process the documentation.
These will be described below. There may be some other packaged
distributions for these tools. Please report package status to the
docs mailing list and we will include that information here.
Many vendors provide a complete RPM set for DocBook processing in
their distribution, which is usually based on the docbook-tools
effort at Red Hat Software. Look for an "SGML"
option while installing, or the following packages:
(or jade). Possibly
sgml-tools will be needed as well. If your
distributor does not provide these then you should be able to make
use of the packages from some other, reasonably compatible vendor.
The FreeBSD Documentation Project is itself a heavy user of
DocBook, so it comes as no surprise that there is a full set of
"ports" of the documentation tools available on
FreeBSD. The following ports need to be installed to build the
documentation on FreeBSD.
A number of things from /usr/ports/print
(tex, jadetex) might
also be of interest.
It's possible that the ports do not update the main catalog file
in /usr/local/share/sgml/catalog. Be sure to
have the following line in there:
The manual installation process of the DocBook tools is somewhat
complex, so if you have pre-built packages available, use them.
We describe here only a standard setup, with reasonably standard
installation paths, and no "fancy" features. For
details, you should study the documentation of the respective
package, and read SGML introductory material.
The installation of OpenJade offers a GNU-style
./configure; make; make install build
process. Details can be found in the OpenJade source
distribution. In a nutshell:
Be sure to remember where you put the "default
catalog"; you will need it below. You can also leave
it off, but then you will have to set the environment variable
SGML_CATALOG_FILES to point to the file
whenever you use jade later on.
(This method is also an option if OpenJade is already
installed and you want to install the rest of the toolchain
Additionally, you should install the files
catalog from the
dsssl directory somewhere, perhaps into
probably easiest to copy the entire directory:
cp -R dsssl /usr/local/share/sgml
Finally, create the file
/usr/local/share/sgml/catalog and add
this line to it:
(This is a relative path reference to the file installed in
step 2. Be sure to adjust it
if you chose your installation layout differently.)
The usual catalog entry in
/usr/local/share/sgml/catalog can also be
Because stylesheets change rather often, and it's sometimes
beneficial to try out alternative versions,
PostgreSQL doesn't use this catalog
entry. See Section B.3 for information about how
to select the stylesheets instead.
To install and use JadeTeX, you will
need a working installation of TeX and
LaTeX2e, including the supported
AMS fonts and
and companion kit of "the 35 fonts", the
dvips program for generating
PostScript, the macro packages
ot2enc. All of these can be found on
your friendly neighborhood CTAN site.
The installation of the TeX base
system is far beyond the scope of this introduction. Binary
packages should be available for any system that can run
Before you can use JadeTeX with the
PostgreSQL documentation sources, you
will need to increase the size of
TeX's internal data structures.
Details on this can be found in the JadeTeX