Custom Protocol Links Oracle Fusion Middleware Online Documentation Library
8.7 Dynamic Mapping of Topic IDs to Files
If your helpset uses a simple convention to map between topic IDs and map files, you may be able to significantly enhance Oracle Helps memory usage and startup time with dynamic mapping. Oracle Help supports an engine attribute on the mapref subelement of the helpsets maps area. By setting the engine attribute, one can use a custom engine to parse the map file and create an object used to map between topic IDs and files. In fact, by using certain engines, you may actually eliminate the map file altogether. The engine attribute is optional, so if it goes unspecified, Oracle Help will expect the location attribute to be set on the mapref, and the map file will be parsed and stored in the same manner as it was in older versions of Oracle Help. However, Oracle Help supports two engines that support certain common conventions for mediating between topic IDs and files: ■ oracle.help.engine.XMLMapFixedConventionEngine ■ oracle.help.engine.XMLMapConventionEngine If those two engines do not satisfy your needs for dynamic mapping, you can write a custom implementation of oracle.help.engine.DataEngine.8.7.1 The oracle.help.engine.XMLMapFixedConventionEngine Help Engine
In many cases, for a filename of myfile.html, the corresponding topic ID is just myfile_html. If your map file is simply a long, redundant list of obvious topic mappings of this form, you will want to set the engine attribute on mapref to oracle.help.engine.XMLMapFixedConventionEngine. While using Oracle Help, setting the engine to this value will make your old map file expendable. However, if your help content may be viewed using an older version of Oracle Help, you should keep your old map file around so that the older versions of Oracle Help can fall back to the standard mechanism of topic mapping. If you are concerned about the help systems memory usage and startup time, it is strongly recommended that you use this new engine. Doing so implies that your map file is never read, and therefore its contents are not stored in the memory. However, there is one caveat to the engines use: All help content HTML files must reside in the same directory as the helpset file. In addition, any subhelpsets must also reside in the same directory as the master helpset file. Subdirectories for subhelpsets are not permitted because the help system will not be able to find your content unless it is in the same directory as the master helpset. However, different helpsets may reside in different directories.: Note: ■ You do not have to use this method for associating topics with window types. It may be easier to do it directly in the map file. ■ Third-party authoring tools may use this META tag for associating topics with window types. ■ In older versions of OHJ, the OHJ display engine read and used this META tag directly. This is no longer the case: the map file is now the central repository for this information.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