Sample Helpset File Helpset File

6-10 Oracle Fusion Middleware Developers Guide for Oracle Help 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. 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. Table 6–8 Map File Elements Element Description map Defines the mappings. The map element contains only mapID elements. mapID An ID and its associations. The mapID element has the following attributes: ■ target – The ID for the associated file. Valid characters are any alphanumeric character or punctuation symbol except the equals sign =. IDs must be unique across all helpsets in a given help instance. However, you can assign multiple IDs to a single file. For example, you could assign one ID for a topic file to appear in one window type and a different ID for the same topic file to appear in a different window type. ■ url – The location of the file to associate with this ID target. Relative URLs are resolved against the absolute URL for the map file. You may also specify a section of the file using anchor links. ■ wintype – [optional] The name of a windows type, defined using wintype elements in the helpset file. If a windows type is not specified, the topic associated with this ID is displayed in the default window defined in the helpset. The attribute is applicable for OHJ only. 7 Help Information Files 7-1 7 Help Information Files Help information files contain information about the content of the help system. The information includes: ■ Section 7.1, Table of Contents File ■ Section 7.2, Index File ■ Section 7.3, Search Index File ■ Section 7.4, Link File

7.1 Table of Contents File

The Table of Contents TOC file is an XML file that describes the content and layout of the table of contents. It is typically rendered as the Contents tab.

7.1.1 TOC Elements

Table 7–1 describes the elements used in the table of contents file: The following example shows a short table of contents file: Table 7–1 TOC File Elements Element Description toc Defines the table of contents. This element contains tocitem elements. The toc element supports the following attribute: ■ version - The version of the table of contents file format specification. The version documented here is 1.0. tocitem Defines a table of contents entry. A tocitem element can contain other tocitem elements to create a hierarchy of topics. Nesting tocitem_1 within tocitem_2 defines tocitem_ 1 to be hierarchically contained within tocitem_2. The tocitem element supports the following attributes: ■ target - The topic ID of the topic to display when this item is selected by a user. Topic IDs are maintained in the map file. A parent node that is, an item that contains others beneath it in the hierarchy may or may not include a target. If it does not have a target, selecting that node will simply display its child items and nodes. ■ text - The text displayed in the table of contents for this item. ■ image - An image to display next to this item. The value of this attribute is an image ID specified in the map file.