You are here: Doc-To-Help Markup Language (D2HML) > Hot Spot Types > Contents Title Hot Spot

Contents Title Hot Spot

The Contents Title hot spot assigns a title you want to appear in the table of contents to the topic containing this hot spot. For example, if you have a topic My New Topic, and you would like the table of contents (TOC) entry for this topic to read New Topic, you can use the contents title hot spot to set the TOC title. You can also achieve this by using the ContentsTitle property in the Doc-To-Help Project Editor.

The Behavior property of this hot spot type is set to Contents Title. The following predefined styles have this Behavior, and the corresponding HTML tag or Word Style can be used when formatting without the D2HML Styles toolbar:

D2HML Style

Corresponding HTML Tag

Corresponding Word Style

C1H Contents Title (Hidden=False)

<span class="C1HContentsTitle"> </span>

C1H Contents Title

 

The following properties are supported by this hot spot type:

Supported Properties:

Description

ContentsTitle

The title of the topic used in TOC. The characteristics of this property are:

      Primary

      Default

To create a Contents Title hot spot, select the link text and secondary part, if it exists, and press Contents Title  on the D2HML Styles toolbar. Use the Contents Title dialog box to specify the properties of the link.

Contents Title Dialog Box

Click the More button  to access additional properties. When the More button is clicked while using this dialog box in Word, you may select the Hide Properties in Document checkbox to hide the properties in your source document. To show the properties, uncheck the Hide Properties in Document checkbox, or select Tools | Options in Word and on the View tab, check the Hidden text checkbox.

If you are not using the toolbar, place the link text and secondary part in the corresponding HTML <Span> tag to format it with the D2HML style.

The following table gives you some examples of using the Contents Title hot spot:

Hot Spot in Word and HTML Editor

HTML Code

Description

New Title

<span class="C1HContentsTitle">New Title</span>

The ContentsTitle of the topic containing this hot spot is set to New Title.

New Title|=A Title

<span class="C1HContentsTitle">New Title|=A Title</span>

The ContentsTitle of the topic containing this hot spot is set to A Title.

New Title|contentstitle=A Title

<span class="C1HContentsTitle">New Title|contentstitle=A Title</span>

The ContentsTitle of the topic containing this hot spot is set to A Title.