13
Introduction to Oracle Help for Java Developers Kit 13-1
13
Introduction to Oracle Help for Java Developers Kit
The Oracle Help for Java Developers Kit OHJDK is a set of Java components and an API for developing and displaying HTML-based help content in a Java environment.
It includes the Oracle Help for Java OHJ engine and additional tools necessary for implementing context-sensitive help in Java applets and applications.
The Oracle Help for Java engine is a full-featured Java-based help system for Java applications and applets. It provides pure Java components for navigating and
displaying context-sensitive help. Oracle Help for Java is available for free, and may be redistributed as the help system for your application see the license distributed with
the release.
Oracle Help for Java supports help content in several file formats, including extensions of the Sun Microsystems JavaHelp and Microsofts HTML Help standards. If you are
authoring help content without using a help authoring tool, it will be helpful to read Oracle Help File Formats. If you are using a third party help authoring system that
supports OHJ, refer to the documentation provided.
13.1 Oracle Help for Java Runtime in JDeveloper
The Oracle Help for Java runtime library, ohj.jar, is distributed as part of JDeveloper. Developers integrating Oracle Help for Java with their applications can
modify their project settings to add the Oracle Help for Java library as a dependency. The full Oracle Help for Java release including sample code, helpset authoring wizard,
indexer, and demos is available at no cost from the Oracle Technology Network
http:www.oracle.comtechnologyindex.html under Oracle Help
Technologies.
13.2 Getting Started with the OHJDK
The Oracle Help for Java Developers Kit OHJDK is a set of Java components and an API for developing and displaying HTML-based help content in a Java environment.
It includes the Oracle Help for Java OHJ engine and additional tools necessary for implementing context-sensitive help in Java applets and applications.
This section describes the contents of the OHJDK and tells how to set up for developing OHJ help systems. It contains the following subsections:
■
Section 13.2.1, Installing OHJDK
■
Section 13.2.2, Contents of an OHJDK Release
■
Section 13.2.3, Setting the Java CLASSPATH for OHJDK Development
13-2 Oracle Fusion Middleware Developers Guide for Oracle Help
13.2.1 Installing OHJDK
The following steps describe OHJDK installation process:
■
Download the latest Oracle Help for Java Developer’s Kit from OTN. For Windows, you may download the Windows executable file or Executable JAR file.
For Solaris or UNIX, download the binary file.
■
In Windows, double click the Windows executable file or executable JAR file to start the installation wizard. By default, the OHJDK is installed at C:\Program
Files\ohelp location. For Solaris and UNIX, run the binary file to start the installation wizard.
■
Open the install folder and verify the files as described in Section 13.2.2, Contents
of an OHJDK Release .
13.2.2 Contents of an OHJDK Release
The OHJDK includes the compiled libraries for the OHJ engine as well as libraries for the authoring tools and demonstrations. These libraries are distributed in JAR Java
ARchive format. The OHJDK also includes documentation, including this document.
The files are discussed in the following sections:
■
Section 13.2.2.1, OHJ Engine
■
Section 13.2.2.2, Authoring Tools
■
Section 13.2.2.3, Demonstration Files
■
Section 13.2.2.4, Documentation
13.2.2.1 OHJ Engine
These files contain binary files for the OHJ engine implementation and its dependencies. You must redistribute these files with your product application.
13.2.2.2 Authoring Tools
The following JAR files contain the implementation for the Helpset Authoring Wizard and the Text Search Indexer. These files are not intended for distribution with your
product application.
Table 13–1 OHJ Binaries
File Contents
helpversion_num.jar The help engine optimized binaries.
oracle_ice.jar Oracles customized version of the ICEbrowser from ICEsoft
Technologies, Inc. The OHJ engine uses the ICEbrowser for displaying HTML topics.
Table 13–2 OHJ Authoring Tools
File Contents
helpwizard-version_ num
.jar Helpset Authoring Wizard implementation. Authors can run the
Helpset Authoring Wizard using batch files created in the bin directory of their OHJDK installation.
helpindexer-version_ num
.jar OHJ Text Search Indexer implementation. Authors can use the
Full-Text Search Indexer to process and create Oracle Help search index .idx files.
