Doctype Maven Plugin – doctype:generate

doctype:generate

Full name:

de.smartics.maven.plugin:doctype-maven-plugin:1.9.4:generate

Description:

Applies changes to a doctype add-on project for the projectdoc Toolbox for Confluence. There is no rollback or 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.
Since version: 1.0.
Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name	Type	Since	Description
`<doctypeMetadataFolder>`	`String`	`1.1`	The location of the metadata files for doctype metadata. Default value is: `/src/main/resources/projectdoc/doctype-metadata`.
`<mainSpaceId>`	`String`	`1.0`	The identifier of the main space to associate the subspace blueprint. Default value is: `main`.
`<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`.
`<rdfFolder>`	`String`	`1.1`	The location of the RDF files for doctype models. Default value is: `/src/main/resources/projectdoc/rdf`.
`<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).
`<generateCategoryTree>`	`boolean`	`1.8`	Controls whether or not the category tree JSON file should be generate. Default value is: `false`. User property is: `generate.categoryTree`.
`<generateDocmap>`	`boolean`	`1.1`	Controls whether or not the docmap JSON file should be generated. This fragment needs to be deployed to the server for documentation support on doctypes. The map allows to link to sections on a doctype documentation document. Default value is: `true`. User property is: `generate.docmap`.
`<generateRdf>`	`boolean`	`1.1`	Controls whether or not the RDF files for doctypes and the whole add-on should be generated or not. Default value is: `true`. User property is: `generate.rdf`.
`<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`.
`<pathTemplate>`	`String`	`1.0`	(no description) Default value is: `de/smartics/projectdoc/${addonId}/content/doctypes`.
`<pluginArtifacts>`	`List`	`1.0`	(no description)
`<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 build process for the add-on project. Default value is: `false`. User property is: `doctype.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: `doctype.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

<doctypeMetadataFolder>

The location of the metadata files for doctype metadata.

Type: java.lang.String
Since: 1.1
Required: Yes
Default: /src/main/resources/projectdoc/doctype-metadata

<generateCategoryTree>

Controls whether or not the category tree JSON file should be generate.

Type: boolean
Since: 1.8
Required: No
User Property: generate.categoryTree
Default: false

<generateDocmap>

Controls whether or not the docmap JSON file should be generated. This fragment needs to be deployed to the server for documentation support on doctypes. The map allows to link to sections on a doctype documentation document.

Type: boolean
Since: 1.1
Required: No
User Property: generate.docmap
Default: true

<generateRdf>

Controls whether or not the RDF files for doctypes and the whole add-on should be generated or not.

Type: boolean
Since: 1.1
Required: No
User Property: generate.rdf
Default: true

<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

<mainSpaceId>

The identifier of the main space to associate the subspace blueprint.

Type: java.lang.String
Since: 1.0
Required: Yes
Default: main

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