Providing online Help for developers
Two ways to provide Help
There are two ways to integrate online Help for your user-defined
functions, user events, and user objects into the PowerBuilder development
- The User
button in the PowerBuilder main Help window is hardcoded to launch
a file named PBUSR70.HLP:
- Context-sensitive Help for user-defined functions can be displayed when you select
the function name in the Script view (or places the cursor in the
function name) and press shift + f1.
How context-sensitive Help
for user-defined functions works
When you select the name of a function or place the cursor
in the function name in the Script view and press shift + f1:
- PowerBuilder looks
for the standard prefix (the default is uf_) in the function
- If the standard prefix is found, PowerBuilder looks
for the Help topic in the Help file containing your user-defined
function Help topics (instead of looking in PBHLP70.HLP, its own
main Help file). The default filename for Help on user-defined functions
PowerBuilder determines the name of the Help file to look
in by reading the UserHelpFile variable in PB.INI. For information
on changing the value of this variable, see “Advanced procedures”.
- If PowerBuilder finds the variable, it looks in
the specified Help file for the name of the selected function. If
there is no UserHelpFile variable in PB.INI, PowerBuilder looks
for the keyword in the PBUSR70.HLP file in the PowerBuilder Help
If you work within the PowerBuilder defaults, you must:
- Compile all of your
online Help for your user-defined functions, user events, and user
objects into a single file named PBUSR70.HLP.
You can optionally provide a contents file, which must be
- Prefix the name of each user-defined function you
create with uf_ (for example, uf_calculate)
Here are details on how to build online Help into the PowerBuilder environment.
To launch online Help for PowerBuilder developers
from the User button:
Create your online Help file using Microsoft
Word and the Microsoft Help Workshop or other Help authoring tool.
Rename the PBUSR70.HLP and PBUSR70.CNT files that
were installed with PowerBuilder. Be sure to rename the original
PBUSR70.CNT file even if you do not provide your own contents file.
Save the compiled Help file and optional contents
file in your PowerBuilder Help directory. Make sure your Help file
is named PBUSR70.HLP and your contents file is named PBUSR70.CNT.
Your Help file will display when you click the User button.
To create context-sensitive Help for user-defined
When you create a user-defined function,
give the name of the function a standard prefix. The default prefix
is uf_ (for example, uf_calculate).
For each user-defined function Help topic, assign
a search keyword (a K footnote entry) identical to the function
For example, in the Help topic for the user-defined function
uf_CutBait, create a keyword footnote uf_CutBait.
PowerBuilder uses the keyword to locate the correct topic to display
in the Help window.
Compile the Help file and save it in the PowerBuilder
You can specify a different filename for context-sensitive
Help by changing the value of the UserHelpFile variable in your
PB.INI file. To use the variable, your Help file must be in the
PowerBuilder Help directory.
To specify a different
filename for context-sensitive Help:
- Open your PB.INI file in a text editor.
In the [PB] section, add a UserHelpFile
variable, specifying the name of the Help file that contains your
context-sensitive topics. The format of the variable is:PowerBuilder1<b>UserHelpFile </b>= <i>helpfile.hlp</i>
Specify only the filename. A full pathname designation will
not be recognized.
You can prefix your user-defined functions with a standard
prefix other than the default uf_ prefix. You define the
prefix you want to use by entering the UserHelpPrefix variable in
your PB.INI file.
To use a different prefix for user-defined functions:
- Open your PB.INI file in a text editor.
In the [PB] section, add a UserHelpPrefix
variable, specifying the value of your prefix. Use this format:PowerBuilder1<b>UserHelpPrefix </b>=<i> yourprefix_</i>
The prefix you provide must end with the underscore character.