| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE html
|
|---|
| 3 | PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|
| 4 | <html xml:lang="en" lang="en">
|
|---|
| 5 | <head>
|
|---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|---|
| 7 | <meta name="copyright" content="(C) Copyright 2005"/>
|
|---|
| 8 | <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
|
|---|
| 9 | <meta name="DC.Type" content="task"/>
|
|---|
| 10 | <meta name="DC.Title" content="Building output using Ant"/>
|
|---|
| 11 | <meta name="abstract" content="You can build output by running the ant command and specifying the DITA-OT parameters at the command prompt. You also can use an Ant build script to provide the DITA-OT parameters"/>
|
|---|
| 12 | <meta name="description" content="You can build output by running the ant command and specifying the DITA-OT parameters at the command prompt. You also can use an Ant build script to provide the DITA-OT parameters"/>
|
|---|
| 13 | <meta name="DC.Relation" scheme="URI" content="../readme/DITA-ant.html"/>
|
|---|
| 14 | <meta name="DC.Relation" scheme="URI" content="../readme/creating-an-ant-build-script.html"/>
|
|---|
| 15 | <meta name="DC.Relation" scheme="URI" content="../readme/ant.html"/>
|
|---|
| 16 | <meta name="DC.Relation" scheme="URI" content="../readme/dita-ot_ant_properties.html"/>
|
|---|
| 17 | <meta name="DC.Relation" scheme="URI" content="http://ant.apache.org/manual/index.html"/>
|
|---|
| 18 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 19 | <meta name="DC.Identifier" content="runant"/>
|
|---|
| 20 | <meta name="DC.Language" content="en"/>
|
|---|
| 21 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 22 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 23 | <title>Building output using Ant</title>
|
|---|
| 24 | </head>
|
|---|
| 25 | <body id="runant">
|
|---|
| 26 |
|
|---|
| 27 |
|
|---|
| 28 | <h1 class="title topictitle1">Building output using Ant</h1>
|
|---|
| 29 |
|
|---|
| 30 |
|
|---|
| 31 | <div class="body taskbody"><p class="shortdesc">You can build output by running the <span class="keyword cmdname">ant</span> command and specifying the
|
|---|
| 32 | DITA-OT parameters at the command prompt. You also can use an Ant build script to provide the
|
|---|
| 33 | DITA-OT parameters</p>
|
|---|
| 34 |
|
|---|
| 35 | <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
|
|---|
| 36 | <span class="ph cmd">Run the <span class="ph filepath">startcmd</span> file that is applicable for your
|
|---|
| 37 | operating system.</span>
|
|---|
| 38 | <div class="itemgroup info">The <span class="ph filepath">startcmd.bat</span> and <span class="ph filepath">startcmd.sh</span>
|
|---|
| 39 | files are in the directory where you installed the DITA-OT.</div>
|
|---|
| 40 | </li>
|
|---|
| 41 | <li class="li step stepexpand">
|
|---|
| 42 | <span class="ph cmd">To provide the DITA-OT parameters from the command prompt, issue the following
|
|---|
| 43 | command:</span>
|
|---|
| 44 | <div class="itemgroup info"><pre class="pre codeblock">ant -Dargs.input=<var class="keyword varname">input-file</var> -Dtranstype=<var class="keyword varname">transformation-type</var> -D<var class="keyword varname">parameter-name</var>=<var class="keyword varname">value</var></pre>
|
|---|
| 45 | where:<ul class="ul">
|
|---|
| 46 | <li class="li"><var class="keyword varname">input-file</var> is the DITA map or DITA file that you want
|
|---|
| 47 | to process.</li>
|
|---|
| 48 |
|
|---|
| 49 | <li class="li"><var class="keyword varname">transformation-type</var> is the transformation type.</li>
|
|---|
| 50 |
|
|---|
| 51 | <li class="li"><var class="keyword varname">parameter-name</var> is the name of an optional
|
|---|
| 52 | parameter.</li>
|
|---|
| 53 |
|
|---|
| 54 | <li class="li"><var class="keyword varname">value</var> is an applicable value for the optional
|
|---|
| 55 | parameter.</li>
|
|---|
| 56 |
|
|---|
| 57 | </ul>
|
|---|
| 58 | </div>
|
|---|
| 59 | <div class="itemgroup stepresult">If you do not specify an output directory,
|
|---|
| 60 | by default, the DITA-OT writes the output to the
|
|---|
| 61 | <span class="ph filepath"><var class="keyword varname">installation-directory</var>\out</span>
|
|---|
| 62 | directory.</div>
|
|---|
| 63 | </li>
|
|---|
| 64 | <li class="li step stepexpand">
|
|---|
| 65 | <span class="ph cmd">If you use a build script, issue the following command:</span>
|
|---|
| 66 | <div class="itemgroup info"><pre class="pre codeblock">ant -f <var class="keyword varname">build-script</var> <var class="keyword varname">target</var></pre>
|
|---|
| 67 | where:<ul class="ul">
|
|---|
| 68 | <li class="li"><var class="keyword varname">build-script</var> is name of the Ant build script.</li>
|
|---|
| 69 |
|
|---|
| 70 | <li class="li"><var class="keyword varname">target</var> is an optional switch that specifies the name of the Ant
|
|---|
| 71 | target that you want to run. If you do not specify a target, the value of the @default
|
|---|
| 72 | attribute for the Ant project is used. </li>
|
|---|
| 73 |
|
|---|
| 74 | </ul>
|
|---|
| 75 | </div>
|
|---|
| 76 | </li>
|
|---|
| 77 | </ol>
|
|---|
| 78 |
|
|---|
| 79 | </div>
|
|---|
| 80 |
|
|---|
| 81 | <div class="related-links">
|
|---|
| 82 | <div class="familylinks">
|
|---|
| 83 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../readme/DITA-ant.html" title="You can use Ant to invoke the DITA Open Toolkit (DITA-OT) and generate output. This is the most robust method of transforming DITA content; you can use the complete set of parameters that are supported by the toolkit.">Publishing DITA content from Ant</a></div>
|
|---|
| 84 | </div>
|
|---|
| 85 | <div class="relinfo relconcepts"><strong>Related concepts</strong><br/>
|
|---|
| 86 | <div><a class="link" href="../readme/ant.html" title="Ant is a Java-based, open-source tool that is provided by the Apache Foundation. It can be used to declare a sequence of build actions. It is well suited for both development and document builds. The full-easy-install version of the toolkit ships with a copy of Ant.">Ant</a></div>
|
|---|
| 87 | </div>
|
|---|
| 88 | <div class="relinfo reltasks"><strong>Related tasks</strong><br/>
|
|---|
| 89 | <div><a class="link" href="../readme/creating-an-ant-build-script.html" title="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.">Creating an Ant build script</a></div>
|
|---|
| 90 | </div>
|
|---|
| 91 | <div class="relinfo relref"><strong>Related reference</strong><br/>
|
|---|
| 92 | <div><a class="link" href="../readme/dita-ot_ant_properties.html" title="Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based transformations. Finally, some parameters apply only to the specific transformation types.">Ant parameters</a></div>
|
|---|
| 93 | <div><a class="link" href="http://ant.apache.org/manual/index.html" target="_blank">Apache Ant documentation</a></div>
|
|---|
| 94 | </div>
|
|---|
| 95 | </div>
|
|---|
| 96 |
|
|---|
| 97 | </body>
|
|---|
| 98 | </html>
|
|---|
