XhtmlCHM.html 5.2 KB

12345678910111213141516171819202122232425262728293031323334
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en-us"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2019"><meta name="DC.rights.owner" content="(C) Copyright 2019"><meta name="DC.type" content="concept"><meta name="description" content="The htmlhelp transformation creates HTML Help control files. If the build runs on a system that has the HTML Help compiler installed, the control files are compiled into a CHM file."><meta name="DC.subject" content="HTML, CHM, dita.map.htmlhelp, targets, HTML Help, .hhp, .hhc, .hhk"><meta name="keywords" content="HTML, CHM, dita.map.htmlhelp, targets, HTML Help, .hhp, .hhc, .hhk"><meta name="DC.relation" scheme="URI" content="../reference/XhtmlWithNavigation.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="xhtmlchm"><meta name="DC.language" content="en-US"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>HTML Help processing</title></head><body id="xhtmlchm"><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.3</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/customizing.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/XhtmlWithNavigation.html">HTML-based processing modules</a><ul><li><a href="../reference/XhtmlCommon.html">Common HTML-based processing</a></li><li><a href="../reference/XhtmlDefault.html">XHTML processing</a></li><li><a href="../reference/html5.html">HTML5 processing</a></li><li><a href="../reference/XhtmlEclipse.html">Eclipse help processing</a></li><li><a href="../reference/XhtmlTocjs.html">TocJS processing</a></li><li class="active"><a href="../reference/XhtmlCHM.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/DITA_spec-support.html">DITA specification support</a></li><li><a href="../reference/license.html">License</a></li></ul></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">HTML Help processing</h1>
  8. <div class="body conbody"><p class="shortdesc">The <span class="keyword option">htmlhelp</span> transformation creates HTML Help control files. If the
  9. build runs on a system that has the HTML Help compiler installed, the control files are compiled
  10. into a CHM file.</p>
  11. <section class="section">
  12. <p class="p">Once the pre-processing and XHTML processes are completed, most of the HTML Help processing is handled
  13. by the following targets:</p>
  14. <dl class="dl">
  15. <dt class="dt dlterm"><code class="ph codeph">dita.map.htmlhelp</code></dt>
  16. <dd class="dd">Create the HHP, HHC, and HHK files. The HHK file is sorted based on the language of the map.</dd>
  17. <dt class="dt dlterm"><code class="ph codeph">dita.htmlhelp.convertlang</code></dt>
  18. <dd class="dd">Ensures that the content can be processed correctly by the compiler, and that the appropriate code pages
  19. and languages are used.</dd>
  20. <dt class="dt dlterm"><code class="ph codeph">compile.HTML.Help</code></dt>
  21. <dd class="dd">Attempts to detect the HTML Help compiler. If the compiler is found, the full project is compiled into a
  22. single CHM file.</dd>
  23. </dl>
  24. </section>
  25. </div>
  26. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/XhtmlWithNavigation.html" title="DITA-OT ships with several varieties of HTML output, each of which follows roughly the same path through the processing pipeline. All HTML-based transformations begin with the same call to the pre-processing module, after which they generate HTML files and then branch to create the transformation-specific navigation files.">HTML-based processing modules</a></div></div></nav></article></main></body></html>