bn
/
se


			
				
					
						
						
							1234567891011121314151617181920212223242526272829303132333435363738
							<!DOCTYPE html
  SYSTEM "about:legacy-compat">
<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 tocjs transformation was originally created as a plug-in that was distributed outside of the toolkit, but it is now bundled in the default distribution. It generates a JavaScript-based frameset for XHTML output with Table of Contents entries that expand and collapse."><meta name="DC.subject" content="HTML, TocJS, dita.map.tocjs, targets, table of contents"><meta name="keywords" content="HTML, TocJS, dita.map.tocjs, targets, table of contents"><meta name="DC.relation" scheme="URI" content="../reference/XhtmlWithNavigation.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="xhtmltocjs"><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>TocJS processing</title></head><body id="xhtmltocjs"><header role="banner"><div class="header">
  <p>DITA Open Toolkit</p>
  <hr>
</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 class="active"><a href="../reference/XhtmlTocjs.html">TocJS processing</a></li><li><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">
  <h1 class="title topictitle1" id="ariaid-title1">TocJS processing</h1>
  
  
  <div class="body conbody"><p class="shortdesc">The <span class="keyword option">tocjs</span> transformation was originally created as a plug-in that was distributed outside
    of the toolkit, but it is now bundled in the default distribution. It generates a JavaScript-based frameset for
    XHTML output with Table of Contents entries that expand and collapse.</p>
    <section class="section">
      <p class="p">The following Ant targets control most of the TocJS processing:</p>
      <div class="p">
        <dl class="dl">
          
            <dt class="dt dlterm"><code class="ph codeph">tocjsInit</code></dt>
            <dd class="dd">Sets up default properties. This target detects whether builds have already specified a name for
              JavaScript control file; if not, the default name <span class="ph filepath">toctree.js</span> is used.</dd>
          
          
            <dt class="dt dlterm"><code class="ph codeph">map2tocjs</code></dt>
            <dd class="dd">Calls the <code class="ph codeph">dita.map.tocjs</code> target, which generates the contents frame for TocJS
              output.</dd>
          
          
            <dt class="dt dlterm"><code class="ph codeph">tocjsDefaultOutput</code></dt>
            <dd class="dd">Ensures that the XHTML processing module is run. If scripts are missing required information, such as a
              name for the default frameset, this target copies default style and control files. This target was added
              to DITA-OT in version 1.5.4; earlier versions of the TocJS transformation created only the JavaScript
              control file by default.</dd>
          
        </dl>
      </div>
    </section>
  </div>
<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>