9.0

281
active Dragon NaturallySpeaking Help folder. If the file is not found there, the
normal HTML Help file search rules apply.
topic The specific HTML topic to display. If the compiled help uses subdirectories, this
parameter must include the subdirectory. For example, this topic is
scrptref/htmlhelp.htm. Note that the identifier uses a forward slash (/).
window The name of the window in which to display the HTML Help, for example, main. This
parameter is always optional.
HH_DISPLAY_TOPIC
HTMLHelp "helpFile[>window]", "HH_DISPLAY_TOPIC", "topic"
Opens the specified topic.
HH_DISPLAY_TOC
HTMLHelp "helpFile[::/topic][>window]", "HH_DISPLAY_TOC"
Displays the Table of Contents navigation pane and opens the specified topic, if any.
HH_DISPLAY_INDEX
HTMLHelp "helpFile[::/topic][>window]", "HH_DISPLAY_INDEX", "[indexSearchText]"
Displays the Index navigation pane and enters the indexSearchText string, if any, in the keyword field.
HH_HELP_CONTEXT
HTMLHelp "helpFile[>window]", "HH_HELP_CONTEXT", "ContextId"
Displays the Help topic for the specified contextId in the specified window. The contextId must be the numeric ID
in the [MAP] section of the Help project (.hhp) file for the topic to display.
HH_CLOSE_ALL
HTMLHelp "", "HH_CLOSE_ALL"
Closes all HTML Help Windows opened by this program. The first argument must be an empty pair of double
quotes.
Examples
HH_DISPLAY_TOC
This instruction opens dragon_enx.chm in the default window, displays the Contents tab in the navigation pane,
and displays the htmlhelp.htm topic (this topic) in the topic pane.
HTMLHelp "dragon_enx.chm::/scrptref/htmlhelp.htm, "HH_DISPLAY_TOC"
HH_HELP_CONTEXT
This instruction opens MyProg.chm in a Help window named "HiddenNav" and displays the topic with the context
ID 133096 (Hex 207E8).
HTMLHelp "C:\\MyProg\Help\MyProg.chm>HiddenNav", "HH_HELP_CONTEXT", "133096"
Notes
• Dragon NaturallySpeaking does not get error returns from the HTML Help engine. As a result, it cannot
display any messages when an HTML Help error occurs.
• If the HTML Help file name does not use an absolute path, The HTMLHelp command first checks in the Dragon
NaturallySpeaking Help directory for the requested help file. If the file is not found, the he normal HTML Help
file search rules apply.