Skip to main content

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. Insert_Admonition.png

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.

Toolbar_Insert_small.png

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

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

  1. Select the topic or component in the Content Manager to open it in the Editor.

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    Alternatively, you can Create a Topic and edit that.

  2. Select the Insert tab in the Toolbar.

    Toolbar_Insert_small.png
  3. Select Insert admonition. Insert_Admonition.png.

  4. Select an admonition type from the menu.

    insert-admonition.png
  5. Enter text inside the admonition.

    Tip

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

  6. Select Save. Save icon.

You can quickly change one type of admonition to another. 

  1. Position the cursor inside the admonition.

  2. Select the admonition element in the Element Structure Menu (1).

    select-admonition-element.png
  3. Select the Insert tab in the Toolbar.

    Toolbar_Insert_small.png
  4. Select Insert Admonition. Insert_Admonition.png

  5. Select a different admonition type from the menu.

  6. Select Save. Save icon.

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).

tip-label.png

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. You will need to send it for translation.

To add a title to an admonition:

  1. Select the admonition element that you want to give a title.

  2. Press Alt + Enter ⏎ (Windows) or Command ⌘ + Enter ⏎ (Mac) to display the Element Context Menu.

    Element context menu shows a search field and a list of elements that are valid at the current position.
  3. Select the Title option.

    admonition-title-context-menu.png
  4. Enter the text for the title.

  5. Select Save. Save icon.