Download ADK User`s Manual (Includes Tecplot GUI Builder)

Chapter 17. Adding Online Help to Your Add-on
}
TecUtilLockFinish(AddonID);
Where MyAddOn/file.htm is the path of the HTML file to be displayed. Typically this will
be named index.htm, but this is not required. Note that by default, Tecplot will prefix
<TEC100HOME>/help/ to the file name, so you only specify the path below the Tecplot
Help directory. Alternatively, you can always use an absolute path to your HTML file, like
C:\MyDir\index.htm.
We highly recommend, however, that you install your help files in Tecplot's help directory.
17.4. Using the TecUtilHelp Function
When TecUtilHelp is called with an HTML (either a local HTML file or a valid URL), the
HTML file is displayed using the default browser installed on the system.
In Windows, the default browser is located for you automatically using the system registry;
there is no additional setup needed.
On UNIX systems, you must specify the command which runs your browser by placing the
following line in the Tecplot configuration file (tecplot.cfg):
$!Interface UnixBrowserLaunchCmd = <string>
where <string> is the command you would type at the command prompt to launch the
browser. You must use the @ symbol to mark the location where the URL or filename should
be placed, as shown in the following example:
$!Interface UnixBrowserLaunchCmd = “\usr\bin\netscape @”
You may use any valid HTTP syntax for the HTML file name, as long as it is accepted by the
selected browser at the command line. For example, you may use special characters such as the
octothorp (#) symbol to specify a particular location in the file.
For complete details on using TecUtilHelp, refer to the ADK Online Reference.
126