Inserting Images into topics

Help Builder allows you to access images in three separate ways:

Linking to an existing image that exists on disk is easily done by using the image icon on the toolbar. Ideally you'll link to an image that exists in your images directory or any other directory that is relative below the project's root folder.

If the file is a relative path to the project, the image is simply embedded as a relative link. If the image is a non-relative path, you are prompted to optionally copy the file to the project's image folder in order to create a relatively linked image that can be embedded into the help file. Images that are outside of the project folder will not automatically be embedded into a help file, and likely won't work on the Web site either.

Avoid using hard coded Image Paths

Although you can link a non-relative image path from your local or network drives, this is not recommended as these images are not part of your project and so are not compiled into help file or published to the Web server when publishing via FTP.

To insert an image simply place the cursor where you want to insert the image, then press the Image button. A file picker pops up and you can select an image from disk. Select and the image is linked into the document using standard Markdown syntax:


And voila your topic now looks like this:

You can also link a Web URL like this either directly or by using the image dialog:

![Help Builder Logo](

Note that you can also use raw HTML if you would like to apply some formatting to the image layout. For example, I'd like for the logo to be left aligned and float with the text. To do this I can use raw HTML like this:

<img src="images/webmonitor_sm.jpg" 
     style="margin: 0px 10px 5px 0px;float: left;"/>

which can embed the image like this:

Pasting Images from the Clipboard (Ctrl-v)

One very convenient way to add images to a document is to use image pasting from the clipboard. There are lots of ways in Windows to capture images on the clipboard. Here are a few common ways to capture images to the clipboard:

  • Copy Image in your Web Browser using Copy Image
  • Copy Image from your favorite Image Editor
  • alt-PrtScn or ctrl-PrtScn to capture screen or active window

To embed an image from the clipboard into your Help Builder topic:

  • Move the cursor to the position to insert the image
  • Press Ctrl-v
  • Select a filename to store the image relative to the project
  • Click OK

When done an image link is embedded into the page.

Screen Captures

Help Builder also allows you to directly capture images from the screen. It supports two modes - if you have TechSmith's SnagIt installed it will use [#SnagIt](SnagIt to capture images directly). Otherwise it will use a more simplistic Ctrl/Alt-PrtScrn based capture mechanism to capture windows and the entire screen.

Built in Screen Capture

Help Builder provides a basic screen capture utility natively. Click the camera icon to start a capture, and you'll see a form like this:

To capture a window, click the big button and hold it down, then drag the cursor over any window or control that you want to capture. Release to capture the window or control.

Once you've captured the window the content displays in the form as shown in the screen shot above displaying a captured preview window.

SnagIt Image Capture

If you have SnagIt from Techsmith installed, Help Builder will allow you to use it to capture images using its Active Window Capture mode. SnagIt use must be enabled in the Options | Help Builder Settings using the Use SnagIt for screen captures if available checkbox.

Once enabled using the Camera Icon immediately jumps you into SnagIt's own capture mode that lets you interactively select a window or other object to capture. Select your image, and when the Image Editor pops up, customize your image as needed and when done press the Finish button. You will be prompted to save the file in the project's image folder.

When you click OK, Help Builder pops up again and embeds the image into the document as shown before:


You can configure the image capture mode for SnagIt, by clicking the dropdown button next to the camera icon which brings up this form:

The settings you set here are used for subsequent SnagIt screen captures. You can optionally force these options to be shown before each capture.

Next: Inserting Hyperlinks to other sites

See also

Step By Step Guide

© West Wind Techologies, 2018 • Updated: 04/09/18
Comment or report problem with topic