5 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-UIX and OHW-RC).

This chapter includes the following sections:

• Section 5.1, "Overview of Oracle Help File Formats"

• Section 5.2, "File Name Extensions"

5.1 Overview of Oracle Help File Formats

The following help file formats are supported by OHJ, OHW-RC, and OHW-UIX.

• Metadata files provide information about the structure and operation of the help system. For more information, see Chapter 6, "Metadata Files".

• Help information files contain information about the content of the help system. For more information, see Chapter 7, "Help Information Files".

• Topic files are the HTML files containing the content for the help system. For more information, see Chapter 8, "Topic Files".

In addition to the above files, OHW-UIX and OHW-RC use a configuration file to configure the servlet file. For more information, see Chapter 9, "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".

5.2 File Name Extensions

When you use helpsets, you don't 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 5-1 shows conventional (but not required) extensions for the helpset-related file formats. It also shows where these files are referenced, so you can be sure that the correct name and extension are used.

Table 5-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-RC and OHW-UIX, 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>