rebuilding-docs.dita 2.5 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="rebuilding-docs">
  5. <title>Rebuilding the DITA-OT documentation</title>
  6. <titlealts>
  7. <navtitle>Rebuilding documentation</navtitle>
  8. </titlealts>
  9. <shortdesc>DITA-OT ships with a <keyword keyref="gradle"/> build script that enables you to rebuild the toolkit
  10. documentation. This is especially helpful if your environment contains plug-ins that add new extension points,
  11. messages, or parameters to the toolkit.</shortdesc>
  12. <prolog>
  13. <metadata>
  14. <keywords>
  15. <indexterm>macOS<indexterm>gradle</indexterm><indexterm>rebuilding documentation</indexterm></indexterm>
  16. <indexterm>Linux<indexterm>gradle</indexterm><indexterm>rebuilding documentation</indexterm></indexterm>
  17. <indexterm>Windows<indexterm>gradlew</indexterm><indexterm>rebuilding documentation</indexterm></indexterm>
  18. </keywords>
  19. </metadata>
  20. </prolog>
  21. <taskbody>
  22. <context>
  23. <p>The documentation build script reads the toolkit’s plug-in configuration and automatically regenerates topics
  24. and properties file templates based on the extension points, messages, and parameters provided by the installed
  25. plug-ins.</p>
  26. <note type="attention">If you have installed new plug-ins, you may need to add the corresponding generated topics
  27. to the DITA maps to include the new information in the output.</note></context>
  28. <steps>
  29. <step>
  30. <cmd>Change to the <filepath>docsrc/</filepath> subdirectory of the DITA-OT installation.</cmd>
  31. </step>
  32. <step>
  33. <cmd>Run one of the following commands.</cmd>
  34. <choices>
  35. <choice platform="linux mac">On Linux and macOS:
  36. <codeblock>./gradlew <varname>target</varname></codeblock></choice>
  37. <choice platform="windows">On Windows: <codeblock>gradlew <varname>target</varname></codeblock></choice>
  38. </choices>
  39. <info>
  40. <p>The <varname>target</varname> parameter is optional and specifies a transformation type. It takes the
  41. following values:
  42. <ul>
  43. <li><option>html</option></li>
  44. <li><option>htmlhelp</option></li>
  45. <li><option>pdf</option></li>
  46. </ul>
  47. </p>
  48. <p>If you do not specify a target, HTML5 and PDF output is generated.</p>
  49. </info>
  50. </step>
  51. </steps>
  52. </taskbody>
  53. </task>