We assume readers are familiar with Maven, especially POM files and the concept of archetypes. Since the license plugin for maven is configured with the generated POM file, you need to apply license file headers (mvn initialize license:format) before running mvn install. To run the short form of commands shown in this usage scenario, the plugin group de.smartics.maven.plugin needs to be registered in the Maven Settings file. | Code Block |
|---|
| <settings
xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<pluginGroups>
...
<pluginGroup>de.smartics.maven.plugin</pluginGroup>
...
</pluginGroups>
</settings> |
Users need also know how page and space blueprints for Confluence work. The plugin does not support many details in dealing with them, so expect to be opening the atlassian-plugin.xml, JavaScript, CSS, and Soy files. You also need to have the Atlassian Software Development Kit (SDK) and to know how to work with it. This includes access to the Atlassian artifact server and manually installing the projectdoc artifacts to your local artifact repository. | Warning Box |
|---|
| title | Deploy projectdoc Artifacts to local Artifact Repository |
|---|
| | Content Marker |
|---|
| id | Manually install projectdoc Artifacts |
|---|
| To actually compile and start the project, you need to have the references artifacts on your artifact repository. Access to Atlassian's artifacts should already been configured when you have installed the Atlassian SDK. You need to download the projectdoc artifacts and install them manually since they are currently not available on a public repository. Here are the coordinates of the compile time dependency (download trial version of the projectdoc Toolbox from the Atlassian Marketplace). | Code Block Placeholder |
|---|
<dependency>
<groupId>de.smartics.atlassian.confluence</groupId>
<artifactId>smartics-projectdoc-confluence</artifactId>
<version>${version.smartics-projectdoc-confluence}</version>
</dependency> |
And this is the additional runtime dependency (download free version of the projectdoc Core Blueprints Add-on from the Atlassian Marketplace). | Code Block Placeholder |
|---|
<pluginArtifact>
<groupId>de.smartics.atlassian.confluence</groupId>
<artifactId>smartics-projectdoc-confluence-space-core</artifactId>
<version>${version.smartics-projectdoc-confluence-space-core}</version>
</pluginArtifact> |
|
|
The project settings allow to specify defaults (for instance groupId and artifactIdPrefix) for the creation of new projects. It is recommended to store the organization specific defaults in that file. | 
