installing-client.dita 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <task id="installing-client" xml:lang="en-US">
  5. <title>Installing DITA Open Toolkit</title>
  6. <titlealts>
  7. <navtitle>Installing DITA-OT</navtitle>
  8. </titlealts>
  9. <shortdesc id="what-is-client">The DITA-OT distribution package can be installed on Linux, macOS, and Windows. It
  10. contains everything that you need to run the toolkit except for Java.</shortdesc>
  11. <prolog>
  12. <metadata>
  13. <keywords>
  14. <indexterm>macOS<indexterm>installing DITA-OT</indexterm></indexterm>
  15. <indexterm>Linux<indexterm>installing DITA-OT</indexterm></indexterm>
  16. <indexterm>Windows<indexterm>installing DITA-OT</indexterm></indexterm>
  17. <indexterm><cmdname>dita</cmdname> command<indexterm>installing</indexterm></indexterm>
  18. <indexterm>installing<indexterm>DITA-OT</indexterm></indexterm>
  19. <indexterm>Java<indexterm>Java Development Kit (JDK)</indexterm><indexterm>Java Runtime Environment (JRE)</indexterm></indexterm>
  20. </keywords>
  21. </metadata>
  22. </prolog>
  23. <taskbody>
  24. <prereq>
  25. <ul>
  26. <li>
  27. <p>Ensure that you have a Java Runtime Environment (JRE) or Java Development Kit (JDK).</p>
  28. <p conkeyref="reusable-components/java-clients"/></li>
  29. <li importance="optional" platform="windows">If you want to generate HTML Help, ensure that you have HTML Help
  30. Workshop installed.
  31. <p>You can download the Help Workshop from <xref keyref="download.html-help-workshop"/>.</p></li>
  32. </ul>
  33. </prereq>
  34. <steps>
  35. <step>
  36. <cmd><ph conref="../resources/conref-task.dita#ID/download-ot"/></cmd>
  37. </step>
  38. <step>
  39. <cmd>Extract the contents of the package to the directory where you want to install DITA-OT.</cmd>
  40. </step>
  41. <step importance="optional">
  42. <cmd>Add the absolute path for the <filepath>bin</filepath> directory to the <varname>PATH</varname> system
  43. variable.</cmd>
  44. <stepresult>
  45. <p>This defines the necessary environment variable to run the <cmdname>dita</cmdname> command from the command
  46. line.</p>
  47. <note type="tip">This step is recommended, as it allows the <cmdname>dita</cmdname> command to be run from any
  48. location on the file system and makes it easier to transform DITA content from any folder.</note>
  49. </stepresult>
  50. </step>
  51. </steps>
  52. </taskbody>
  53. </task>