Help & Manual 5 - User Help

The TOC template for Webhelp

Hide Navigation Pane

The TOC template for Webhelp

Previous topic Next topic No directory for this topic No expanding text in this topic  

The TOC template for Webhelp

Previous topic Next topic Topic directory requires JavaScript JavaScript is required for expanding text JavaScript is required for the print function  

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.

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:

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

Note that these links can only be used within the TOC template. You cannot use them in your topic pages or in other panes of the navigation frame.

See also:

Editing HTML templates

Variables

Conditional output

Help Windows