Document a version of a product or service.
Version documents, and their subdocuments (typically of document type Metadata), provide information that is specific for a special version of a product or service.
The version information is kept for each version. Reference the current version of the documentation from the space homepage. Please refer to Space Properties Extension (Space Property) for details.
This mechanism allows to import information from a POM and store it in a space. The space provides information for all versions of the product or service and its version specific information is available to all documents. It is not designed to keep multiple versions of document trees. Although this may work for projects with minor variable parts, but may not scale with the number of documents you need for version specifics.
The document type version provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
A hidden property to store the logo of the project to be transcluded using the Display Document Property Macro.
A hidden property that references all Metadata documents that are children to this Version document.
The space properties can be easily defined to include all document properties of a Version document and all its Metadata documents. See Space Properties Extension (Space Property) for more information.
A description of the version.
Lists the reports that are attached as children to this version document and are not of type Metadata.
If the version document is created from a Maven POM file, the generation process will create a Metadata document with that POM's information. The POM file will be attached as a JSON document to that Metadata document.
There is a slight difference between specifying the POM via URL or G:A:V (
|URL||The POM file is stored in a temporary folder and then resolved. Only dependent artifacts end up in the local artifact repository.|
|G:A:V||The POM file is resolved within the Maven environment. Every artifact ends up in the local artifact repository.|
Therefore using an URL to a POM file is only recommended if you do not want to add this file to the repository.
To use the POM feature, the Maven Extension has to be installed for the projectdoc Toolbox version greater or equal to 1.11. If not, the POM Reference input field is disabled.
Version documents do not provide a separate homepage from their index page. This is because subversions are not attached as children to a page. Therefore the contents of a homepage and a index page would be the same. To remove redundancies, the default target for a version document is its index page.
The following doctypes are related to the Version doctype.
The following resources are related to the Version doctype.