Open Perl IDE - User Manual
6 Help System
This section explains the concepts of the highly configurable Open Perl IDE help system.
6.1 Help Configuration
The complete help data consists of several main help topics. Each main help topic has a descriptive title, is associated with a base directory and
These main help topics can be configured on the "Preferences | Help" page as follows:
Figure: Use the popup menu to setup the main help topics
6.2 Help windows: Contents, Index and Viewer
You can open help windows by choosing Contents or Index from the Help Menu, by choosing "Help windows" from the Windows menu or by pressing F1 from within an editor window.
Hint: Pressing the ESC-Key in a Help window always switches the focus back to the previous control.
All help windows are dockable windows. However, the following screenshot shows the Help Contents window in floating state as a stand alone window.
Figure: Help Contents
In the contents tree, Shell Links are automatically resolved to the source document. So it is possible to create an independent contents organization containing shortcuts to the original files.
The next screenshot shows a typical help viewer, if the Perl command "print" has been typed into an editor window and after that F1 has been pressed.
Figure: Help Index and Viewer
The keyword index is automatically rebuilt, if the help configuration has been changed.
Figure: Keyword index generation
6.3 Help System Internals
The keyword index generation consists of several steps:
For each main topic
See the Open Perl IDE Software Design Specification for further information.