<< Click to Display Table of Contents >>

Navigation:  Reference > Workspace, Toolbars and Dialogs > The Write Tab > Insert / Insert Object >


This dialog contains all the options for inserting hyperlinks in your topics. For detailed instructions see the Links, Anchors, Macros Scripts and HTML chapter. The appearance of the dialog changes depending on the kind of link you are inserting.

The Insert Hyperlink dialog:


Common options for all link types:

Caption / Picture:

The caption displayed in the text for the link if you are creating a text link. If you select text in the editor before invoking the Insert Link function the selected text is displayed here.

If you select Picture in the Style section (see below) Picture: is displayed above this field instead of Caption:. The BTN_Browse_Folder browse button to the right of the entry field is then activated so that you can select a picture to use.

Using the Automating Publishing Jobs variable:
If you type this variable in the Caption: field it will automatically insert the title of the target topic as the caption of the link when you publish your project. See Inserting topic links for details.


Adds text for a tooltip that is displayed on mouseover in HTML-based output formats.



The standard link format: text link, displayed in blue with an underline.


Displays the link as plain text that you must format yourself in the editor. If you don't format the link it will be active but it will not look any different from the text around it, i.e. it will not be identifiable as a link.


Displays the link as a standard Windows button. The caption in the Caption: field is used as the label text on the button.


Uses a graphic as the link instead of a text caption. The supported graphics types are indicated by file extensions are displayed in the dialog displayed when you click on the BTN_Browse Browse button to select a file.

Topic link dialog options:


Help file:

The file containing the topic you want to link to. By default this is the current project file but you can also create links to other project files and compiled HTML Help CHM files.

Click on the BTN_Browse browse button to select a different help file. Its topics will then be displayed in the Topic ID list.

The target help file must be present in the same directory as the file containing the link at runtime (i.e. on the user's computer). Also, the target help file must have the same format as the help file containing the link. You cannot create links between help files of different types, only between two CHM files.


Only relevant in HTML Help. If you have defined secondary window types for your project you can select a different help window type for opening the target topic.

In HTML Help selecting a secondary help window here only opens an external window if secondary HTML Help windows are activated in the Help Windows configuration. If they are not activated this setting has no effect in HTML Help.

Topics in HTML Help do not change their background colors when you specify a secondary help window in a hyperlink. Their colors are defined by the HTML template of their own window type definition and this cannot be changed by a link. Even when they are displayed in an external window the secondary window type only controls the appearance of the window, not of the topic itself.


The topic ID of the topic you want to link to. Select the ID from the list or type its name in the entry field. Each letter you type will automatically display the first topic matching that letter.

(drop-down list next to Target:)

Use to link to an anchor inside the selected topic, so that clicking on the link takes the user directly to the position of the anchor. Anchors are only displayed here if the target topic already contains anchors. If you have just inserted an anchor in the target topic it is not displayed until you save your project.

Internet link dialog options:



The website URL or email address you want to link to. Always enter a complete URL for websites, including the http:// protocol prefix. Links without this prefix sometimes don't work in HTML Help.


Test the URL. Opens your browser or email program.

Links to an Internet address:

Select to enter a website URL.

Sends an email:

Select to enter an email address.

Target window:

Same as referring topic
Opens the web page in the current browser window or the help viewer if possible. (The Windows Exe eBook viewers cannot display web pages, ePUB readers will only open a browser if possible and available.)

Arrow_rUse this option instead of Top frame when loading web pages into WebHelp topics if you want the Table of Contents to remain visible when the web page is loaded.

New window:
Opens the web page in a new browser window.

Top frame:
This option is designed for WebHelp output. It  loads the web page into the topmost frame in the current frame structure, completely overwriting the Table of Contents so that the web page fills the entire browser window.

File link dialog options:

File links link to external files located in the same directory as the help file containing the link. When the user selects the link it is like double-clicking on a file in the Windows Explorer.

See Inserting file links for details and compatibility with various output formats.


File name:

The name of the file you want to link to. You can use the BTN_Browse browse button to select a file but this will not enter any path information because it is assumed that the file will be in the same directory as the help file containing the link.

If you enter the file name manually always type the complete name of the file, including the extension.

Execution parameters:

Any parameters you want to add to the file link, for example switches or a file name to follow an executable program.


Tests the file link with the execution parameters. If you use the BTN_Browse button in the File name: field to select the file this will access the file wherever it is located.

Note that this doesn't test whether the file link is compatible with your output format! It only tests how executing the external file behaves with the execution parameters entered.

Script link dialog options:

This option enters a link that executes a Winhelp macro or some JavaScript code. Please see Inserting script and macro links for information on how to use this function.


HTML JavaScript:

Select this to enter JavaScript code. Only supported in HTML Help and WebHelp output.

Winhelp macro:

Select to enter a Winhelp macro. Although the obsolete Winhelp output is no longer supported, four special Winhelp macros are automatically converted to their ActiveX equivalents in HTML Help. See Inserting script and macro links for details.


Enter your script or Winhelp macro here.

Note on script links:

Script links are generated as follows:

<a href=" contents of Script window ">

If you are familiar with web scritping you can use this information to enter complex scripts. (See the links under See also: below for full details on this.)

Load from File:
Save to File:

These buttons allow you to save and load blocks of script and macro code that you want to reuse.

Load from file.. loads a text file to the current cursor position in the script window.
Save to file.. saves the entire contents of the script window to a text file.

See also:

Inserting script and macro links

Scripts, HTML and Macros (Reference)