Documentation in production

Overview

The RichFaces 4.x documentation can be checked out from the Git repository athttps://github.com/richfaces/docs/

The documentation can be built using either Publican (preferred) or Maven.

Maven

Although primarily designed for building with Publican (see bellow), the documentation can also be built using Maven 2 and the Maven-JDocBook plug-in.

For instructions on how to install Maven 2, refer to http://maven.apache.org/.

Building the documentation with Maven

Building all books

1. Install Maven using the instructions above.
2. Check out the latest documentation source from the SVN repository at:

3. https://github.com/richfaces/docs/

4. Change to the trunk directory you just checked out.
5. Build all books as all types (single html page, several html pages connected with hyperlinks, and a PDF document) by entering the following command:

   mvn compile -Pdocs

6. The documentation will be built to the target/docbook/publish/en-US/ sub-directory of each book's directory.

Building books individually

1. Install Maven using the instructions above.
2. Check out the latest documentation source from the SVN repository at:

3. https://anonsvn.jboss.org/repos/richfaces/root/docs/trunk/https://github.com/richfaces/docs/

4. Change to the directory of the documentation book you wish to build, either Migration_Guide, Developer_Guide, Component_Reference, or Component_Development_Kit_Guide.
5. JDocBook-Maven can build documentation as either a single html page, several html pages connected with hyperlinks, or a PDF document. Enter the following commands as appropriate:
   

   mvn compile -Phtml-single

   mvn compile -Phtml

   mvn compile -Ppdf

   mvn compile (compiles all above formats)

6. The documentation will be built to the target/docbook/publish/en-US/ sub-directory.
   

Publican (alternative build)

(not sure if it's working anymore)

The documentation for RichFaces 4.0 is written in DocBook XML and primarily designed to be built using Publican.

More information about Publican, such as the User Guide and installation instructions, can be found at https://fedorahosted.org/publican/.

Publican is currently only available for Linux systems (only Red Hat Enterprise Linux and Fedora have been tested) and Windows systems.

Building the documentation with Publican

1. Install Publican using the instructions at https://fedorahosted.org/publican/.
2. Check out the latest documentation source from the SVN repository at:
3. https://anonsvn.jboss.org/repos/richfaces/root/docs/trunk/
4. Change to the directory of the documentation book you wish to build, either Migration_Guide, Developer_Guide,Component_Reference, or Component_Development_Kit_Guide.
5. Publican can build documentation as either a single html page, several html pages connected with hyperlinks, or a PDF document. Enter the following commands as appropriate:
   publican build --formats=html-single --langs=en-US
   publican build --formats=html --langs=en-US
   publican build --formats=pdf --langs=en-US
6. The documentation will be built to the tmp/en-US/ sub-directory.