Get Started!

The project settings allow to specify defaults that makes the creation of new doctype add-on projects much easier.

You may skip this step if you are searching for an overview on what the Doctype Maven Plugin offers. But you certainly want to come back to this topic once you start using the doctype:create goal.

Copy the following content in a file names project-settings.xml to your Maven folder (.m2) in your user home directory.

<?xml version='1.0'?>

<project-settings
  xmlns="http://smartics.de/xsd/projectdoc/project-settings/1"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <coordinates>
    <groupId>com.mycompany.projectdoc.doctypes</groupId>
    <artifactIdPrefix>mycompany-doctype-addon-</artifactIdPrefix>
  </coordinates>

  <keys>
    <packagePrefix>com.mycompany.projectdoc.doctypes</packagePrefix>
    <organizationSignature>My Company</organizationSignature>
  </keys>
</project-settings>

To create a new project (with some sample files) run:

mvn doctype:create -DshortId=myshortid -DprojectName="My Doctypes"

Since there are sample files in the new project, you can now generate blueprint files based on the example files.

mvn doctype:generate

Then start your Confluence server locally to test the add-on.

atlas-debug

The Usage page lists typical usage scenarios. Pick the ones you are interested in.

Typically you need to create a new doctype add-on and then want to add new Doctypes to it.

Remember: create creates a new project, generate generates files and applies changes based on your descriptors. So to generate blueprint files based on your descriptors type from within your project:

mvn doctype:generate

This will skip descriptor files that have already been generated.

The documentation of the goals provides detailed information on all parameters.

In projectdoc model descriptors you'll find information on how to write descriptors for the add-on, the spaces, and the doctypes. There is also a link to XML schema files (XSD) that can be installed into XML editors.