Adding Link Tags

A link tag is a unique identifier for a topic, and makes it possible to create a jump or popup link to a topic. If a paragraph style has the Auto Link check box selected, then Doc-To-Help will automatically create a link tag for every topic using that style (see About Project Styles and Topic Types). Automatic link tags are identical to the topic title, but spaces, hyphens, and periods are replaced by underscores.

Sometimes you may need to manually create a unique link tag for a topic, particularly if you have two or more topics with the same name, and therefore the same link tag. The Link Tag dialog makes this possible. A topic can have more than one link tag, and can be viewed in the Topics window (right-click and select Columns>Link Tag from the context menu).

  1. In the Word source document, select text where you want to add the link tag.
  2. Select the Doc-To-Help ribbon.
  3. In the D2HML Styles group, click the Link Tag button. The Link tag dialog opens. The selected text is displayed at the top of the dialog.
  4. (Optional) By default, the link tag will be the selected text. The phrase "Link tag defined by Text" is displayed in the Link Tag field. If you would prefer to use another link tag, use one of these options:

    • If you would like to assign a link tag to the text, select it in the Link tags area.

    • If you would prefer to use another link tag, you can add a new link tag to the list. To do this, in the Link tags area, click Add New Link Tag. An editable link tag is created, titled "New Link Tag." Type the new link tag within the box and press ENTER.
  5. (Optional) If you want to hide the tag, you can select the Hide properties in document. Clearing the Visible check box will hide the text in your source document. See Showing Hidden Hotspots.
  6. Click OK.

Tip If you want to link to a topic title that will change with each build (e.g., some text is conditioned or it includes a dynamic variable), create a link tag and link to it to avoid broken links when the text changes.