dita2htmlhelp.dita 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <concept id="dita2htmlhelp" xml:lang="en-US">
  5. <title>HTML Help</title>
  6. <shortdesc>The <option>htmlhelp</option> transformation generates HTML output, CSS files, and the control files that
  7. are needed to produce a Microsoft Compiled HTML Help (.chm) file.</shortdesc>
  8. <conbody>
  9. <p>In addition to the HTML output and CSS files, this transformation returns the following files, where
  10. <varname>mapname</varname> is the name of the master DITA map. <simpletable frame="all" relcolwidth="2.0* 3.0*">
  11. <sthead>
  12. <stentry>File name</stentry>
  13. <stentry>Description</stentry>
  14. </sthead>
  15. <strow>
  16. <stentry><filepath><varname>mapname</varname>.hhc</filepath></stentry>
  17. <stentry>Table of contents</stentry>
  18. </strow>
  19. <strow>
  20. <stentry><filepath><varname>mapname</varname>.hhk</filepath></stentry>
  21. <stentry>Sorted index</stentry>
  22. </strow>
  23. <strow>
  24. <stentry><filepath><varname>mapname</varname>.hhp</filepath></stentry>
  25. <stentry>HTML Help project file</stentry>
  26. </strow>
  27. <strow>
  28. <stentry><filepath><varname>mapname</varname>.chm</filepath></stentry>
  29. <stentry>
  30. <p>Compiled HTML Help file</p>
  31. <note>The compiled file is only generated if the HTML Help Workshop is installed on the build system.</note>
  32. </stentry>
  33. </strow>
  34. </simpletable>
  35. </p>
  36. <p>To run the HTML Help transformation, set the <parmname>transtype</parmname> parameter to
  37. <option>htmlhelp</option>, or pass the <parmname>--format</parmname>=<option>htmlhelp</option> option to the
  38. <cmdname>dita</cmdname> command line.</p>
  39. </conbody>
  40. </concept>