|Oracle® Fusion Middleware Developer's Guide for Oracle Help
11g Release 1 (5.0)
Part Number E14149-01
Older versions of OHJ used a helpbook file and a
HelpBook object. Helpbooks are still supported in current versions of OHJ; however, it is preferable in current versions to use helpsets (helpset file and
If you are still using helpbook file and object, and do not wish to use helpsets, the following sections provide helpbook specific information.
If you are using helpbooks, you must ensure that file name and extensions are correct. OHJ and OHW look in a specified directory for files with file name extensions that correspond to the supported file formats, including TOC, TOK, HHC, HHK, OHT, and IDX. For more information about correct file name and extansions, see Section 5.1, "File Name Extensions"
When you use helpsets, you don't have to use specific extensions for the names of the associated control files.
If you want to add a helpbook in OHJ, you must first create a
Help object. For more information, see Section 14.2, "Constructing the Help Object".
Note:When an OHJ system is implemented using a HelpBook, the map file must use the OHT file format. HelpBooks and OHT files are legacies from early versions of OHJ and are no longer recommended, but they are still supported by OHJ. For more information about the map file, see Section 6.2, "Map Files".
After creating a
Help object, you must add one or more
Book objects to it. A
Book object encapsulates a collection, or a book of help content.
HelpBook book implementation handles legacy OHJ file formats. The HelpBook class examines a directory, identifies files with known extensions, and adds them to the help system.
The following sections describe how to add the helpbooks, and other optional features:
For more information, see the API documentation for
HelpBook format is directory based. Use its constructors to specify the location of the directory containing the help content (HTML topic files).
Table C-1 HelpBook() Constructors
Once you have constructed a
Book instance using the HelpBook or
HelpSet constructors, you must add the
Book to your
Help instance. This is accomplished by calling the following method on the
Table C-2 addBook() Constructors
This method adds a
For more information on configuration file, see Chapter 9, "Oracle Help for the Web Configuration File".
<books> element specifies the content to be displayed in Oracle Help for the Web. The
<books> element can contain any number of helpbooks, or a combination of helpsets and helpbooks. Helpsets and helpbooks are also called as books.
Table C-3 describes the
<helpbook> child element:
Table C-3 <books> Child Elements
The helpbook to include in this instance of OHW. This element has the following attributes:
<books> <helpBook id="disco" baseName="discoverer" location="discoverer/" title="Discoverer Help" /> </books>
<helpbook> elements can contain zero or more
<contentLocation> elements for situation when help topic files are located in locations other than those expected by Oracle Help.
For more information about other child elements of
<books>, see Section 9.3.1, "<books> Child Elements".
In helpbooks, OHW processes help topic HTML files:
in the helpbook base directory and subdirectories under that location
or if the helpbook is in a JAR file, all help topic files in the same JAR
If you have help topic files in some other location, you must use the
<contentLocation> element to point to that location.
<contentLocation> element has the attribute
baseURI. It represents a URI to the root location of a set of help content, using a path that is either absolute or relative.
<contentLocation> element can be a child of
A <helpbook> can contain zero or more
This element is needed because, unlike plain HTML files, Oracle Help help topic files must be processed by the servlet in order to be displayed. Therefore, it is necessary to explicitly list the locations where help topic files referenced in the helpbook reside, if they are not in the default locations. This can happen if your helpset includes a subhelpset in another location or even on another web server or if your context sensitive map file contains references to help topic files located elsewhere on the same server or on a different server.
For more information, see Section 9.3.2, "The <contentLocation> Element".