< Create a New Project

Index >

Appendix D.  DocBook Documentation Generation

CartoWeb documentation source are in DocBook XML format and located in documentation/user_manual/source in CartoWeb archive.

You may want to generate it by yourself in order to produce XHTML or PDF output.

D.1.  Documentation Generation on UNIX-like System

D.1.1.  Tiny DocBook Install

Uncompress the tiny-docbook-1-6-16.tar.bz2 archive somewhere in your filesystem.

Execute:

$ ./configure --enable-install
$ make install

to install and configure Tiny DocBook environment.

D.1.2.  JAI Install

For PNG support with PDF generation you will also need to install JAI. If you don't plan to produce PDF, you could jump to next step, otherwise process as following:

  1. Retrieve JAI archive from Sun site, (took the classpath one for your platform).
  2. Uncompress it in your Tiny DocBook install dir:
    $ tar xvzf jai-1_1_2_01-lib-linux-i586.tar.gz
  3. Move jai-1_1_2_01/lib/jai_codec.jar and jai-1_1_2_01/lib/jai_core.jar to fop/lib .
    $ mv jai-1_1_2_01/lib/jai_codec.jar fop/lib/
    $ mv jai-1_1_2_01/lib/jai_core.jar fop/lib/
  4. Remove the becoming useless JAI archive, like that:
    $ rm -rf jai-1_1_2_01*

D.1.3.  Create a Symbolic Link to Documentation Source

Create a symbolic link in the Tiny DocBook install directory pointing to the CartoWeb documentation sources <cartoweb_home>/documentation/user_manual/source , like that:

$ ln -s CARTOWEB_HOME/documentation/user_manual/source

D.1.4.  XHTML Generation

Then, to generate an XHTML version of the documentation, execute as follow:

$ ./configure
$ make xhtml

Output result will be generated in xhtml/ directory.

D.1.5.  PDF Generation

To generate a pdf version of the documentation, execute instead:

$ ./configure
$ make pdf

Resulting pdf will be generated in book.pdf file.

Note

You need to have at least a JRE (or JDK ) installed on your system in order to generate PDF . The environment variable JAVA_HOME must also be rightly set, e.g

$ export JAVA_HOME=dir_path_where_jre_is_put_on_your_system

D.2.  Documentation Generation on Windows using Cygwin

At this time, the only known way to generate xhml or pdf version of the documentation on Windows is by using Cygwin.

You will need to install the following Cygwin packages: libxml2, libxslt, make .

Then follow the same instructions as for UNIX-like system Section D.1, “ Documentation Generation on UNIX-like System ”.

valid xhtml 1.0 valid css