User Guide
Table of Contents
User Guide
Images
Using images
Best practices for using images in easyDITA and ensuring your images are optimized for various outputs.
Inserting an Image
Add media to a topic and set its properties.
Using images

Best practices for using images in easyDITA and ensuring your images are optimized for various outputs.
section
Images can add value to your content and convey visual information. In DITA, the authoring process is separate from the publishing process, which will impact the way you use images in easyDITA. Use the following best practices to use images successfully.
section

File Type

Choosing the correct file type to save your images as can affect how the image displays and scales. If you’re uploading photos of people, objects, or landscape, save your images as JPGs. If you’re adding screenshots, we recommend saving your images as PNGs. In general, you should use PNGs and SVGs whenever possible because they are the best file formats for different screen sizes and for a variety of publishing outputs like html, xhtml, pdf, etc.
section

Sizing Images

You should avoid manually sizing images as this can cause inconsistencies in publishing. For example, scaling down an image to 300px works when publishing to PDF, but it’s far too small for a webpage.
By default, when publishing using the DITA Open Toolkit, images are not automatically resized. We recommend using custom plugins to consistently restrict the size of images. For example, you can use a custom PDF plugin to restrict the size of all images to the page margins and a custom HTML plugin to restrict the size of all images to the size of the webpage.
section

Using Images in Topics

You can insert images anywhere they’re valid. If you’re using images in a Task topic to explain a step, we recommend nesting it in another element first. For example, insert an image in the Step Information (< info> ) element:
Inserting an Image

Add media to a topic and set its properties.
  1. In the Content Manager , open a topic and place your cursor where you want to insert the image.
  2. Click the Image icon in the toolbar.

    Step Information

    Expected Result
    The Select Image window displays.

  3. Do one of the following:

    • To insert an existing image, navigate to the image, check it, and click Select .

    • To upload and insert a new image, click the Upload icon and click Select files to upload to locate the file on your computer. Click Upload . Select the thumbnail and click Select .

  4. (Optional) Select the image and use the Media toolbar to align the image within your document, add alternate text, or set the image width.

    Step Information

    If your image is too large, set the width to 420px.

  5. (Optional) Set the image attributes by selecting the image and clicking the Properties

    Expected Result
    The Properties Pane displays.

result

A reference to the image is inserted into your topic.