Tornado API Reference : GUI Tcl Library (UNIX)
windHelpLib [unix] - Tornado help Tcl library
windHelpInit - initialises the help data base
windHelpDisplay - displays specified link in a web browser
windHelpDocDirGet - gets the current doc directory
windHelpDocDirSet - sets the current doc directory
windHelpEntryLookup - gets the entry number in entry names list
windHelpIndexGet - gets the current complete help index
windHelpLinkGet - gets the helpTopic hyper link
windHelpListGet - gets the list of help entries
This library contains all the Wind River Systems help related procedures. Those procedures allow to easily access to the Wind River Systems HTML reference help
fileLib.tcl htmlLib.tcl
- docDir/INDEX.WRS
- This is the raw text file containing the whole WRS help data base. Its location is docDir. See windHelpDocDirGet for more details.
- docDir/TREE.WRS
- This file is a raw text file that contains a description of the WRS help tree as given to a controlValuesSet function. See windHelpDocDirGet for more informations on docDir
windHelpInit - initialises the help data base
windHelpInit [inDir]
This routine populates the help data base list with entries got from the LIB and RTN files from the inDir directory.
inDir default value is set to windHelpDocDirGet. If inDir is specified, a windHelpDocDirSet is proceeded with path argument set to inDir. Thus, all new calls to windHelpLib procedures will refer to that directory for doc directory
inDir - docs subdirectory to look LIB and RTN files in
N/A
N/A
windHelpDisplay - displays specified link in a web browser
windHelpDisplay helpLink [-usetarget | -notarget]
This routine displays in a navigator the specified helpLink.
The default value for option is set to -usetarget
helpLink - the link to the file to display in the browser option - either -usetarget or -notarget for calling targetted URL or not
When htmlBrowser is iexplore 3.0 or less, calling for an URL that contains a target (URLName#targetName) fails. The iexplore 3.0 doesn't support call of targeted URL. As far as it is the only browser (Netscape Navigator, Netscape Communicator and iexplore 4.0 do support targetted URL calls), it is the users responsibility to get rid of the target by using the -noanchor option if he uses iexplore 3.0 (or any other browser that doesn't support targetted URL calls)
The execution status. First member of returned list is OK or ERROR. On ERROR, the remaining members of list are the error messages.
N/A
windHelpDocDirGet - gets the current doc directory
windHelpDocDirGet
This procedure returns the path to the currently used doc directory. This directory must be set through windHelpInit, or through windHelpDocDirSet
Its default value is set to wtxPath/docs
N/A
N/A
windHelpDocDirSet - sets the current doc directory
windHelpDocDirSet path
This procedure sets the path to the doc directory to be used. After that setting, all the help entries reachable through windHelpListGet or through windHelpLinkGet procedures, will be those visible from the path directory.
If operation failed (see ERRORS), then the docDirectory keeps its original value.
path - the path to set the doc directory
a list which first element is OK or ERROR. On ERROR, the remaining elements of list ar the error codes.
on error, the first element of the returned list is ERROR, next elements are error codes. The following error codes may happen :
- PATH_IS_NOT_DIR
- the specified path is not a directory
- PATH_IS_NOT_READABLE
- the specified path is not a readable directory
- PATH_DOESNT_EXIST
- the specified path does not exist
windHelpEntryLookup - gets the entry number in entry names list
windHelpEntryLookup rule entryPattern entryNameList
This procedure looks up for the help entry value, and selects the closer help topic index (alphabeticaly speaking).
rule should be set to either -exact or to -regexp.
If set to -exact, then the entryPattern must be the exact match in entryNameList
If set to -regexp, lookup is done through a regexp that begins with the given entryPattern, and then, any other character. The first occurrence is then returned.
rule - the rule to lookup for entryPattern pattern entryPattern - the help pattern to look for in entryNameList entryNameList - list of entry names in which to look for entryPattern
the index of the designed entry.
N/A
windHelpIndexGet - gets the current complete help index
windHelpIndexGet [inDir]
This procedure just reads the inDir/INDEX.WRS file in order to have a quick and complete access to the WRS reference help index.
The returned list is a list of help entries with the following format :
{ {entryName} {shortDescription} {entryLink} {bookName} {chapterName}
{category} }
- entryName
- This is the name of the help entry.
- shortDescription
- The help entry short description. Some few words to describe the entry and its use.
- entryLink
- The help entry html link. This value can directly be used through a call to windHelpDisplay.
- bookName
- The book name the help entry belongs to.
- chapterName
- The chapter name the help entry belongs to.
- category
- This parameter is to differenciate several help entries that could have the same name (for example, sysLib for several BSPs)
inDir/INDEX.WRS : this file is generated when the windHelpIndexGet procedure is called and doesn't find the INDEX.WRS file.
inDir - the directory where to read / write the INDEX.WRS file
the list of available help entries or {} if INDEX.WRS is not readable
N/A
windHelpLinkGet - gets the helpTopic hyper link
windHelpLinkGet rule helpTopic [keyWords]
According to the rule parameter, this routine gets the list of hyperlinks the helpTopic refers to.
If rule is set to -name, the result should be empty or unique. If set to -desc, it returns all the hyperlinks that have descriptions matching helpTopic
rule - retreiving rule helpTopic - the help topic to look for keyword - a pipe separated list of kewords to look for in order to make the # help research more precise.
The list of links or {} if no links found
N/A
windHelpListGet - gets the list of help entries
windHelpListGet [type]
This routine returns the list of help entries according to the type parameter. This allow to get a list of the entries name / link / desc or all of them. If type is set to all, then a list of help entries is returned. Those help entries are made of : name, description, extracted link, book name, chapter name and category name. Default type is set to all.
type - the returned help entry type [desc link name all]
The list of asked type(s) or {} if none
N/A