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

Group Link Hot Spot

The Group Link hot spot creates a link to the topics belonging to the group contained in the hot spot or the specified group. A topic must be a group member before this hot spot can link to it. For example, you can create a link to the topics belonging to the group MyGroup if the topics are members of MyGroup. To assign a topic to a group, see Group and Invisible Group Hot Spots.

The Behavior property of this hot spot type is set to Group 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 Group Link (Hidden=False)

<span class="C1HGroupLink"></span>

C1H Group Link

 

The following properties are supported by this hot spot type:

Supported Properties:

Description

Group

This is one or more groups (usually one) defining the list of topics shown to the user as link targets. The characteristics of this property are:

      Primary

      Default

      Collection

      Case-insensitive

Window

This is the name of the window displaying the topic after the user selects the target from the list. The characteristics of this property are:

      Secondary

      Case-insensitive

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 Group Link hot spot, select the link text and press Group Link  on the D2HML Styles toolbar. Use the Group Link dialog box to specify the properties of the link.

Group Link 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.

Note: When the More button is clicked while using this dialog box in FrontPage and Dreamweaver, there is a Display as a button checkbox, not a Hide Properties in Document checkbox. When this checkbox is selected and the help target is built, the link appears as a button rather than a link.

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

Hot Spot in Word and HTML Editor

HTML Code

Description

MyTopic

<span class="C1HGroupLink">MyTopic</span>

A link to the topics belonging to the group MyTopic is created.

MyTopic|window=proc

<span class="C1HGroupLink">MyTopic|window=proc</span>

A link to the topics belonging to the group MyTopic is created. The topic selected by the user is shown in the window with the name proc.

MyTopic|group=Group;window=proc

<span class="C1HGroupLink">MyTopic|group=Group;window=proc</span>

A link to the topics belonging to the group Group is created. The topic selected by the user is shown in the window with the name proc.

MyTopic|group=Group1+Group2

<span class="C1HGroupLink">My Topic|group=Group1+Group2</span>

A link to the topic list containing topics in groups Group1 and Group2 is created.

MyTopic|=Group1+Group2

<span class="C1HGroupLink">My Topic|=Group1+Group2</span>

A link to the topic list containing topics in groups Group1 and Group2 is created.