Skip to main content

Images

With Paligo, you can add and manage all of the images that you need to use in your technical communication. This includes images in the source language and also images for your translations.

There are different image types that you can use, depending on your requirements, and they use different structures in the XML. So if you are new to working with images in Paligo, it is a good idea to learn about the image types first. Once you are familiar with those, refer to the various Image topics to learn about adding and managing images, applying effects such as thumbnails, and setting alt descriptions for accessibility.

The following sections cover the basics for adding and managing your images:

Paligo supports a wide range of image file formats, including:

  • jpg

  • jpeg

  • png

  • gif and animated gif

  • pdf

  • psd

  • tif

  • tiff

  • ai

  • svg

  • eps

  • ps

Adding an image in Paligo requires some extra structure to be added to the XML of your content. Paligo creates this structure for you automatically, but there are different structures depending on what type of image you want to use. Here, you can learn about the different types of images and the structures that Paligo will create.

Use a Image if you want to use a picture that has no title.

Topic containing an image. The image is of a space shuttle. It has no title and no caption.

When you add an image, Paligo adds the necessary structure for you. All you need to do is choose which image to use. By default, an image has no caption, but you can add your own caption element if you prefer.

Use a figure when you want an image that has a title and a caption.

In the output, the figure title is numbered automatically by default. If you leave a title empty, then the image will use just the word "Figure" followed by the figure number, for example "Figure 3".

A topic containing a figure. There is an image of a space shuttle and it has a title and a caption.

When you add a figure, Paligo adds the structural elements for the figure to your topic automatically. All you need to do is choose the image that you want to use and enter the text for the title and caption.

Here is an example of the structure Paligo adds for a figure:

 <figure xml:id="figure-idm4650264082761632281569246364">
    <title xinfo:text="931664">SPACEX Module</title>
    <mediaobject>
      <imageobject>
        <imagedata fileref="UUID-49641102-0174-ceeb-6547-f32581461aea" xinfo:image="UUID-49641102-0174-ceeb-6547-f32581461aea"/>
      </imageobject>
      <caption>
        <para xinfo:text="931665">The SPACEX module above the earth.</para>
      </caption>
    </mediaobject>
  </figure>

The caption is optional, but is included by default. You can remove it if you prefer.

An inline image is a small picture that appears in the flow of the text, for example, an icon that appears inside a paragraph. In the following image, a save icon has been added as an inline image in a step in a procedure.

A topic containing some text and procedure list. One of the steps has a save icon at the end of a paragraph. A callout arrow points to the save icon.

When you add an inline image, Paligo creates the necessary structure for you automatically. All you need to do is choose the image you want to use.

Here is an example of the structure that Paligo adds to a topic for an inline image:

                                <para xinfo:text="931661">Select the <emphasis role="bold">save as</emphasis> icon <inlinemediaobject><imageobject><imagedata fileref="UUID-25aa4f06-9f19-0875-70d5-343f5ba68460" xinfo:image="UUID-25aa4f06-9f19-0875-70d5-343f5ba68460"/></imageobject></inlinemediaobject>.</para>

The inlinemediaobject > imageobject > imagedata structure is needed, and this can only be used inside other block elements such as para.

With Side-by-side images, you can have two images next to each other on the same line, rather than stacked one above the other. To create this effect, Paligo adds the images inside a table, but you cannot see the table in the published output.

A topic containing side-by-side images. There is a table that spans the width of the content area and it has two equal sized columns and one row. There is an image of a space shuttle in the first column and an image of a control center in the second column. Below the table there is a caption.

When you add a side-by-side image, Paligo inserts all of the necessary structure for you. The structure includes an informaltable, which is only visible in the Paligo editor. When you publish, the table is not shown, so you only see two images next to each other on the page. The images are contained in the imagedata elements. The caption is optional, but is included by default. You can remove it if you prefer.

Here is an example of the structure that Paligo uses for the side-by-side images:

 <informalfigure>
    <informaltable frame="void" rules="none" width="100%" role="sidebyside">
      <col width="50%"></col>
      <col width="50%"></col>
      <tbody>
        <tr>
          <td>
            <mediaobject>
              <imageobject>
                <imagedata fileref="UUID-49641102-0174-ceeb-6547-f32581461aea" xinfo:image="UUID-49641102-0174-ceeb-6547-f32581461aea"/>
              </imageobject>
            </mediaobject>
          </td>
          <td>
            <mediaobject>
              <imageobject>
                <imagedata fileref="UUID-51feab7f-acb9-96e3-740d-be6d0a35dd02" xinfo:image="UUID-51feab7f-acb9-96e3-740d-be6d0a35dd02"/>
              </imageobject>
            </mediaobject>
          </td>
        </tr>
      </tbody>
    </informaltable>
    <caption>
      <para xinfo:text="931666">The SPACEX module and command center.</para>
    </caption>
  </informalfigure>

Use the Image Size setting to control the resolution of the images in your published HTML5 output. For example, you may want to reduce the resolution so that the image file size is smaller and so the page will load more quickly. The Image Size setting is available when you edit an HTML5 layout.

There are several image attributes that you can use to control the size of images, see Image Sizing.

Note

The Image Size setting affects the resolution (image quality and file size) of the image. It does not change the physical size of the image on the page. For that, you can use the width and contentwidth attributes, which can be set on the mediaobject element of an image.

  1. Select the Layout tab in the top menu.

    Paligo editor. The Layout option in the header menu is highlighted.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the configuration to be updated or Create a Layout.

    Tip

    You can copy the URL of the layout editor and paste it into a new tab in your browser. This can be useful if you need to frequently switch between your Paligo content and the layout settings.

  3. Select Image in the left menu.

    Images_Layout_options.jpg
  4. Scroll down to Image size.

    The image size setting on the HTML5 layout. This setting has options for choosing the resolution that will be used for all of the images in your published output.
  5. Select Save.

By default, Paligo uses a nominal width and height when precalculating the percentage scaling of images. This might cause layout shifts for HTML5 Help Center outputs and result in Search Engine Optimization (SEO) issues.

If you enable the Image size attribute for your HTML5 output, Paligo will instead use the actual width and height when precalculating the percentage scaling of images. This makes the webpage load faster and provides a smoother user experience, as it allows the browser to precalculate the page layout more accurately.

To improve Search Engine Optimization (SEO) and the user experience, this setting can be used in combination with the Image size setting to boost site visibility, see Adjust Image Resolution.

Caution

Before you enable Image size attribute, you have to investigate if you have used contentwidth and / or contentdepth when scaling images, see Search for Attributes.

If you have, it is important to consider whether to:

  • Update the scaling for all images after enabling this setting.

  • Replace the above-mentioned attributes with the width attribute before enabling this setting.

  1. Select the Layout tab in the top menu.

    Paligo editor. The Layout option in the header menu is highlighted.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the configuration to be updated or Create a Layout.

    Tip

    You can copy the URL of the layout editor and paste it into a new tab in your browser. This can be useful if you need to frequently switch between your Paligo content and the layout settings.

  3. Select Image in the left menu.

    Images_Layout_options.jpg
  4. Scroll down to Image size attribute.

    Image_Size_Attributes.jpg
  5. Select Enable from the menu.

  6. Select Save.

You can download an image from Paligo so that it can be used elsewhere. This feature is especially useful if you have lost the original image file that you uploaded to Paligo. For example, let's say you have a screenshot that you upload to Paligo. You later later realise it contains sensitive information, but you have lost the original file. Rather than take an entirely new screenshot, you can download the image from Paligo, block out the sensitive information, and then upload it again.

To download an image from Paligo:

  1. Access the Image Details for the image file. You can do this from the image's options menu in the Media library - select the Edit Image option. Alternatively, right-click on an image in a topic and select Edit Properties.

    Image file selected in the Media library. Its options menu is shown and the Edit image option is being selected.
  2. On the Image Details dialog, select the link in the Filename entry.

    Image details dialog. There is a callout arrow pointing to the filename entry and a callout box around the hyperlink text in that entry.

    The browser shows the image at maximum size in a new tab.

  3. Right-click on the image and use the browser's features to save the image to your computer. The options for saving the image can vary, depending on which browser you use. Here, we are showing the options in Google Chrome.

    A close-up view of the Chrome browser options when you right-click on an image. The Save Image As option is selected.

You can view information about an image by displaying its properties on the Image Details dialog. The details you see there are the settings for the source image, but you can see previews of variant images for different languages too.

To display the Image Details dialog:

  1. Either:

    • Find the image in the Media library, select its options menu ( ... ) and then select Edit Image.

    • Right-click on the image in a topic and then select Edit Properties.

    Paligo displays the Image details.

    Image details dialog. It provides details about where the image is used, its filename, its taxonomy tags, and its dimensions. There are also settings for setting language variants and an alt text description.
  2. Use the Image details dialog to:

Note

To set the width of an image, use the image attributes (see Image Sizing).