How to Add Screenshots to a Wiki

Screen captures can help you highlight parts of your site that are particularly interesting to users. Screen captures can also help to you illustrate the steps you're asking users to follow on support or help pages. This topic covers how to:

  • Obtain an image editor.
  • Get a screen capture into the editor.
  • Crop the image.
  • Draw a red circle on the image to call out an interesting feature. Optional.
  • Resize the image. Optional.
  • Add a border to the image. Optional.
  • Save the image.
  • Add your image to a wiki-language wiki.
  • Add your image to an HTML-language wiki. Optional.
Obtain an image editor.
  • Download and install a basic image editing program. This tutorial assumes that you will use paint.net, a simple, free program that works well for screen captures. The following screen capture shows paint.net in action and includes circles around key features discussed below.

Get a screen capture into the editor.

  • Do a screen capture for your desktop. The correct key combo varies by keyboard or may be facilitated with a "Print Screen" button or "Snipping Tool". An PNG image of the desktop and any open windows is now contained in the clipboard, or stored in a common location such as a "Screenshots" folder.
  • Within paint.net, open the saved image (or paste from the clipboard to a blank canvas).
Crop the image.
  • In the "Tools" floating menu, select the "Rectangle Select," which is represented by a dashed rectangle and is located at the top left of the menu.
  • 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.
Resize the image. Optional.
  • 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.
Draw a red outline on the image to call out an interesting feature. Optional.
  • In the "Colors" floating menu, click on the top square to allow yourself to select the primary color. Then click on the tiny red square to pick red as the primary color.
  • In the "Tools" menu, 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 red oval to the image.
Add red text or arrows to explain as needed. Optional.
  • Click the 'T' button to enter text, type into the image as you feel is necessary and helpful.
  • Arrows can also be added using the line icon with a "Style" selection including an arrow at the end.
Add a mouse cursor to the image. Optional
  • 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.
Add a border to the image.
  • In the "Colors" floating menu, click on the bottom, large square to allow yourself to select the secondary color. Then click on the tiny black square in the color palette to pick black as the secondary color. This color will be used for the border of the image.
  • 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.
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-language wiki.
  • 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-language wiki.
  • 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.

Discussion

previousnext
 
expand all collapse all