Following is a new section that should be added to the development page:
** Introduction
The documentation make use of Maven's
{{{https://maven.apache.org/plugins/maven-site-plugin/}maven-site-plugin}} to
generate the website and {{{https://maven.apache.org/doxia/index.html}Doxia}}
for content genration.
** Formats
The documentation's source is located under src/site
and is written using 3 formats:
{{{https://maven.apache.org/doxia/references/apt-format.html}APT}}
APT is the preferred format since it is much easier to work with than XML.
If any new documents should be created, it should be in APT format.
XDoc
XML based format, harder to read and write. It is deprecated within the
project and eventually, all XML documents will be converted to APT.
{{{https://maven.apache.org/doxia/references/fml-format.html}FML}}
This format is only used only for the FAQ. Despite being XML, the XSL
associated with is makes writing FAQs quite easy. Thus, this format
remains for the FAQ, but no other page should make use of it.
** Generating
Generating the website is performed by running the following commands:
cd code/dbunit
mvn -DskipTests -DgenerateReports=false -o site
Once generated, it can be viewed by loading <<<./target/site/index.html>> with any browser.
