##### Quick Links

- Home
- Getting Started
- Download
- Overview
- FAQ
- Documentation

##### Developers

- Building Rio

##### Sub Projects

- Rio Installers
- Rio QA
- Rio Substrates
- Rio Utilities
- Classdepandjar

##### Project Documentation

- Project Information

## Documentation Build Process

### Overview

This document explains how the documentation for Rio is built. The build process uses two different skins: one for online documentation (in order to integrate well in java.net environment), and one for offline usage.

The online and offline documentations do not only differ by the skin used, but also some URLs. So, for example, when modifying the source of the `documentation.html` page, you should edit `documentation-orig.xml` and NOT `documentation.xml` which will be overriden by a previous run of the documentation build process.

### Skins

Before you can build either the online or offline versions of the documentation, you need to build the skins.

In order to do so, you need to go in `src/site/maven-javanet-skin` and run `mvn install`. You should do the same in the directory `src/site/maven-tapestry-skin`.

### Online documentation build process

Simply run `mvn site -DsiteEnvironment=online`.

### Offline documentation build process

Simply run `mvn site -DsiteEnvironment=offline`.

### Online & Offline documentation build process

If you run `ant site`, the two above steps will be done for you!