Keyword Index

<< Click to Display Table of Contents >>

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

Keyword Index

This section allows you to edit the HTML template that defines the layout and appearance of the Keyword Index pane in your WebHelp output. See Using HTML Templates for full details.

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.

Simple Template Layout tab:

This mode is recommended if you do not have experience with editing HTML code!

Text above Keyword Index:

Any text you enter in this editing box will be inserted above the Keyword Index. HTML tags are allowed.

The default code inserts the title of the Keyword Index and links to the TOC and Full-text Search (if activated in your settings) panes. Please do not change this code unless you really understand how it works.

Keyword Index Font:

These settings define the font styles to be used for the components of your Keyword Index.

Index Separators:

These entries generate the headings for each letter group in the Keyword Index. If your help is not in English you can add appropriate letters for your language.

BTN_ResetDefaults

This button automatically clears the HTML template and reloads the default template. Use with caution – this function completely overwrites all your editing changes!

Disabled Simple Layout tab:
The Simple Layout tab will be disabled as soon as you edit source code to prevent accidental deletion of your custom code. It can only be re-enabled by clicking on the Reset Template button. This will delete the edited code and replace it with the standard template

HTML Source Code tab:

This tab allows you to see and edit all the code of the TOC template manually. Experience in editing HTML code is necessary for using this mode! Note that the code in this template is essential for the proper functioning of the TOC. Please don't change or delete anything that you don't fully understand!

Disabled Simple Layout tab:
The Simple Layout tab will be disabled as soon as you edit source code to prevent accidental deletion of your custom code. It can only be re-enabled by clicking on the Reset Template button. This will delete the edited code and replace it with the standard template

Editing window:

The editor provides full HTML syntax highlighting to make editing easier. To enlarge the window for easier editing just resize the window.

BTN_ResetDefaults

This button automatically clears the HTML template and reloads the default template. Use with caution. This function completely overwrites all your editing changes in the source code!

Applying this change re-enables the Simple Layout Tab.

See also:

Using HTML Templates

HTML Templates (Reference)

WebHelp (Help Formats)