projectdoc Toolbox

A short introduction on how to work with different versions of documentation for a Java library.

Since
4.0

This short introduction explains ways to handle different version of documentation for a Java library.

 

Note that this procedure has beta status. Please check if the procedure works with your requirements.

This procedure is valid for version 4.0 of the Doctype Add-on for Java Developers.

Unversioned Title

The current version is typically represented by an unversioned title.

The generated pages will have a "(Current Version)" marker in their title.

Previous versions can be easily added to the same space using the Version doctype. This will import metadata from the Java library artifact with the version number as part of each page title (for instance "POM (1.2.0)").

Next Version

To add a new version the current tree of versioned information should be copied and the "(Current Version)" should be replaced by this version's version number.

Then delete the tree and import the metadata of the new version by using the Version doctype. This time use check the Unversioned Title checkbox (as has been the case when the space has been created).