Home Explore Help
Sign In
bn
/
se
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 0b6fc7fd2b
Branches Tags
se
/
SE
/
stuff
/
dita-ot-2.3.3
/
doc
/
user-guide
/
build-using-dita-command.html

build-using-dita-command.html 12 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100 
  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="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."><meta name="DC.Relation" scheme="URI" content="../user-guide/transforming-dita-content.html"><meta name="DC.Relation" scheme="URI" content="../user-guide/build-using-dita-properties-file.html"><meta name="DC.Relation" scheme="URI" content="../user-guide/build-migrating-ant-to-dita.html"><meta name="DC.Relation" scheme="URI" content="../parameters/dita-command-arguments.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters_intro.html"><meta name="DC.Relation" scheme="URI" content="../parameters/internal-ant-properties.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="using-command-line-tool"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Building output using the dita command</title></head><body id="using-command-line-tool"><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 class="active"><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><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">Building output using the <span class="keyword cmdname">dita</span> command</h1>
    8. 

  8.   
    9. 

  9.   <div class="body taskbody"><p class="shortdesc">You can generate output using the DITA Open Toolkit <span class="keyword cmdname">dita</span> command-line tool. Build
    10. 

  10.     parameters can be specified on the command line or with <span class="ph filepath">.properties</span> files.</p>
    11. 

  11.     
    12. 

  12.     <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><div class="li step p">
    13. 

  13.         <span class="ph cmd">At the command-line prompt, enter the following command:</span>
    14. 

  14.         <div class="itemgroup info"><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> <span class="keyword option">-input</span>&nbsp;<var class="keyword varname">input-file</var> <span class="keyword option">-format</span>&nbsp;<var class="keyword varname">format</var> <var class="keyword varname">options</var></code></pre>
    15. 

  15.           <p class="p">where:</p>
    16. 

  16.           <ul class="ul">
    17. 

  17.             <li class="li"><span class="ph filepath"><var class="keyword varname">dita-ot-dir</var></span> is the DITA-OT installation directory.</li><li class="li"><var class="keyword varname">input-file</var> is the DITA map or DITA file that you want to process.</li><li class="li"><var class="keyword varname">format</var> is the output format (transformation type). Use the
    18. 

  18.               same values available for the <span class="keyword parmname">transtype</span> build parameter, for example,
    19. 

  19.                 <code class="ph codeph">html5</code> or <code class="ph codeph">pdf</code>.</li>
    20. 

  20.             <li class="li"><var class="keyword varname">options</var> include the following optional build parameters:<dl class="dl parml">
    21. 

  21.         
    22. 

  22.           <dt class="dt pt dlterm"><span class="keyword parmname">-o</span>, <span class="keyword parmname">-output</span>
    23. 

  23.             <var class="keyword varname">dir</var></dt>
    24. 

  24.           <dd class="dd pd" id="using-command-line-tool__d21e286">Specifies the path of the output directory; the path can be
    25. 

  25.             absolute or relative to the current directory. By default, the output is written to the
    26. 

  26.               <span class="ph filepath">out</span> subdirectory of the current directory.</dd>
    27. 

  27.         
    28. 

  28.         
    29. 

  29.           <dt class="dt pt dlterm"><span class="keyword parmname">-filter</span>
    30. 

  30.             <var class="keyword varname">file</var></dt>
    31. 

  31.           <dd class="dd pd">Specifies a filter file to be used to include, exclude, or flag content.</dd>
    32. 

  32.         
    33. 

  33.         
    34. 

  34.           <dt class="dt pt dlterm"><span class="keyword parmname">-t</span>, <span class="keyword parmname">-temp</span>
    35. 

  35.             <var class="keyword varname">dir</var></dt>
    36. 

  36.           <dd class="dd pd">Specifies the location of the temporary directory.</dd>
    37. 

  37.         
    38. 

  38.         
    39. 

  39.           <dt class="dt pt dlterm"><span class="keyword parmname">-v</span>, <span class="keyword parmname">-verbose</span></dt>
    40. 

  40.           <dd class="dd pd">Verbose logging.</dd>
    41. 

  41.         
    42. 

  42.         
    43. 

  43.           <dt class="dt pt dlterm"><span class="keyword parmname">-d</span>, <span class="keyword parmname">-debug</span></dt>
    44. 

  44.           <dd class="dd pd">Debug logging.</dd>
    45. 

  45.         
    46. 

  46.         
    47. 

  47.           <dt class="dt pt dlterm"><span class="keyword parmname">-l</span>, <span class="keyword parmname">-logfile</span>
    48. 

  48.             <var class="keyword varname">file</var></dt>
    49. 

  49.           <dd class="dd pd">Write logging messages to a file.</dd>
    50. 

  50.         
    51. 

  51.         
    52. 

  52.           <dt class="dt pt dlterm"><span class="keyword parmname">-D</span><var class="keyword varname">parameter</var>=<var class="keyword varname">value</var></dt>
    53. 

  53.           <dd class="dd pd">Specify a value for a DITA-OT or Ant build parameter. <p class="p">Parameters not implemented by
    54. 

  54.               the specified transformation type or referenced in a <span class="ph filepath">.properties</span>
    55. 

  55.               file are ignored.</p><div class="note tip note_tip"><span class="note__title tiptitle">Tip:</span> If you are building in different environments where the location of the input
    56. 

  56.         files is not consistent, set <span class="keyword option">args.input.dir</span> with the <span class="keyword cmdname">dita</span> command and
    57. 

  57.         reference its value with <code class="ph codeph">${args.input.dir}</code> in your <span class="ph filepath">.properties</span>
    58. 

  58.         file.</div></dd>
    59. 

  59.         
    60. 

  60.         
    61. 

  61.           <dt class="dt pt dlterm"><span class="keyword parmname">-propertyfile</span>
    62. 

  62.             <var class="keyword varname">file</var></dt>
    63. 

  63.           <dd class="dd pd">Use build parameters defined in the referenced <span class="ph filepath">.properties</span> file.
    64. 

  64.               <p class="p">Build parameters specified on the command line override those set in the
    65. 

  65.                 <span class="ph filepath">.properties</span> file.</p></dd>
    66. 

  66.         
    67. 

  67.       </dl></li>
    68. 

  68.           </ul></div>
    69. 

  69.         <div class="itemgroup stepresult">
    70. 

  70.           <p class="p">If processing is successful, nothing is printed in the terminal window. The built output is written to the
    71. 

  71.             specified output directory (by default, in the <span class="ph filepath">out</span> subdirectory of the current
    72. 

  72.             directory).</p>
    73. 

  73.           <div class="note tip note_tip" id="using-command-line-tool__d8e151"><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
    74. 

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

  75.         </div>
    76. 

  76.       </div>
    77. 

  77.     
    78. 

  78.     <div class="example"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Example</h2></div>
    79. 

  79.       <p class="p">For example, from <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span>, run:</p>
    80. 

  80.       <pre class="pre codeblock"><code>dita <span class="keyword option">-input</span> sequence.ditamap <span class="keyword option">-format</span> html5 \
    81. 

  81.      <span class="keyword option">-output</span> output/sequence \
    82. 

  82.      <span class="keyword option">-D</span>args.input.dir=<span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span> \
    83. 

  83.      <span class="keyword option">-propertyfile</span> properties/sequence-html5.properties</code></pre>
    84. 

  84.       <p class="p">This builds <span class="ph filepath">sequence.ditamap</span> to HTML5 output in <span class="ph filepath">output/sequence</span> using
    85. 

  85.         the additional parameters specified in the <span class="ph filepath">properties/sequence-html5.properties</span> file:</p>
    86. 

  86.       <pre class="pre codeblock"><code>args.gen.task.lbl = NO
    87. 

  87. args.cssroot = ${args.input.dir}/css/
    88. 

  88. args.css = style.css
    89. 

  89. args.copycss = yes
    90. 

  90. args.csspath = branding
    91. 

  91. nav-toc = full
    92. 

  92. args.xhtml.toc = toc</code></pre>
    93. 

  93.     </div>
    94. 

  94.     <section class="section postreq"><div class="tasklabel"><h2 class="sectiontitle tasklabel">What to do next</h2></div>
    95. 

  95.       
    96. 

  96.       <p class="p">Usually, you will want to specify a set of reusable build parameters in a
    97. 

  97.           <span class="ph filepath">.properties</span> file.</p>
    98. 

  98.     </section>
    99. 

  99.   </div>
    100. 

  100. <nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../user-guide/build-using-dita-properties-file.html">Setting build parameters with .properties files</a></strong><br>Usually, DITA builds require setting a number of parameters that do not change frequently. You can     reference a set of build parameters defined in a <span class="ph filepath">.properties</span> file when building output with the       <span class="keyword cmdname">dita</span> command. If needed, you can override any parameter by specifying it explicitly as an     argument to the <span class="keyword cmdname">dita</span> command.</li><li class="link ulchildlink"><strong><a href="../user-guide/build-migrating-ant-to-dita.html">Migrating Ant builds to use the dita command</a></strong><br>Although Ant builds are still supported in the DITA Open Toolkit, you might want to switch to use the new       <span class="keyword cmdname">dita</span> command.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../user-guide/transforming-dita-content.html" title="You can use either the dita command-line tool or Ant to transform DITA content to the various output formats that are supported by the DITA Open Toolkit.">Publishing DITA content</a></div></div><div class="linklist linklist relinfo relref"><strong>Related reference</strong><br><div><a class="link" href="../parameters/dita-command-arguments.html" title="The dita command takes mandatory arguments to process DITA content, manage plug-ins, or print information about the command. Options can be used to modify the command behavior or specify additional configuration parameters.">Arguments and options for the dita command</a></div><div><a class="link" href="../parameters/parameters_intro.html" title="Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based transformations. Some parameters apply only to specific transformation types. These parameters can be passed as options to the dita command using the -Dparameter-name=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div><div><a class="link" href="../parameters/internal-ant-properties.html" title="Reference list of Ant properties used by DITA-OT internally.">Internal Ant properties</a></div></div></nav></article></main></body></html>
    101.