rebuilding-the-dita-ot-documentation.dita 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  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-the-dita-ot-documentation">
  5. <title>Rebuilding the DITA-OT documentation</title>
  6. <titlealts>
  7. <navtitle>Rebuilding documentation</navtitle>
  8. </titlealts>
  9. <shortdesc>The DITA-OT ships with Ant scripts that enable you to rebuild the toolkit documentation. This is especially
  10. helpful if your environment contains plug-ins that add new extension points, messages, or parameters to the
  11. toolkit.</shortdesc>
  12. <taskbody>
  13. <context>
  14. <p>The documentation build script reads the toolkit’s plug-in configuration and automatically regenerates topics
  15. and properties file templates based on the extension points, messages, and parameters provided by the installed
  16. plug-ins.</p>
  17. <note type="attention">If you have installed new plug-ins, you may need to add the corresponding generated topics
  18. to the DITA maps to include the new information in the output.</note></context>
  19. <steps>
  20. <step>
  21. <cmd>Change to the <filepath>docsrc</filepath> directory.</cmd>
  22. </step>
  23. <step>
  24. <cmd>Run the following command:</cmd>
  25. <info>
  26. <codeblock>ant -f build.xml <varname>target</varname></codeblock>
  27. </info>
  28. <info>
  29. <p>The <varname>target</varname> parameter is optional and specifies a transformation type. It takes the
  30. following values:
  31. <ul>
  32. <li><option>html</option></li>
  33. <li><option>htmlhelp</option></li>
  34. <li><option>pdf</option></li>
  35. </ul>
  36. </p>
  37. <p>If you do not specify an Ant target, HTML5 and PDF output is generated.</p>
  38. </info>
  39. </step>
  40. </steps>
  41. </taskbody>
  42. </task>