The Topic Link hot spot creates a jump or pop-up link in the topic containing this hot spot.

The Behavior property of this hot spot type is set to Topic Link. 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 Jump (Hidden=False)	<span class="C1HJump"></span>	C1H Jump
C1H Popup (Hidden=False)	<span class="C1HPopup"></span>	C1H Popup

 

The following properties are supported by this hot spot type:

Supported Properties:	Description
Tag	This is the link tag of a topic, or the target of the link. The characteristics of this property are: •      Primary •      Default •      Simple •      Case-insensitive
Document	This is the document where the target of the link is located. The characteristics of this property are: •      Secondary •      Case-insensitive There is a special value reserved for the this property: Document=d2hmlDefault. This value refers to the current document, or the document where the hot spot is located.
Bookmark	This is the bookmark where the target of the link is located within the document specified by the Document property. The characteristics of this property are: •      Secondary •      Case-insensitive In Word, this is a bookmark name. In HTML source documents, this is the name of an <A> anchor tag.
Window	This is the name of the window where the target topic appears. The characteristics of this property are: •      Secondary •      Case-insensitive Note: This property does not apply to the C1H Popup style.
DisplayAsButton	This property specifies whether the hot spot is represented by a button in help targets. The characteristics of this property are: •      Secondary •      Boolean value True or False •      Case-insensitive •      Default value: False

To create a Topic Link hot spot, select the link text and press Jump Topic Link , Popup Topic Link  or Glossary Link  on the D2HML Styles toolbar. Use the Topic Link, Popup Link and Glossary Term Link dialog boxes to specify the properties of the link.

Topic Link Dialog Box

Popup Link Dialog Box

Glossary Term Link Dialog Box

There are several options for creating topic and pop-up links. You can create a link to a topic using the topic's link tag or topic title and the Tag property. You can also create a link to a bookmark inside a topic using the Document and Bookmark properties. If you have multiple, identical topics, you can specify in which document the topic you want to link to is located using the Tag and Document properties.

To link to a topic using the topic's link tag and the Tag property:

•      If the topic you are linking to is identical to the link text, you can leave the Topic field set to the default (Link tag defined by text). The link tag is specified in the Tag property of the hot spot:

Topic Link

•      If the topic you are linking to does not match the link text, enter a link tag in the Topic field. If the link tag is unknown, click the Browse button next to the Topic field, select Link Tags in the Select Topic dialog box, and choose one of the link tags for the topic. The link tag is specified in the Tag property of the hot spot:

Topic Link|tag=My_Topic

To link to a topic using the topic's title and the Tag property:

Enter the topic's name, if known, in the Topic field or click the Browse button next to the Topic field and select the topic. The topic title is specified in the Tag property of the hot spot:

Topic Link|tag=My Topic

To link to a bookmark inside a document using the Document and Bookmark properties:

1.   Check the Document checkbox and select the document where the bookmark is located. If the bookmark is in the current document, leave the (Current document) setting, which sets the Document property to d2hmlDefault.

2.   Click the Browse button next to the Bookmark field and select a bookmark from the specified document. The document is specified in the Bookmark property of the hot spot:

Topic Link|document=d2hmlDefault;bookmark=Boomark1

If your project contains multiple, identical topics, it is recommended that you create a unique link tag for each topic and then link to the topic using the topic's link tag. For more information on link tags, see Link Tag and Invisible Link Tag Hot Spots and Adding a Link Tag to a Topic. Alternatively, if you want to link to a topic using the topic title, you can use the Document property to specify which topic you want to link to.

To link to a topic using the Tag and Document properties:

1.   Specify a topic. If you click Browse and use the Select Topic dialog box, you can look for topics in different documents by clicking the Look in drop-down arrow and selecting a document.

2.   Check the Document checkbox and select the document where the topic you want to link to is located. If it is located in the current document, leave the default (Current document) setting, which sets the Document property to d2hmlDefault.

Topic Link|tag=My Topic; document=WordDocuments\Doc1.doc

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 Topic Link hot spot. Each of the following hot spots appears as Topic 12 in the help target. The secondary part is not visible.

 

Hot Spot in Word and HTML Editor	HTML Code	Description
Topic 12	<span class="C1HPopup">Topic 12</span>	A pop-up link to a topic having Topic_12 as one of its link tags is created.
Topic 12|window=proc	<span class="C1HJump">Topic 12|window=proc</span>	A jump to a topic having Topic_12 as one of its link tags is created. That topic will be shown in the ‘proc’ window.
Topic 12|tag=Topic 12;window=proc	<span class="C1HJump">Topic 12|tag=Topic 12;window=proc</span>	A jump to a topic having Topic_12 as one of its link tags is created. That topic will be shown in the window with the name proc.
Topic 12|=op	<span class="C1HPopup">Topic 12|=op</span>	A pop-up link to a topic having op as one of its link tags is created.
Topic 12|tag=Topic 12;bookmark=Bookmark1;document=WordDocuments\Doc1.doc	<span class="C1HJump"> d2hml="tag=Topic 12;bookmark=Bookmark1;document=HTMLDocuments\Doc1.htm	A jump to Bookmark1 in a topic having Topic_12 as one of its link tags in the Doc1.doc is created.
Glossary Term	<span class="C1HPopup">Glossary Term</span>	A pop-up link to a glossary heading having gloss_Glossary Term as one of its link tags is created.

 

Hot Spot in Word	Description
Topic 12|tag=Topic 12;bookmark=Bookmark1;document=WordDocuments\Doc1.doc	A jump to Bookmark1 in a topic having Topic_12 as one of its link tags in Doc1.doc is created.
Topic 12|bookmark=Bookmark1;document=WordDocuments\Doc1.doc	A jump to Bookmark1 in Doc1.doc is created. It is not necessary for the tag property to be specified since bookmark names are unique.

 

Hot Spot in HTML Editor	HTML Code	Description
Topic 12|tag=Topic 12;bookmark=Bookmark1;document=HTMLDocuments\Doc1.htm	<span class="C1HJump"> Topic12|tag=Topic 12;bookmark=Bookmark1;document=HTMLDocuments\Doc1.htm	A jump to Bookmark1 in a topic having Topic_12 as one of its link tags in Doc1..htm is created.
Topic 12|bookmark=Bookmark1;document=HTMLDocuments\Doc1.htm	<span class="C1HJump"> Topic12|bookmark=Bookmark1;document=HTMLDocuments\Doc1.htm	A jump to Bookmark1 in Doc1..htm is created. It is not necessary for the tag property to be specified since bookmark names are unique.