XhtmlTocjs.dita 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  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="xhtmltocjs" xml:lang="en-US">
  5. <title>TocJS processing</title>
  6. <shortdesc>The <option>tocjs</option> transformation was originally created as a plug-in that was distributed outside
  7. of the toolkit, but it is now bundled in the default distribution. It generates a JavaScript-based frameset for
  8. XHTML output with Table of Contents entries that expand and collapse.</shortdesc>
  9. <prolog>
  10. <metadata>
  11. <keywords>
  12. <indexterm>HTML<indexterm>TocJS</indexterm></indexterm>
  13. <indexterm>dita.map.tocjs</indexterm>
  14. <indexterm>TocJS</indexterm>
  15. <indexterm>targets<indexterm>TocJS</indexterm></indexterm>
  16. <indexterm>table of contents<indexterm>TocJS</indexterm></indexterm>
  17. </keywords>
  18. </metadata>
  19. </prolog>
  20. <conbody>
  21. <section>
  22. <p>The following Ant targets control most of the TocJS processing:</p>
  23. <p>
  24. <dl>
  25. <dlentry>
  26. <dt><codeph>tocjsInit</codeph></dt>
  27. <dd>Sets up default properties. This target detects whether builds have already specified a name for
  28. JavaScript control file; if not, the default name <filepath>toctree.js</filepath> is used.</dd>
  29. </dlentry>
  30. <dlentry>
  31. <dt><codeph>map2tocjs</codeph></dt>
  32. <dd>Calls the <codeph>dita.map.tocjs</codeph> target, which generates the contents frame for TocJS
  33. output.</dd>
  34. </dlentry>
  35. <dlentry>
  36. <dt><codeph>tocjsDefaultOutput</codeph></dt>
  37. <dd>Ensures that the XHTML processing module is run. If scripts are missing required information, such as a
  38. name for the default frameset, this target copies default style and control files. This target was added
  39. to DITA-OT in version 1.5.4; earlier versions of the TocJS transformation created only the JavaScript
  40. control file by default.</dd>
  41. </dlentry>
  42. </dl>
  43. </p>
  44. </section>
  45. </conbody>
  46. </concept>