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

Part Number E16280-01
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

A Oracle Help and JavaHelp File Formats

The Oracle Help file formats are based on the JavaHelp specification. Oracle Corporation has extended the JavaHelp file definitions to support additional features. The differences are summarized in the following sections:

These conventions apply to the following tables:

A.1 Helpset File

For more information about this file, see Section 5.1, "Helpset File".

Table A-1 Helpset Elements

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


A.2 Map File

For more information about this file, see Section 5.2, "Map Files".

Table A-2 Map File Elements

Element Attribute Origin 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


A.3 Table of Contents File

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

Table A-3 Table of Contents Elements

Element Attribute Origin 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


A.4 Index File

For more information about this file, see Section 6.3, "Index File".

Table A-4 Index File Elements

Element Attribute Origin 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


A.5 Search Index File

This file is unique to Oracle Help. For more information, see Section 6.4, "Search Index File".

A.6 Link File

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

A.7 OHW Configuration File

This file is unique to Oracle Help. For more information, see Chapter 8, "Oracle Help for the Web Configuration File".