The Search template for WebHelp

<< Click to Display Table of Contents >>

Navigation:  More Advanced Procedures > HTML Output and HTML Templates >

The Search template for WebHelp

This HTML template is only used in WebHelp and is only active if you have the Professional or Server version of Help+Manual, which include a bundled, royalty-free license for the Wrensoft Zoom web search engine necessary for full-text search in WebHelp. It generates the Search pane in the frame layout that emulates the appearance and functionality of the HTML Help viewer in a normal browser.

The Search template is an integral part of the full-text search function in the WebHelp output. Its code is essential for the proper functioning of the search function. Please be extremely careful when you are editing this template – if you don't understand what a piece of code is for it's better to leave it alone!

The standard search script is inserted in the Search page by the <%SEARCH_SCRIPT%> variable. You can't edit this script but you can configure all the text used in the script and other features. See Full Text Search in the reference section for details on the configuration options for Search.

See Editing HTML templates for details on how to edit templates and Script and CSS components for experts for more information on the template contents.

Template location

Configuration > Publishing Options > WebHelp > Full Text Search

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.

See also:

Editing HTML templates

Script and CSS components for experts


Conditional output

Help Windows