doctype:create

Full name:

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

Description:

Creates a new project based on the doctype add-on archetype.

Attributes:

  • Since version: 1.0.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
shortId String 1.0 The identifier part of artifact ID and package path of the new project.
User property is: shortId.

Optional Parameters

Name Type Since Description
archetypePluginVersion String 1.0 The version of the archetype plugin to call. Defaults to 3.0.1.
Default value is: 3.0.1.
User property is: archetypePluginVersion.
archetypeVersion String 1.0 The version of the archetype 'de.smartics.atlassian.confluence:smartics-projectdoc-doctype-addon-archetype'. Defaults to '1.0.0.b4'.
Default value is: 1.0.0.b4.
User property is: archetypeVersion.
artifactIdPrefix String 1.0 The prefix of the artifact ID for the new project. Defaults to 'myorg-doctype-addon-'.
Default value is: myorg-doctype-addon-.
User property is: artifactIdPrefix.
createExamples boolean 1.0 Per default the folder structure for models (descriptor files) is created with example files. If you do not want this folder to be added, set this flag to false.
Default value is: true.
User property is: createExamples.
dependencies List 1.0 (no description)
groupId String 1.0 The group ID of the new project. Defaults to 'com.myorg.projectdoc.doctypes'.
Default value is: com.myorg.projectdoc.doctypes.
User property is: groupId.
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.

Use createExamples to create this folder structure with example files.


Default value is: /src/main/resources/projectdoc-models.
User property is: modelsFolder.
organizationSignature String 1.0 The optional organization signature which is used to construct the copyright notice.
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.
pluginArtifacts List 1.0 (no description)
projectDescription String 1.0 The optional project description.
User property is: projectDescription.
projectName String 1.0 The name of the add-on. Defaults to the value of the short ID.
User property is: projectName.
projectSettingsId String 1.0 The identifier of the project settings to use. This id is the name of the file (without the filename extension) that is expected to be stored in the Maven directory (.m2).
Default value is: project-settings.
User property is: projectSettingsId.
projectVersion String 1.0 The starting version new project. Defaults to '0.1.0-SNAPSHOT'.
Default value is: 0.1.0-SNAPSHOT.
User property is: projectVersion.
readProjectSettings boolean 1.0 Controls whether or not default settings for a project should be read from the user's .m2 folder.
Default value is: true.
User property is: readProjectSettings.
references List 1.0 (no description)
verbose boolean 1.0 A simple flag to log verbosely.
Default value is: false.
User property is: verbose.

Parameter Details

archetypePluginVersion:

The version of the archetype plugin to call. Defaults to 3.0.1.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: archetypePluginVersion
  • Default: 3.0.1

archetypeVersion:

The version of the archetype ' de.smartics.atlassian.confluence:smartics-projectdoc-doctype-addon-archetype'. Defaults to ' 1.0.0.b4'.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: archetypeVersion
  • Default: 1.0.0.b4

artifactIdPrefix:

The prefix of the artifact ID for the new project. Defaults to ' myorg-doctype-addon-'.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: artifactIdPrefix
  • Default: myorg-doctype-addon-

createExamples:

Per default the folder structure for models (descriptor files) is created with example files. If you do not want this folder to be added, set this flag to false.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: createExamples
  • Default: true

dependencies:

(no description)
  • Type: java.util.List
  • Since: 1.0
  • Required: No

groupId:

The group ID of the new project. Defaults to ' com.myorg.projectdoc.doctypes'.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: groupId
  • Default: com.myorg.projectdoc.doctypes

modelsFolder:

The location of the model descriptors.

The models folder contains the add-on.xml and folders for space and doctype descriptors.

Use createExamples to create this folder structure with example files.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: modelsFolder
  • Default: /src/main/resources/projectdoc-models

organizationSignature:

The optional organization signature which is used to construct the copyright notice.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No

packagePrefix:

The package prefix for the new project. Defaults to ' com.myorg.projectdoc.doctypes'.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: packagePrefix
  • Default: com.myorg.projectdoc.doctypes

pluginArtifacts:

(no description)
  • Type: java.util.List
  • Since: 1.0
  • Required: No

projectDescription:

The optional project description.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: projectDescription

projectName:

The name of the add-on. Defaults to the value of the short ID.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: projectName

projectSettingsId:

The identifier of the project settings to use. This id is the name of the file (without the filename extension) that is expected to be stored in the Maven directory ( .m2).
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: projectSettingsId
  • Default: project-settings

projectVersion:

The starting version new project. Defaults to ' 0.1.0-SNAPSHOT'.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: projectVersion
  • Default: 0.1.0-SNAPSHOT

readProjectSettings:

Controls whether or not default settings for a project should be read from the user's .m2 folder.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: readProjectSettings
  • Default: true

references:

(no description)
  • Type: java.util.List
  • Since: 1.0
  • Required: No

shortId:

The identifier part of artifact ID and package path of the new project.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • User Property: shortId

verbose:

A simple flag to log verbosely.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: verbose
  • Default: false