Export (0) Print
Expand All

Table of Contents (.HxT) File 

Defines the content and organization of a table of contents (TOC) associated with a compiled Help (.HxS) file. The .HxT file also contains general properties for both the TOC as a whole and each individual node. The TOC provides a structured view of the Help content and in many cases is the main entry point into Help. When a user opens the TOC of a compiled Help (.HxS) file and chooses a topic title, the content file associated with that topic opens. You add one or more .HxT files to your Help project, and then use the TOC Editor to manipulate TOC nodes and their properties.

The following example shows the basic structure of a TOC file.

NoteNote

The file consists of tags, each of which contains one or more attributes.

Choose an attribute to see its corresponding topic.

Comments indicate which attributes are required.

Where applicable, defined choices are displayed in parentheses.

All attribute values must be enclosed in quotation marks.

As with all XML documents, the tags and attributes in this file are case-sensitive.

<?xml version="1.0"?>

<!DOCTYPE HelpTOC SYSTEM "MS-Help://Hx/Resources/HelpTOC.dtd">

<HelpTOC

   Id Attribute = ""

  DTDVersion Attribute = "1.0" <!-- Required -->

   FileVersion Attribute = ""

   LangId Attribute = ""

   Font Attribute = ""

   FontSize Attribute = ""

   Charset Attribute = ""

>

<HelpTOCNode <!-- Can appear 1 or more times -->

   Id Attribute = ""

   NodeType Attribute = (TOC | Regular)

   New Attribute = ""

   Title Attribute = ""

   LangId Attribute = ""

   Font Attribute = ""

   FontSize Attribute = ""

   Charset Attribute = ""

   Url Attribute = ""

   Owner Attribute = ""

/>

</HelpTOCNode>

<ToolData <!-- Can appear 0 or more times -->

   Name Attribute = "" <!-- Required -->

   Value Attribute = "" <!-- Required -->

>

</HelpTOC>

Remarks

The <HelpTOC> tag defines the general options for the entire table of contents, and can appear only once per document, while the <HelpTOCNode> tag can appear as often as required. The <ToolData> tag is optional.

To create a hierarchy of Help topics, use nested <HelpTOCNode> tags. The following example shows how to nest TOC nodes.

<HelpTOCNode Title="First Node">
      <HelpTOCNode Title = "Subnode A"/>
      <HelpTOCNode Title = "Subnode B">
         <HelpTOCNode Title = "B1"/>
      </HelpTOCNode>
<HelpTOCNode Title = "Second Node"/>
</HelpTOCNode>
NoteNote

The closing slash is omitted from the <HelpTOCNode> tag whenever a subnode follows.

Topics associated with parent TOC nodes need to contain the same set of attributes as all child node topics beneath the parent. This is so that the parent node behaves properly and still links to a topic if filtering is applied to the TOC.

The respective values assigned to the Title and Id attributes should not exceed 2000 characters. If this limit is exceeded, the value is truncated. The compiler does not issue an error or warning at this time.

See Also

Community Additions

ADD
Show:
© 2014 Microsoft