ITT Rule IDL Version 7.0 User Manual download pdf (Page 49)

Chapter 2: iTool System Architecture 49

iTool Developer’s Guide System Resources

MyVisType.html

to describe it. In order to display your HTML file when the user

selects a

MyVisType visualization and selects Help → Help on Selected Item, you

would do something like the following:

1. Install the

MyVisType.html file somewhere. Installing the file in the same

directory as the

MyVisType__define.pro and other associated iTool files

would be a reasonable choice, and for the purposes of this example we assume

this is the location of the file. In addition, suppose that you create this directory

myvistype at the same level as the itt directory that contains the IDL

hierarchy.

2. Copy the

<IDL_DIR>/help/template_help.xml file to the same directory

as the

MyVisType.html file and rename it. The exact name does not matter,

as long as the filename matches the pattern

*help.xml. We’ll assume the file

is named

MyVisType_help.xml.

3. Copy the

<IDL_DIR>/help/itools.xsd file to the same directory as the

MyVisType.html file.

4. Edit the

MyVisType_help.xml file to contain topic information for your

help file. The

<Topic> element would look like:

<Topic>

<Keyword>MyVisType</Keyword>

</Topic>

5. Ensure that the directory that includes the MyVisType files is included in

IDL’s help path. (You may already be adding this directory to IDL’s search

path.) Since you have created your

myvistype directory at the same level as

the

itt directory, you could use IDL code that looks like this:

idldir=EXPAND_PATH('<IDL_DIR>')

myVisDir=idldir + PATH_SEP() + '..' + PATH_SEP() + '..' + $

PATH_SEP() + 'myvistype'

!HELP_PATH = !HELP_PATH + PATH_SEP(/SEARCH) + myVisDir

You might include this code block in the myvistype__define.pro file, to

ensure that the help path is set correctly when your visualization type is in use.

With this preparation, a user who displayed a visualization of type

MyVisType could

select the visualization and then select Help → Help on Selected Item to display

your

MyVisType.html file in the default web browser.

Providing help content using the IDL Assistant help viewer, a PDF file, or any other

supported help content format would follow the same procedure, with adjustments

for the help file type in the

MyVisType_help.xml file.

1 2 ... 44 45 46 47 48 49 50 51 52 53 54 ... 429 430

Comments to this Manuals

No comments

ITT Rule IDL Version 7.0 User Manual Page 49

Comments to this Manuals