8.5.1 Linking Your Help Files

By default, only the About box is available from the User Agent's Help menu. You can add your own HTML guide to the menu by adding entries to a configuration file. You can make help files available in either of these ways:

The HTML files can include links to other pages, either to other pages stored locally, or to remote Web sites. Note, however, that advanced HTML features such as JavaScript will be ignored. If you want to show the user the structure of the guide, you can provide an HHC file as a table of contents. Refer to 8.5.2 Building a Table of Contents for further details.

The configuration file directives for the help menu are described in full under 8.4.13 Help Directives. Below are some examples of possible sets of directives.

The following entry will create a Help menu entry that when selected will display the local file {current directory}\lib\userhelp\upload\about.html.

 

#

# Example 1 – a single local help file.

#

help.menu.001=About Upload

help.file.001=upload/about.html

 

The following entry will create a Help menu entry that when selected will display the table contents specified by the content.hhc file. If no 'help.content.start' directive is specified then the starting page will be the root level document.

 

#

# Example 2 – a local guide with a table of contents

#

help.menu.002=Upload Help

help.keystroke.002=F2

help.content.002=upload/content.hhc

# help.content.start.002=misc.html

#

 

The following entry will create a Help menu entry that when selected will display the remote resource.

 

#

# Example 3 – a single help file from a Web server

#

help.menu.003=Latest Information

help.url.003=http://www.mycompany.com/info.html