1/34
Contents
List of Figures
List of Tables
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
What's New
Part I Oracle Help Overview
1
Introduction to Oracle Help
1.1
Oracle Help for Java
1.2
Oracle Help for the Web
1.3
Oracle Help in Oracle JDeveloper
1.4
Oracle Help Licensing and Support
2
Oracle Help for Java User Interface
2.1
OHJ Topic Windows
2.2
OHJ Navigator Window
2.2.1
Contents Tab
2.2.2
Index Tab
2.2.3
Search Tab
2.2.4
Favorites Tabs
2.2.5
Custom Navigator Tabs
2.3
Merged Helpsets
2.3.1
Merging Table of Contents
2.4
Other OHJ Features
2.4.1
Accessibility Features
2.4.2
Internationalization Features
2.4.3
Java Foundation Class (JFC) Swing Components
2.4.4
Open, Pluggable Architecture
3
Oracle Help for the Web User Interface
3.1
OHW Global Toolbar
3.2
OHW-RC Contents Navigator
3.3
OHW Index Navigator
3.4
OHW Search Navigator
3.5
OHW Topic Pane
3.6
Other OHW Features
3.6.1
About OHW Feature
3.6.2
Bookmarking Feature
3.6.2.1
Backward Compatibility
3.6.3
Single Pane Layout Feature
Part II Oracle Help File Formats
4
Introduction to Oracle Help File Formats
4.1
File Name Extensions
5
Metadata Files
5.1
Helpset File
5.1.1
The <helpset> Element
5.1.2
The <title> Element
5.1.3
The <maps> Element
5.1.4
The <wintype> Element
5.1.5
The <links> Element
5.1.6
The <view> Element
5.1.6.1
Data View Type and Engines
5.1.7
The <subhelpset> Element
5.1.8
Sample Helpset File
5.2
Map Files
5.2.1
Map File Elements
6
Help Information Files
6.1
Table of Contents File
6.1.1
TOC Elements
6.2
Master Table of Contents
6.2.1
How To Configure Master Table of Contents
6.3
Index File
6.3.1
Index Elements
6.4
Search Index File
6.5
Link File
6.5.1
Link File Elements
7
Topic Files
7.1
Topic ID Links
7.2
Associative Links
7.3
Custom Protocol Links
7.4
Popups
7.5
Topic IDs
7.6
Window Types
7.7
Dynamic Mapping of Topic IDs to Files
7.7.1
The oracle.help.engine.XMLMapFixedConventionEngine Help Engine
7.7.2
The oracle.help.engine.XMLMapConventionEngine Help Engine
7.7.3
Optimizing Dynamic Maps
8
Oracle Help for the Web Configuration File
8.1
The <helpConfiguration> Element
8.1.1
The debugMode Attribute
8.2
The <brandings> Element
8.2.1
Best Practice for Internationalization
8.3
The <locales> Element
8.3.1
The <locale> Child Element <books>
8.3.2
The <contentLocation> Element
8.3.3
Sample <locales> Section
8.4
Sharing Resources Across Helpsets
8.5
The <parameters> Element
8.6
The <navigatorAliases> Element
8.7
Custom Protocol Links
8.8
Preloading Helpsets Containing Embedded Help
Part III Authoring Oracle Help
9
Authoring Oracle Help Systems
9.1
Overview of Authoring
9.2
Authoring Utilities Included with Oracle Help for Java
9.3
Authoring Embedded Help
9.3.1
HTML Files
10
Helpset Authoring Wizard
10.1
Starting the Wizard
10.2
Creating a Helpset File
10.3
Specifying Authoring Tool and HTML Browser
10.4
Specifying Source Directory
10.5
Defining Views
10.5.1
Defining a New View
10.5.2
Defining a Custom View Type
10.5.3
Defining a Custom Data Engine
10.6
Defining Full-Text Search View
10.7
Defining Map File
10.8
Converting Associative Links
10.9
Converting Popup Window Links
10.10
Defining Window Types
10.10.1
Window Identity
10.10.2
Placement Attributes
10.10.3
Style Attributes
10.10.4
Toolbar Buttons
10.11
Finalizing the HelpSet
11
Using the Text Search Indexer
11.1
Java Requirements
11.2
Running the Indexer
11.3
Running the JapaneseIndexer
Part IV Oracle Help for Java
12
Introduction to Oracle Help for Java Developer's Kit
12.1
Oracle Help for Java Runtime in JDeveloper
12.2
Getting Started with the OHJDK
12.2.1
Installing OHJDK
12.2.2
Contents of an OHJDK Release
12.2.2.1
OHJ Engine
12.2.2.2
Authoring Tools
12.2.2.3
Demonstration Files
12.2.2.4
Documentation
12.2.3
Setting the Java CLASSPATH for OHJDK Development
13
Adding OHJ to Your Application
13.1
Overview of Adding OHJ to an Application
13.2
Constructing the Help Object
13.3
Adding the Help Data
13.3.1
Constructing a HelpSet
13.3.2
Adding Books to Help
13.4
Adding the Favorites Tab or Custom Tab
13.5
When to Create the Help object
13.6
Showing the Navigator Window
13.7
Showing a Topic
13.7.1
Catching TopicDisplayExceptions
13.8
Disposing of the Help Object
14
Enabling Context-Sensitive Help in Your Application
14.1
Mapping Topic IDs to Help Topics
14.2
Programming Your Application to Support Context-Sensitive Help
14.3
Using CSHManager to Implement Context-Sensitive Help
14.3.1
CSHManager Constructors
14.3.2
Setting the Default Book
14.3.3
Associating Topic IDs with User Interface Components
14.3.4
Explicitly Showing Help for Components
15
Deploying an OHJ Help System
15.1
Supported Java Virtual Machines
15.2
Which OHJ JAR Files Must Be Shipped
15.3
Deploying Compressed Help Content in JARs
15.3.1
Creating JAR files
15.3.2
Which Book Constructor to Use
Part V Oracle Help for the Web
16
Deploying OHW Demo File
16.1
Understanding the OHW Demo Files
16.2
Installing the OHW Demo EAR File on Standalone Oracle WebLogic Server
16.3
Installing the OHW Demo EAR File on JDeveloper Integrated Oracle WebLogic Server
16.4
Running the OHW Demo EAR File
17
Understanding OHW Deployment
17.1
Verifying Requirements and Dependencies
17.2
Verifying OHW Library Files
17.3
Installing OHW Artifacts
17.4
Understanding OHW Configuration Files
17.5
Configuring OHW to Display Custom Helpsets
17.6
Changing the OHW-RC Access URL
17.6.1
Changing the final URL element of the access URL
17.6.2
Changing the access URL to another name
17.7
Deploying OHW as a Standalone Web Application
17.7.1
Installing the OHW-RC Artifacts
17.7.2
Configuring OHW as Standalone Web Application
17.8
Deploying OHW as part of a Web Application
17.8.1
Installing the OHW Artifacts
17.8.2
Configuring OHW as Part of Web Application
17.9
Deploying Multiple Help Instances in a Web Application
17.9.1
Application and OHW Configuration Files and Setup
17.9.2
Running the application
18
Implementing Context-Sensitive Help in a Web Application
18.1
Mapping Topic IDs to Help Topics
18.2
Creating Context-Sensitive Links to the Help System
18.2.1
Linking to the Front Main Page
18.2.2
Linking to a Topic
18.2.3
Specifying the Locale and Group
19
ADF Rich Client Help Provider
19.1
Integrating Online Help With ADF Faces Application
19.2
Registering OHW-RC as an ADF Rich Client Help Provider
19.3
Using HelpTopicId Attribute
19.4
Using Other Help Providers
A
Oracle Help and JavaHelp File Formats
A.1
Helpset File
A.2
Map File
A.3
Table of Contents File
A.4
Index File
A.5
Search Index File
A.6
Link File
A.7
OHW Configuration File
B
Working Around the Java Modal Window Problem
B.1
About the Java Modal Window Problem
B.2
Registering a Window
B.3
Unregistering a Window
C
Working With HelpBooks
C.1
HelpBook File Name Extensions
C.2
Adding the Help Data in OHJ
C.2.1
Constructing a HelpBook
C.2.2
Adding Books to Help
C.3
Locales in Oracle Help for the Web Configuration File
C.3.1
The <locale> Child Element <books>
C.3.2
The <contentLocation> Element
D
Oracle Help for the Web – UIX
D.1
OHW-UIX User Interface
D.1.1
OHW-UIX Table of Contents
D.1.2
OHW-UIX Index
D.1.3
OHW-UIX Search
D.1.4
OHW-UIX Topics
D.2
Deploying OHW-UIX Demo File
D.2.1
Understanding the OHW-UIX Demo File
D.2.2
Installing the OHW-UIX Demo EAR File on Oracle WebLogic Server
D.2.3
Installing the OHW-UIX Demo EAR File using Oracle JDeveloper
D.2.4
Running the OHW-UIX Demo EAR File
D.3
Understanding OHW-UIX Deployment
D.3.1
Verifying Requirements and Dependencies
D.3.2
Understanding OHW-UIX Configuration Files
D.3.3
Configuring OHW-UIX to Display Custom Helpsets
D.3.4
Changing the OHW-UIX Access URL
D.3.4.1
Changing the final URL element of the access URL
D.3.4.2
Changing the access URL to another name
D.3.5
Upgrading OHW-UIX and UIX
D.4
Implementing Context-Sensitive Help in a Web Application
D.4.1
Mapping Topic IDs to Help Topics
D.4.2
Creating Context-Sensitive Links to the Help System
D.4.2.1
Linking to the Front Page
D.4.2.2
Linking to a Topic
D.4.2.3
Specifying the Locale
D.4.3
Implementing Context-Sensitive Help in Oracle UIX-based Applications
D.4.3.1
Registering OHW-UIX in the OracleHelpProvider
D.4.3.2
Databinding a Destination
D.5
Upgrading OHW-UIX Help System to OHW-RC Help System
Scripting on this page enhances content navigation, but does not change the content in any way.