dita:run

Full name:

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

Description:

Execute DITA Open Toolkit's Ant command line to transform DITA files to desired output format.

Behind the scene, antProperties are temporarily stored under ${dita.temp.dir}/properties.temp to be used with

ant -f ${dita.dir}/build.xml -propertyFile ${dita.temp.dir}/properties.temp

Attributes:

  • Requires dependency resolution of artifacts in scope: compile.

Optional Parameters

Name Type Since Description
antArguments String since 1.0-beta-1 If given, will be added to Ant command line. Use this for trouble shooting purpose
antHome File since 1.0-beta-1 Point to Ant installation directory. If given, it will override useDitaAnt and ${env.ANT_HOME}
antOpts String since 1.0-beta-1 Equivalent with ANT_OPTS environment. This parameter overrides the current env.ANT_OPTS if given. Typical usage is to setup JVM's heap space ( example -Xmx500m )
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
attach boolean since 1.0-beta-1 Controls whether this goal tries to compress the output directory and attach compressed output file to the project for install and deploy purposes.
Default value is: false.
attachClassifier String since 1.0-beta-1 Output file classifier to be attached to the project.
attachType String since 1.0-beta-1 Output file extension to be attached to the project. When transtype is one of the pdf types or htmlhelp, the attachType will be hard coded to pdf and chm respectively.
Default value is: jar.
classpathElements List 1.0-beta-1 Internal. Compile time project dependencies to be add ed to Ant's classpath
skip boolean 1.0-beta-1 Skip the execution
Default value is: false.
useDitaAnt boolean since 1.0-beta-1 Use DITA Open Toolkit's tools/ant
Default value is: true.
useDitaClasspath boolean 1.0-beta-1 Add jar files under DITA Open Toolkit's lib directory to execution classpath
Default value is: true.

Parameter Details

antArguments:

If given, will be added to Ant command line. Use this for trouble shooting purpose
  • Type: java.lang.String
  • Since: since 1.0-beta-1
  • Required: No
  • Expression: ${dita.antArguments}

antHome:

Point to Ant installation directory. If given, it will override useDitaAnt and ${env.ANT_HOME}
  • Type: java.io.File
  • Since: since 1.0-beta-1
  • Required: No
  • Expression: ${dita.antHome}

antOpts:

Equivalent with ANT_OPTS environment. This parameter overrides the current env.ANT_OPTS if given. Typical usage is to setup JVM's heap space ( example -Xmx500m )
  • Type: java.lang.String
  • Since: since 1.0-beta-1
  • Required: No
  • Expression: ${dita.antOpts}

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

attach:

Controls whether this goal tries to compress the output directory and attach compressed output file to the project for install and deploy purposes.
  • Type: boolean
  • Since: since 1.0-beta-1
  • Required: No
  • Expression: ${dita.attach}
  • Default: false

attachClassifier:

Output file classifier to be attached to the project.
  • Type: java.lang.String
  • Since: since 1.0-beta-1
  • Required: No
  • Expression: ${dita.attachClassifier}

attachType:

Output file extension to be attached to the project. When transtype is one of the pdf types or htmlhelp, the attachType will be hard coded to pdf and chm respectively.
  • Type: java.lang.String
  • Since: since 1.0-beta-1
  • Required: No
  • Expression: ${dita.attachType}
  • Default: jar

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}

skip:

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

useDitaAnt:

Use DITA Open Toolkit's tools/ant
  • Type: boolean
  • Since: since 1.0-beta-1
  • Required: No
  • Expression: ${dita.useDitaAnt}
  • Default: true

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