rebuilding-the-dita-ot-documentation.html 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="task"><meta name="description" content="The DITA-OT ships with Ant scripts that enable you to rebuild the toolkit documentation. This is especially helpful if your environment contains plug-ins that add new extension points, messages, or parameters to the toolkit."><meta name="DC.Relation" scheme="URI" content="../topics/extending-the-ot.html"><meta name="DC.Format" content="HTML5"><meta name="DC.Identifier" content="rebuilding-the-dita-ot-documentation"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Rebuilding the DITA-OT documentation</title></head><body id="rebuilding-the-dita-ot-documentation"><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.0</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a></li><li><a href="../topics/extending-the-ot.html">Customizing DITA-OT</a><ul><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/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/custom-plugins.html">Custom plug-ins</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../topics/migration.html">Migrating customizations</a></li><li class="active"><a href="../topics/rebuilding-the-dita-ot-documentation.html">Rebuilding documentation</a></li></ul></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">Rebuilding the DITA-OT documentation</h1>
  8. <div class="body taskbody"><p class="shortdesc">The DITA-OT ships with Ant scripts that enable you to rebuild the toolkit documentation. This is especially
  9. helpful if your environment contains plug-ins that add new extension points, messages, or parameters to the
  10. toolkit.</p>
  11. <section class="section context"><div class="tasklabel"><h2 class="sectiontitle tasklabel">About this task</h2></div>
  12. <p class="p">The documentation build script reads the toolkit’s plug-in configuration and automatically regenerates topics
  13. and properties file templates based on the extension points, messages, and parameters provided by the installed
  14. plug-ins.</p>
  15. <div class="note attention note_attention"><span class="note__title">Attention:</span> If you have installed new plug-ins, you may need to add the corresponding generated topics
  16. to the DITA maps to include the new information in the output.</div></section>
  17. <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
  18. <span class="ph cmd">Change to the <span class="ph filepath">docsrc</span> directory.</span>
  19. </li><li class="li step stepexpand">
  20. <span class="ph cmd">Run the following command:</span>
  21. <div class="itemgroup info">
  22. <pre class="pre codeblock"><code>ant -f build.xml <var class="keyword varname">target</var></code></pre>
  23. </div>
  24. <div class="itemgroup info">
  25. <div class="p">The <var class="keyword varname">target</var> parameter is optional and specifies a transformation type. It takes the
  26. following values:
  27. <ul class="ul">
  28. <li class="li"><span class="keyword option">html</span></li>
  29. <li class="li"><span class="keyword option">htmlhelp</span></li>
  30. <li class="li"><span class="keyword option">pdf</span></li>
  31. </ul>
  32. </div>
  33. <p class="p">If you do not specify an Ant target, HTML5 and PDF output is generated.</p>
  34. </div>
  35. </li></ol>
  36. </div>
  37. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/extending-the-ot.html" title="There are several ways to customize and extend the toolkit. You can adjust various aspects of the default output by setting parameters or using custom stylesheets. For more complex customizations, use custom DITA-OT plug-ins to override other parts of processing.">Customizing the DITA Open Toolkit</a></div></div></nav></article></main></body></html>