
This wizard is designed to create a so-called online help, the format that is usually called as WebHelp. Essentially it is about copying the directory structure of your project (the source files) to a specified folder and the generation of a "frame" (main page) in HTML or XML format, that allows such a help to be easily browsed in the web browser.
Precision Helper allows usage of user defined templates for the creation of online help (see below).
In the wizard, select a template, that will be used to build online help, and the main file location of newly created WebHelp (i.e. C:\webhelp\test\index.htm, C:\webhelp\test\default.htm, etc.). Then click "Next >" to start this action.
When the wizard successfully finishes its work, you will be asked if you want to immediately open the newly created help in the webbrowser.
WebHelp templates
Examples of these templates can be found in application data folder of Precision Helper product (in Templates subfolder).
For default installation on Windows 2000/XP it is a folder:
"C:\Documents and Settings\%UserName%\AppData\Precision\precisionhelper\Templates\"
For default installation on Windows Vista (and newer) it is a folder:
"C:\Users\%UserName%\AppData\Roaming\Precision\precisionhelper\Templates\"
Each template must be located in separate folder and the folder name must have a proper language identifier as an extension (i.e. "test.en", "test.cs", etc.). The template definition file must have a "WebHelp.ini" name. Definition file syntax is simple and is included in Precision Helper template examples. So, if you want to create your own templates, study the definition files in installed examples.
The rest of the template may comprise any files you want to use in your online help - ie. html, xml, xslt, css, js files, etc.
In Precision Helper, there is a special template included, to create so-called single html document. This template is usefull to create a document, that can be opened in some text editors and especially that can be converted (or virtually printed) to Adobe PDF document format.
Additional functions in WebHelp templates
Standard WebHelp template and Standard WebHelp template (synchronized topics and TOC) implements the following additional features:
- Automatic highlighting of searched terms
- Automatic synchronization of displayed topic and the contents tree
-
Direct navigation to desired topic from an external application.
So, although the WebHelp is designed with HTML frames, you can refer directly to desired topic by using the simple url syntax like:
"c:\webhelp\index.htm#mytopic.htm",
"c:\webhelp\index.htm#topics/mytopic.htm",
"http://www.mysite.com/webhelp/index.php#mytopic.htm", apod.
Link to the help topic has to be placed after the # (sharp) sign.