Navigation:  Reference > Project Configuration Settings > Publishing Options > Webhelp >

Navigation

Print this Topic Previous pageReturn to chapter overviewNext page

These settings control how the navigation is handled in your Webhelp output. Like the settings in the Layout section they are essential for the functioning of your help. You should always check them very carefully before publishing your Webhelp to make absolutely sure that the help will behave as you want.

For more information see Webhelp in the Configuring Your Output chapter and Webhelp and Browser compatibility in the Reference > Help Formats chapter.

Include Keyword Index
Include Full-text Search

These features should be self-explanatory. They simply switch individual features in your Webhelp on and off.

Note that Full Text Search is only available in the Professional version of Help & Manual and will only work if the user has JavaScript enabled.

If you activate search you should also configure the search options in the Full Text Search section.

Add ordering numbers to Table of Contents:

Adds topic/chapter numbering to the TOC in your output, using the standard legal format (1, 1.1, 1.2, 1.2.1 etc).

Lazy content synchronization:

This is a specialized setting for advanced users that should be left turned off for all normal output. Activating it may slightly slow down synchronization between topics and the TOC, particularly in menus with many entries.

Lazy synchronization activates a different method for "synchronizing" the item highlighted in the TOC pane with the topic displayed in the topic pane.

In normal mode, when lazy synchronization is deactivated, all topics include information about where their entries are in the TOC. When the user clicks on a topic hyperlink the entry for the target topic in the TOC will be highlighted as soon as the topic is displayed.

Activating lazy synchronization removes this TOC address information from the individual topics. When the user clicks on a link the browser must first search for the matching entry in the TOC, and this can cause a small delay.

Single click on caption in Table of Contents expands chapter:

By default, the user must double-click on chapters to expand them in the TOC. This option allows you to change this to expand on a single click.

Note:
We recommend leaving this option off. The default mode allows you to select chapters without expanding them automatically and you can still expand chapters with a single click on the chapter icon.

Automatically collapse unfocused entries:

When you set this option all chapters except the chapter in which the user is currently browsing collapse (close) automatically. This can make navigation easier in large help projects because you do not have a large number of chapters open at the same time.

Note:
Selecting this option will disable On load, expand... All Entries (see below)

On load, expand:

Allows you to expand the TOC automatically when the user opens the help. You can expand either all entries or just top-level entries (main chapters).

Note:
Expand All Entries is disabled when Automatically collapse unfocused entries is selected (see above).

Icons in the TOC:

If you want you can select your own icons to be used in the Table of Contents here. If you select custom icons stored in folders listed in your Image Folders they will be copied to your output directory automatically.

See also:

Webhelp (Configuring your Output)

Webhelp (Help Formats)

Browser compatibility

 


Page url: http://www.helpandmanual.com/help/index.html?hm_projectprops_htmlex_navigation.htm