Page History

The ServiceMix documentation project aims to build a set of manuals for ServiceMix using DocBook XML Scalate.

...

Sample output

For ServiceMix 4.3-SNAPSHOT

• Programmer's Guide (One-page HTML) (HTML) (PDF)
• JBI Reference Guide (One-page HTML) (HTML) (PDF)

: http://servicemix.apache.org/docs/4.3.0-SNAPSHOT/^{Image Added}

Source code

The source code for this project can be found at

• https://svn.apache.org/repos/asf/servicemix/documentation/^{Image Modified}
• git://git.apache.org/servicemix-documentation.git

Branches:

• trunk refers to the next development version of ServiceMix (currently 4.3-SNAPSHOT)

Content can be added in two formats:

• pure DocBook XML source files go in the src/docbkx folder
• a Confluence-alike wiki markup can be used in src/confluence

Project layout

Prerequisites

Before being able to build and run this project, you need to download and install:

• Pygments : http://pygments.org/download/^{Image Added}
• Prince XML : http://princexml.com/download/^{Image Added}

Project layout

The project is a basic Maven WAR project. Some important directories and files in the project:

• src/main/webapp/commands : TOC and index files for Console Commands manual section
• src/main/webapp/karaf : TOC and index files for Karaf manual section
• src/main/webapp/users-guide : The ServiceMix User's Guide section
• src/main/webapp/WEB-INF/scalate/layouts : Scalate SSP templates for the site
• common : common files (xsl, css, ...)
• docs : common maven plugin setup for underlying projects
• docs/manual : Programmer's Manual
• docs/jbi : JBI Reference Manual

Building and deploying

The documentation can be built by running mvn clean install on the documentation project. This will create and install:

• target/sitegen: a local copy of the static website
• A WAR file for installing the documentation on an application server
• PDF file for the users-guide directory

You can also deploy the site directly by running mvn sitescalate:deploy afterwards, provided you have set up the correct credentials for people.apache.org in ~/.m2/settings.xml:

...