For routines which are not documented in an HTML manual (for example
personal or library routines), the source code itself is used as help
text. If the requested information can be found in a (more or less)
standard DocLib file header, IDLWAVE shows the header (scrolling down to
a keyword, if appropriate). Otherwise the routine definition statement
function) is shown. The doclib header sections which
are searched for include ‘NAME’ and ‘KEYWORDS’. Localization
support can be added by customizing the
Help is also available for class structure tags (
generic structure tags, if structure tag completion is enabled
(see Structure Tag Completion). This is implemented by visiting the
tag within the class or structure definition source itself. Help is not
available on built-in system class tags.
The help window is normally displayed in the same frame, but can be popped-up in a separate frame. The following commands can be used to navigate inside the help system for source files:
|<SPACE>||Scroll forward one page.
|<RET>||Scroll forward one line.
|<DEL>||Scroll back one page.
|h||Jump to DocLib Header of the routine whose source is displayed
|H||Jump to the first DocLib Header in the file.
|. (Dot)||Jump back and forth between the routine definition (the
|F||Fontify the buffer like source code. See the variable |
|q||Kill the help window.
nilmeans use a separate frame for Online Help if possible.
The frame parameters for the special Online Help frame.
nilmeans fontify source code displayed as help.
nilmeans try to find help in routine header when displaying source file.
The case-insensitive heading word in doclib headers to locate the name section. Can be a regexp, e.g.,