The TOC template for WebHelp

Navigation:  More Advanced Procedures > Using HTML Templates >

The TOC template for WebHelp

Previous pageReturn to chapter overviewNext page

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.

flag_green        Key Information

If you are publishing with a skin you must edit the templates in the skin, not in your project! Skins always replace all the HTML templates in your project. Changes made in HTML templates your project will not be reflected in your output when you use skins!

Template location

Configuration > Publishing Options > WebHelp > Table of Contents

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

Variables

Conditional output

Help Windows

Script and CSS components for experts