Table of Contents
Tutorials
easyDITA Image Annotations
easyDITA Image Annotations

Using Image Annotations

Learn how to use easyDITA’s image annotations to add visual markups to images.
easyDITA provides an image annotation feature that enables you to upload an image and add annotations to it. Annotations are visuals that help to indicate and clarify areas of an image. They’re especially useful for labeling screenshots.
Adding annotations to an image places the image in a SVG container, which allows you to add annotations over the image without modifying the image itself. That way, you can still use the original image elsewhere.
This tutorial will walk you through the types of annotations in easyDITA, how to annotate images, and the ways you can modify an annotation.  
Note:You must have the correct DTDs installed to annotate images.  

Types of Annotations

section
You can upload an image and annotate it using basic annotations or linked annotations.
Basic Annotations
Basic annotations are rounded rectangles that direct a reader’s attention to a specific region of the image.
Linked Annotations
Linked annotations are numbered pointers that link to a particular step or ordered list item. They display a number that correlates to the step or ordered list item number. Adding a linked annotation assigns an id to the step. So if the step order changes, you can click Refresh Annotations to update the annotations instead of uploading and annotating the image again.
Note:You must have the correct DTDs installed to annotate images.  
Here’s an example of a topic with an annotated image:

Adding a Basic Annotation

Annotate images with a basic annotation to help clarify areas of an image.
  1. First, you need to convert your image to an annotated image so you can annotate it. Right-click the image and select Annotate Image .
  2. Right-click the image and select Add Basic Annotation -> Rectangle.

    Step Information
  3. To modify the rectangle annotation, select the annotation and do any of the following:

    Step Information
    A blue box displays outlining the selected annotation.
    1. To move the annotation, click and drag the annotation to a new location.
    2. To resize the annotation, click and drag the red ball.
    3. The change the color of the annotation, click Change Color and enter the color you want to display in hexadecimal code. For example, the hexadecimal code for red is FF0000.
result
You annotated your image a basic annotation.

Adding a Linked Annotation

Annotate images with a linked annotation to help clarify areas of an image or a step.
prereq
Note:Linked annotations correspond to steps or ordered lists, so your topic must contain one of these before you can add a linked annotation.
  1. First, you need to convert your image to an annotated image so you can annotate it. Right-click the image and select Annotate Image .
  2. Right-click the image and select Add Linked Annotation . The lists in the topic display, including both ordered lists and sets of steps. Select the list and list item you want to link to.

    Step Information
    When you hover over one of the steps in the context menu, it will highlight the step that corresponds to it in the topic.
  3. To modify the linked annotation, select the annotation and do any of the following:

    Step Information
    A blue box displays outlining the selected annotation.
    1. To move the annotation, click and drag the annotation to a new location.
    2. To rotate the annotation, click and drag the red ball above the annotation. This does not rotate the number.
    3. To adjust the length of the pointer, click and drag the red ball beside the pointer.
    4. To resize the annotation, click and drag the red ball in the corner. This scales the whole annotation, including the text.
    5. The change the color of the annotation, click Change Color and enter the color you want to display in hexadecimal code. For example, the hexadecimal code for red is FF0000.
result
You annotated your image with a linked annotation.
Note:If you find that the numbered text is off center of the annotation, you can select an annotation and click Refresh to reset the text position, or rotate the annotation to reset the circle center position and resolve alignment issues.

Configurable Annotation Properties

Manage the annotations on an image using the toolbar and context menu.
section
You can modify an annotation using the annotation toolbar and context menu.
section

Toolbar

The annotation toolbar displays when an annotated image or specific annotation is selected. Different options display depending on your current context. You’ll only see the options to change the color and remove annotations if you have an annotation selected. Otherwise, selecting just the annotated image displays the refresh annotation option.
With an annotation selected, three options display:
Control Description
Refresh Annotations Update the numbers within the pointers to match the corresponding steps. Use this button if you have rearranged the steps or ordered list and want your annotations to update.
Remove Delete the selected annotation from the image.
Change Color Change the outline color of the annotation. Only 6 digit hexadecimal RBG color codes are valid.
section

Context Menu

Right-clicking an annotated image displays the context menu.
You can use this menu to perform the following actions:
Control Description
Add Basic Annotation Create a rectangle annotation.
Add Linked Annotation Create a numbered pointer annotation linked to the selected step or list item.
Resize Annotated Image Displays a dialog box where you can modify the image size.
Removed Annotated Image Delete the selected annotation from the image.
Note:Resizing annotated images may require you to realign some of your annotations.