The TOC template for WebHelp

<< Click to Display Table of Contents >>

Navigation:  More Advanced Procedures > HTML Output and HTML Templates >

The TOC template for WebHelp

This HTML template is only used in WebHelp. It generates the Table of Contents (TOC) pane in the frame layout that emulates the appearance and functionality of the HTML Help viewer in a normal browser.

Be particularly careful when editing this template! The TOC template is an integral part of the dynamic TOC of your WebHelp output. Its code is essential for the proper functioning of the help.

When you publish the actual table of contents for your project is inserted in the TOC page by the <%TABLE_OF_CONTENTS%> variable.

See Editing HTML templates for details on how to edit templates and Script and CSS components for experts for more details on its contents.

Template location

Configuration > Publishing Options > WebHelp > Table of Contents

If you are using an HTML skin you must edit your templates and settings in the skin!

Nowadays you will almost always choose an HTML skin to publish your project to WebHelp or HTML Help/CHM. A skin is a special kind of Help+Manual project without topics that only stores your HTML templates and all the settings relevant for HTML output to these two formats. When you choose a skin, the templates and settings in the skin completely replace those in your project.

Normally, a skin is pre-designed and you don't need to change anything. However, if you do want to change something, you must do all your editing in the .hmskin skin file. Editing in your Help+Manual project won't have any effect because those templates and settings are not used.

To edit a skin, make a copy of the .hmskin skin file in your project folder and then open it in Help+Manual by selecting .hmskin as the file type to open in the Open dialog. All the templates and settings are in the same places as in a normal Help+Manual project.

Exception: HTML Export Options

The HTML Export Options section is not stored in skins and needs to be edited in your project.

Script links for expanding and collapsing the TOC

You can use the following code to create links that will allow the user to expand and collapse the entire TOC with a single click:

In the TOC or topic page template pages:

<a href="javascript:parent.fullexpand()">Expand the TOC</a>
<a href="javascript:parent.fullcollapse()">Collapse the TOC</a>

In the main layout template page, or in the TOC page if "No Frames" is selected:

<a href="javascript:fullexpand()">Expand the TOC</a>
<a href="javascript:fullcollapse()">Collapse the TOC</a>

See also:

Editing HTML templates


Conditional output

Help Windows

Script and CSS components for experts