Oracle Help File Formats	Contents	Previous	Next

Comparison to JavaHelp File Formats

The Oracle Help file formats are based on the Sun Microsystems JavaHelp ^TM 1.0 Specification. Oracle Corporation has extended the JavaHelp file definitions to support additional features. The differences are summarized in the following sections:

Helpset File
Map File
Table of Contents File
Index File
Link File
Search Index File
OHW Configuration File

These conventions apply to the following tables:

In the Element column, child elements are indented under parent elements.
The items in the Attribute column are attributes of the element listed directly above the attribute(s).
In the Origin column, "JH" refers to the JavaHelp 1.0 file format specification from Sun Microsystems. "OH" refers to Oracle Help. Oracle's extensions to JavaHelp were originally developed for Oracle Help for Java (OHJ). However, most of the formats now apply to both OHJ and Oracle Help for the Web (OHW). Therefore, "OH" alone is used.
In the Supported By column, "OH" refers both to OHJ and OHW.

Helpset File

For more information about this file, see Helpset File.

Element	Attribute	Origin	Supported By
`<helpset>`	-	JH	OH & JH - Differences as shown below
-	`xml:lang`	JH	JH only
-	`version`	JH	JH only
`<title>`	-	JH	OH & JH
`<maps>`	-	JH	OH & JH
`<homeID>`	-	JH	JH & OH (in some circumstances)
`<mapref>`	-	JH	OH & JH - Differences as shown below
-	`location`	JH	OH & JH
-	`class`	OH	OH only
`<wintype>`	-	OH	OH only
-	`default`	OH	OH only
`<name>`	-	OH	OH only
`<height>`	-	OH	OH only
`<width>`	-	OH	OH only
`<x>`	-	OH	OH only
`<y>`	-	OH	OH only
`<textfg>`	-	OH	OH only
`<linkfg>`	-	OH	OH only
`<bg>`	-	OH	OH only
`<title>`	-	OH	OH only
`<toolbar>`	-	OH	OH only
`<links>`	-	OH	OH only
`<linkref>`	-	OH	OH only
-	`location`	OH	OH only
`<view>`	-	JH	OH & JH - Differences as shown below
`<name>`	-	JH	JH only
`<label>`	-	JH	OH & JH
-	`image`	OH	OH only
`<title>`	-	OH	OH only
-	`image`	OH	OH only (TOC view only)
`<type>`	-	JH	OH & JH
`<data>`	-	JH	OH & JH - Differences as shown below
-	`class`	OH	OH only
-	`engine`	JH	OH & JH
`<subhelpset>`	-	OH	OH only
-	`location`	OH	OH only
-	`class`	OH	OH only

Map File

For more information about this file, see Map File.

Element	Attribute	Source	Supported By
`<map>`	-	JH	OH & JH - Differences as shown below
-	`xml:lang`	JH	JH only
-	`version`	JH	JH only
`<mapID>`	-	JH	OH & JH - Differences as shown below
-	`target`	JH	OH & JH
-	`url`	JH	OH & JH
-	`wintype`	OH	OH only
-	`xml:lang`	JH	JH only

Table of Contents File

For more information about this file, see Table of Contents File.

Element	Attribute	Source	Supported By
`<toc>`	-	JH	OH & JH - Differences as shown below
-	`xml:lang`	JH	JH only
-	`version`	JH	JH only
`<tocitem>`	-	JH	Differences as listed below
-	`target`	JH	OH & JH
-	`text`	JH	OH & JH
-	`image`	JH	OH & JH
-	`xml:lang`	JH	JH only

Index File

For more information about this file, see Index File.

Element	Attribute	Source	Supported By
`<index>`	-	JH	OH & JH - Differences as shown below
-	`xml:lang`	JH	JH only
-	`version`	JH	JH only
`<indexitem>`	-	JH	OH & JH - Differences as shown below
-	`target`	JH	OH & JH
-	`text`	JH	OH & JH
`<indexentry>`	-	OH	OH only
-	`target`	OH	OH only
-	`text`	OH	OH only

Link File

This file is unique to Oracle Help. For more information, see Link File.

Search Index File

This file is unique to Oracle Help. For more information, see Text Search File.

OHW Configuration File

This file is unique to Oracle Help. For more information, see OHW Configuration File.