Graphics with hotspots, macros and scripts

Navigation:  Basic Working Procedures > Using Graphics >

Graphics with hotspots, macros and scripts

Previous pageReturn to chapter overviewNext page

Show/Hide Hidden Text

Hotspots are active, clickable areas in graphics. Hotspot data is stored separately from the graphics, which  makes it possible to add hotspots to all graphics types, not just special hotspot graphics. All the link types supported in the editor are also supported in hotspots (topic links, Internet links, file links and script links).

Since the link types are identical to those used in normal topics their settings are only described briefly here. See Links, Anchors, Macros, Scripts and HTML for more information on hyperlinks.

 

flag_green        Key Information

Hotspots in graphics are only supported in electronic output formats (HTML Help, Windows Exe eBooks, Visual Studio Help and PDF with hyperlinks activated). ePub eBook readers do not support hotspots.

Click to expand/collapseHow to insert and edit a hotspot in a graphic

1.Insert the graphic in your topic.

2.Open the hotspot editor:

Double-click on the graphic and then click on the Hotspots... button

OR

Right-click on the graphic and select Picture > Edit Hotspots in the context menu.

DLG_Insert_Image_Hotspots

3.Click on one of the Insert Hotspot tools (this will insert a new hotspot in the top left corner of the graphic):

BTN_HSP_topic

Topic link hotspot

BTN_HSP_net

Internet link hotspot

BTN_HSP_file

File link hotspot

BTN_HSP_scrpt

Script link hotspot

4.Move and resize the hotspot with the mouse and select the hotspot style (Rectangle or Ellipse). You can also enter the precise size and position of your hotspot as pixel values.

5.Select and enter the hotspot details. These are exactly the same as for ordinary links in topics.

Editing hotspots:

To edit a hotspot just double-click on the graphic and open the Hotspots editor again.

Click to expand/collapseLinking to popup topics

You don't have to do anything special to create a link to a popup topic. A topic defined as a popup will automatically display as a popup when you link to it, so you just need to create a normal topic link and choose a popup topic as the target.

See Creating popup topics for full instructions on how to create and use popup topics. All the instructions here apply for links in hotspots, which are essentially exactly the same as normal links.

Click to expand/collapseHow to align hotspots precisely

The Align buttons arrange all the selected hotspots in a row, aligning them to first hotspot that you select:

1.Use Shift+Click to select all the hotspots you want to align. The hotspots will be lined up with the first hotspot you select.

2.Select one of the two Align tools to align the hotspots vertically or horizontally:

BTN_HSP_vertical

aligns the hotspots in a vertical row, using the first hotspot selected as the reference.

BTN_HSP_horizontal

aligns the hotspots in a horizontal row, using the first hotspot selected as the reference.

Click to expand/collapseOld IPP and SHG graphics with hotspots

In Help & Manual 3 and earlier, hotspots were stored in Impict IPP graphics files and in files in the standard Microsoft SHG format. If you convert HM3 projects containing these graphics to the current Help & Manual format the hotspots will be converted correctly.

However if you insert old IPP or SHG graphics containing hotspots in a current Help & Manual project the hotspots will not be available. If you want to use hotspots in these graphics you must re-enter them using the hotspot editor following the instructions above.

Click to expand/collapseHotspot compatibility in publishing formats

HTML Help:

Supported (JavaScript and four standard Winhelp macros)

Visual Studio Help:

Same as HTML Help but all external file links are explicitly forbidden in Visual Studio Help.

WebHelp:

Supported (JavaScript but no Winhelp macros, JavaScript support also depends to a great extent on the user's browser, so use with caution)

Windows Exe eBooks:

Hotspot topic links are supported, no support for script or macro links

ePub eBooks

Hotspots are included in the ePub specification but most ePub readers (both hardware and software) do not support them

Adobe PDF:

Hotspot topic links are supported, no support for script or macro links

Word RTF:

No support for graphics hotspots.

See also:

Links, Anchors, Macros, Scripts and HTML

IDs, Context Numbers and Keywords