Index

A C D E F H I J L M O P R S T U W

A

addBook() constructors, 14.3.2

addComponent() constructors, 15.3.3

Adding Books to Help, 14.3.2

Adding Custom tab to OHJ, 14.4

Adding Favorites tab to OHJ, 14.4

Adding Help Data in a HelpBook, C.2

Adding Help data to OHJ, 14.3

Adding OHJ to Application, 14

ADF Faces Help Provider

ELHelpProvider, 20.4

ResourceBundleHelpProvider, 20.4

ADF Rich Client Help Provider, 20

Authoring

overview, 10.1

step-by-step process, 10.1

Authoring embedded help, 10.3

Authoring Tools, 10

Authoring utilities, 10.2

C

Changing the Oracle Help for the Web - UIX URL, 22.4

Comparing Oracle Help and JavaHelp File Formats, A

Configuration File, A.7

Helpset File, A.1

Index File, A.4

Link File, A.6

Map File, A.2

Search Index File, A.5

Table of Contents File, A.3

Constructing Help object, 14.2

CSHManager() constructors, 15.3.1

Custom Helpsets for Oracle Help for the Web - UIX, 22.3

Custom Protocol, 9.7

custom Protocol Links, 8.3

Custom Tab

Oracle Help for Java, 2.2.5

D

Debugging helpset, 9.1.1

Deploying Multiple Help Instances in a Web Application, 18.9

Deploying OHW-RC as a Standalone Web Application, 18.7

Deploying Oracle Help for Java

Book constructors, 16.3.2

creating JAR files, 16.3.1

introduction, 16

shipped JAR files, 16.2

Deploying Oracle Help for the Web - Rich Client Demo File, 17

Deploying Oracle Help for the Web - UIX Demo File, 21

dispose() constructors, 14.8

Disposing Help object, 14.8

Dynamic mapping, 8.7

optimizing, 8.7.3

oracle.help.engine.XMLMapConventionEngine engine, 8.7.2

oracle.help.engine.XMLMapFixedConventionEngine engine, 8.7.1

example, 8.7.1

E

Enabling context-sensitive OHJ help, 15

Enabling context-sensitive Oracle Help for the Web - Rich Client help, 19

Enabling context-sensitive Oracle Help for the Web - UIX help, 23

F

Favorites

Oracle Help for Java, 2.2.4

File Extensions, 5.1

Free OHJ resources, 14.8

H

Help() constructors, 14.2

HelpBook File Name Extensions, C.1

HelpBooks, C

helpConfiguration Element

debugMode attribute, 9.1.1

Helpset Authoring Wizard, 11

helpset element, 6.1.1

Helpset File

elements, 6.1

helpset element, 6.1.1

introduction, 6.1

links element, 6.1.5

maps element, 6.1.3

child elements, 6.1.3

sample file, 6.1.8

subhelpset element, 6.1.7

title element, 6.1.2

view element, 6.1.6

child elements, 6.1.6

view types, 6.1.6.1

wintype element, 6.1.4

child elements, 6.1.4

HelpSet() constructors, 14.3.1

Helpsets

merging, 2.3

Merging table of contents, 2.3.1

sharing resources, 9.4

HelpTopicId attribute, 20.3

I

ICEbrowser, 2.1

support, 2.1

technologies, 2.1

Implementing Context-Sensitive Help in Oracle UIX-based Applications, 23.3

Index

Oracle Help for Java, 2.2.2

Oracle Help for the Web - Rich Client, 3.3

Oracle Help for the Web - UIX, 4.2

Index File

elements, 7.2.1

example, 7.2.1

introduction, 7.2

Installing OHJDK, 13.2.1

Installing Oracle Help for the Web - UIX Demo File on Oracle JDeveloper, 21.3

Installing Oracle Help for the Web - UIX Demo File on Oracle WebLogic Server, 21.2

Integrating Online Help With ADF Faces Application, 20.1

J

Java Modal Window Problem

introduction, B

Registering a Window, B.2

Unregistering a Window, B.3

JDeveloper

Oracle Help, 1.4

L

Licensing and Support, 1.5

Link File

elements, 7.4.1

example, 7.4.1

introduction, 7.4

Locales in Oracle Help for the Web Configuration File, C.3

The contentLocation Element, C.3.2

The locale Child Element books, C.3.1

M

Map File

elements, 6.2.1

introduction, 6.2

Mapping Oracle Help for the Web - UIX Topic IDs to Help Topics, 23.1

Mapping Topic IDs to OHJ Help Topics, 15.1

Merging Helpsets, 2.3

Metadata Files, 6

Helpset File, 6.1

O

OHJ Authoring Wizard

converting popup window links, 11.9

creating helpset file, 11.2

defining Full-Text search, 11.6

defining map file, 11.7

defining Views, 11.5

defining a new view, 11.5.1

defining custom data engine, 11.5.3

defining custom view, 11.5.2

Finalizing helpset, 11.11

introduction, 11

select source and target, 11.3

specifying source directory, 11.4

starting the wizard, 11.1

Window Types, 11.10

Identity, 11.10.1

Placements, 11.10.2

Style, 11.10.3

Toolbar buttons, 11.10.4

OHJ components, 1.1

OHJ Demo Files, 13.2.2.3

OHJ Documentation, 13.2.2.4

OHJ Engine, 13.2.2.1

OHW configuration file, 9

OHW Custom Protocol, 9.7

ohwconfig.xml, 9

OHW-UIX Components, 1.3

Optimizing Dynamic Maps, 8.7.3

Oracle Help

authoring tools, 10

introduction, 1

JDeveloper, 1.4

licensing, 1.5

topic ids, 8.5

Oracle Help for Java

accessibility, 2.4.1

addBook constructors, 14.3.2

adding books, 14.3.2

adding Custom tab, 14.4

adding Favorites tab, 14.4

adding help data, 14.3

adding to an application, 14

steps, 14.1

architecture, 2.4.4

components, 1.1

constructing Help object, 14.2

constructing HelpSet, 14.3.1

CSHManager, 15.3

associating topic ids with user interface components, 15.3.3

constructors, 15.3.1

explicitly showing help for components, 15.3.4

setting default book, 15.3.2

deploying, 16

dispose constructors, 14.8

Disposing Help object, 14.8

enabling context sensitive help, 15

Favorites Window

Custom Navigator Tab, 2.2.5

Search Tab, 2.2.4

File Extensions, 5.1

Help() constructors, 14.2

internationalization, 2.4.2

introduction, 1.1

mapping topic ids to help topics, 15.1

Merged helpsets, 2.3

Navigator Window, 2.2

Contents Tab, 2.2.1

Index Tab, 2.2.2

Search Tab, 2.2.3

programming your application to support context-sensitive help, 15.2

showing Navigator window, 14.6

showing Topic window, 14.7

showTopic constructors, 14.7

Topic Window, 2.1

TopicDisplay Exceptions, 14.7.1

UI Components, 2

User Interface, 2

window types, 8.6

Oracle Help for Java Developer's Kit

Contents, 13.2.2

Demonstration files, 13.2.2.3

OHJ Authoring Tools, 13.2.2.2

OHJ Engine, 13.2.2.1

Documentation, 13.2.2.4

Getting Started, 13.2

Installing, 13.2.1

introduction, 13

Java Runtime, 13.1

Setting CLASSPATH, 13.2.3

Oracle Help for the Web

best practice for internationalization, 9.2.1

brandings element, 9.2

child elements, 9.2

example, 9.2

child elements, 9

contentLocation element, 9.3.2, C.3.2

absolute path content location, 9.3.2

relative path content location, 9.3.2

custom protocol, 9.7

helpConfiguration element, 9.1

locales element, 9.3

books, 9.3.1, C.3.1

child elements, 9.3

example, 9.3

sample, 9.3.3

navigatorAliases element, 9.6

example, 9.6

parameters element, 9.5

child elements, 9.5

keyword child element, 9.5

performance child element, 9.5

preloading helpsets, 9.8

sharing resources, 9.4

Oracle Help for the Web - RC

Bookmarking, 3.6.2

File Extensions, 5.1

introduction, 1.2

Search, 3.4

Single pane layout, 3.6.3

Toolbar, 3.1

Topic View, 3.5

Oracle Help for the Web - Rich Client

changing access URL, 18.6

configuration files, 18.4

Contents, 3.2

Creating Context-Sensitive Links to the Help System, 19.2

deploying as a part of web application, 18.8

deploying as a standalone web application, 18.7

deploying demo file, 17

deploying multiple help instances, 18.9

deployment requirements, 18.1

display custom helpsets, 18.5

HelpTopicId attribute, 20.3

implementing context-sensitive help in a web application, 19

Index, 3.3

installing artifacts, 18.3

installing demo file on Oracle JDeveloper, 17.3

installing demo file on Oracle WebLogic Server, 17.2

library files, 18.2

Mapping Topic IDs to Help Topics, 19.1

registering as an ADF-RC help provider, 20.2

running demo file, 17.4

understanding demo filles, 17.1

understanding deployment process, 18

upgrading from Oracle Help for the Web - UIX, 24

User Interface, 3

Oracle Help for the Web - UIX

access url, 22.4

comparison with Oracle Help for Java, 4

components, 1.3

configuration files, 22.2

configuring custom helpsets, 22.3

creating context sensitive links, 23.2

File Extensions, 5.1

implementing context sensitive help, 23

implementing context-censitive help in Oracle UIX-based applications, 23.3

Index, 4.2

introduction, 1.3

mapping topic ids to help topics, 23.1

registering OHW-UIX in the OracleHelpProvider, 23.3.1

requirements and dependencies, 22.1

Search, 4.3

Table of Contents, 4.1

Topics, 4.4

understanding deployment, 22

upgrading, 22.5

User Interface, 4

Oracle Help for the Web - UIX Demo File

Installing on Oracle JDeveloper, 21.3

Installing on Oracle WebLogic Server, 21.2

introduction, 21.1

running, 21.4

Oracle Help for the Web Configuration File, 9

Oracle JDeveloper

installing Oracle Help for the Web - Rich Client demo file, 17.3

installing Oracle Help for the Web - UIX Demo File, 21.3

Oracle WebLogic Server

installing Oracle Help for the Web - Rich Client demo file, 17.2

installing Oracle Help for the Web - UIX Demo File, 21.2

P

Preloading Helpsets, 9.8

Programming Your Application to Support Context-Sensitive OHJ Help, 15.2

R

Registering OHW-Rich Client as an ADF Rich Client Help Provider, 20.2

Registering OHW-UIX in the OracleHelpProvider, 23.3.1

Databinding a Destination, 23.3.2

Running the OHW-UIX Demo EAR File, 21.4

S

Sample Helpset File, 6.1.8

Sample locales element, 9.3.3

Oracle Help for Java, 2.2.3

Oracle Help for the Web - RC, 3.4

Oracle Help for the Web - UIX, 4.3

Search Index File, 7.3

setDefaultBook() constructors, 15.3.2

Sharing Resources across Helpsets, 9.4

showHelpForCompponent() method, 15.3.4

Showing Navigator window in OHJ, 14.6

Showing Topic window in OHJ, 14.7

showTopic() constructors, 14.7

T

Table of Contents

merging, 2.3.1

Oracle Help for Java, 2.2.1

Oracle Help for the Web - Rich Client, 3.2

Oracle Help for the Web - UIX, 4.1

Table of Contents File

elements, 7.1.1

example, 7.1.1

introduction, 7.1

Text Search Indexer

introduction, 12

Java Requirements, 12.1

Running Indexer, 12.2, 12.3

Topic Files

associative links, 8.2

custom protocol links, 8.3

introduction, 8

pop-ups, 8.4

topic id, 8.1

TopicDisplay Exceptions, 14.7.1

U

Understanding Oracle Help for the Web - Rich Client Demo Files, 17.1

Understanding Oracle Help for the Web - Rich Client Deployment, 18

User Interface

Oracle Help for Java, 2

Oracle Help for the Web - Rich Client, 3

Oracle Help for the Web - UIX, 4

W

Window Types, 8.6