Mapping Topic IDs to Help Topics
20.2 Registering OHW-RC as an ADF Rich Client Help Provider
ADF Rich Client Faces includes a variety of help providers. You can use a combination of the different help providers or create your own help provider class. You can also use OHW-RC as a help provider. You need to perform the following tasks in order to set up OHW-RC as a Help Provider in an ADF Rich Client application: 1. Deploy OHW-RC as a web application: a. Deploy an RC application to web application server. b. Note down the context-root of this deployment. c. Open the web.xml file in this deployment. d. Find the OHW-RC servlet instance. 2. Develop the jspx Web pages. a. Create an ADF Faces-based Web application. ADF Rich Client Help Provider 20-3 b. Create a jspx Web page; for some components input, select, etc, where you can find an attribute named helpTopicId, specify the ID you want to display with your OHW-RC instance. 3. Copy the helpsets into a direcotry under your application_rootpublic_ html folder. For example, let’s name this directory helpsets. 4. Set up the adf-settings.xml file. a. Navigate to your applications directory, and look for the .adfMETA-INF directory. Under that directory you can find the adf-settings.xml file. If the .adfMETA-INF directory is not present, create the META-INF directory under the ViewControllersrc directory. b. Enter code into adf-settings.xml; for example: adf-settings xmlns=http:xmlns.oracle.comadfsettings help-provider help-provider-classoracle.help.web.rich.helpProvider.OHWHelpProviderhel p-provider-class property property-nameohwConfigFileURLproperty-name valuehelpsetsohwconfig.xmlvalue property --property property-namegroupproperty-name valuenullvalue property-- property property-namebaseURIproperty-name valuehttp:localhost:8989help-ohw-rcf-context-rootohguidevalue property help-provider adf-settings In this adf-settings.xml file: If you want to use OHW-RC as your help provider, then, in this adf-settings.xml file, the class has to be OHWHelpProvider. Set the ohwConfigFileURL property to point to your helpsetsohwconfig.xml. Noe that you created the helpsets directory in Step 3.Parts
» Oracle Fusion Middleware Online Documentation Library
» Oracle Help for the Web – Rich Client
» Oracle Help for the Web – UIX
» Oracle Help in Oracle JDeveloper Oracle Help Licensing and Support
» OHJ Topic Windows Oracle Fusion Middleware Online Documentation Library
» Case Sensitive Search for Topic List
» Branding area Open, Pluggable Architecture
» Toolbar area Open, Pluggable Architecture
» Navigator area Open, Pluggable Architecture
» Topic view area Open, Pluggable Architecture
» OHW-RC Global Toolbar Oracle Fusion Middleware Online Documentation Library
» Show permanent link for this topic page OHW-RC Contents Navigator
» OHW-RC Index Navigator Oracle Fusion Middleware Online Documentation Library
» OHW-RC Search Navigator Oracle Fusion Middleware Online Documentation Library
» About OHW-RC Feature Bookmarking Feature
» Branding area Single Pane Layout Feature
» Helpset switcher Single Pane Layout Feature
» Tab bar Single Pane Layout Feature
» OHW-RC Topic Pane OHW-UIX Table of Contents
» OHW-UIX Index OHW-UIX Search OHW-UIX Topics
» File Name Extensions Oracle Fusion Middleware Online Documentation Library
» The helpset Element Helpset File
» The title Element Helpset File
» The maps Element Helpset File
» The wintype Element Helpset File
» The links Element Helpset File
» The view Element Helpset File
» The subhelpset Element Helpset File
» Sample Helpset File Helpset File
» TOC Elements Table of Contents File
» Link File Elements Link File
» Search Index File Topic ID Links
» Associative Links Oracle Fusion Middleware Online Documentation Library
» Custom Protocol Links Oracle Fusion Middleware Online Documentation Library
» Popups Oracle Fusion Middleware Online Documentation Library
» Topic IDs Oracle Fusion Middleware Online Documentation Library
» Window Types Oracle Fusion Middleware Online Documentation Library
» The oracle.help.engine.XMLMapFixedConventionEngine Help Engine
» The oracle.help.engine.XMLMapConventionEngine Help Engine Optimizing Dynamic Maps
» The debugMode Attribute The helpConfiguration Element
» Best Practice for Internationalization
» The locale Child Element books The contentLocation Element
» Sample locales Section The locales Element
» Sharing Resources Across Helpsets
» The parameters Element Oracle Fusion Middleware Online Documentation Library
» The navigatorAliases Element Custom Protocol Links Preloading Helpsets Containing Embedded Help
» HTML Files Authoring Embedded Help
» Starting the Wizard Creating a Helpset File
» Specifying Authoring Tool and HTML Browser Specifying Source Directory
» Defining Full-Text Search View Defining Map File
» Converting Associative Links Converting Popup Window Links
» Window Identity Defining Window Types
» Placement Attributes Style Attributes
» Finalizing the HelpSet Oracle Fusion Middleware Online Documentation Library
» Java Requirements Oracle Fusion Middleware Online Documentation Library
» Running the Indexer Oracle Fusion Middleware Online Documentation Library
» Running the JapaneseIndexer Oracle Fusion Middleware Online Documentation Library
» Installing OHJDK Contents of an OHJDK Release
» Setting the Java CLASSPATH for OHJDK Development
» Oracle Help for Java Runtime in JDeveloper Overview of Adding OHJ to an Application
» Constructing the Help Object
» Adding the Favorites Tab or Custom Tab
» When to Create the Help object
» Showing the Navigator Window
» Catching TopicDisplayExceptions Showing a Topic
» Disposing of the Help Object
» Mapping Topic IDs to Help Topics Programming Your Application to Support Context-Sensitive Help
» CSHManager Constructors Setting the Default Book
» Associating Topic IDs with User Interface Components
» Explicitly Showing Help for Components
» Supported Java Virtual Machines
» Which OHJ JAR Files Must Be Shipped
» Creating JAR files Deploying Compressed Help Content in JARs
» Which Book Constructor to Use
» Understanding the OHW-RC Demo Files
» Installing the OHW-RC Demo EAR File on Oracle WebLogic Server
» Installing the OHW-RC Demo EAR File on Oracle JDeveloper
» Running the OHW-RC Demo EAR File
» Verifying Requirements and Dependencies
» Verifying OHW-RC Library Files
» Installing OHW-RC Artifacts Oracle Fusion Middleware Online Documentation Library
» Understanding OHW-RC Configuration Files
» Configuring OHW-RC to Display Custom Helpsets
» Installing the OHW-RC Artifacts
» Configuring OHW-RC as Standalone Web Application
» Application and OHW-RC Configuration Files and Setup Running the application
» Mapping Topic IDs to Help Topics
» Linking to the Front Main Page Linking to a Topic
» Specifying the Locale and Group
» Using HelpTopicId Attribute Oracle Fusion Middleware Online Documentation Library
» Understanding the OHW-UIX Demo File
» Installing the OHW-UIX Demo EAR File on Oracle WebLogic Server
» Installing the OHW-UIX Demo EAR File using Oracle JDeveloper
» Running the OHW-UIX Demo EAR File
» Understanding OHW-UIX Configuration Files
» Configuring OHW-UIX to Display Custom Helpsets
» Upgrading OHW-UIX and UIX Mapping Topic IDs to Help Topics
Show more