HELP Mnemonic - Access HTML and Java Help
BBj-Specific Information
For this topics original documentation, see the HELP
Mnemonic - Access WinHelp.
In BBj, the HELP mnemonic uses the platform independent system found in
JavaHelp, an HTML-based Help technology. This change means that BBj developers
can provide online help directly from their applications and have it available
(and appear the same) regardless of the platform.
|
Parameter |
Description |
|
helpfile$ |
The JavaHelp (.hs) Help Set file. The BBj CLASSPATH references the .hs file's location. This file can exist either as a standalone in a directory or in an archive along with the supporting Java Help files within a compressed .jar file. BBj must be able to locate this file and all the associated Help files via the CLASSPATH. |
The HELP_CONTEXT, HELP_CONTEXTPOPUP, HELP_FINDER, and HELP_SETCONTENTS commands are supported.
|
helpcmd |
Value |
Description |
cmdparam Parameter |
|
HELP_CONTEXT |
2 |
Displays the topic identified by the specified topic ID in the help set's map file. A string value that references the topic ID as defined by the target="…" parameter for the desired mapID. |
The topic ID (recommended) or the HTML file that contains the topic. |
|
HELP_CONTEXTPOPUP |
4 |
Displays the topic identified by the specified topic ID in the help set's map file in a pop-up window. |
The topic ID (recommended) or the HTML file that contains the topic. |
|
HELP_FINDER |
5 |
Displays the Help Topics dialog box starting at the first topic. |
N/A. |
|
HELP_SETCONTENTS |
10 |
Specifies the default topic to be displayed if the table of contents entry does not exist. |
The topic ID (recommended) or the HTML file that contains the Contents topic. |
JavaHelp Overview
With BBj, the best way to create online help for an application is to create a JavaHelp project. JavaHelp projects can be created manually or by using a help-authoring tool. The purpose of this section is to give the developer a brief overview of the JavaHelp specification, and a starting point for creating JavaHelp projects that can be accessed from a BBj application.
JavaHelp Project Structure
A JavaHelp project consists of a combination of XML and HTML files.
HTML files contain the actual content for each topic in the help system,
and the instructions for formatting and displaying of the content. The
XML files contain information that tells the help system how the information
is organized such as how topic ID's are mapped to HTML files, the table
of contents structure, and the index topics.
There are several files that are used by the help system to set up the
mapping of the table of contents to topics, and topics to HTML content
files. These files are briefly described here, however, it is recommended
that help authors consult the JavaHelp User's Guide (http://java.sun.com)
and the documentation for the help authoring tool (if one is being used)
for complete details on the use, format, and purpose of each component
of a JavaHelp project.
Help Set File
This file (usually called ProjectName.hs) is an XML file that contains the features that the user can use to select help from such as the table of contents, index, and keyword search. This file maps these features to an XML file where the information structure is specified in detail, as explained in the Table of Contents File and Index File paragraphs below.
Map File
The map file (usually called Map.jhm or Map.xml) contains the mappings between topic ID's and the HTML file that should be displayed when the ID is requested. It is strongly recommended that all references from applications be made to the topic ID rather than the HTML file directly because it makes it possible to change the topic's HTML file name or location without changing any of the application's code.
Table of Contents File
The table of contents file is an XML file which contains a hierarchical definition of the table of contents. Each table of contents item has a topic ID that is associated with it. When the user selects an item from the table of contents, the associated topic is displayed in the contents pane.
Index File
The index is an XML file which contains a hierarchical definition of the index items. Each index item has a topic ID that is associated with it. When the user selects an item from the index, the associated topic is displayed in the content pane.
HTML Files
The actual documentation itself is stored in HTML files. These are standard HTML 3.2 files that the help system uses to display each of the topics. The HTML topic files can contain images, formatted text, bulleted lists, hyperlinks, etc. Because these files use standard HTML, they can also be deployed on a website for Internet access.
Example
The following example displays the "Managing Databases" help
topic for the BBj Enterprise Manager Java Help:
0010
LET SYSGUI=UNT
0020 OPEN (SYSGUI)"X0"
0030 PRINT (SYSGUI)'WINDOW'(100,100,100,100,"Window",$$,$$)
0040 PRINT (SYSGUI)'HELP'(0,"b3odbc.hs",2,"Managing_Databases")
0050 ESCAPE