You can add images, videos, audio and 3D models to your content to provide a more engaging experience. In some cases, it is easier to learn from audio and visuals than text.
For images, you can upload the files to Paligo and then insert them directly into your content. For videos and 3D models, you should host them elsewhere and then embed them in your content by using a link.
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:
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 an Image if you want to use a picture that has no title.
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".
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.
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.
When you Add Side-By-Side Images, 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.
-
Select the Layout tab in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the layout to be updated or Create a Layout.
-
Select Images in the sidebar.
-
Scroll down to Image size.
-
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.
-
Select the Layout tab in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the layout to be updated or Create a Layout.
-
Select Images in the sidebar.
-
Scroll down to Image size attribute.
-
Select Enable from the menu.
-
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:
-
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.
-
On the Image Details dialog, select the link in the Filename entry.
The browser shows the image at maximum size in a new tab.
-
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.
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:
-
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.
-
-
Use the Image details dialog to:
-
View information about the image, such as its filename and dimensions
-
Preview the image
-
Change its title
-
Find out which folder contains the image in the Media library
-
See which taxonomy tags it has (if any)
-
Find out where the image is reused
-
Add alternative versions of the image for different languages (see Translate Images)
-
Add alt text (image description)
-
Note
To set the width of an image, use the image attributes (see Image Sizing).
When you publish HTML content in Paligo, any images in the output are given a file name. The file name can be either:
-
A unique ID that is based on the UUID of the image. This file name remains the same every time you publish and is known as a "persistent" file name.
-
A unique ID that is automatically generated by Paligo each time you publish. This file name will be different each time you publish.
In most cases, the "persistent" file name is preferable, especially if you use GitHub or similar for version control. For example, let's say that you have a publication with 200 topics and they all contain images. You publish the publication several times, without changing the content at all. Each time you publish, it is going to appear that all 200 topics and all the images have changed, because all of the images have had new file names generated. But if you had "persistent" file names, there would be no updates, which is correct.
However, if you have a particular need for the image file names to change each time you publish, you can disable "persistent" file names.
To enable or disable "persistent" file names, use the Display System Settings.
Note
The reason that we use IDs for file names is that the IDs are unique and are supported for translations, imports, exports, etc. If we only used regular text file names, there could be problems with special characters not being recognized by other systems, or multiple files all having the same file name.
This section explains how to add an image to a topic. An image is a picture without a title or caption, although you can add a caption manually if you prefer.
Note
There are separate sections that explain how to add an image with a title (figure), inline images, and side-by-side images. To find out more about the different types of image structures, see Image Types.
There are several ways to add an image:
-
Select Insert > Image and browse to the image you want to use, or upload an image file.
For details, see: Use the Insert Menu to Add an Image
-
Drag and drop an image from your computer on to the topic. This will add the image and upload it into the Media library at the same time.
For more details, see: Drag and Drop an Image into a Topic
-
Use the element context menu to add the mediaobject element and then search for the image you want to use.
For more detail, see Use the Element Context Menu to Add an Image.
Tip
You can also use the keyboard shortcuts:
On Mac:
Option ⌥ Control ^ I
On Windows:
Alt I or Alt Ctrl I
"Drag and drop" is a quick way to add an image to a topic and upload it into your media library at the same time.
-
Place your cursor where you want to add an image. The position of the cursor is important, as you can only add an image where it is valid. For example, if you are inserting an image or figure, you could place the cursor after a
para
element. But if you are inserting an inline image, you would need to place the cursor inside thepara
element. -
On your computer, find the image file that you want to add to your topic and drag it on to the topic.
Paligo adds the elements for an image to your topic structure and opens the Upload images dialog. The file that you have dragged on to the topic is listed.
-
Select the blue icon next to "in folder" at the top of the dialog to display a hierarchical view of your media library folders. Select the folder that you want your new images to be uploaded into.
-
Decide whether you want Paligo to compare your new images to images in the selected folder only, or images in child folders too.
When you upload an image, Paligo compares the image filename to the images that already exist in the media library. Then, if there are images with matching filenames, you can choose to update them or add the new images as well as the existing ones.
Clear the Update in any existing folder checkbox to set Paligo to look only in the root of the selected folder.
Check the Update in any existing folder box to set Paligo to look in the selected folder and also any of its descendant folders (child folders).
Paligo then compares the names of the files you are uploading to the files that already exist in the media library. What happens next, depends on the files you are uploading.
-
If there are no matching files, your new files are listed and a green icon shows that they will be added as new image files.
-
If there are matching files, Paligo shows Update checkboxes. You can use these to replace the existing images (see the next step).
Note
If you are uploading files that have a hyphen and language code suffix, such as battery-fr.jpg, Paligo will look for source language versions of the same image. If it finds a match, you get the option to update the language variant. For more details, see Translate Images.
-
-
Decide whether you want your new files to update any existing files of the same name.
-
Check the Update box to replace an existing image with your new image.
-
Clear the Update box to upload the new image in addition to the existing image.
This will mean you have multiple images with the same name. You can rename the images in the Content Manager to make them easier to manage.
Tip
You may be able to save time by selecting the Update all existing box, which automatically selects all of the update boxes at once.
-
-
Check the Remove whitespace box if you want Paligo to automatically remove any unnecessary white space (empty areas) from the edges of your image. This only applies if your image is AI. EPS, or PDF.
-
Select Upload.
Paligo uploads your image file to the media library and adds it to your topic. You can close the Upload Images dialog.
If you prefer, you can add the elements for an image individually, and for this, you can use the element context menu.
-
Place your cursor where you want to add an image. The position of the cursor is important, as you can only add an image where it is valid. For example, if you are inserting an image or figure, you could place the cursor after a
para
element. But if you are inserting an inline image, you would need to place the cursor inside thepara
element. -
Access the element context menu.
To access the element context menu, press Alt and Enter (Windows) or Option ⌥ and Enter (Mac).
-
Add the
mediaobject
element.Paligo adds the mediaobject element and also adds the imageobject and imagedata elements that are needed for an image.
-
Right-click on the placeholder for the image and select Image browser.
-
In the dialog that opens, browse or search for the image in your Media library.
Note
If the dialog does not open automatically, right-click on the placeholder icon for the image and select Image browser.
Note
If the image is not in the Media library yet, you can upload it directly in this dialog by using the upload icon in the top-right.
To find out more about uploading images, see Upload Images to the Media Library.
-
Select the image to insert it into your topic.
Note
To use alt text in PDF outputs, it is important that you do not use tagged PDFs as images. For PDFs to use alt text, the layout has to have Generate tagged PDF enabled. The PDF processor cannot complete the publishing if your content contains tagged PDFs as images and Generate tagged PDF is enabled. You will need to use untagged PDFs as images or use different types of image files.
If you try to publish content that has a tagged PDF embedded as an image and the Generate tagged PDF enabled, you will get a "production failed" error.
-
Select Save.
This section explains how to add a figure to a topic. A figure is a picture with a title and a caption, and it can support some DocBook elements that are unavailable for regular images. However, at the moment, most of these additional elements, such as calloutlist
do not have any functionality in Paligo.
Note
There are separate sections that explain how to add an image without a title (image), inline images, and side-by-side images. To find out more about the different types of image structures, see Image Types.
There are several ways to add a figure:
-
Select Insert > Figure and browse to the image you want to use, or upload an image file.
For details, see: Use the Insert Menu to Add a Figure
-
Use the element context menu to add the figure element and then select the image placeholder and search for the image you want to use.
For more detail, see Use the Element Context Menu to Add a Figure.
If you prefer, you can add the elements for a figure manually, and for this, you can use the element context menu.
-
Place your cursor where you want to add a figure, for example, inside a
step
element or after apara
. -
Access the element context menu.
To access the element context menu, press Alt and Enter (Windows) or Option ⌥ and Enter (Mac).
-
Add the
figure
element.Paligo adds the figure element and also adds the
title
,caption
,imageobject
andimagedata
elements that are needed for a figure. -
Right-click on the placeholder for the image and select Image browser.
-
In the dialog that opens, browse or search for the image in your Media library.
Note
If the dialog does not open automatically, right-click on the placeholder icon for the image and select Image browser.
Note
If the image is not in the Media library yet, you can upload it directly in this dialog by using the upload icon in the top-right.
To find out more about uploading images, see Upload Images to the Media Library.
-
Select the image to insert it into your topic.
Note
To use alt text in PDF outputs, it is important that you do not use tagged PDFs as images. For PDFs to use alt text, the layout has to have Generate tagged PDF enabled. The PDF processor cannot complete the publishing if your content contains tagged PDFs as images and Generate tagged PDF is enabled. You will need to use untagged PDFs as images or use different types of image files.
If you try to publish content that has a tagged PDF embedded as an image and the Generate tagged PDF enabled, you will get a "production failed" error.
-
Enter the text for the figure title in the
title
element. -
Enter a caption for the figure in the
caption
element. You can delete thecaption
element if you do not want a caption. -
Select Save.
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.
Note
There are separate sections that explain how to add an image without a title (image), image with a title (figure), and side-by-side images. To find out more about the different types of image structures, see Image Types.
There are several ways to add an inline image to a topic:
"Drag and drop" is a quick way to add an image to a topic and upload it into your media library at the same time.
-
Place your cursor where you want to add an inline image, for example, inside a
para
element. -
On your computer, find the image file that you want to add to your topic and drag it on to the topic.
Paligo adds the elements for an image to your topic structure and opens the Upload images dialog. The file that you have dragged on to the topic is listed.
-
Select the blue icon next to "in folder" at the top of the dialog to display a hierarchical view of your media library folders. Select the folder that you want your new images to be uploaded into.
-
Decide whether you want your new files to update any existing files of the same name.
-
Check the Update box to replace an existing image with your new image.
-
Clear the Update box to upload the new image in addition to the existing image.
This will mean you have multiple images with the same name. You can rename the images in the Content Manager to make them easier to manage.
Tip
You may be able to save time by selecting the Update all existing box, which automatically selects all of the update boxes at once.
-
-
Check the Remove whitespace box if you want Paligo to automatically remove any unnecessary white space (empty areas) from the edges of your image. This only applies if your image is AI. EPS, or PDF.
-
Select Upload.
Paligo uploads your image to the media library and inserts it as an inline image in your topic. You can close the Upload Images dialog.
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.
Note
To find out about the elements that are used for a side-by-side table, and also the other types of image structures you can add, see Image Types.
To add side-by-side images to a topic:
-
Place your cursor where you want to add an image. The position of the cursor is important, as you can only add an image where it is valid. For example, if you are inserting an image or figure, you could place the cursor after a
para
element. But if you are inserting an inline image, you would need to place the cursor inside thepara
element. -
Select the Insert menu.
-
Select Image and then Side by side images.
-
Right-click on the placeholder for the image and select Image browser.
-
In the dialog that opens, browse or search for the image in your Media library.
Note
If the image is not in the Media library yet, you can upload it directly in this dialog by using the upload icon in the top-right.
To find out more about uploading images, see Upload Images to the Media Library.
-
Select the image to insert it into your topic.
-
Repeat steps 4-6 inclusive for the other image.
-
Enter a caption for the figure in the
caption
element. You can delete thecaption
element if you do not want a caption. -
Check the box Use gateway to enable IP Allowlisting. Optional
Tip
By default, images will come out two in a row in HTML5 output. But you can easily change how these come out. For example, if you want more than two images to still appear in one row, and shrink to fit, you can do so with this in your custom CSS:
.flex-container{ display: flex; width: 100%; justify-content: space-between; flex-wrap: wrap; }.informalfigure .flex-item{ width: auto !important; margin: 0px; }.informalfigure .flex-item:last-child{ margin-right: 0px; }@media (min-width : 480px){ .informalfigure .flex-item{ width: 49% !important; } }@media (min-width : 992px){ .flex-container{ flex-wrap: nowrap; } .informalfigure .flex-item{ margin-right: 10px; } }
This would make the side-by-side images use up the entire space, and all in one row. But if viewed on smaller devices, it will change to only two in a row for medium-sized, and finally to only one, so they are stacked on top of each other, for mobile devices.
Paligo has an image library that contains all of the images you upload. To add images to the library you can:
When you upload images to the library, Paligo manages the image formats and translated images automatically. We call this Smart Image Management
You can add images to the library directly from the Content Manager. The images that you add are then available to select when you add a figure, image, inline image, or side-by-side images.
-
In the Content Manager, open the Media section.
-
Select the options menu ( ... ) for a folder or create a new folder and select the options menu for that.
-
Select Upload Images.
-
Decide whether you want Paligo to compare your new images to images in the selected folder only, or images in child folders too.
When you upload an image, Paligo compares the image filename to the images that already exist in the media library. Then, if there are images with matching filenames, you can choose to update them or add the new images as well as the existing ones.
Check the Update in any existing folder box to set Paligo to look in the selected folder and also any of its descendant folders (child folders).
Clear the Update in any existing folder checkbox to set Paligo to look only in the root of the selected folder.
-
Drag and drop your image files from your computer into the box. Alternatively, select Add Files and browse to the files you want to upload.
Paligo then compares the names of the files you are uploading to the files that already exist in the media library. What happens next, depends on the files you are uploading.
If all the image files you are adding are new, and there are no image files with matching names already in the media library, your new files are listed. Next to each image name there is a green icon to show that the image will be uploaded as a new file in the library.
If there are images with matching names already in the media library, the new images are listed, but they also have an Update checkbox.
Note
If you are uploading files that have a hyphen and language code suffix, such as battery-fr.jpg, Paligo will look for source language versions of the same image. If it finds a match, you get the option to update the language variant, for example, Update (fr) for a French variant. For more details, see Translate Images.
-
Decide whether you want your new files to update any existing files of the same name.
-
Check the Update box to replace an existing image with your new image.
-
Clear the Update box to upload the new image in addition to the existing image.
This will mean you have multiple images with the same name. You can rename the images in the Content Manager to make them easier to manage.
Tip
You may be able to save time by selecting the Update all existing box, which automatically selects all of the update boxes at once.
-
-
Check the Remove whitespace box if you want Paligo to automatically remove any unnecessary white space (empty areas) from the edges of your image. This only applies if your image is AI. EPS, or PDF.
-
Use the Open parent folder box to choose whether Paligo will show you the folder that contains the images when they have finished uploading.
-
Select Upload.
Paligo uploads your image files to the media library. If you have updated any of the image files, the topics that use those images are automatically updated with the new images.
When you are editing a topic, you can insert a figure, image, inline image, or side-by-side images. When you do this, you can choose one of the existing images from the library or you can upload a new image to the library and insert that.
Note
It is also possible to upload an image to a topic by using the image details dialog. But that approach does not include checking the filenames against existing images in the library or language variants.
To add images to the library from a topic:
-
Edit a topic and add a figure, image, inline image, or side-by-side images.
Paligo displays a browse dialog that you can use to browse the media folders. But here, you want to upload a new image, not use an existing image. So browse to the folder where you want to store the new image, and then you will add the image in the next step.
-
Select the upload icon to display the Upload Images dialog.
-
Select the blue icon next to "in folder" at the top of the dialog to display a hierarchical view of your media library folders. Select the folder that you want your new images to be uploaded into.
-
Decide whether you want Paligo to compare your new images to images in the selected folder only, or images in child folders too.
When you upload an image, Paligo compares the image filename to the images that already exist in the media library. Then, if there are images with matching filenames, you can choose to update them or add the new images as well as the existing ones.
Check the Update in any existing folder box to set Paligo to look in the selected folder and also any of its descendant folders (child folders).
Clear the Update in any existing folder checkbox to set Paligo to look only in the root of the selected folder.
-
Drag and drop your image files from your computer into the box. Alternatively, select Add Files and browse to the files you want to upload.
Paligo then compares the names of the files you are uploading to the files that already exist in the media library. What happens next, depends on the files you are uploading.
If all the image files you are adding are new, and there are no image files with matching names already in the media library, your new files are listed. Next to each image name there is a green icon to show that the image will be uploaded as a new file in the library.
If there are images with matching names already in the media library, the new images are listed, but they also have an Update checkbox.
Note
If you are uploading files that have a hyphen and language code suffix, such as battery-fr.jpg, Paligo will look for source language versions of the same image. If it finds a match, you get the option to update the language variant, for example, Update (fr) for a French variant. For more details, see Translate Images.
-
Decide whether you want your new files to update any existing files of the same name.
-
Check the Update box to replace an existing image with your new image.
-
Clear the Update box to upload the new image in addition to the existing image.
This will mean you have multiple images with the same name. You can rename the images in the Content Manager to make them easier to manage.
Tip
You may be able to save time by selecting the Update all existing box, which automatically selects all of the update boxes at once.
-
-
Check the Remove whitespace box if you want Paligo to automatically remove any unnecessary white space (empty areas) from the edges of your image. This only applies if your image is AI. EPS, or PDF.
-
Use the Open parent folder box to choose whether Paligo will show you the folder that contains the images when they have finished uploading.
-
Select Upload.
Paligo uploads your image files to the media library. If you have updated any of the image files, the topics that use those images are automatically updated with the new images.
-
Paligo uploads your image files to the media library. If you have updated any of the image files, the topics that use those images are automatically updated with the new images.
Paligo takes care of the complexity of managing different versions of images for you:
-
Automatic image formats: You can upload an image in just one format, for example the highest resolution version, or an original source file in Photoshop (PSD), or Illustrator (AI). Paligo will automatically handle the conversion to suitable output format for print, web, etc, so you don't have to keep track of multiple format versions of the same image.
-
Images in multiple languages: You can also upload the same image translated into multiple languages (such as screen shots for localized software). Paligo will automatically select the right language version when you publish to different languages. Read more about that in Translate Images.
When you are updating your technical documentation, you will most likely need to replace some of your images. For example, if you document software, you may need to add new screenshots. Content reuse applies to images as well as text in Paligo, so you can update an image once, in one place, and the change will apply wherever that image is used. This can save you a lot of time and effort.
In this section, we explain how to replace your "source language" images. These are the images that you add and use in the content for your default language. If you translate your content into different languages, and have "language variant images", you can find out how to update those in Translate Images.
There are two different approaches to replacing "source language" images:
Note
If you need to replace an image in one topic only, add the updated image as a new image (or figure, inline image, etc.). Then remove the previous image and its related elements, such as figure
, mediaobject
, from the topic.
To replace an image with a new image that you will upload to Paligo:
-
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.
-
Select Upload Image to replace the current image with a new one.
-
Use the Upload Image dialog to add the replacement image and then select Upload. Close the dialog when the upload is complete.
Every topic that used the previous image will now use the new one instead.
To replace an image with another image from the media library:
-
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.
-
Select Replace with existing to replace the current image with another image from the media library.
-
Use the Media dialog to find and select the alternative image that you want to use. When you have selected the image, close the Image Details dialog.
Note
If the replacement image is not in the media library, you can upload it. To find out more, see Upload Images to the Media Library.
All topics that used the original image are now updated. They will use the alternate image that you selected instead of the original image.
A caption is included by default if you add a figure or side by side images, but not if you add an image. You can add the caption manually by using the caption
element.
In the image below, you see a figure where both the title and caption is used.
Important
The validation will fail if the caption is positioned above the image. To move a misplaced caption, select it in the Element Structure Menu and choose Move down.
A caption is included by default if you add a figure or side by side images, but not if you add an image.
To manually add a caption to an image:
-
Position the cursor on the right side of the image.
-
Press Alt + Enter ⏎ (Windows) or Command ⌘ + Enter ⏎ (Mac) to display the Element Context Menu.
-
Select Caption from the menu.
-
Enter a text inside the
caption
element. -
Select Save.
If you have added a figure, side by side images or manually added a caption that you need to remove:
-
Select the image that has the caption.
-
Select the
caption
element in the Element Structure Menu. -
Select Delete.
-
Select Save.
We recommend adding "alt text" to your images. Alt text is a text description of the image that is in the code of the page, but is not visible to the reader. It is useful for:
-
Search Engine Optimization (SEO)
-
Accessibility for people with certain disabilities. The alt text description can be read out by a screen reader.
In Paligo, you can add:
If you are publishing to PDF, we recommend that you also read Alt Text for Images in PDFs. For alt text in PDFs, you will need to set Paligo to publish a tagged PDF.
Note
If you are going to have other versions of an image for different languages, use the alt element for alt text. The alt
element content can be translated, whereas the image description is always in the default language and is not translated.
To add alt text that applies to an image everywhere that image is used:
-
Add the image to a topic and then right-click on it and select Edit properties. Alternatively, find the image in the Media section of the Content Manager, select its options menu ( ... ) and then select Edit Image.
Paligo displays the Image details.
-
Enter a description. This is the alt text for the image and will be used wherever that image appears, unless the image has an alt element. (Alt elements take priority over the description).
Aim to provide a text description of the image, as if you were explaining what it shows to someone with a visual impairment.
-
Select Update description to save.
Note
If an image does not have a description or an alt
element, the title
is used instead. If there is no title
, the filename of the image is used.
If you want an alt text description to only apply to an image when it is used in one specific topic, use the alt
element. This approach is useful when you reuse an image in many topics, but you want the description to be different, depending on the context of the topic.
You should also use the alt
element if you have language variants of your images and want text descriptions in different languages.
-
Add the image to the topic and then select the image.
-
In the Element Structure Menu, select the
mediaobject
element and choose Go to element from the menu. -
To display the element context menu, press Alt and Enter (Windows) or Option ⌥ and Enter (Mac).
-
Select the
alt
element.Paligo adds an
alt
element above the image (but inside themediaobject
element in the topic structure). -
Enter the text description in the
alt
element.
If you add an alt
element, it is used instead of any description that is set for the image (in the image properties). But the alt
element only applies to the topic where you have added it. The image will not have the alt
element in any other topics where the image is used.
Aim to provide a text description of the image, as if you were explaining what it shows to someone with a visual impairment. Try to include a keyword or synonym for your page. Do not use images for "keyword stuffing".
Your images in PDF outputs can use alternative text too, and it appears in a "hover pop-up" when you position the cursor over an image. For accessibility, the alt text can also be detected by the "Read Out Loud" feature in Adobe Reader .
To use alt text in PDF outputs:
-
Add the alt text to the image. There are two ways to do this, depending on what you need, see:
-
Select Layout and then edit the PDF layout you are going to use for publishing. Alternatively, you can create a new PDF layout and edit that.
-
In the Layout Editor for the PDF layout, select General > Misc.
-
Set Generate tagged PDF to Enabled.
-
Check the box Use gateway to enable IP Allowlisting. Optional
When you publish using this layout, the PDF will be tagged and will include the alt text you have set for your images.
Note
To use alt text in PDF outputs, it is important that you do not use tagged PDFs as images. For PDFs to use alt text, the layout has to have Generate tagged PDF enabled. The PDF processor cannot complete the publishing if your content contains tagged PDFs as images and Generate tagged PDF is enabled. You will need to use untagged PDFs as images or use different types of image files.
If you try to publish content that has a tagged PDF embedded as an image and the Generate tagged PDF enabled, you will get a "production failed" error.
There are several image attributes that you can use to control the size of images in your Paligo topics. You can add the attributes to the imagedata
element, and the following sections explain how to set the size values and what results to expect.
Note
What would commonly be called the "height" of an image is called depth as an attribute in Paligo. This is a legacy from DocBook, which Paligo uses as the foundation for the Paligo content model.
For vector images, such as SVG, you should only use contentwidth
and contentdepth
. These can also be used for certain other use cases, such as if you want spacing around an image, see Examples of Image Sizing.
In most cases, it is better to use the width
and depth
attributes as they are easier to predict. The contentwidth
and contentdepth
can produce unexpected (but accurate) results with bitmap images. This is because it is not always possible to determine the intrinsic image size of a bitmap image when processing the output.
Define the image size by using one of the following attributes to the imagedata
element:
-
width
- sets the width value in relation to the viewport. -
depth
- sets the depth (height) value in relation to the viewport. -
contentwidth
- sets the width value of the image and has no effect on the viewport. -
contentdepth
- sets the depth (height) value of the image and has no effect on the viewport. -
scalefit
- allows an image to be scaled up or down to fit within available space. Ifscalefit="1"
the image is scaled (with the same factor in both dimensions) so that the graphic will just fit within the available height or width (whichever is more constraining). If any other image size attribute is specified, those attributes determine the graphic size andscalefit
will be ignored.
The viewport is the available space for the imageobject
on the page. Depending on which element that is used on the imagedata
element the result will differ. If you set the image:
-
width
to 50% - the image will be sized so that it takes up half of the available space on the page. -
contentwidth
to 50% - the image will be reduced to 50% of its original size.
|
|
To the left - The image (2) uses 50% of the viewport (1) To the right - The image (2) is reduced to 50% of its original size (1)
When you publish your content, the images will be sized based on the values and attributes you added. You can use the preview to see what the sizing will look like in your different outputs.
There are several other attributes to control width, height and so on. If you want to learn more about the possibilities, see DocBook image sizing reference.
Tip
For HTML5 output, you can use the thumbnail and lightbox features to add small versions of an image to a page. When a user selects the image, a larger version is displayed.
To set the image sizing attributes:
-
Select the topic or component in the Content Manager to open it in the Editor.
Alternatively, you can Create a Topic and edit that.
-
Select the image that you want to size.
-
Select the
imagedata
element in Element Structure Menu and choose Go to element. -
Add the sizing attribute(s) and set the value(s) in the Element Attributes Panel.
Typically, you should only set the width (or contentwidth) of an image. The depth (height) is then calculated automatically, so that the image dimensions keep the same ratio as the original image file.
If you do set height and width, the smallest value of the two is used, and the image is scaled according to that.
When you set the value, you can use any of the Measurement Units for Image Sizing. By default, the sizes are in pixels.
-
Select Save.
When you set the value for a width
, depth
, contentwidth
, or contentdepth
attribute, you can use any of these units:
- px
-
Pixels (the default unit if none is specified)
- pt
-
Points (1/72 of an inch)
- cm
-
Centimeters
- mm
-
Millimeters
- pc
-
Picas (1/6 of an inch)
- in
-
Inches
- em
-
Ems (the font size of the current surrounding element)
- %
-
Percentage (of intrinsic image size for
contentwidth
andcontentdepth
, of the available page area forwidth
anddepth
).
Here are some examples of different image sizing combinations, designed to show you the different effects the sizing attributes can have:
Attribute contentwidth
= 400px. Sets the width of the image itself.
(The value could be 400 or 400px, as "px" is the default if no unit is set.)
Attribute contentdepth
= 400px. Sets the height of the image itself.
Attribute width
= 400px. Sets the width of the viewport of the image, which scales to fit to that area. (The border is not added normally, it is just added here to illustrate the viewport.)
This is the most commonly used attribute for image size.
Attribute contentdepth
= 400px, width
= 420px. If the contentdepth
or contentwidth
is set, and a width
or depth
attribute is also set, with a higher value, it creates an area around the image.
Use the align
attribute to set the alignment for images.
-
Edit a topic that contains the image. Alternatively, add an image or figure to a topic.
-
Select the image.
-
In the element structure menu, select the
imagedata
element. -
In the Element attributes section, add the
align
attribute and set its value.You can choose from:
-
Left
-
Center
-
Right
-
-
Check the box Use gateway to enable IP Allowlisting. Optional
For example, with the following image, we have given its imagedata
element the align
attribute. The value of the attribute is set to center.
If you publish HTML outputs, you may want to style your images, for example, you could add a border around all of your images.
To style images in HTML, use CSS to create the styling, upload the CSS file to your HTML layout, and then republish.
For the CSS, you will need the image class names. There are default class names, which you can use to style all images at once, or you can add your own custom class names. With your own custom class names, you can style an individual image or multiple images of your choice.
Note
It is beyond the scope of the Paligo documentation to cover all of the possibilities for styling images with CSS. There are many online resources for learning about styling images with CSS, including www.w3schools.com.
Tip
To find out how to upload a CSS file that you have created, see Style with CSS.
All images in your published HTML content have a class name. You will need the class name to style the images with CSS.
By default, the class names are:
-
mediaobject
for block images -
inlinemediaobject
for inline images.
In the published HTML, the mediaobject
is the class name for a container <div> element, and the image is inside the <div>.
Similarly, the inlinemediaobject class name is for a span element that contains the inline image.
You can use a CSS selector to style the image inside the mediaobject and inlinemediaobject "containers". For example, to put a border around all mediaobjects, you could create a CSS file containing the following styling:
.mediaobject img { border: blue; border-style: dashed; }
You would then upload that CSS file to your CSS layout and publish using that layout. The block images in your published output would then have a blue dashed line as a border.
If you apply styling to mediaobject
or inlinemediaobject
, it will apply to all images that have that class name. So if the default settings are in place and none of your images have a custom class name, styling mediaobject
will affect all of your block images and styling inlinemediaobject
will affect all of your inline images.
If you only want to style specific images, you can give those images their own class names. There are two ways to do this: you can Custom Class Names for Images - Role Attribute or Custom Class Names for Images - Taxonomy Tag .
To style an individual image or perhaps a selection of images, you need to give the image(s) a class name. The class name has to be different to the general mediaobject
or inlinemediaobject that is assigned to all images by default. When the class name is in place, that class can be styled separately in your CSS.
One way to give an image a class name is to use the role
attribute. You can set it on the image's mediaobject
element, and then set its value as the class name you want to use.
-
In Paligo, open the topic that contains the image you want to style once it is published.
-
Select the image and then, in the element structure menu, select the
mediaobject
element. From the menu, select Go to element. -
In the Element attributes section, use the Add attribute field to add a
role
attribute. For therole
attribute's value, enter the name you want to use as the class name. Use lower case. -
Check the box Use gateway to enable IP Allowlisting. Optional
-
Use a code/text editor to create a custom CSS stylesheet file (or edit an existing CSS file that you use for Paligo).
When Paligo publishes your content, the role is added to the "container" mediaobject <div> or <span> inlinemediaobject for the image. For example, if you have a block image and add a role with the value diagram-large, this will appear like this in the HTML:
<div class="mediaobject diagram-large"> <div class="material-placeholder"> <img src="image/1602519409130b.png" style="" alt="image2-transparent.png" class="materialboxed"> </div> </div>
If you have an inline image and add a role with the value diagram-small, it will appear in the HTML like this:
<span class="inlinemediaobject diagram-small"> <img src="image/16025194086577.jpg" alt="large-version-screenshot2.jpg"> </span>
To style the image rather than the container <div> or <span>, use a CSS selector to target the image inside the container, for example:
.mediaobject.diagram-large img { border: blue; border-style: dashed; }
or for an inline image:
.inlinemediaobject.diagram-small img { border: blue; border-style: dashed; }
-
Upload your CSS file to your HTML layout.
For more information on uploading CSS to HTML layouts see Style with CSS.
-
Publish your content using the HTML layout that contains the CSS file with the image styling.
Paligo publishes the content and the output includes your CSS. The styles in your CSS take precendence over the other CSS provided by Paligo, and the styling is applied to your images.
To style an individual image or perhaps a selection of images, you need to give the image(s) a class name. The class name has to be different to the general mediaobject
or inlinemediaobject that is assigned to all images by default. When the class name is in place, that class can be styled separately in your CSS.
One way to add a class name for an image is to use taxonomy tags:
-
Select Layout and then edit the HTML5 layout you are going to use for publishing. Alternatively, you can create a new HTML5 layout and edit that.
-
In the Classes and Attributes settings, set Output taxonomies as class names to Enable.
-
Select Save.
-
Select the Taxonomy Manager in the Content Manager to open the structure.
-
Either:
-
Find an existing taxonomy tag and drag it on to the image in the Media section of the content manager.
-
Create Taxonomy Tags and Add Taxonomy Tags by dragging it on to the image in the Media section of the content manager.
-
-
Publish your content using the HTML layout you edited in step 2.
-
View the published output in a browser. Use the browser's inspection tool to find the image in the HTML. You should see that it has a class name that matches the taxonomy tag.
-
Use a code/text editor to create a custom CSS stylesheet file (or edit an existing CSS file that you use for Paligo).
In the CSS, style the class that has been added for the image. For example, if you added a taxonomy tag called "battery", the image in your HTML output would have these elements:
<div class="mediaobject taxonomy-product-battery"> <div class="material-placeholder"> <img src="image/1602a53b445615.jpg" style="" alt="battery.jpg" class="materialboxed"> </div> </div>
So you could style the image by using a CSS selector to select the image inside the class .taxonomy-product-battery. For example, to give the image a blue dashed border, you could use:
.mediaobject.taxonomy-product-battery img { border: blue; border-style: dashed; }
-
In Paligo, select Layout and edit the layout that you used for publishing in step 6.
-
Upload your CSS file to your HTML layout.
For more information on uploading CSS to HTML layouts see Style with CSS.
-
Check the box Use gateway to enable IP Allowlisting. Optional
-
Publish your content using the HTML layout that contains your custom CSS.
In the HTML output, the image should now be using the custom styling you defined in your CSS.
You can use the Image Title Attribute setting to add a title to an image in your HTML5 output. The title is shown as text in a tooltip when you position the cursor over the image.
-
Set the text that you want to appear as the title. To do this, edit the topic that contains the image and then right-click on it. Select Edit Properties and then select the edit icon for the Title field. Enter the text that you want to use as the title, and then close the dialog.
-
Check the box Use gateway to enable IP Allowlisting. Optional
-
Select Layout and then edit the HTML5 layout you are going to use for publishing. Alternatively, you can create a new HTML5 layout and edit that.
-
Select Images.
-
Set Image title attribute to Enable.
If you set Image title attribute to Disable, the hover tooltip will not appear on the image in the published HTML5 output.
-
Check the box Use gateway to enable IP Allowlisting. Optional
When you publish to HTML5 using this layout, the image in your output will have a tooltip that shows the title text.
In your HTML5 output, you can show diminished images that are enlarged when selected. The enlarged version of the image is shown in a "lightbox", which is a separate display that overlays your content.
This is especially useful when you have large images that would provide a better experience for users if they were smaller. This is achieved if you resize the images by using the width
attribute or enabling Thumbnail Images and then enable the Lightbox feature.
Diminished images are shown on the page |
With the Lightbox feature enabled, the images are enlarged when selected. |
To use Lightbox for Images you have to activate the feature in the Layout Editor. Lightbox can be used on Thumbnail Images as well as images resized with the width
attribute. Click the image below to test this feature.
This image is resized with the width
attribute and the value is set to 50%.
To enable or disable the Lightbox feature for all of the images in your HTML5 output:
-
Select the Layout tab in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the layout to be updated or Create a Layout.
-
Select Images in the sidebar.
-
Set the Use lightbox for images to:
-
Enable if you want all block images to use the Lightbox feature.
-
Disable to turn off the Lightbox feature.
Note
If you enable the lightbox feature, you can either set all block images to use thumbnails or you can set thumbnails individually. To find out more, see Thumbnail Images.
-
-
Select Save.
Tip
The lightbox feature is also available for Zendesk outputs, but it is set up differently.
For Zendesk, Paligo has asset files that are included in the zip file that is downloaded in your browser when you publish. You can upload those asset files to the Assets section in Zendesk guide, and then add the following code to the Document head section:
<link href="{{asset 'lightbox.min.css'}}" rel="stylesheet" type="text/css" /> <script src="{{asset 'lightbox.min.js'}}"></script> <script src="{{asset 'paligo-zd-lightbox.js'}}"></script>
You only need to do this once, the first time you publish to Zendesk, see Customize Zendesk Articles Using Javascript.
You may have content that needs to have large images, but these images take up too much space on the page and make it more difficult to read the text. One way to handle this for HTML5 outputs is to use "thumbnails". This is where large images are shown at a much smaller size on the page. If you use Lightbox for Images, readers can click on the thumbnail image to display a larger version.
In Paligo, you can Set All Images as Thumbnails from the HTML5 layout or you can Set Thumbnails for Individual Images.
Thumbnail images are shown at a smaller size on the page |
If lightbox is enabled, a user can select a thumbnail image to view it at a larger size |
Note
By default the thumbnail will get a rounded border and a max width and height of 200 pixels (px). This can be customized in your CSS.
Tip
If you are publishing to other outputs, such as PDF, you may need to have a specific width on the image too. For this, use the contentwidth
attribute instead of width
, otherwise the thumbnail feature may not work as intended.
If you want all block images to appear as thumbnails in your HTML5 output, use the Use thumbnails for all mediaobject (block) images setting. This is in the HTML5 layout. This can be useful when you have large images that take up too much space on the page. By setting them as "thumbnail" images, they will appear much smaller. You should also enable the lightbox feature so that end users can select the images to display a larger version.
When you enable the setting and publish, the images will appear as smaller "thumbnail" images. We recommend that you also enable Lightbox for Images so that your readers can select the "thumbnail" images to display a larger version.
Tip
If you only want certain images to appear as thumbnails, see Set Thumbnails for Individual Images.
-
Select the Layout tab in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the layout to be updated or Create a Layout.
-
Select Images in the sidebar.
-
Set the Use thumbnails for all mediaobject (block) images to:
-
Enable if you want all block images to appear as thumbnails.
-
Disable if you do not want all block images to be thumbnails.
-
-
Select Save.
You can set the thumbnail feature for individual images rather than for all block images at once. This is useful if you only want the thumbnail feature for certain images, for example, if most of your images are fine at their regular size but you have a small number of unusually large images to include too.
Tip
If you want most, but not all, images to use thumbnails it may be quicker to Set All Images as Thumbnails and exclude some images from using thumbnails by adding a role
attribute to the mediaobject
element and with the value set to img-thumbnail-reset.
To use the thumbnail feature for individual images:
-
Select the Layout tab in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the layout to be updated or Create a Layout.
-
Select Images in the sidebar.
-
Set Use thumbnails for all mediaobject (block) images to default or Disable.
-
Enable Use Lightbox for images to allow users to click on your thumbnail image to display it at a larger size.
-
Select Classes and attributes in the sidebar.
-
Select Enable for Output 'role' attribute as class names.
-
Select Save.
-
Select the topic or component in the Content Manager to open it in the Editor.
Alternatively, you can Create a Topic and edit that.
-
Select the image in the content.
-
Select the image's
mediaobject
element in Element Structure Menu and choose Go to element. -
Add the
role
attribute Element Attributes Panel and set its value toimg-thumbnail
. -
Select Save.
For HTML outputs, you can use CSS to add borders around images and sections that contain images. For example, you could add a pink dotted line around your images, like this:
To create the pink dotted line border, we used this CSS:
.mediaobject img { border: 3px dotted #FF1493; padding:1em; }
Our sample CSS styling works like this:
-
The .mediaobject img defines the class we are going to style. There are different classes for the different image types, as explained in Borders on All Images (HTML).
-
border: defines the start of the border styling.
-
3px is the width of the border line
-
dotted is the style of the border line
-
#FF1493 is the color
-
padding: defines the start of the padding styling. The padding is the space between the image and the border.
When you style your own borders, you can use similar CSS. There are other border styles you could apply too, and if you want to find out more, we recommend the w3schools website as a resource.
Note
For information on setting image borders for PDF outputs, see Borders for Images (PDF).
You can use CSS to add borders around all images, based on the image type. For example, you could add borders around all block images, but leave inline images to have no borders.
With images that are inside figures and informalfigures, you also have the option to add a border around the entire figure/informalfigure section. So you could have a border around the section, but not the image. Or you could have different borders around both.
To use CSS to style image borders for HTML ouputs, follow the steps below. Note that for the examples provided, we have used a pink dotted border that is 3px wide. There is 1em padding (internal margin) on each image too. You can change the sizing, style, and padding as required.
Tip
For information on using CSS for border styles, we recommend the w3schools website.
-
Use a code or text editor to create a CSS file. Give it a suitable name and save it with the
.css
extension. -
Enter the CSS for the border styles you want.
To style block images, add your border styling for the
.mediaobject img
class. For example:.mediaobject img { border: 3px dotted #FF1493; padding:1em; }
To style figure sections, add your border styling for the
.figure
class. For example:.figure { border: 3px dotted #FF1493; padding:1em; }
To style informalfigure sections, add your border styling for the
.informalfigure
class. For example:.informalfigure { border: 3px dotted #FF1493; padding:1em; }
To style inline images, add your border styling for the
.inlinemediaobject
class. For example:.inlinemediaobject { border: 3px dotted #FF1493; padding:1em; }
-
Save your CSS file.
-
Select the Layout tab in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the layout to be updated or Create a Layout.
-
Select CSS, JS, logos and other assets in the sidebar.
-
Upload your CSS file in the CSS section.
-
Select Save.
When you publish with that layout, the CSS styles will be applied to your published output.
If you only want to apply borders to specific images, follow these steps:
-
Open a topic that contains the image and then select the image.
-
In the Element Structure Menu, select the "parent" element for the content that you want to style.
For a block image, the element is
mediaobject
For an inline image, the element is
inlinemediaobject
For a figure, the element is
figure
For an informal figure, the element is
informalfigure
-
Select Go to element.
-
In the Element attributes section, use the Add attribute field to give the element the
role
attribute. Give the attribute a name as the value. We recommend that you use a name that is easy to recognize, for example,specialborder
. -
Check the box Use gateway to enable IP Allowlisting. Optional
-
Use a code or text editor to create a CSS file. Give it a suitable name and save it with the
.css
extension.If you already use a custom CSS for your layout, you should edit that CSS file instead.
-
To add borders that will only be used by images that have the defined role, add this code to your CSS:
.specialborder img { border: 3px dotted #FF1493; padding:1em; }
Where:
specialborder
is the name of the value you gave to the role attribute in step 4.Note
You can change the border style and color to meet your own requirements. The values used here are just examples.
-
Save your CSS.
-
Select the Layout tab in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the layout to be updated or Create a Layout.
-
Select CSS, JS, logos and other assets in the sidebar.
-
Upload your CSS file in the CSS section.
-
Select Save.
When you publish with that layout, the CSS styles will be applied to your published output.
You may find that you want most of your images to have borders, but there are some exceptions and these need to have no borders. Rather then set up every image border independently, you can apply borders to all images and then set your "exception" images to use different styling.
-
Set the border styles that you want to apply to those images that are to have borders. For this, follow the instructions in Borders on All Images (HTML).
-
Open a topic that contains one of the images that are to have no borders.
-
Select the mediaobject element for the image.
-
In the Element attributes section, add the role attribute and give it a value of:
noborder
-
Check the box Use gateway to enable IP Allowlisting. Optional
-
Use a code or text editor to create a CSS file. Give it a suitable name and save it with the
.css
extension.If you already use a custom CSS for your layout, you should edit that CSS file instead.
-
To disable borders on those images with the role you created in step 4, add this code to your CSS:
.mediaobject.noborder img { border: none; }
-
Save your CSS file.
-
Select the Layout tab in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the layout to be updated or Create a Layout.
-
Select CSS, JS, logos and other assets in the sidebar.
-
Upload your CSS file in the CSS section.
-
Select Save.
When you publish with that layout, the CSS styles will be applied to your published output.
For PDF outputs, you can add borders around images. For example, you could add a pink dotted line around your images, like this:
It's also possible to add borders around the space that contains the image on a page.
When setting the image borders for PDFs, you can use the:
-
PDF layout to set the default image borders that will apply to all images, inline images, figures, and informal figures.
-
role
attribute to define specific image border styles that will only apply to one specific image.
Note
For information on adding borders for HMTL outputs, see Borders for Images (HTML).
The PDF layout editor has settings for adding borders around your block images. These settings are the borders that will apply to all block images by default.
Block image with a dotted pink border.
To set a border that will apply to all block images in your PDF layout:
-
Make sure that all of the images you want to style have a
width
attribute and a value for the width. This has to be set on theimagedata
element.To add a
width
attribute, select the image and then select itsimagedata
element in the Element Structure Menu. Select Go to element, and then in the Element attributes section, add thewidth
attribute and value. -
Select Layout and then edit the PDF layout you are going to use for publishing. Alternatively, you can create a new PDF layout and edit that.
-
Select General > Images.
-
Set the Default border for images.
This setting adds a border around block images (images that are on a new line). When you set the default border, include the size, the style, and the color. The syntax for this is: size, style, color. For example:
0.5pt dotted #FF1493
The styles you can use are none, hidden, dotted, dashed, solid, double, groove, ridge, inset, and onset.
-
Set the Default border radius for images.
This setting gives borders rounded corners.
When setting a rounded corner, it is important to consider the style of the border too. To get rounded corners, you can use padding to get it as a frame. Alternatively, you can "cut" the corners of the image, and to do this, you will need to experiment with setting the border color to match the background color of the page, for example, white. Usually, a ratio of 3 provides a good result, for example, border = 3pt solid white and border radius = 9pt.
-
Use Default padding for images to set the amount of space between the image and the border (the "inner" margin).
-
Check the box Use gateway to enable IP Allowlisting. Optional
When you publish to PDF using this layout, your block images will have a border that matches the styles you have set.
Note
To define borders that only apply to one specific image, see Borders on Selected Images Only (PDF).
If you have a figure
or informalfigure
in your content, you can apply borders to the figure/informalfigure element. These settings do not affect the border around the actual image, they only affect the border of the figure/informalfigure "container".
A figure "container" with a green ridge border and gray background. Note that the pink dotted border around the image is the border set for block images.
To define the default border settings that will apply to all figures/informalfigures:
-
Select Layout and then edit the PDF layout you are going to use for publishing. Alternatively, you can create a new PDF layout and edit that.
-
Select Formal elements > Figure.
-
Use the border settings to define the styles for the border. There are settings for width, border line style, border color, background color, and padding (internal margin).
These settings will apply to any
formal
elements in your content. -
Select Formal elements > Informalfigure.
-
Use the border settings to style the informalfigure border.
These settings work in the same way as the formal figure options in step 3, except that they apply to the
informalfigure
element instead of thefigure
element. -
Check the box Use gateway to enable IP Allowlisting. Optional
When you publish to PDF using this layout, your figure
and informalfigure
"containers" have a border that matches the styles you have set.
Note
To define borders that only apply to one specific image, see Borders on Selected Images Only (PDF).
You can set borders that will apply to all of your inline images by default. For this type of border, your inline images need to be inside a guiicon
element, which you can add from the element context menu.
Inline image with pink dotted border.
To define the default border settings that will apply to all inline images, follow the steps below.
-
Make sure the inline images are inside a
guiicon
element. Theinlinemediaobject
element has to be inside a guiicon element.Use the element context menu to add the guiicon element. You can select Insert > Image > Inline image to add the
inlinemediaobject
. -
Select Layout and then edit the PDF layout you are going to use for publishing. Alternatively, you can create a new PDF layout and edit that.
-
Select Inline elements > guiicon.
-
Use the border settings to style the width, line style, color, background color, and padding (internal margin).
-
Check the box Use gateway to enable IP Allowlisting. Optional
When you publish to PDF using this layout, your inline images will have a border that matches the styles you have set.
Note
To define borders that only apply to one specific image, see Borders on Selected Images Only (PDF).
You can set borders on individual images and these borders will override any borders that are set in the PDF layout. For example, if your PDF layout sets all images to have a black dashed border, you could set one image to have a dotted red border. That image's own settings (dotted red border) take priority over the border settings in the layout.
To set the borders on a specific image:
-
Open a topic that contains the image you want to have borders.
-
Select the image and then in the Element Structure Menu, select the
imagedata
element and Go to element. -
Make sure that your image has a
width
attribute and a value. This has to be set on theimagedata
element.To add a
width
attribute, select the image and then select itsimagedata
element in the Element Structure Menu. Select Go to element, and then in the Element attributes section, add thewidth
attribute and value. -
Use the Add attribute field to give the
imagedata
element therole
attribute. -
For the
role
attribute value, enter the border settings, for example:border: 0.25pt solid silver; border-radius: 3pt; padding: 15pt;
The syntax here is similar to that used for CSS and HTML, but only border, border-radius, and padding properties are supported.
Use semi-colons to separate the settings. The example above shows a border that is 0.25pt wide, solid line, and silver. It has a border radius of 3pt (rounded corners) and interior spacing (padding) of 15pt.
-
Check the box Use gateway to enable IP Allowlisting. Optional
When you publish to PDF, the image will have the border settings that you applied specifically to that image, rather than those defined in the PDF layout.
If you are publishing to HTML or HTML5, you can add links to videos to your topics. When you publish your content to a web server, the videos will appear on your pages as embedded content.
Paligo supports videos on YouTube, Vimeo, Wistia, or Microsoft Stream. If you want to use another video service, it may be possible, but could require a customization (contact support for advice).
(Microsoft Stream videos require that the user has an account to view the video.)
Tip
If you also publish to PDF, the video will appear, but as a hyperlink to the video. By default, the link text will display the url, but you can add a caption
in your mediaobject
element, an alternative image to display, or the alt
or textobject
elements (if you don't want a caption in HTML output).
-
Select the video icon in the toolbar:
.
A video frame appears.
-
Select the frame to display a popup toolbar, and insert the link to the video.
-
For YouTube, use the share link.
-
For Vimeo use the embed link.
-
For Wistia, you can use either the regular Inline embed, or the iFrame (fallback) embed link:
Only get the url from the
src
attribute in the script tag (ending with .jsonp), or thesrc
attribute in theiframe
element for the iFrame fallback version. Read more about the types here: Inline embed, Fallback (iframe) Embed.Note
The Wistia video embed is by default responsive, adapting to the size of the screen. But it has a default
max-width
value set to 620px. If you want to change that default width, override this property in your CSS:.video-container.wistia{ max-width: 620px; }
If you want it to utilize the entire screen space, just set the value to
none
.
-
-
Save, and the preview of the video appears for YouTube and Vimeo videos.
Microsoft Stream and Wistia currently do not show you the preview in the editor, but will work just fine when you publish.
When you publish to HTML or HTML5 you should now see the video embedded in your content.
Note
If you are publishing videos to Zendesk, but cannot see them, you need to enable videos in the Zendesk settings: Why are videos not displaying in Help Center?
It is also possible to set options for your video, for some of the available video formats. For example if you want the video to start playing as soon as the page is viewed, or if you want it to start at a particular time into the video. This is done a bit differently depending on what video platform you use:
YouTube
-
Add a "querystring" at the end of the embedcode, e.g
?autoplay=1
to autoplay the video. -
To add more than one option, add them with an ampersand after the first option, e.g
?autoplay=1&start=34
. Note that the start time option does not use any unit, just specify it as the number of seconds.Tip
See YouTube Embedded Players and Player Parameters for a complete list of possible options.
Vimeo
-
Set options the same way as for YouTube videos, with the exception that start time uses a hash (
#
) instead of a question mark or ampersand (for example,#t=1m2s
)Tip
See Using Player Parameters for a complete list of possible options.
Wistia
-
Add an
autoplay
attribute.(Note that it is used for more options than just autoplay)
-
Set the options according to the format specified by Wistia, but separated with semicolons, e.g
autoPlay=true;time=0m34s
to set it to autoplay and start at 34 seconds in. Take care to use the correct capitalization of the properties.Tip
See Embed Options and Plugin for a complete list of possible options.
You can add links to audio files in your topics so that they can be played in published HTML outputs. The audio files must be hosted elsewhere, for example, in a repository.
You can add links to external audio sources in your topics (these must be audio files hosted elsewhere, you cannot upload audio files to Paligo). When you publish to HTML, the page for the topic will include a player that you can use to play the audio file.
To add a link to an external audio source:
-
Create a new topic or edit an existing one by selecting it in the Content Manager.
-
Position the cursor at a valid position for a
mediaobject
element. For example, on the next line after apara
element. -
Use the Element Context Menu to add a
mediaobject
element.To display the Element Context Menu, use the shortcuts:
When you add a mediaobject element, it contains an imageobject by default.
-
In the Element Structure Menu, select the
imageobject
element and then select Delete.You are left with just the
mediaobject
element. -
Select the
mediaobject
element and then use the Element Context Menu to add theaudioobject
element. -
Select the
audioobject
element and then use the Element Context Menu to add theaudiodata
element. -
Select the
audiodata
element and then use the Element Context Menu to add themultimediaparam
element.You should now have a structure like this:
mediaobject
>audioobject
>audiodata
>multimediaparam
The
mediaobject
,audioobject
, andaudiodata
are the elements that are needed for the audio link. Themultimediaparam
element is needed to provide the audio player. -
Select the multimediaparam element and then use the Element attributes section to add these attributes and values:
-
name: controls
-
value: true
Note
There are other multimediaparam attributes and values that you can use. For details, see Autoplay, Mute, and Download for Audio.
-
-
Select the
audiodata
element and then use the Element attributes section to add the fileref attribute. Set the value of the fileref attribute to the URL for the audio file, for example, https://file-examples-com.github.io/uploads/2017/11/file_example_MP3_700KB.mp3. -
Check the box Use gateway to enable IP Allowlisting. Optional
When you publish this content to HTML, the page for the topic will contain an embedded audio file player that you can use to play the audio file (as long as there is an Internet connection available).
Example 37. Audio file stored in GitHub
Here is a sample of an entire topic. It contains a link to an audio file, and the link is part of step 2 in a procedure list.
The source code of this topic looks like this:
<?xml version="1.0"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xinfo="http://ns.expertinfo.se/cms/xmlns/1.0" xml:id="UUID-75e269ad-3848-623e-3f4d-aadec221fac4" version="5.0" xml:lang="en" xinfo:resource="UUID-75e269ad-3848-623e-3f4d-aadec221fac4" xinfo:resource-id="14240" xinfo:resource-type="component" xinfo:resource-title="Audio file is stored in GitHub" xinfo:resource-titlelabel="" xinfo:version-major="1" xinfo:version-minor="0"> <title xinfo:text="14241">Audio file is stored in GitHub</title> <para xinfo:text="14242">This topic contains instructions for playing an audio file.</para> <procedure> <step> <para xinfo:text="14243">Open the page that contains the audio content. The audio is embedded in the page, but is actually stored in GitHub.</para> </step> <step> <para xinfo:text="14244">Use the media player to play the audio.</para> <mediaobject> <audioobject> <audiodata fileref="https://file-examples-com.github.io/uploads/2017/11/file_example_MP3_700KB.mp3"> <multimediaparam name="controls" value="true"></multimediaparam> </audiodata> </audioobject> </mediaobject> <mediaobject></mediaobject> </step> <step> <para xinfo:text="14245">Stop the audio.</para> </step> </procedure> </section>
The published HTML version of the topic has a media player that plays the audio file that is stored in GitHub.
You can use the attributes for the multimediaparam element to control whether the audio file plays automatically, is muted, and how it downloads. The following table shows the attributes you can use.
Table 1. List of supported multimediaparam attributes for audio links
Name |
Description |
---|---|
controls |
If set to true, this adds controls to your audio object. Example: <multimediaparam name="controls" value="true"></multimediaparam> |
autoplay |
If set to true, it automatically plays the audio when the page loads. Example: <multimediaparam name="controls" value="true"></multimediaparam> <multimediaparam name="autoplay" value="true"></multimediaparam> |
loop |
If set to true, the audio will repeat indefinitely. Example: <multimediaparam name="controls" value="true"></multimediaparam> <multimediaparam name="loop" value="true"></multimediaparam> |
muted |
If set to true, the audio is muted. To hear the audio, the user has to adjust the volume on the player. Example: <multimediaparam name="controls" value="true"></multimediaparam> <multimediaparam name="muted" value="true"></multimediaparam> |
preload |
If set to none, the browser will download the audio the file when the playback starts. If set to auto, the browser can download the audio file in advance, even if the user does not play the audio. If set to metadata, the browser will only download the audio file's metadata in advance. If preload is not included, most browsers will only download metadata about the file. Example: <multimediaparam name="controls" value="true"></multimediaparam> <multimediaparam name="preload" value="auto"></multimediaparam> |
You can insert fully interactive 3D models in your HTML5 Help Center output, which you can rotate, zoom in and out, and have interactive callouts in.
Paligo supports the same formats as SketchFab for embedding 3D models in HTML. This includes most common 3D formats, such as formats for Solidworks, 3D Studio Max, Rhino, and many more.
Inserting a 3D model works very similar to how you insert a video, and in fact you use the same element, i.e a mediaobject
with a videoobject
(most easily inserted through the toolbar menu command Insert video).
Note
Currently, the 3D hosting platform supported for inserting 3D models is SketchFab (https://sketchfab.com/). There are different accounts available from free to Business with private access.
Should you be interested in support for another 3D hosting platform, please submit a request to support.
-
Create an account on Sketchfab, if you don't already have one.
-
Upload 3D models to the platform.
-
Open the embed code on a 3D object you want to add in Paligo. Get only the value in the
src
attribute. -
Paste the
src
attribute value in the widget for thevideoobject
element, or in thefileref
attribute in the Element attributes widget on the right (with thevideodata
element selected).
You can embed a viewer from Lucidchart with all its functionalities to a Paligo topic.
-
Select the topic or component in the Content Manager to open it in the Editor.
Alternatively, you can Create a Topic and edit that.
-
Position the cursor where the diagram or flowchart is to be positioned.
-
Select the Insert tab in the Toolbar.
-
Select Video.
-
Click inside the gray box and paste the URL to the diagram or flowchart.
-
Select the checkmark to confirm the link.
-
Select Save.
-
Select the Preview tab in the Toolbar.
-
Select HTML5 to see the diagram or flowchart.
Comments
0 comments
Article is closed for comments.