Navigation

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

Navigation

Previous pageReturn to chapter overviewNext page

These settings control how the navigation is handled in your WebHelp output. Like the settings in the Layout template, they are important for the functionality and appearance of your help in web browsers. You should always check them 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 and Server versions 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 chapter numbers to Table of Contents:

Adds topic/chapter numbering to the TOC in your WebHelp output.

Numbering format string:

This string defines the format of your chapter numbers. The standard format is standard legal numbering (1.1, 1.2 etc.), defined by the string 1.1.1.1.1.1

The characters in the string are processed in pairs for each level: A format character followed by a spacing character. Enter as many pairs as you need for the levels in your project. There are five format characters you can use. Do not include a spacing character after the last format character.

Format characters: (only these characters allowed)

1 =Numeric/Arabic
I =Roman, upper case
i =Roman, lower case
A =Alphabetic, upper case
a =Alphabetic, lower case

Examples:

Format String

Result

1.1.1.1.1.1

"1.4.5" or "2.1.16.7.9"

I 1.a.1.a.1

"I 4.e" or "II 1.p.7.i"

I-1.1

"I-4.5" or "II.1.16"

A.i.1.1.1.1

"A.iv.5" or "B.i.16.7.9"

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).

When a topic is loaded outside the navigation frame, force it to reload the navigation frame

Leave this on unless you have a special reason for disabling it. It is crucial for the proper indexing of your help by search engines like Google and Bing. When it is on, the entire WebHelp interface is automatically loaded when a user opens a topic file directly, and the corresponding entry in the Table of Contents is highlighted. This is what you want when a search engine links to a topic in your help.

Create a sitemap for improved search engine visibility:

Generates an XML sitemap file that will be automatically read by search engines like Google, Yahoo!, Ask and Bing. The sitemap tells the search engine where all your topics are and when they were last updated. This can improve search engine efficiency when scanning your site.

Full website URL: You must enter the fully-qualified URL to your WebHelp folder on your website here, including the http:// protocol prefix and the last slash. For example:

http://www.yourdomain.com/info/help/

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