doctype:concat-docmaps

Full name:

de.smartics.maven.plugin:doctype-maven-plugin:1.4.3:concat-docmaps

Description:

Create a docmap JSON file from resources found in the file system.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.1.

Optional Parameters

Name Type Since Description
<docmapFileName> String 1.1 Allows to override the name of the file containing the information to concatenate. All files are required to have the same name.
Default value is: docmap.json.
User property is: file-name.
<docmapPrefix> String 1.1 Content to add to the generated docmap file.
User property is: prefix.
<docmapSuffix> String 1.1 Content to append to the generated docmap file.
User property is: suffix.
<encoding> String 1.1 The character encoding for the docmap files to read.
Default value is: UTF-8.
User property is: encoding.
<rootFolderName> String 1.1 The root folder to search for the docmap JSON files to concatenate.
Default value is: ...
User property is: root.
<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.
<verbose> boolean 1.0 A simple flag to log verbosely.
Default value is: false.
User property is: doctype.verbose.

Parameter Details

<docmapFileName>

Allows to override the name of the file containing the information to concatenate. All files are required to have the same name.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: file-name
  • Default: docmap.json

<docmapPrefix>

Content to add to the generated docmap file.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: prefix

<docmapSuffix>

Content to append to the generated docmap file.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: suffix

<encoding>

The character encoding for the docmap files to read.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: encoding
  • Default: UTF-8

<rootFolderName>

The root folder to search for the docmap JSON files to concatenate.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: root
  • Default: ..

<skip>

A simple flag to skip the build process for the add-on project.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: doctype.skip
  • Default: false

<verbose>

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