The oracle.help.engine.XMLMapFixedConventionEngine Help Engine

8-6 Oracle Fusion Middleware Developers Guide for Oracle Help URL. If all of your topic IDs begin with a string that is not a part of the filename or extension, you can specify a value for text at the beginning of the convention. Then you must specify either the filename or the extension to indicate whether the filename or extension appears first in your topic name convention. Then you can specify the text that separates the filename and extension. Either the filename or the extension should follow to indicate whether the filename or extension appears second in the convention. A final text may be specified if all topic IDs end with some text that is not part of the filename or extension. According to the above topic name convention, the topic ID of beginningTextmyfile_htmlendingText would resolve to the file http:www.example.orghelpmyfile.html. If the urlBase attribute was unspecified, it would be assumed that myfile.html is in the same directory as the helpset file. If you want to set up some standard topic mappings and window types in your map file but still use the topic name convention provided by the XMLMapFixedConventionEngine, you could define a topicNameConvention in your map file as follows: map version=1.1 topicNameConvention filename text_text extension topicNameConvention mapID etc... map In the above convention and the XMLMapFixedConventionEngine, the text that separates the filename and extension can appear multiple times in the topic ID. For example, consider the topic my_file_html. The engines assume that the separator between filename and extension is actually the last appearance of the _ character in the topic ID. Therefore, the topic resolves to my_file.html.

8.7.3 Optimizing Dynamic Maps

Dynamic mapping of topic IDs to files can result in great improvements in your help system performance. However, context sensitive help calls to specific topics may take a long time to resolve if your library includes many helpsets. The fundamental reason for this is that the convention-based mapping engines return URLs for topic IDs even if the URLs do not resolve to anything. Because of this, context sensitive help calls go through each helpset in the library and check whether the URLs generated by the engines actually resolve. In the worst case, for a single context sensitive help call, the help system will attempt to connect to as many URLs as there are helpsets in your library. However, Oracle Help provides a simple remedy to alleviate the problem. If you set an engine on your mapref element, you may also set the engineParams attribute. If you use the XMLMapConventionEngine or the XMLMapFixedConventionEngine, you may want to set engineParams to be a space-separated list of prefixes for the topics in your helpset. For example, if all topics in your helpset begin with either oh or help, your mapref would look like the following: mapref engine=XMLMap... engineParams=oh help Topic Files 8-7 Setting engineParams for either of the convention-based engines ensures that the helpset will only try to resolve topics if they start with a valid prefix, preventing an attempted connection to an URL. Failure to set engineParams will not break your help system, but performance will not be optimal.