Understanding OHW-UIX Configuration Files

23-2 Oracle Fusion Middleware Developers Guide for Oracle Help be displayed in. For more information about the elements used in the map file, see Section 13.2.2, Contents of an OHJDK Release .

23.2 Creating Context-Sensitive Links to the Help System

Applications that rely on OHW-UIX for context-sensitive help request the context-sensitive topics via specially formulated URLs to the OHW-UIX servlet. Any user interface control with a URL destination links, images, etc. can be associated with a context-sensitive topic. When creating a link to OHW-UIX for context-sensitive help, you can either use the URL destination for the front page with the Contents, Index, and Search navigators, or you can create a URL destination for a topic using the topic ID. You can also specify a locale in the URL destination. ■ Section 23.2.1, Linking to the Front Page ■ Section 23.2.2, Linking to a Topic ■ Section 23.2.3, Specifying the Locale

23.2.1 Linking to the Front Page

The URL to the front page is simply the URL to the OHW-UIX servlet: http:server:portservlet mapping where server is the name of your server running the servlet container, port is the port used by the servlet container, and servlet mapping is the servlet mapping set up in the web.xml file for the OHW-UIX servlet by default this is ohw-uixhelp. For example: http:www.yourcompany.com:7101ohw-uixhelp When a user requests help for a user interface control that is linked to the front page, OHW-UIX will be displayed in the users browser, showing the first page of the help system usually a table of contents.

23.2.2 Linking to a Topic

To create the URL for linking to a topic, add a topic parameter to the URL of the OHW-UIX servlet. The value of the topic parameter is the topic ID of the help topic: http:server:portservlet mapping?topic=topic-id For example, the following URL requests the topic associated with the topic ID topic_1: http:www.yourcompany.com:7101ohw-uixhelp?topic=topic_1 When implementing context-sensitive links to OHW-UIX, you may also wish to use JavaScript to open the link in a secondary window rather than replace the main application page. When a user requests help for a user interface control that is linked to a topic ID, OHW-UIX displays the file associated with the topic ID in a window page that does not include the OHW-UIX navigators tabs. However, the topic page has a link to the front page of the help system should the user wish to access the main help.