Admonitions

You can add notes, warnings, tips and other "admonition" elements to make parts of your content stand out. Admonitions is the term for collectively describing all of the notes, warnings and tips.

The admonition elements include Note, Caution, Warning, Danger, Notice , Important and Tip. You can add them from the Insert tab in Toolbar and some of them can be added with keyboard shortcuts, see Keyboard Shortcuts.

You can use the admonition elements in most types of block content, including paragraphs and tables. Paligo does not restrict how you use the elements, but you need to be aware that some industries have rules about how they are used. For example, in some industries, you must use a warning if there is a risk of injury.

Admonition Types

Admonitions also called "safety messages" or "hazard statements" is an umbrella term used for note, important, notice, caution, warning, danger and tip elements.

Paligo includes a variety of admonition elements that you can use:

Note

This is a note element

The note is normally used for general information that you want to stand out.

Caution

This is a caution element

The caution element can be used however you need, but has a certain significance in some industry standards.

Warning

This is a warning element

The warning element can be used however you need, but has a certain significance in some industry standards.

Danger

This is a danger element

Danger is a custom Paligo element. It is actually a warning element with its Role attribute set to Danger. It can be used for any purpose, but is designed for content that describes situations that could result in physical injury or death.

Tip

This is a tip

Tips are designed for giving readers helpful advice and suggestions.

Important

This is an important element

The important element is for adding extra emphasis to general information.

Notice

This is a notice element

"Notice" is a variant of note used in certain industry standards (especially manufacturing). If used, it is generally regarded as being of more importance than a regular note.

Add Admonitions

To add a note, warning, tip or other type of admonition to your content:

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 Insert tab in the Toolbar.
Select Insert admonition. .
Select an admonition type from the menu.
Enter a text inside the admonition.

Tip

You can add most types of elements inside an admonition element (text, images, tables).
Select Save.

Convert Admonitions

You can quickly change one type of admonition to another.

To convert an admonition into a different admonition type:

Position the cursor inside the admonition.
Select the admonition element in the Element Structure Menu (1).
Select the Insert tab in the Toolbar.
Select Insert Admonition.
Select a different admonition type from the menu.
Select Save.

Style Admonitions for PDF

You can change the appearance of your notes, warnings, and tips to meet your needs.

For HTML/HTML5 outputs, you can use CSS to customize the appearance, see Style Admonitions with CSS.

For PDF outputs, you can set the colors and icons in the PDF layout.

Select Layout.
Select the PDF layout that you use for publishing the content.
In the Layout Editor, use the Annotations options (1 and 2 in the following image) to define the appearance. There are settings for adjusting the font size, colour, icons, and spacing.
Select Save.

Admonition Titles

By default, Paligo creates a label for each admonition element and does not include a title. The label adds the name of the element in the published content, for example, if you add a tip, the word "tip" is used as the label (shown as 1 in the following image).

The labels that Paligo generates, such as "tip" and "warning" are translated automatically for most languages.

If you prefer, you can add a title. Paligo will then use your title instead of generating a label (but your title will not be translated automatically).

To add a title:

Select the admonition element that you want to give a title.
To display the element context menu, press Alt and Enter (Windows) or Option ⌥ and Enter (Mac).
Select the Title option.
Enter the text for the title.
Check the box Use gateway to enable IP Allowlisting. Optional

Articles in this section

Admonition Types