about.xml 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!--
  3. This file is part of the DITA Open Toolkit project.
  4. See the accompanying LICENSE file for applicable license.
  5. Copyright 2007 Shawn McKenzie
  6. *-->
  7. <?xml-stylesheet href="../../../../xsl/ditaview_shell.xsl" type="text/xsl"?>
  8. <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
  9. "../../../../dtd/concept.dtd">
  10. <concept id="tocjs_about" xml:lang="en-us">
  11. <title>About tocjs</title>
  12. <shortdesc>JavaScript TOC Navigation Plugin for the DITA Open Toolkit's XHTML output.</shortdesc>
  13. <conbody>
  14. <p>The tocjs plugin generates a Table of Contents for the DITA Open Toolkit's XHTML output that can expand and
  15. collapse nodes. It is a more usable and visually pleasing option than the standard
  16. <filepath>index.html</filepath> generated by the Open Toolkit's <codeph>dita2html</codeph>
  17. transformation.</p>
  18. <p>The JavaScript code used in this plugin is derived from the Yahoo YUI Treeview widget. This
  19. plugin goes a long way to making DITA XHTML output slick and professional looking for a web site
  20. or custom built help engine.</p>
  21. <p>Beginning with DITA-OT version 1.5.4, the code has been updated to supply default framesets using
  22. the same look-and-feel as this sample documentation. Existing users with customized tocjs processing
  23. will not notice a change; new users will immediately get working tocjs based output. If you want
  24. your own look and feel, rather than that of the samples, you will need to customize several
  25. things to get it working properly with your project. </p>
  26. <note type="note">All examples in this documentation assume a Unix style file separator. If you
  27. are on a Windows machine, replace the '<codeph>/</codeph>' character with a '<codeph>\</codeph>'
  28. character for all file paths.</note>
  29. </conbody>
  30. <related-links>
  31. <link href="http://developer.yahoo.com/yui/treeview/" scope="external" type="html">
  32. <linktext>Yahoo! Treeview Widget</linktext>
  33. <desc>http://developer.yahoo.com/yui/treeview/</desc>
  34. </link>
  35. <link href="http://wsa.sophos.com/docs/ws1000/" scope="external" format="html">
  36. <linktext>Sophos tocjs output</linktext>
  37. <desc>http://wsa.sophos.com/docs/ws1000/</desc>
  38. </link>
  39. </related-links>
  40. </concept>