Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle Help
11
g
Release 1 (5.0)
E14149-01
Index
Next
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 – UIX
1.3
Oracle Help for the Web – Rich Client
1.4
Oracle Help in Oracle JDeveloper
1.5
Oracle Help Licensing and Support
2
OHJ 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
OHW-UIX User Interface
3.1
OHW-UIX Table of Contents
3.2
OHW-UIX Index
3.3
OHW-UIX Search
3.4
OHW-UIX Topics
4
OHW-RC User Interface
4.1
OHW-RC Global Toolbar
4.2
OHW-RC Contents Navigator
4.3
OHW-RC Index Navigator
4.4
OHW-RC Search Navigator
4.5
OHW-RC Topic Pane
4.6
Other OHW-RC Features
4.6.1
About OHW-RC Feature
4.6.2
Bookmarking Feature
4.6.2.1
Backward Compatibility
4.6.3
Single Pane Layout Feature
Part II Oracle Help File Formats
5
Introduction to Oracle Help File Formats
5.1
File Name Extensions
6
Metadata Files
6.1
Helpset File
6.1.1
The <helpset> Element
6.1.2
The <title> Element
6.1.3
The <maps> Element
6.1.4
The <wintype> Element
6.1.5
The <links> Element
6.1.6
The <view> Element
6.1.6.1
Data View Type and Engines
6.1.7
The <subhelpset> Element
6.1.8
Sample Helpset File
6.2
Map Files
6.2.1
Map File Elements
7
Help Information Files
7.1
Table of Contents File
7.1.1
TOC Elements
7.2
Index File
7.2.1
Index Elements
7.3
Search Index File
7.4
Link File
7.4.1
Link File Elements
8
Topic Files
8.1
Topic ID Links
8.2
Associative Links
8.3
Custom Protocol Links
8.4
Popups
8.5
Topic IDs
8.6
Window Types
8.7
Dynamic Mapping of Topic IDs to Files
8.7.1
The oracle.help.engine.XMLMapFixedConventionEngine Help Engine
8.7.2
The oracle.help.engine.XMLMapConventionEngine Help Engine
8.7.3
Optimizing Dynamic Maps
9
Oracle Help for the Web Configuration File
9.1
The <helpConfiguration> Element
9.1.1
The debugMode Attribute
9.2
The <brandings> Element
9.2.1
Best Practice for Internationalization
9.3
The <locales> Element
9.3.1
The <locale> Child Element <books>
9.3.2
The <contentLocation> Element
9.3.3
Sample <locales> Section
9.4
Sharing Resources Across Helpsets
9.5
The <parameters> Element
9.6
The <navigatorAliases> Element
9.7
Custom Protocol Links
9.8
Preloading Helpsets Containing Embedded Help
Part III Authoring Oracle Help
10
Authoring Oracle Help Systems
10.1
Overview of Authoring
10.2
Authoring Utilities Included with Oracle Help for Java
10.3
Authoring Embedded Help
10.3.1
HTML Files
11
OHJ Authoring Wizard
11.1
Starting the Wizard
11.2
Creating a Helpset File
11.3
Specifying Authoring Tool and HTML Browser
11.4
Specifying Source Directory
11.5
Defining Views
11.5.1
Defining a New View
11.5.2
Defining a Custom View Type
11.5.3
Defining a Custom Data Engine
11.6
Defining Full-Text Search View
11.7
Defining Map File
11.8
Converting Associative Links
11.9
Converting Popup Window Links
11.10
Defining Window Types
11.10.1
Window Identity
11.10.2
Placement Attributes
11.10.3
Style Attributes
11.10.4
Toolbar Buttons
11.11
Finalizing the HelpSet
12
Using the Text Search Indexer
12.1
Java Requirements
12.2
Running the Indexer
12.3
Running the JapaneseIndexer
Part IV Oracle Help for Java
13
Introduction to Oracle Help for Java Developer's Kit
13.1
Oracle Help for Java Runtime in JDeveloper
13.2
Getting Started with the OHJDK
13.2.1
Installing OHJDK
13.2.2
Contents of an OHJDK Release
13.2.2.1
OHJ Engine
13.2.2.2
Authoring Tools
13.2.2.3
Demonstration Files
13.2.2.4
Documentation
13.2.3
Setting the Java CLASSPATH for OHJDK Development
14
Adding OHJ to Your Application
14.1
Overview of Adding OHJ to an Application
14.2
Constructing the Help Object
14.3
Adding the Help Data
14.3.1
Constructing a HelpSet
14.3.2
Adding Books to Help
14.4
Adding the Favorites Tab or Custom Tab
14.5
When to Create the Help object
14.6
Showing the Navigator Window
14.7
Showing a Topic
14.7.1
Catching TopicDisplayExceptions
14.8
Disposing of the Help Object
15
Enabling Context-Sensitive Help in Your Application
15.1
Mapping Topic IDs to Help Topics
15.2
Programming Your Application to Support Context-Sensitive Help
15.3
Using CSHManager to Implement Context-Sensitive Help
15.3.1
CSHManager Constructors
15.3.2
Setting the Default Book
15.3.3
Associating Topic IDs with User Interface Components
15.3.4
Explicitly Showing Help for Components
16
Deploying an OHJ Help System
16.1
Supported Java Virtual Machines
16.2
Which OHJ JAR Files Must Be Shipped
16.3
Deploying Compressed Help Content in JARs
16.3.1
Creating JAR files
16.3.2
Which Book Constructor to Use
Part V Oracle Help for the Web – UIX
17
Deploying OHW-UIX Demo File
17.1
Understanding the OHW-UIX Demo File
17.2
Installing the OHW-UIX Demo EAR File on Oracle WebLogic Server
17.3
Installing the OHW-UIX Demo EAR File using Oracle JDeveloper
17.4
Running the OHW-UIX Demo EAR File
18
Understanding OHW-UIX Deployment
18.1
Verifying Requirements and Dependencies
18.2
Understanding OHW-UIX Configuration Files
18.3
Configuring OHW-UIX to Display Custom Helpsets
18.4
Changing the OHW-UIX Access URL
18.4.1
Changing the final URL element of the access URL
18.4.2
Changing the access URL to another name
18.5
Upgrading OHW-UIX and UIX
19
Implementing Context-Sensitive Help in a Web Application
19.1
Mapping Topic IDs to Help Topics
19.2
Creating Context-Sensitive Links to the Help System
19.2.1
Linking to the Front Page
19.2.2
Linking to a Topic
19.2.3
Specifying the Locale
19.3
Implementing Context-Sensitive Help in Oracle UIX-based Applications
19.3.1
Registering OHW-UIX in the OracleHelpProvider
19.3.2
Databinding a Destination
Part VI Oracle Help for the Web – Rich Client
20
Deploying OHW-RC Demo File
20.1
Understanding the OHW-RC Demo Files
20.2
Installing the OHW-RC Demo EAR File on Oracle WebLogic Server
20.3
Installing the OHW-RC Demo EAR File on Oracle JDeveloper
20.4
Running the OHW-RC Demo EAR File
21
Understanding OHW-RC Deployment
21.1
Verifying Requirements and Dependencies
21.2
Verifying OHW-RC Library Files
21.3
Installing OHW-RC Artifacts
21.4
Understanding OHW-RC Configuration Files
21.5
Configuring OHW-RC to Display Custom Helpsets
21.6
Changing the OHW-RC Access URL
21.6.1
Changing the final URL element of the access URL
21.6.2
Changing the access URL to another name
21.7
Deploying OHW-RC as a Standalone Web Application
21.7.1
Installing the OHW-RC Artifacts
21.7.2
Configuring OHW-RC as Standalone Web Application
21.8
Deploying OHW-RC as part of a Web Application
21.8.1
Installing the OHW-RC Artifacts
21.8.2
Configuring OHW-RC as Part of Web Application
21.9
Deploying Multiple Help Instances in a Web Application
21.9.1
Application and OHW-RC Configuration Files and Setup
21.9.2
Running the application
22
Implementing Context-Sensitive Help in a Web Application
22.1
Mapping Topic IDs to Help Topics
22.2
Creating Context-Sensitive Links to the Help System
22.2.1
Linking to the Front Main Page
22.2.2
Linking to a Topic
22.2.3
Specifying the Locale and Group
23
ADF Rich Client Help Provider
23.1
Integrating Online Help With ADF Faces Application
23.2
Registering OHW-RC as an ADF Rich Client Help Provider
23.3
Using HelpTopicId Attribute
23.4
Using Other Help Providers
24
Upgrading From OHW-UIX
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
Index