DataNucleus has 2 primary sites
-
datanucleus.com
- for commercial facing aspects of the project
-
datanucleus.org
- for the community side, at a developer level
These use plan Maven1 "site" command using documents in "XDOC" format. This process makes use
of 2 key files. To generate the docs in either, type "maven clean site" from the command line.
The documentation is generated every night from what is in SVN, and this appears on the website.
The Maven process makes use of "Velocity" templating.
site.jsl
uses Jelly scripting language and provides the mechanism to convert the XML
documents into the layout seen on the website. It adds the standard header and footer, as well
as the side menu.
navigation.xml
is an XML definition of quick links, horizontal navigation and
vertical navigation. It is used by the "site.jsl" file to decide what links need adding to each
generated page.
If you want to add a new document to any of these areas, add the XML document in XDOC format
in the required directory, and then add a link to it in
navigation.xml
. Easy.
Each product has its own documentation, again using the Maven1 style. So if you look
under
documentation/accessplatform.datanucleus.org
you find the docs for
Access Platform. In addition to the standard HTML web-based docs the nightly process
also generates for you a PDF of docs for the product. This again uses Maven and internally
Apache "fo".
