Contents
Previous
Next
| Oracle Help for the Web Developer's Guide | Contents | Previous | Next |
|---|
Oracle Help for the Web (OHW) is a Java servlet and therefore requires a servlet engine. When OHW is used as the help system for a web application, OHW can use the same servlet engine as the application.
This page contains the following sections:
OHW requires a servlet engine that supports the Java Servlet API version 2.0 or later, for example a recent version of the following:
The Servlet API is defined by Sun Microsystems. More information on the Servlet
API can be found on Sun's Java Servlet Technology site at the URL http://java.sun.com/products/servlet/.
None are required. The client receives only HTML, and all it requires is a web browser to display and view the OHW help content. The web browser must have JavaScript support enabled.
http://helponline.oracle.com/jdeveloper/help/.In general, help authors create the help content using the authoring tools of their choice. Help authors also create the Oracle Help control files that are needed for deploying the help content as OHW help systems. For information about the control files, see Oracle Help File Formats.
OHW administrators set up the servlet engine and OHW on the server. The basic OHW administrative tasks are:
The servlet engine must be installed and configured to support OHW. This is handled differently for each servlet engine, so consult the documentation for the servlet engine for more information.
Also see Deploying OHW on OC4J Using the Demo Bundle, Deploying OHW on OC4J Using the Deploy Bundle and Deploying OHW on Tomcat Using the Deploy Bundle.
The various files that constitute the OHW servlet--including Java class files, XML configuration files, and others--must be installed on the server, in the appropriate locations for the servlet engine. This is handled differently for each servlet engine, so consult the documentation for the servlet engine for more information.
Also see Deploying OHW on OC4J Using the Demo Bundle, Deploying OHW on OC4J Using the Deploy Bundle and Deploying OHW on Tomcat Using the Deploy Bundle.
Depending on the servlet engine, you would typically modify one to four XML configuration files to deploy OHW.
On OC4J, you need to modify the following files:
On Tomcat, you need to modify the web.xml file to configure the web modules.
More information about the XML configuration files are provided below:
server.xml: This file defines all OC4J applications. Two J2EE applications are typically required for OHW deployment: one for OHW (mandatory) and one for UIX (recommended, but optional). It also defines any *-web-site.xml files that are used for the web modules. There is only one server.xml for a running OC4J instance.
http-web-site.xml: This file maps URLs to the web modules and declares the port number that OC4J is using. A URL directed to this port number is routed to the appropriate Web site for the web module. Oracle recommends using a single *-web-site.xml file named http-web-site.xml, which contains many web module definitions. The location of http-web-site.xml is determined by server.xml, which is typically in the same directory as server.xml. The file http-web-site.xml changes frequently as web modules (product helpsets) are added or reconfigured.
application.xml: This file is a manifest of all web modules that run under a given J2EE application. It points to each web module of each product that is deployed. Oracle recommends using two instances of application.xml: 1) a relatively stable version for the UIX application (optional) and 2) a version for the OHW application that changes frequently as web modules are added or reconfigured. The name and location of the application.xml file is fixed by the J2EE standard.
web.xml: This file sets the initialization parameters for the servlet, including the location of the OHW configuration file. There is one instance for each web module. If OHW configuration files are located and named in a uniform manner, then this file should be the same for all OHW web modules.
Only one OHW configuration file is required to configure OHW itself (default file name is ohwconfig.xml). For example, you must specify which helpsets to display and how to present them. You can also specify locales, branding information, and various other settings. For information about this configuration file, see OHW Configuration File. The name and location of this file is set as a servlet initialization parameter, which is handled differently for each servlet engine. Consult the documentation for the servlet engine for more information.
Also see Deploying OHW on OC4J Using the Demo Bundle, Deploying OHW on OC4J Using the Deploy Bundle and Deploying OHW on Tomcat Using the Deploy Bundle.
The servlet engine must be started to be available to users via the web. This is handled differently for each servlet engine, so consult the documentation for the servlet engine for more information.
If you modify a helpset in an OHW installation, the servlet engine must be restarted for users to see the changes.
Also see Deploying OHW on OC4J Using the Demo Bundle, Deploying OHW on OC4J Using the Deploy Bundle and Deploying OHW on Tomcat Using the Deploy Bundle.
When new versions of OHW and UIX are released, be sure to check the OHW and UIX download pages for the latest download and install instructions before upgrading your OHW/OC4J or OHW/Tomcat installation.
To upgrade OHW to a newer version, you need to replace the OHW and UIX JAR files, and the OHW JavaScript files (distributed in ohw-install.zip).
To upgrade UIX to a newer version, you need to replace the UIX installable resource files (distributed in uix2-install.zip).
Also see Deploying OHW on OC4J Using the Deploy Bundle and Deploying OHW on Tomcat Using the Deploy Bundle.
Copyright © 1996, 2004, Oracle. All rights reserved.