installing-client.dita 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  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 the 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. <taskbody>
  12. <prereq>
  13. <ul>
  14. <li>Ensure that you have a Java Runtime Environment (JRE) or Java Development Kit (JDK), version <keyword
  15. keyref="tool.java.version"/> or later installed.
  16. <p>You can download the Oracle JRE or JDK from <xref keyref="download.oracle-jdk"/>.</p></li>
  17. <li importance="optional" platform="windows">If you want to generate HTML Help, ensure that you have HTML Help
  18. Workshop installed.
  19. <p>You can download the Help Workshop from <xref keyref="download.html-help-workshop"/>.</p></li>
  20. </ul>
  21. </prereq>
  22. <steps>
  23. <step>
  24. <cmd><ph conref="../resources/conref-task.dita#ID/download-ot"/></cmd>
  25. </step>
  26. <step>
  27. <cmd>Extract the contents of the package to the directory where you want to install the DITA-OT.</cmd>
  28. </step>
  29. <step importance="optional">
  30. <cmd>Add the absolute path for the <filepath>bin</filepath> directory to the <varname>PATH</varname> system
  31. variable.</cmd>
  32. <stepresult>
  33. <p>This defines the necessary environment variable to run the <cmdname>dita</cmdname> command from the command
  34. line.</p>
  35. <note type="tip">This step is recommended, as it allows the the <cmdname>dita</cmdname> command to be run from
  36. any location on the file system and makes it easier to transform DITA content from any folder.</note>
  37. </stepresult>
  38. </step>
  39. </steps>
  40. </taskbody>
  41. </task>