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:
The following help file formats are used by OHJ and OHW:
Metadata files provide information about the structure and operation of the help system. For more information, see Chapter 5, "Metadata Files".
Help information files contain information about the content of the help system. For more information, see Chapter 6, "Help Information Files".
Topic files are the HTML files containing the content for the help system. For more information, see Chapter 7, "Topic 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".
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.
| Type of File | Conventional Extension | Referenced By |
|---|---|---|
|
Helpset |
|
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 |
|
Master helpset file in <subhelpset location="filename.hs"/> |
|
Map |
|
Helpset file in <maps> <mapref>filename.xml</mapref> </maps> |
|
TOC |
|
Helpset file in <maps> <view> <data engine="oracle.help.engine.XMLTOCEngine">filename.xml</data> </view> |
|
Keyword Index |
|
Helpset file in <view> <data engine="oracle.help.engine.XMLIndexEngine">filename.xml</data> </view> |
|
Link |
|
Helpset file in <links> <linkref>filename.xml</linkref> </links> |
|
Search Index |
|
Helpset file in <view> <data engine="oracle.help.engine.SeearchEngine">filename.idx</data> </view> |