Doctype Maven Plugin – doctype:generate

doctype:generate

Full name:

de.smartics.maven.plugin:doctype-maven-plugin:1.0.0.b4:generate

Description:

Applies changes to a doctype add-on project for the projectdoc Toolbox for Confluence. There is no rollback of backup function! Make sure to run this only against projects that are in version control and up-to-date. On any problem sources (not files in the target folder) have to be fetched from version control.

Attributes:

Requires a Maven project to be executed.
The goal is thread-safe and supports parallel builds.
Since version: 1.0.
Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name	Type	Since	Description
modelsFolder	`String`	`1.0`	The location of the model descriptors. The models folder contains the `add-on.xml` and folders for space and doctype descriptors. Default value is: `/src/main/resources/projectdoc-models`.
shortId	`String`	`1.0`	The identifier part of artifact ID and package path of the new project.

Optional Parameters

Name	Type	Since	Description
artifactIdPrefix	`String`	`1.0`	Artifact ID for the project files in the target folder. `null` if in archetype mode. Archetype mode generates to the source folder. Otherwise the generation is run in the target folder (not using the POM in the target folder).
groupId	`String`	`1.0`	Group ID for the project files in the target folder. `null` if in archetype mode. Archetype mode generates to the source folder. Otherwise the generation is run in the target folder (not using the POM in the target folder).
mode	`String`	`1.0`	Instruction on whether doctypes should only be created (`create`) or updated (`update`). Creation will not run, if a template of a doctype already exists. If the update mode is selected, the doctype will be removed and the resources in the resource bundle will be updated. Mode applies only to doctypes, not to spaces. Default value is: `create`. User property is: `mode`.
packagePrefix	`String`	`1.0`	The package prefix for the new project. Defaults to '`com.myorg.projectdoc.doctypes`'. Default value is: `com.myorg.projectdoc.doctypes`. User property is: `packagePrefix`.
projectName	`String`	`1.0`	The name of the add-on. Defaults to the value of the short ID.
references	`List`	`1.0`	(no description)
skip	`boolean`	`1.0`	A simple flag to skip the generation process. Default value is: `false`. User property is: `skip`.
skipPatching	`boolean`	`1.0`	A simple flag to skip the patching process. Default value is: `false`. User property is: `skip.patching`.
verbose	`boolean`	`1.0`	A simple flag to log verbosely. Default value is: `false`. User property is: `verbose`.

Parameter Details

artifactIdPrefix:

Artifact ID for the project files in the target folder. null if in archetype mode.

Archetype mode generates to the source folder. Otherwise the generation is run in the target folder (not using the POM in the target folder).

Type: java.lang.String
Since: 1.0
Required: No

groupId:

Group ID for the project files in the target folder. null if in archetype mode.

Archetype mode generates to the source folder. Otherwise the generation is run in the target folder (not using the POM in the target folder).

Type: java.lang.String
Since: 1.0
Required: No

mode:

Instruction on whether doctypes should only be created ( create) or updated ( update). Creation will not run, if a template of a doctype already exists. If the update mode is selected, the doctype will be removed and the resources in the resource bundle will be updated.

Mode applies only to doctypes, not to spaces.