Topic IDs Oracle Fusion Middleware Online Documentation Library

Topic Files 8-5 In the following example, the map IDs topic_1 and topic_2 are not associated with window types and therefore use the helpsets default window type. The map IDs topic_3 and topic_4 map to topic files that will be displayed in the window defined by the intro window type. Map ID topic_5.tsk will display File_5.html in the window defined by the task window type. Map ID topic_5.cncpt will display the same topic file File_5.html in a different window type concept. Note also that the association between URL and wintype will be used when linking from topic to topic using URLs instead of topic IDs. For example, if a topic had a hard-coded target to File_5.html, clicking the link would display the HTML content in a task window type. ?xml version=1.0 ? map version=1.0 mapID target=topic_1 url=file_1.html mapID target=topic_2 url=file_2.htmla1 mapID target=topic_3 url=file_3.html wintype=intro mapID target=topic_4 url=file_4.htmla2 wintype=intro mapID target=topic_5.tsk url=file_5.html wintype=task mapID target=topic_5.cncpt url=file_5.html wintype=concept map This scheme allows authors to assign window types to HTML files and to also override those associations by linking to an alternate topic ID. For example, for topic-to-topic links, TOC links, index links, and hard-coded links to File_5.html, the author might use topic_5.tsk, but for links from a tutorial, the author might use topic_5.cncpt. By keeping this information in the map file, the author has one central repository for managing these assignments.

8.7.2 The oracle.help.engine.XMLMapConventionEngine Help Engine

If on your mapref element you set engine to be oracle.help.engine.XMLMapConventionEngine you may define your own topic name convention in your map file. For example, consider the following maps definition in a helpset: maps mapref location=map.xml engine=oracle.help.engine.XMLMapConventionEngine maps The XMLMapConventionEngine supports the standard mechanisms for setting up topic ID and window type mappings. However, it also supports the new topicNameConvention element. If using the XMLMapConventionEngine, your map.xml may resemble the following: map version=1.1 topicNameConvention urlbase=http:www.example.orghelp textbeginningTexttext filename text_text extension textendingTexttext topicNameConvention map The idea of the topicNameConvention is simple.You simply specify how your topic IDs are structured. If you set the urlBase attribute on the topicNameConvention, all help content files are assumed to be located at that