Prerequisites

Document Properties Marker

override	false

Short Description

The plugin is part of a development process. Therefore there are some prerequisites to get started.

Doctype

topic

hide

Name

Prerequisites

Short Name

Parent

Parent Property

property	Parent
property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
names	Maven Plugin Developer
property	Audience

Level of Experience

Name List

doctype	experience-level
render-no-hits-as-blank	true
names	Novice
property	Level of Experience

Expected Duration

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

hide

Section

show-title	false
title	Description

Using the DTSMP to create doctypes for the PDAC1 requires expertise in a number of fields.

Section

title	Summary

Section

title	Prerequisites

Section

title	Confluence

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.

Section

title	Maven

We assume readers are familiar with Maven, especially POM files and the concept of archetypes.

Section

title	License Plugin

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.

Section

title	Maven Settings

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

language	xml

<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>

Section

title	Atlassian SDK

You also need to have the Atlassian Software Development Kit (SDK) and to know how to work with it.

Section

title	Atlassian Artifact Server

This includes access to the Atlassian artifact server since the POM file declares dependencies to Atlassian artifacts.

Section

title	Access Maven Plugin

The Doctypes Maven Plugin (and the archetype it uses) is available on the public smartics Artifact server.

Section

title	projectdoc Artifacts

You'll also need to manually install the projectdoc artifacts to your local artifact repository. This may be an internal artifact server.

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>

Section

title	Plugin Configuration

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.

Section

title	Subordinate Topics

Display Table

doctype	topic
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

required-permissions	write-access
title	Notes

Section

title	References

Section

title	Resources

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 1

New Version 2

Key

About

Keep up-to-date!

Powered by