Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle Help
11g Release 2 (11.1.2.3.0)

Part Number E16280-04
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

4 Introduction to Oracle Help File Formats

This chapter describes the various file formats (such as metadata files, information files, and topic files) used by Oracle Help for Java (OHJ) and Oracle Help for the Web (OHW).

This chapter includes the following sections:

4.1 About Oracle Help File Formats

Oracle Help for Java (OHJ) and Oracle Help for the Web (OHW) both use the following kinds of files:

In addition to the above files, OHW uses a configuration file to configure the servlet filter. For more information, see Chapter 8, "Oracle Help for the Web Configuration File".

The Oracle Help file formats are based on the JavaHelp™ specification. For more information about differences between Java Help and Oracle Help file formats, see Appendix A, "Oracle Help and JavaHelp File Formats".

4.2 File Name Extensions

When you use helpsets, you do not have to use specific extensions for the names of the associated control files, but you must ensure that the correct file name and extensions are used when the file is referenced.

Table 4-1 shows conventional (but not required) extensions for the helpset-related file formats. It also shows where these files are referenced, so you ensure that the correct name and extension are used.

Table 4-1 OHJ and OHW Files

Type of File Conventional Extension Referenced By

Helpset

.hs

In OHJ, the calls from the Java program that launches the help.

In OHW, from the configuration file:

<books>
  <helpSet location="filename.hs" />
</books>

Helpset used as a subhelpset

.hs

Master helpset file in

<subhelpset location="filename.hs"/> 

Map

.xml

Helpset file in

<maps>
  <mapref>filename.xml</mapref>
</maps>

TOC

.xml

Helpset file in

<maps>
<view>
  <data engine="oracle.help.engine.XMLTOCEngine">filename.xml</data>
</view>

Keyword Index

.xml

Helpset file in

<view>
  <data engine="oracle.help.engine.XMLIndexEngine">filename.xml</data>
</view>

Link

.xml

Helpset file in

<links>
  <linkref>filename.xml</linkref>
</links>

Search Index

.idx

Helpset file in

<view>
  <data engine="oracle.help.engine.SeearchEngine">filename.idx</data>
</view>