46 Chapter 2: iTool System Architecture
System Resources iTool Developer’s Guide
Note
You must also copy the file
<IDL_DIR>/help/itools.xsd into your help
directory.
See “Example: Help Topic for MyVisType” on page 48 for an example outlining the
process of creating a help topic for a user-created iTool component.
Format of Help Entries
The format for a help entry in the *help.xml file is:
<Topic>
<Keyword>
helpKeyword
</Keyword>
<Link type="IDLHELP" book="
adpFile
">
fileName
</Link>
<Link type="MSHTMLHELP" book="
chmFile
">
contextNumber
</Link>
<Link type="PDF" book="
pdfFile
"></Link>
<Link type="HTML" book="
htmlFile
">
htmlAnchor
</Link>
<Link type="TEXT">
path_to_textFile
</Link>
</Topic>
Where:
The value of the
<Keyword> element is the iTool object class name of the selected
object. There can be multiple
<Keyword> elements for a given <Topic>, but they
must all precede any
<Link> element. There must be at least one <Link> element
for a given
<Topic>.
Note
All strings are case sensitive. “Book” is not the same as “book”.
The
type attribute of the <Link> element defines the type of help viewer to be
invoked. The allowed values for the
type attribute are:
Link type Meaning
IDLHELP Use the default IDL online help viewer application.
MSHTMLHELP Use the Microsoft Windows HTML Help viewer application.
PDF Use the system default PDF file viewer application.
HTML Use the system default web browser.
TEXT Use the IDL XDISPLAYFILE procedure.
Table 2-2: Help Topic Link Types
