Provides an overview over the model descriptors to describe the add-on, spaces, and doctypes.

Audience
Level of Experience

The models describe projectdoc documents and are themselves described with XML files. There is one file to define add-on-wide information. Currently this allows to define categories for the defined doctypes. Then there are (potentially) a number of space descriptors to define space blueprints. Currently only one such space is supported. Lastly there are descriptors for doctypes. With these descriptors template authors can define the templates that need.

Descriptors

The following descriptors define projectdoc models.

DescriptorShort DescriptionXSDDownload
Add-on DescriptorDescribes add-on level elements of the projectdoc model.Add-on XSDadd-on.xsd
Space DescriptorDescribes the spaces model. Currently only one space per add-on is supported.Space XSDspace.xsd
Doctype DescriptorDescribes the doctypes model.
Doctype XSDdoctype.xsd

Patching

 

If the model descriptors do not support one of your use cases, try patching the generated result.

Example Projects

The test suite of the plugin provides a small example for a project with an add-on, a space, and a couple of related doctype descriptors.

We are moving our doctype add-ons to descriptor add-ons and will base our new add-ons on this approach. All model-based doctype add-on project follow the artifact ID naming scheme smartics-doctype-model-XYZ, where XYZ is the project ID and are available on Bitbucket.

Resources

Information related to the handling of projectdoc models.

Usage
List of usage scenarios creating blueprints with the plugin for Maven.
Patching
Generating everything does not work if the models do not support some use cases. Therefore the plugin provides a simple patch mechanism to work around the model deficiencies.
projectdoc Toolbox Online Manual
The online manual for version 1 of the projectdoc Toolbox for Confluence.
projectdoc Document
projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.