XhtmlTocjs.dita 1.8 KB

1234567891011121314151617181920212223242526272829303132
  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
  7. distributed outside of the toolkit, but it now ships bundled in the default packages. This
  8. HTML5-based output type creates a JavaScript-based frameset with TOC entries that expand and
  9. collapse.</shortdesc>
  10. <conbody>
  11. <section><p>The following Ant targets control most of the TocJS processing:<dl>
  12. <dlentry>
  13. <dt><codeph>tocjsInit</codeph></dt>
  14. <dd>Sets up default properties. This target detects whether builds have already specified a name for
  15. JavaScript control file; if not, the default name <filepath>toctree.js</filepath> is used.</dd>
  16. </dlentry>
  17. <dlentry>
  18. <dt><codeph>map2tocjs</codeph></dt>
  19. <dd>Calls the <codeph>dita.map.tocjs</codeph> target, which generates the contents frame for TocJS
  20. output.</dd>
  21. </dlentry>
  22. <dlentry>
  23. <dt><codeph>tocjsDefaultOutput</codeph></dt>
  24. <dd>Ensures that the HTML5 processing module is run. If scripts are missing required information, such as a
  25. name for the default frameset, this target copies default style and control files. This target was add to
  26. the DITA-OT in version 1.5.4; earlier versions of the TocJS transformation created only the JavaScript
  27. control file by default.</dd>
  28. </dlentry>
  29. </dl></p></section>
  30. </conbody>
  31. </concept>