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.
7-2 Oracle Fusion Middleware Developers Guide for Oracle Help
?xml version=1.0? toc version=1.0
tocitem text=Introduction to My Product tocitem target=aboutmyp text=About My Product
tocitem target=architec text=My Product Architecture tocitem target=feature1 text=About Feature One
tocitem target=feature2 text=About Feature Two tocitem target=feature3 text=About Feature Three
tocitem text=Learning My product tocitem target=qtour text=Quick Tour
tocitem target=docguide text=Guide to Documentation tocitem
tocitem tocitem text=Step-by-step Procedures
tocitem text=Basic Tasks tocitem target=task1 text=To...
tocitem target=task2 text=To... tocitem target=task3 text=To...
tocitem tocitem text=Working with ...
tocitem target=task4 text=To... tocitem target=task5 text=To...
tocitem tocitem
toc
This definition produces the following TOC hierarchy:
■
Introduction to My Product
– About My Product
– My Product Architecture
– About Feature One
– About Feature Two
– About Feature Three
– Learning My Product
Quick Tour Guide to Documentation
■
Step-by-step Procedures
– Basic Tasks
To... To...
To...
– Working with ...
To ... To ...
7.2 Index File
The index file is an XML file that describes the content and layout of the index. It is typically rendered as the Index tab.
Help Information Files 7-3
7.2.1 Index Elements
Table 7–2 describes the elements used in the index file:
This example defines a very short index file: ?xml version=1.0 ?
index version=1.0 indexitem target=Add_Icon
text=Add Icon Command indexitem target=addtosheet
text=Adding an icon to a sheet indexitem target=addtoworkbook
text=Adding an icon to a workbook indexitem
indexitem target=Sheet_Background text=Adding a background to a sheet
indexitem text=Adding a new sheet to a workbook indexentry target=New_Sheet_command
text=New Sheet Command indexentry target=Add_new_sheet
text=To add a new sheet to a workbook indexitem
indexitem target=Add_item_to_sheet text=Adding an item to a sheet
index
The file in the example above produces this index list: Add Icon Command
Adding an icon to a sheet Adding an icon to a workbook
Table 7–2 Index File Elements
Element Description
index Defines the index. It can contain indexitem and
indexentry tags. indexitem
Defines an index item that appears in the keyword list. Nesting index_item_1 within index_item_2 defines index_item_1 to be
hierarchically contained within index_item_2, listed and indented below index_item_2 in the index. Oracle Help
currently supports only two levels of keywords. The index view collapses any nesting beyond two levels.
If an index item has more than one topic associated with it, the topics should be listed as index entries defined in
indexentry elements. The indexitem element has the following attribute:
■
target - The topic ID defined in the map file of the topic to display when the entry is chosen by the user.
indexentry Defines an index entry displayed in the topics list when the
parent index item is selected in the index list. This tag uses the following attribute:
■
target - The topic ID defined in the map file of the topic to display when the entry is chosen by the user.