| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
- <!--This file is part of the DITA Open Toolkit project. See the accompanying LICENSE.md file for applicable licenses.-->
- <task id="creating-an-ant-build-script">
- <title>Creating an Ant build script</title>
- <shortdesc>Instead of typing the DITA-OT parameters at the command prompt, you might want to create an Ant build
- script that contains all of the parameters.</shortdesc>
- <taskbody>
- <steps>
- <step>
- <cmd>Create an XML file that contains the following content:</cmd>
- <info>
- <codeblock><?xml version="1.0" encoding="UTF-8" ?>
- <project name="%project-name%" default="%default-target%" basedir=".">
- <property name="dita.dir" location="%path-to-DITA-OT%"/>
-
- <target name="%target-name%">
- <ant antfile="${dita.dir}/build.xml">
- <property name="args.input" value="%DITA-input%"/>
- <property name="transtype" value="html5"/>
- </ant>
- </target>
- </project></codeblock>
- </info>
- <info>You will replace the placeholder content (indicated by the % signs) with content applicable to your
- environment.</info>
- </step>
- <step>
- <cmd>Specify project information:</cmd>
- <substeps>
- <substep importance="optional">
- <cmd>Set the value of the <xmlatt>name</xmlatt> attribute to the name of your
- project.</cmd>
- </substep>
- <substep>
- <cmd>Set the value of the <xmlatt>default</xmlatt> attribute to the name of a target in
- the build script.</cmd>
- <info>If the build script is invoked without specifying a target, this target will be
- run.</info>
- </substep>
- </substeps>
- </step>
- <step>
- <cmd>Set the value of the <parmname>dita.dir</parmname> property to the location of the DITA-OT.</cmd>
- <info>This can be a fully qualified path, or you can specify it relative to the location of the Ant build script
- that you are writing. </info>
- </step>
- <step>
- <cmd>Create the Ant target:</cmd>
- <substeps>
- <substep>
- <cmd>Set the value of the <xmlatt>name</xmlatt> attribute.</cmd>
- </substep>
- <substep>
- <cmd>Specify the value for the <parmname>args.input</parmname> property.</cmd>
- </substep>
- <substep>
- <cmd>Specify the value of the <parmname>transtype</parmname> property.</cmd>
- </substep>
- </substeps>
- </step>
- <step>
- <cmd>Save the build script.</cmd>
- </step>
- </steps>
- <example>
- <p>The following Ant build script generates CHM and PDF output for the sample DITA
- maps.<codeblock><coderef href="../samples/ant_sample/build-chm-pdf.xml"/></codeblock></p>
- <p>In addition to the mandatory parameters (<parmname>args.input</parmname> and <parmname>transtype</parmname>),
- the chm and pdf targets each specify some optional parameters:
- <ul>
- <li>The <parmname>args.gen.task.lbl</parmname> property is set to YES, which ensures that headings are
- automatically generated for the sections of task topics.</li>
- <li>The <parmname>output.dir</parmname> property specifies where the DITA-OT writes the output of the
- transformations.</li>
- </ul></p>
- <p>The pdf target also specifies that related links should be generated in the PDF, but only
- those links that are created by relationship tables and <xmlelement>link</xmlelement>
- elements.</p>
- <p>Finally, the all target simply specifies that both the chm and pdf target should be run.</p>
- </example>
- <postreq>Another resource for learning about Ant scripts are the files in the <filepath
- conref="../resources/conref-task.dita#ID/samples-dir"/><filepath>/ant_samples</filepath>
- directory. This directory contains the Ant build files used by the demo build, as well as
- templates that you can use to create Ant scripts.</postreq>
- </taskbody>
- </task>
|