Index file

This topic describes the syntax of the index.xml file.

The index.xml file enables you to include and organize the HTML topics in the application help.

Syntax

<?xml version="1.0" encoding="UTF-8"?><?xml-stylesheet  href="../../theme/xsl/index2html.xslt" type="text/xsl"?>
<topics FeatureID="FEATURE_ID" title="TITLE_OF_THE_HELP" compressed="true">
	<topicref FeatureID="FEATURE_ID" href="PATH_OF_the_HTML_TOPIC_1" navtitle="TITLE_OF_the_HTML_TOPIC_1"/>
	<topicref FeatureID="FEATURE_ID" href="PATH_OF_the_HTML_TOPIC_1" navtitle="TITLE_OF_the_HTML_TOPIC_1"/>
	...
	...
</topics>

In the preceding code snippet, <topics> is the root element of the index.xml file which includes the <topicref> tags to define topics of the help. The <topics> tag contains the following parameters:

FeatureID="FEATURE_ID": Specify the value –1.
title="TITLE_OF_THE_HELP": Indicates the title of the application help.

You must add the <topicref> tags in <topics> for the each HTML topic you want to include in the application help. The <topicref> tag contains the following parameters:

FeatureID="FEATURE_ID": Specify the value –1.
href="PATH_OF_the_HTML_TOPIC_1": Specifies the path of the HTML topic.
navtitle="TITLE_OF_the_HTML_TOPIC_1": Specifies the title of the HTML topic.

Note: The values of the title and navtitle must be in the language that you have selected while creating the application help. For example, if you have selected the Chinese language, the values of these parameters must be in that language.

Example

 <?xml version="1.0" encoding="UTF-8"?><?xml-stylesheet href="../../theme/xsl/index2html.xslt" type="text/xsl"?>
<topics FeatureID="-1" title="CS Help HelloWorld application" compressed="true">
	<topicref FeatureID="-1" href="SAMPLE_HLP_TOPIC_1.html" navtitle="Formatting the content"/>
	<topicref FeatureID="-1" href="SAMPLE_HLP_TOPIC_2.html" navtitle="Linking a topic"/>
</topics>

The preceding index.xml file defines the application help for the CS Help HelloWorld application. The application help contains two topics, Formatting the content and Linking a topic.