Inserting topic links

<< Click to Display Table of Contents >>

Navigation:  Basic Working Procedures > Links, Anchors, Macros, Scripts and HTML >

Inserting topic links

Previous pageReturn to chapter overviewNext page

Show/Hide Hidden Text

The easiest way to create hyperlink to another topic in your current project is with Drag & Drop just select text in the editor and drag it onto the topic you want to link to in the Table of Contents.

 

prod_tip       Productivity Tip

You can navigate to the targets of your links within your project by holding down Ctrl and clicking on the link.

tog_minusHow to create a topic hyperlink with Drag & Drop

Drag topic text on to the target topic:

This method turns text in your topic into a hyperlink to a selected topic in the TOC.

1.Select the text in your topic that you want to use as the link caption (you can edit this later).

WIN_Hyperlink1T

2.Drag the selected text onto the topic in the Table of Contents (TOC) that you want to link to and release the mouse button.
3.To view and edit the hyperlink settings double-click on the link to display the Hyperlink dialog box.

Drag target topic into the topic text:

This method turns a TOC entry into a hyperlink to that entry in your topic.

1.Click on the target topic in the TOC and hold down the mouse button (if you release the button this won't work).
2.Drag to the position in the current topic where you want to insert the link, then release the button.
3.Double-click on the new hyperlink to open its properties if you want to edit the link text etc.

Links to anchors:

To quickly create a link to an anchor in the current or another topic just create the link with Drag & Drop and then double-click on the link to select the target anchor in the dialog. Select the anchor from the drop-down list next to the Target: field (see below for details).

Links to popup topics:

You do not need to do anything special to create a popup link. Links to popup topics in your project automatically open the target topics as popups.

tog_minusHow to create a topic hyperlink manually
1.Select text in your document if you want to use it as the link. You can also skip this step and enter the caption in the hyperlink dialog.
2.Open the Insert Hyperlink dialog box. There are two different ways to do this:
Press Ctrl+L
Select the Link tool in Write > Insert

DLG_Insert_Link

3.Right-click on the target ID to quickly copy the title of the target topic to the Caption (Ctrl+L) or Tooltip (Ctrl+T) fields:

dlg_linktitle

4.Edit the Caption: if necessary and select the link style (standard link, plain text, button or graphic).

You can type the <%TARGETTITLE%> variable in the Caption;: field to automatically insert the title of the target topic as the caption. See further below for full instructions.

5.Select the ID of the topic you want to link to from the Topic ID: list.

If the topic contains anchors you can also select an anchor  from the drop-down list next to the Target: field. The link will then jump directly to the position of the anchor in the topic instead of the top of the topic.

See The Hyperlink dialog for details of the other settings in the dialog. See Linking to other projects and help files for details on creating external links.

Links to popup topics:

You do not need to do anything special to create a popup link. Links to popup topics in your project automatically open the target topics as popups.

Click to expand/collapseAutomatic hyperlink captions with the <%TARGETTITLE%> variable

When you create topic links you can insert any text you like as the link text (caption). However, you can also insert a special variable that automatically inserts the title of the target topic when you publish your help. The advantage of this is that the link caption will update automatically if the title of the target topic changes.

1.Create a hyperlink using any of the methods described on this page.
2.In the Caption: field of the Edit Hyperlink dialog enter the following variable, typing all characters of the variable exactly as shown, including the <% and %> characters:

<%TARGETTITLE%>

Tip: Double-click on a hyperlink in the editor to display the Edit Hyperlink dialog.

Click to expand/collapseInsert page references for links in PDF and printed manuals

In print-style (non-interactive) PDFs and printed manuals links are not active – you can't click in a paper printout. You can configure Help & Manual to automatically insert the page numbers of the targets of topic links in a little icon directly after the link in PDFs and printed manuals.

To activate this, go to Project Explorer > Configuration > Publishing Options > PDF > PDF Layout and turn on the option "Insert Page Referrers". If you do this, you should also turn on the "Underline topic links" option to make the links visible.

Click to expand/collapseHow to create multiple topic links with Copy & Paste

This method works with both single and multiple links. If you copy multiple items in the TOC and paste them in the editor the result will be a list of links to the selected topics.

1.Select one or more items in the TOC that you want to link to. Use Ctrl+Click and Shift+Click to select multiple items.
2.Select Copy in the Clipboard tools in the Ribbon or press Ctrl+C.
3.Click in the editor where you want to insert the links.
4.Select Paste in the Clipboard tools the Ribbon or press Ctrl+V.

This will insert a list of links to all the items you copied from the TOC.

Click to expand/collapseOpening topics in external windows in CHM and HLP

In HTML Help (.chm) you can open topics in external windows by specifying a secondary help window type in the link definition. Just select the window type you want to link to in the Window: field in the Insert Hyperlink dialog.

See Using help windows for more details.

Click to expand/collapseLinking to anchors in topics

If the target topic contains anchors you can link to an anchor to take the user directly to a point inside the target topic.

Double-click on the link in the editor to display hyperlink dialog and select the anchor from the drop-down list next to the Target: field.

dlg_targetanchor

The procedure is the same when you are creating a new link. Just select the anchor you want to link to from the drop-down list.

Anchors in embedded topics:

If you link to a topic containing an embedded topic any anchors in the embedded topic will not be displayed in the drop-down anchor list. To link to an anchor in an embedded topic make a note of the anchor ID and type it in the drop-down list box next to the Target: field manually when you edit the hyperlink.

Click to expand/collapseTopic link compatibility in publishing formats

HTML Help:

Fully functional

Visual Studio Help:

Fully functional.

WebHelp:

Fully functional

Adobe PDF:

Functional if activated in Configuration > Publishing Options > Adobe PDF > PDF Layout.

Windows Exe and ePub eBooks:

Fully functional

MS Word RTF:

Fully functional (links in RTF are activated with Ctrl+Click)