Screen captures can illustrate features of your site and steps users need to follow on support or help pages. This topic covers how to add screenshots, aka screencaps, or other illustrations to a wiki document.

Obtain an Image Editor

You'll need a basic image editing program. A simple option is to use, available here, and described in the following steps:

The following screen capture shows in action and includes circles around key features discussed below.

Capture and Open a Screen Image

Methods for taking a screen capture of your desktop vary by platform. Look for a print screen key or "Snipping Tool" utility.

Capture the entire screen or a subset showing the area of interest. It may also help to resize your browser display window prior to capturing. In the LabKey Documentation, we aim for 800px wide images for a good display width.

Save the capture, typically as a PNG, jpg, or similar file. It may give you an option to choose the save location or save to your Documents or Pictures folder, sometimes in a Screenshots subfolder.

Open and open the image.

Crop and/or Resize the Image

The "Tools" panel typically floats on the left edge of the canvas. If this, or any tool, disappears, you can click the boxes in the upper right to show them again.

  • In the "Tools" panel, select the "Rectangle Select," represented by a dashed rectangle.
  • Click and drag the selection rectangle across the region of interest in your desktop screenshot.
  • Click the now-activated crop icon in the menu bar.
  • You may wish to repeat this process a few times to refine the selected region. If necessary, use the 'back' action in the history panel to undo any action.
To resize a large image:
  • Use the "Image" drop-down to select "Resize."
  • Make sure that "Maintain aspect ratio" is checked to allow the image to be shrunk in a uniform way in all directions.
  • Choose a new width for the image. LabKey documentation wikis typically keep images smaller than 800 pixels wide; given the border added below, this means a max-width of 798 pixels.

Annotate the Image

Using outlining, arrows, and text can help call out interesting features. First select the color palette you want to use. For LabKey documentation we use either an orange or red highlight color to be consistent with product branding.

  • In the "Colors" panel, you can click the wheel, or use the More >> menu to select colors by hex code, RGB, HSV, etc.
    • The 'Primary' color will be used for outlines, arrows, and text.
    • The 'Secondary' color will be added to the background if you expand the image (to add an outline below) or if you fill a shape).
  • In the "Tools" panel, select the "Shape" button at the bottom of the menu, then choose "Rounded Rectangle" from the pulldown in the menu bar.
    • Click on your image and drag the rounded rectangle across the image to add a highlight outline to the image.
  • In the "Tools" panel, click the 'T' button to enter text.
    • The font and size will be selectable above the workspace.
    • Type into the image as you feel is necessary and helpful.
    • After you add text you will see a handle for moving it around.
  • Arrows can also be added using the line icon with a "Style" selection including an arrow at the end.

Add a Pointer or Cursor Image

  • Download one of the cursor images:
  • Select "Layers" -> "Import from File" and browse to the downloaded cursor image.
  • Position the cursor image as appropriate using the handle.
After adding a cursor, note that the file will be in several layers (shown in the "Layers" panel). When you save, you will want to specify saving as a PNG file and accept Flattening of the image. By default, multilayer files will be saved as workspaces and not display correctly until flattened.

Add a Border

  • In the "Colors" floating menu, set the 'Secondary' color to black.
  • Use the "Image" drop-down to select "Canvas Size."
  • Make sure that the image icon in the "Anchor" section of the popup is centered so that the canvas will be expanded in equal amounts on all sides.
  • Increase "Width" and "Height" in the "Pixel size" section by 2 pixels each. This adds a one-pixel border on each side of the image.
You can skip this step if you will add a border in the HTML for the page.

Save the Image

  • Typically, save the image as a .png for use on a web site. This compact format displays well on the web.
  • You will be prompted to flatten the image if you imported cursors or other image files.

Add your Image to a Wiki-syntax Page

  • Open a wiki page for editing
  • Add the saved file as an attachment to the wiki.
  • Uncheck the "Show attachments" box.
  • At the point in the text where you would like to display the image, enter the name of the image file enclosed in square brackets. Example: [myImage.png].
  • Save and close the wiki.

Add your Image to an HTML-syntax Page

  • Open a wiki page for editing
  • Add the saved file as an attachment to the wiki.
  • Make sure that the "Show attachments" box is checked.
  • Save and close the wiki.
  • You will see a hyperlink to the uploaded image below the text of the wiki page. Copy the URL for the image.
  • Open the wiki page for editing again.
  • Uncheck the "Show attachments" box.
  • At the point in the text where you would like to display the image, click the Image icon in the wiki editor (it looks like an image of a tree).
  • Enter the copied URL for the image. Optionally, enter a description. Select "Insert" in the dialog to save your changes. Note that you may be warned that you have not entered a description if you left one out. Entering a description is optional.
  • Save and close the wiki.

Related Topics


Was this content helpful?

Log in or register an account to provide feedback

expand all collapse all