dita:version

Full name:

org.codehaus.mojo:dita-maven-plugin:1.0-beta-3:version

Description:

Display DITA Open Toolkit's built-in version, with option to insert a custom version found under ${dita.dir}/ditaotVersionPath, via version property to Maven's ${versionName}. It is mainly used with maven-enforcer-plugin for build validation purpose.

Attributes:

  • Binds by default to the lifecycle phase: validate.

Optional Parameters

Name Type Since Description
antProperties Map 1.0-beta-1 Ant key/value pair properties. Default properties for all dita's goals
  • dita.dir=${env.DITA_HOME}
Default properties for dita:run goal
  • basedir=${project.basedir}
  • output.dir=${project.build.directory}/dita/out
  • dita.temp.dir=${project.build.directory}/dita/temp
  • args.logdir=${project.build.directory}/dita/log
  • args.input=${project.basedir}/src/main/dita/${artifactId}.ditamap
classpathElements List 1.0-beta-1 Internal. Compile time project dependencies to be add ed to Ant's classpath
displayDitaOTVersion boolean 1.0-beta-1 Display DITA Open Toolkit's built-in version
Default value is: true.
ditaotVersionPath String 1.0-beta-1 Relative path to DITA-OT custom version properties file path
Default value is: custom.version.properties.
skip boolean 1.0-beta-1 Skip the execution
Default value is: false.
useDitaClasspath boolean 1.0-beta-1 Add jar files under DITA Open Toolkit's lib directory to execution classpath
Default value is: true.
versionName String 1.0-beta-1 Maven project property name to store custom version value
Default value is: dita.custom.version.

Parameter Details

antProperties:

Ant key/value pair properties. Default properties for all dita's goals
  • dita.dir=${env.DITA_HOME}
Default properties for dita:run goal
  • basedir=${project.basedir}
  • output.dir=${project.build.directory}/dita/out
  • dita.temp.dir=${project.build.directory}/dita/temp
  • args.logdir=${project.build.directory}/dita/log
  • args.input=${project.basedir}/src/main/dita/${artifactId}.ditamap
  • Type: java.util.Map
  • Since: 1.0-beta-1
  • Required: No

classpathElements:

Internal. Compile time project dependencies to be add ed to Ant's classpath
  • Type: java.util.List
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${project.compileClasspathElements}

displayDitaOTVersion:

Display DITA Open Toolkit's built-in version
  • Type: boolean
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${dita.displayDitaOTVersion}
  • Default: true

ditaotVersionPath:

Relative path to DITA-OT custom version properties file path
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${dita.displayDitaOTVersion}
  • Default: custom.version.properties

skip:

Skip the execution
  • Type: boolean
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${dita.skip}
  • Default: false

useDitaClasspath:

Add jar files under DITA Open Toolkit's lib directory to execution classpath
  • Type: boolean
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${dita.useDitaClasspath}
  • Default: true

versionName:

Maven project property name to store custom version value
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${dita.versionName}
  • Default: dita.custom.version