installing-client.html 7.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en-us"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="DC.rights.owner" content="(C) Copyright 2020"><meta name="DC.type" content="task"><meta name="description" content="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."><meta name="DC.subject" content="macOS, installing DITA-OT, Linux, Windows, command, dita, installing, installing, DITA-OT, Java, Java Development Kit (JDK), Java Runtime Environment (JRE)"><meta name="keywords" content="macOS, installing DITA-OT, Linux, Windows, command, dita, installing, installing, DITA-OT, Java, Java Development Kit (JDK), Java Runtime Environment (JRE)"><meta name="DC.relation" scheme="URI" content="../topics/prerequisite-software.html"><meta name="DC.relation" scheme="URI" content="../topics/determining-version-of-ditaot.html"><meta name="DC.relation" scheme="URI" content="../topics/first-build-using-dita-command.html"><meta name="DC.relation" scheme="URI" content="../topics/installing-via-homebrew.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="installing-client"><meta name="DC.language" content="en-US"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Installing DITA Open Toolkit</title></head><body id="installing-client"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.5</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li class="active"><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><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/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</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. <h1 class="title topictitle1" id="ariaid-title1">Installing DITA Open Toolkit</h1>
  8. <div class="body taskbody"><p class="shortdesc">The DITA-OT distribution package can be installed on Linux, macOS, and Windows. It
  9. contains everything that you need to run the toolkit except for Java.</p>
  10. <section class="section prereq"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Before you begin</h2></div>
  11. <ul class="ul">
  12. <li class="li">
  13. <p class="p">Ensure that you have a Java Runtime Environment (JRE) or Java Development Kit (JDK).</p>
  14. <div class="p">DITA-OT is designed to run on Java version <span class="keyword">8u101</span> or later and
  15. built and tested with the Open Java Development Kit (OpenJDK). Compatible Java distributions are available from
  16. multiple sources:
  17. <ul class="ul">
  18. <li class="li">You can download the Oracle JRE or JDK from
  19. <a class="xref" href="http://www.oracle.com/technetwork/java/javase/downloads" target="_blank" rel="external noopener">oracle.com/technetwork/java</a> under commercial license.</li>
  20. <li class="li">OpenJDK is a free open-source implementation of Java available from
  21. <a class="xref" href="https://adoptopenjdk.net" target="_blank" rel="external noopener">adoptopenjdk.net</a>.</li>
  22. <li class="li">Amazon Corretto is an OpenJDK distribution from
  23. <a class="xref" href="https://aws.amazon.com/corretto/" target="_blank" rel="external noopener">aws.amazon.com/corretto</a>.</li>
  24. </ul>
  25. </div></li>
  26. <li class="li">If you want to generate HTML Help, ensure that you have HTML Help
  27. Workshop installed.
  28. <p class="p">You can download the Help Workshop from
  29. <a class="xref" href="http://msdn.microsoft.com/en-us/library/windows/desktop/ms669985%28v=vs.85%29.aspx" target="_blank" rel="external noopener">msdn.microsoft.com</a>.</p></li>
  30. </ul>
  31. </section>
  32. <section><div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
  33. <span class="ph cmd"><span class="ph">Download the <span class="ph filepath">dita-ot-<span class="keyword">3.5</span>.zip</span>
  34. package from the project website at
  35. <a class="xref" href="https://www.dita-ot.org/download" target="_blank" rel="external noopener">dita-ot.org/download</a>.</span></span>
  36. </li><li class="li step stepexpand">
  37. <span class="ph cmd">Extract the contents of the package to the directory where you want to install DITA-OT.</span>
  38. </li><li class="li step stepexpand"><strong>Optional: </strong>
  39. <span class="ph cmd">Add the absolute path for the <span class="ph filepath">bin</span> directory to the <var class="keyword varname">PATH</var> system
  40. variable.</span>
  41. <div class="itemgroup stepresult">
  42. <p class="p">This defines the necessary environment variable to run the <span class="keyword cmdname">dita</span> command from the command
  43. line.</p>
  44. <div class="note tip note_tip"><span class="note__title">Tip:</span> This step is recommended, as it allows the <span class="keyword cmdname">dita</span> command to be run from any
  45. location on the file system and makes it easier to transform DITA content from any folder.</div>
  46. </div>
  47. </li></ol></section>
  48. </div>
  49. <nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../topics/prerequisite-software.html">Prerequisite software</a></strong><br>The prerequisite software that DITA-OT requires depends on the types of transformations that you want to use.</li><li class="link ulchildlink"><strong><a href="../topics/determining-version-of-ditaot.html">Checking the DITA-OT version number</a></strong><br>You can determine the DITA Open Toolkit version number from a command prompt.</li><li class="link ulchildlink"><strong><a href="../topics/first-build-using-dita-command.html">Building output using the dita command</a></strong><br>You can generate output using the <span class="keyword cmdname">dita</span> command-line tool. Build parameters can be specified on the command line or with <span class="ph filepath">.properties</span> files.</li><li class="link ulchildlink"><strong><a href="../topics/installing-via-homebrew.html">Installing on macOS via Homebrew</a></strong><br>An alternative installation method can be used to install DITA-OT on macOS via <a class="xref" href="https://brew.sh" target="_blank" rel="external noopener">Homebrew</a>, the platform’s most popular open-source package manager.</li></ul></nav></article></main></body></html>