Prerequisites

Create new Project

First create a new project using the Doctype Add-on Archetype. The interface to use the archetype is simplified by the create model mojo. So we recommend to use the following command on the commandline. This reduces the number of parameters you have to specify to one (shortId), also it is recommended to also provide a name for the new project (projectName) and a description (projectDescription).

mvn doctype:create-model -DcreateExamples=false -DshortId=myshortid 
  -DprojectName="My Doctype Add-on" 
  -DprojectDescription="Description of my project."

Specify a short ID (only characters, digits allowed except as first char) and an optional project name and description (which is recommended). With that a project based on Maven for the model for the projectdoc Toolbox is created.

mvn doctype:create-model -Default="myshortid | My Doctype Add-on | Description of my project." 

Add the projectdoc models and then create the doctype add-on project and launch it in a Confluence server.

mvn clean package doctype:run

Configuration

The project POM contains the configuration to create blueprint files based on the model descriptors.

      <plugin>
        <groupId>de.smartics.maven.plugin</groupId>
        <artifactId>doctype-maven-plugin</artifactId>
        <version>1.9.4</version>
        <executions>
          <execution>
            <id>doctype</id>
            <goals>
              <goal>generate</goal>
            </goals>
            <phase>generate-resources</phase>
          </execution>
        </executions>
        <configuration>
          <shortId>myshortid</shortId>
        </configuration>
      </plugin>

So the next step is to provide the model descriptors. There are basically there models: add-on, spaces, and doctypes. All descriptors are XML files stored in

src\main\resources\projectdoc-models

spaces are stored in a subfolder spaces, doctypes in a subfolder doctypes.

The createExamples flag is set true by default. So there are some sample files to start with describing your model.

Create Blueprint Files

Based on the model files the following command, run from within the project (where the pom.xml is found), creates the necessary files to make the blueprint files come to life.

mvn doctype:generate

After that everything is in place in your source folder of your project. You can start the Confluence server on your developer box (see next step).

Check that Everything is in Place

The next step is to start (for instance in debug mode) a local Confluence server instance with your add-on.

atlas-debug

After the server is up, login as admin (password admin), create a new space and create a couple of pages of with your blueprints.

Create an OBR

The OSGi Bundle repository (OBR) is the deployment unit of your add-on. Create this OBR file by the use of your SDK. The OBR file can then be installed on a Confluence server. Please note that the projectdoc Tooolbox for Confluence (commercial) and the Core Blueprints Add-on (free) for the Core Doctypes need to be installed.

Resources

More information on working with the Doctypes Plugin for Maven.

More usage scenarios: