Inicio Explorar Ayuda
Iniciar sesión
bn
/
se
2
0
Fork 0
Archivos Incidencias 0 Pull Requests 0 Wiki
Árbol: a4b429aad5
Ramas Etiquetas
se
/
SE
/
schema
/
WPS_Functions
/
dita-ot
/
dita-ot-3.3.3
/
doc
/
topics
/
first-build-using-dita-command.html

first-build-using-dita-command.html 7.7 KB
Histórico Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 
  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 2019"><meta name="DC.rights.owner" content="(C) Copyright 2019"><meta name="DC.type" content="task"><meta name="description" content="You can generate output using the dita command-line tool. Build parameters can be specified on the command line or with .properties files."><meta name="DC.subject" content="macOS, command, dita, Linux, Windows, using"><meta name="keywords" content="macOS, command, dita, Linux, Windows, using"><meta name="DC.relation" scheme="URI" content="../topics/installing-client.html"><meta name="DC.relation" scheme="URI" content="../topics/build-using-dita-command.html"><meta name="DC.format" content="HTML5"><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 3.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a><ul><li><a href="../topics/prerequisite-software.html">Prerequisite software</a></li><li><a href="../topics/determining-version-of-ditaot.html">Checking the version</a></li><li class="active"><a href="../topics/first-build-using-dita-command.html">Building output</a></li><li><a href="../topics/installing-via-homebrew.html">Installing via Homebrew</a></li></ul></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a></li><li><a href="../topics/customizing.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">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.   
    10. 

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

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

  12.     <section class="section context"><div class="tasklabel"><h2 class="sectiontitle tasklabel">About this task</h2></div>The DITA-OT client is a command-line tool with no graphical user interface. To verify
    13. 

  13.       that your installation works correctly, you can build output using the sample files included in the distribution
    14. 

  14.       package.</section>
    15. 

  15.     <section><div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
    16. 

  16.         <span class="ph cmd">Open a terminal window by typing the following in the search bar:</span>
    17. 

  17.         <div class="itemgroup info">
    18. 

  18.           <ul class="ul">
    19. 

  19.             <li class="li">On Linux and macOS, type <kbd class="ph userinput">Terminal</kbd>.</li>
    20. 

  20.             <li class="li">On Windows, type <kbd class="ph userinput">Command Prompt</kbd>.</li>
    21. 

  21.           </ul>
    22. 

  22.         </div>
    23. 

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

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

  25.         <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 parmname">--input</span>=<var class="keyword varname">input-file</var> <span class="keyword parmname">--format</span>=<var class="keyword varname">format</var> </code></pre>
    26. 

  26.           <p class="p">where:</p>
    27. 

  27.           <ul class="ul">
    28. 

  28.             <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
    29. 

  29.               process.</li><li class="li">
    30. 

  30.               <p class="p" id="using-command-line-tool__d12e189">
    31. 

  31.                 <var class="keyword varname">format</var> is the output format (transformation type).
    32. 

  32.                 This argument corresponds to the common parameter
    33. 

  33.                 <span class="keyword parmname">transtype</span>.
    34. 

  34.                 Use the same values as for the <span class="keyword parmname">transtype</span> build
    35. 

  35.                 parameter, for example <span class="keyword option">html5</span> or <span class="keyword option">pdf</span>.
    36. 

  36.               </p>
    37. 

  37.             </li>
    38. 

  38.             
    39. 

  39.             
    40. 

  40.             
    41. 

  41.           </ul></div>
    42. 

  42.         <div class="itemgroup stepresult">
    43. 

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

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

  45.             directory).</p>
    46. 

  46.           <div class="note tip note_tip" id="using-command-line-tool__d12e590"><span class="note__title">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
    47. 

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

  48.             
    49. 

  49.           </div>
    50. 

  50.         </div>
    51. 

  51.       </li></ol></section>
    52. 

  52.     <section class="example"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Example</h2></div>
    53. 

  53.       <p class="p">Run from <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span>, the following command generates
    54. 

  54.         HTML5 output for the <span class="ph filepath">sequence.ditamap</span> file:</p>
    55. 

  55.       <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 parmname">--input</span>=<span class="ph filepath">sequence.ditamap</span> <span class="keyword parmname">--format</span>=<span class="keyword option">html5</span></code></pre>
    56. 

  56.       
    57. 

  57.     </section>
    58. 

  58.     
    59. 

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

  60.       <p class="p">Most builds require you to specify more options than are described in this topic.</p>
    61. 

  61.       
    62. 

  62.     </section>
    63. 

  63.   </div>
    64. 

  64. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/installing-client.html" title="The DITA-OT distribution package can be installed on Linux, macOS, and Windows. It contains everything that you need to run the toolkit except for Java.">Installing DITA Open Toolkit</a></div></div><div class="linklist relinfo reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/build-using-dita-command.html" title="You can generate output using the dita command-line tool. Build parameters can be specified on the command line or with .properties files.">More information about building output with the <span class="keyword cmdname">dita</span> command</a></li></ul></div></nav></article></main></body></html>
    65.