Navigation:  Project Properties Reference > Browser-based Help >

Keyword Index

Print this Topic Previous pageReturn to chapter overviewNext page

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

Simple editing mode:

When the Let me edit HTML code directly option at the top of the dialog is not selected you can only define some basic options for the Keyword Index template. This mode is recommended if you do not have experience with editing HTML code!

Let me edit HTML code directly:

Activate this check box to view and edit the HTML code of the template. See below for details on direct HTML editing mode.

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

If you select the button accidentally just click Cancel.

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.

HTML editing mode:

When the Let me edit HTML code directly option at the top of the dialog is selected you can edit all the code of the Keyword Index template manually. Experience in editing HTML code is necessary for using this mode!

Also, please note that the code in this template is essential for the proper functioning of the Keyword Index. Please don't change or delete anything that you don't understand!

Note that switching back to simple editing mode from HTML editing mode will overwrite all your changes with the default Keyword Index template! If you do this accidentally just click Cancel.

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

If you select the button accidentally just click Cancel.

Editing window:

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

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.

See also:

Using HTML Templates

HTML Templates (Reference)

Browser-based Help (Help Formats)

 


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