Man 1 apcs02

From Bluefish Wiki
Jump to navigation Jump to search

Please consider to upgrade to Bluefish 2!

Please consider to edit the Manual 2!

How To edit the Wiki Manual
{{#if:2. Manual building requirements|
2. Manual building requirements
Prev }}
Appendix C. Guidelines for Writing this Manual

2. Manual building requirements

To generate HTML, PDF or PostScript files out of the source XML, you will need the following:

  • the Bluefish manual source files via CVS
  • DocBook 4.4
  • DocBook XSL style sheets 1.71.0
  • XSLT Processors and Parsers: we use xsltproc for HTML production, and fop for PDF and PostScript production.
  • xmllint for validating all files

Here are the procedures to install the required files:

Procedure C.1. Getting the Bluefish manual source files

  1. First, think about where in the filesystem you would like to build the manual. Let us assume you choose your home directory. So, from your home directory, login to Bluefish's CVS repository by issuing the command::
    $ cvs -d \
  2. Hit enter at the prompt when asked for your password.
  3. Checkout the directory containing the Bluefish documentation:
    $ cvs -z3 -d \
    co bluefish-doc
    This will download the bluefish-doc CVS module, containing the Bluefish manual source files, to your system in a newly created directory bluefish-doc.

Procedure C.2. Installing DocBook and DocBook XSL

  1. Install DocBook 4.4 for your distribution
  2. Install DocBook XSL version 1.71.0 if it is available for your distribution
    Otherwise, get it from the DocBook Project pages on and unpack it into the bluefish-doc directory.

Procedure C.3. Installing the xslt processors and parsers

  1. Install libxslt if needed.
    xsltproc is provided by the libxslt, distributed as part of the GNOME desktop environment and is packaged for most Linux distributions. Fink provides the package for Mac OS X.
  2. If you wish to build PDF or PostScript versions of the manual, you will need the Formatting Objects Processor (FOP) package from Apache. If it is not already installed on your system, get the latest binary distribution from the FOP download page on the Apache web site.
  3. Unpack it into the bluefish-doc directory:
    $ tar zxvf fop-0.20.5-bin.tar.gz -C ~/bluefish-doc
    The files will be unpacked to a directory called fop-0.20.5.
  4. Rename fop-0.20.5 to fop:
    $ mv ~/bluefish-doc/fop-0.20.5 ~/bluefish-doc/fop
  5. FOP does not yet support embedding PNG images in pdf files. To get PNG support, we need from Java Advanced Imageing (JAI) or the JIMI Software Development Kit (especially for Debian and Ubuntu users, read /usr/share/doc/fop/README.Debian).
    For Linux, download the CLASSPATH version, jai-1_1_2-lib-linux-i586.tar.gz. Unpack and copy the files jai_core.jar and jai_codec.jar files to ~/bluefish-doc/fop/lib. Debian and Ubuntu users running fop with JIMI-support download jimi1_0.(zip|tar.Z) and place jimi-1.0.jar into /usr/share/java.

JAI and JIMI support are available for FOP release 0.20.5 and later.

Prev }}
Appendix C. Guidelines for Writing this Manual}}
Home | ToC
 3. Make HTML/PDF/PostScript Versions of the Bluefish manual