Accueil Explorer Aide
Connexion
bn
/
se
2
0
Fork 0
Fichiers Tickets 0 Pull Requests 0 Wiki
Aborescence: 0b6fc7fd2b
Branches Tags
se
/
SE
/
stuff
/
dita-ot-2.3.3
/
doc
/
user-guide
/
build-migrating-ant-to-dita.html

build-migrating-ant-to-dita.html 10 KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112 
  1. <!DOCTYPE html
    2. 

  2.   SYSTEM "about:legacy-compat">
    3. 

  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><meta name="DC.Type" content="task"><meta name="description" content="Although Ant builds are still supported in the DITA Open Toolkit, you might want to switch to use the new dita command."><meta name="DC.Relation" scheme="URI" content="../user-guide/build-using-dita-command.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="migrating-ant-to-dita"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Migrating Ant builds to use the dita command</title></head><body id="migrating-ant-to-dita"><header role="banner"><div class="header">
    4. 

  4.   <p>DITA Open Toolkit</p>
    5. 

  5.   <hr>
    6. 

  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 2.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../getting-started/index.html">Getting Started</a></li><li><a href="../user-guide/index.html">User Guide</a><ul><li><a href="../user-guide/transforming-dita-content.html">Publishing DITA content</a><ul><li><a href="../user-guide/build-using-dita-command.html">Using the dita command</a><ul><li><a href="../user-guide/build-using-dita-properties-file.html">Using a properties file</a></li><li class="active"><a href="../user-guide/build-migrating-ant-to-dita.html">Migrating Ant builds</a></li></ul></li><li><a href="../user-guide/publishing-with-ant.html">Using Ant</a></li></ul></li><li><a href="../user-guide/AvailableTransforms.html">Output formats</a></li><li><a href="../user-guide/DITA_spec-support.html">DITA specification support</a></li><li><a href="../user-guide/DITA-globalization.html">Globalizing DITA content</a></li><li><a href="../user-guide/troubleshooting-overview.html">Troubleshooting</a></li></ul></li><li><a href="../parameters/index.html">Parameter Reference</a></li><li><a href="../dev_ref/index.html">Developer Reference</a></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
    7. 

  7.   <h1 class="title topictitle1" id="ariaid-title1">Migrating Ant builds to use the <span class="keyword cmdname">dita</span> command</h1>
    8. 

  8.   
    9. 

  9.   <div class="body taskbody"><p class="shortdesc">Although Ant builds are still supported in the DITA Open Toolkit, you might want to switch to use the new
    10. 

  10.       <span class="keyword cmdname">dita</span> command.</p>
    11. 

  11.     <section class="section context"><div class="tasklabel"><h2 class="sectiontitle tasklabel">About this task</h2></div>
    12. 

  12.       <p class="p">Building output with the <span class="keyword cmdname">dita</span> command is often easier than using Ant. In particular, you can
    13. 

  13.         use <span class="ph filepath">.properties</span> files to specify sets of DITA-OT parameters for each build.</p>
    14. 

  14.       <p class="p">You can include the <span class="keyword cmdname">dita</span> command in shell scripts to perform multiple builds.</p>
    15. 

  15.       <div class="note tip note_tip"><span class="note__title tiptitle">Tip:</span> Add the absolute path for <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var></span><span class="ph filepath">/bin</span> to the <var class="keyword varname">PATH</var> environment variable to run the
    16. 

  16.               <span class="keyword cmdname">dita</span> command from any location on the file system without typing the path.</div>
    17. 

  17.     </section>
    18. 

  18.     <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
    19. 

  19.         <span class="ph cmd">In your Ant build file, identify the properties set in each build target.</span>
    20. 

  20.         <div class="itemgroup info">
    21. 

  21.           <div class="note note note_note"><span class="note__title notetitle">Note:</span> Some build parameters might be specified as properties of the project as a whole. You can refer to a
    22. 

  22.             build log to see a list of all properties that were set for the build.</div>
    23. 

  23.         </div>
    24. 

  24.       </li><li class="li step stepexpand">
    25. 

  25.         <span class="ph cmd">Create a <span class="ph filepath">.properties</span> file for each build and specify the needed build parameters, one
    26. 

  26.           per line, in the format <code class="ph codeph">name = value</code>.</span>
    27. 

  27.       </li><li class="li step stepexpand">
    28. 

  28.         <span class="ph cmd">Use the <span class="keyword cmdname">dita</span> command to perform each build, referencing your
    29. 

  29.             <span class="ph filepath">.properties</span> file with the <span class="keyword parmname">-propertyfile</span> option.</span>
    30. 

  30.       </li></ol>
    31. 

  31.     <div class="example"><h2 class="title sectiontitle">Example: Ant build</h2>
    32. 

  32.       <div class="p">Sample build file: <span class="ph filepath" id="migrating-ant-to-dita__samples-dir"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/ant_sample/build-chm-pdf.xml</span>
    33. 

  33.         <pre class="pre codeblock"><code>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
    34. 

  34. 

  35. &lt;project name="build-chm-pdf" default="all" basedir="."&gt;
    36. 

  36. 

  37.   &lt;property name="dita.dir" location="${basedir}/../../.."/&gt;
    38. 

  38. 

  39.   &lt;target name="all" description="build CHM and PDF" depends="chm,pdf"/&gt;
    40. 

  40. 

  41.   &lt;target name="chm" description="build CHM"&gt;
    42. 

  42.     &lt;ant antfile="${dita.dir}/build.xml"&gt;
    43. 

  43.       &lt;property name="args.input" location="../sequence.ditamap"/&gt;
    44. 

  44.       &lt;property name="transtype" value="htmlhelp"/&gt;
    45. 

  45.       &lt;property name="output.dir" location="../out/chm"/&gt;
    46. 

  46.       &lt;property name="args.gen.task.lbl" value="YES"/&gt;
    47. 

  47.       &lt;property name="args.breadcrumbs" value="yes"/&gt;
    48. 

  48.     &lt;/ant&gt;
    49. 

  49.   &lt;/target&gt;
    50. 

  50. 

  51.   &lt;target name="pdf" description="build PDF"&gt;
    52. 

  52.     &lt;ant antfile="${dita.dir}/build.xml"&gt;
    53. 

  53.       &lt;property name="args.input" location="../taskbook.ditamap"/&gt;
    54. 

  54.       &lt;property name="transtype" value="pdf"/&gt;
    55. 

  55.       &lt;property name="output.dir" location="../out/pdf"/&gt;
    56. 

  56.       &lt;property name="args.gen.task.lbl" value="YES"/&gt;
    57. 

  57.       &lt;property name="args.rellinks" value="nofamily"/&gt;
    58. 

  58.     &lt;/ant&gt;
    59. 

  59.   &lt;/target&gt;
    60. 

  60. 

  61. &lt;/project&gt;</code></pre></div></div>
    62. 

  62.     <div class="example"><h2 class="title sectiontitle">Example: <span class="ph filepath">.properties</span> files with <span class="keyword cmdname">dita</span> command</h2>
    63. 

  63.       
    64. 

  64.       <p class="p">The following <span class="ph filepath">.properties</span> files and <span class="keyword cmdname">dita</span> commands are equivalent to the
    65. 

  65.         example Ant build.</p>
    66. 

  66.       <div class="p">Sample <span class="ph filepath">.properties</span> file: <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/properties/chm.properties</span><pre class="pre codeblock"><code>output.dir = out/chm
    67. 

  67. args.gen.task.lbl = YES
    68. 

  68. args.breadcrumbs = yes</code></pre></div>
    69. 

  69.       <div class="p">Sample <span class="ph filepath">.properties</span> file: <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/properties/pdf.properties</span><pre class="pre codeblock"><code>output.dir = out/pdf
    70. 

  70. args.gen.task.lbl = YES
    71. 

  71. args.rellinks = nofamily</code></pre></div>
    72. 

  72.       <p class="p">Run from <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span>:</p>
    73. 

  73.       <pre class="pre codeblock"><code><span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/bin/<span class="keyword cmdname">dita</span></span> -input sequence.ditamap -format htmlhelp -propertyfile properties/chm.properties
    74. 

  74. <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/bin/<span class="keyword cmdname">dita</span></span> -input taskbook.ditamap -format pdf -propertyfile properties/pdf.properties</code></pre>
    75. 

  75.     </div>
    76. 

  76.     <div class="example"><h2 class="title sectiontitle">Example: Call the <span class="keyword cmdname">dita</span> command from an Ant build</h2>
    77. 

  77.       
    78. 

  78.       <p class="p">In some cases, you might still want to use an Ant build to implement some pre- or post-processing steps, but
    79. 

  79.         also want the convenience of using the <span class="keyword cmdname">dita</span> command with <span class="ph filepath">.properties</span>
    80. 

  80.         files to define the parameters for each build. This can be accomplished with Ant's <code class="keyword markupname xmlelement">&lt;exec&gt;</code>
    81. 

  81.         task.</p>
    82. 

  82.       <p class="p">This example uses a <code class="keyword markupname xmlelement">&lt;dita-cmd&gt;</code> Ant macro defined in the <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/ant_sample/dita-cmd.xml</span> file.</p>
    83. 

  83.       <div class="p">Sample build file: <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/ant_sample/build-chm-pdf-hybrid.xml</span>
    84. 

  84.         <pre class="pre codeblock"><code>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
    85. 

  85. 

  86. &lt;project name="build-chm-pdf-hybrid" default="all" basedir="."&gt;
    87. 

  87. 

  88.   &lt;description&gt;An Ant build that calls the dita command&lt;/description&gt;
    89. 

  89. 

  90.   &lt;include file="dita-cmd.xml"/&gt;&lt;!-- defines the &lt;dita-cmd&gt; macro --&gt;
    91. 

  91. 

  92.   &lt;target name="all" depends="pre,main,post"/&gt;
    93. 

  93. 

  94.   &lt;target name="pre"&gt;
    95. 

  95.     &lt;description&gt;Preprocessing steps&lt;/description&gt;
    96. 

  96.   &lt;/target&gt;
    97. 

  97. 

  98.   &lt;target name="main"&gt;
    99. 

  99.     &lt;description&gt;Build the CHM and PDF with the dita command&lt;/description&gt;
    100. 

  100.     &lt;dita-cmd input="../sequence.ditamap" format="htmlhelp" propertyfile="../properties/chm.properties"/&gt;
    101. 

  101.     &lt;dita-cmd input="../taskbook.ditamap" format="pdf" propertyfile="../properties/pdf.properties"/&gt;
    102. 

  102.   &lt;/target&gt;
    103. 

  103. 

  104.   &lt;target name="post"&gt;
    105. 

  105.     &lt;description&gt;Postprocessing steps&lt;/description&gt;
    106. 

  106.   &lt;/target&gt;
    107. 

  107. 

  108. &lt;/project&gt;</code></pre>
    109. 

  109.       </div>
    110. 

  110.     </div>
    111. 

  111.   </div>
    112. 

  112. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../user-guide/build-using-dita-command.html" title="You can generate output using the DITA Open Toolkit dita command-line tool. Build parameters can be specified on the command line or with .properties files.">Building output using the dita command</a></div></div></nav></article></main></body></html>
    113.