This class implements help via an external browser.
It requires the name of a directory containing the documentation and a file mapping numerical Section numbers to relative URLS.
The map file contains two or three fields per line: numeric_id relative_URL [; comment/documentation]
The numeric_id is the id used to look up the entry in DisplaySection/DisplayBlock(). The relative_URL is a filename of an html file, relative to the help directory. The optional comment/documentation field (after a ‘;’) is used for keyword searches, so some meaningful text here does not hurt. If the documentation itself contains a ‘;’, only the part before that will be displayed in the listbox, but all of it used for search.
Lines starting with ‘;’ will be ignored.
See also
HelpController
__init__ | |
DisplayBlock | Display help for URL (using DisplayHelp) or keyword (using KeywordSearch). |
DisplayContents | Display list of all help entries. |
DisplayHelp | Call the browser using a relative URL. |
DisplaySection | Display help for id sectionNo. |
GetFrameParameters | Obtains the latest settings used by the help frame and the help frame. |
Initialize | This must be called to tell the controller where to find the documentation. |
KeywordSearch | Search comment/documentation fields in map file and present a list to chose from. |
LoadFile | If file is “”, reloads file given in Initialize. |
OnQuit | Does nothing. |
Quit | Does nothing. |
SetFrameParameters | Allows one to override the default settings for the help frame. |
SetViewer | Tell it which browser to use. |
This class implements help via an external browser.
Possible constructors:
ExtHelpController(parentWindow=None)
Display help for URL (using DisplayHelp) or keyword (using KeywordSearch).
Parameters: | blockNo (long) – |
---|---|
Return type: | bool |
Returns: | True on success |
Display list of all help entries.
Return type: | bool |
---|---|
Returns: | True on success |
Call the browser using a relative URL.
Parameters: | relativeURL (string) – |
---|---|
Return type: | bool |
Overloaded Implementations:
DisplaySection (self, sectionNo)
Display help for id sectionNo.
Parameters: | sectionNo (int) – |
---|---|
Return type: | bool |
Returns: | True on success |
DisplaySection (self, section)
Display help for id sectionNo – identical with DisplaySection .
Parameters: | section (string) – |
---|---|
Return type: | bool |
Returns: | True on success |
Obtains the latest settings used by the help frame and the help frame.
Parameters: | |
---|---|
Return type: |
This must be called to tell the controller where to find the documentation.
If a locale is set, look in file/localename, i.e. If passed “/usr/local/myapp/help” and the current Locale is set to be “de”, then look in “/usr/local/myapp/help/de/” first and fall back to “/usr/local/myapp/help” if that doesn’t exist.
Parameters: | dir (string) – directory name where to fine the help files |
---|---|
Return type: | bool |
Returns: | True on success |
Search comment/documentation fields in map file and present a list to chose from.
Parameters: |
|
---|---|
Return type: | bool |
Returns: | True on success |
If file is “”, reloads file given in Initialize.
Parameters: | file (string) – Name of help directory. |
---|---|
Return type: | bool |
Returns: | True on success |
Does nothing.
Does nothing.
Return type: | bool |
---|
Allows one to override the default settings for the help frame.
Parameters: |
---|
Tell it which browser to use.
The Netscape support will check whether Netscape is already running (by looking at the .netscape/lock file in the user’s home directory) and tell it to load the page into the existing window.
Parameters: |
|
---|