You are here: Doc-To-Help Markup Language (D2HML) > Hot Spot Types > Keyword and Invisible Keyword Hot Spots

Keyword and Invisible Keyword Hot Spots

The Keyword and Invisible Keyword hot spots assign a keyword or list of keywords to the topic containing the hot spot. The keyword appears in the index, and when it is clicked, it will jump to the topic containing this hot spot. The difference between the two hot spot types is that the text of the Invisible Keyword hot spot does not appear in the help target.

The Behavior property of these hot spot types is set to Keyword. 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 Index (Hidden=False)

<span class="C1HIndex"></span>

C1H Index

C1H Index Invisible (Hidden=True)

<span class="C1HIndexInvisible"></span>

C1H Index Invisible

Note: The AutoIndex property of these character styles is set to True.

 

The following properties are supported by this hot spot type:

Supported Properties:

Description

Keyword

This is the keyword or list of keywords to assign to the topic containing this hot spot. You can create keywords, if necessary. The characteristics of this property are:

      Primary

      Default

      Collection

      Case-insensitive

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

Keyword 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 Keyword hot spot:

Hot Spot in Word and HTML Editor

HTML Code

Description

My Topic

<span class="C1HIndex">My Topic</span>

The topic containing this hot spot is associated with the keyword My Topic; the keyword is created if it does not already exist.

My Topic|=Keyword

<span class="C1HIndex">My Topic|=Keyword</span>

The topic containing this hot spot is associated with the keyword Keyword; the keyword is created if it does not already exist.

My Topic|keyword=Keyword

<span class="C1HIndex">My Topic|keyword=Keyword</span>

The topic containing this hot spot is associated with the keyword Keyword; the keyword is created if it does not already exist.

My Topic|keyword =Keyword1+Keyword2

<span class="C1HIndex">My Topic|keyword =Keyword1+Keyword2</span>

The topic containing this hot spot is associated with the keywords Keyword1 and Keyword2; the keywords are created if they do not already exist.

My Topic|Keyword1+Keyword2, Secondary keyword

<span class="C1HIndex">My Topic|Keyword1+Keyword2, Secondary keyword</span>

The keywords Keyword1, Keyword2 and Secondary keyword are associated with the topic containing this hot spot. Secondary keyword is a child (second-level) keyword with parent Keyword2. The keywords are created if they do not already exist.

My Topic|keyword=Keyword1

<span class="C1HIndexInvisible">My Topic|keyword=Keyword1</span>

The topic containing this hot spot is associated with the keyword Keyword1; the keyword is created if it does not already exist. My Topic|keyword=Keyword1 is not visible in the help target.

Remarks:

In a second-level keyword (one containing a comma), only the child keyword is associated with the topic. If you need to associate the parent keyword with the topic, include it in the list as a separate first-level keyword.