Reuse Notes, Warnings, Cautions

You can draw the reader's attention to information by using admonitions, such as warning, caution, danger, and note. These are special pieces of content that stand out from the rest of your content and often have a special icon. For example, the warning admonition has this icon:

warning.png

Warning Icon

This type of content is often highly repetitive and so ideal for content reuse. In Paligo, you can create a library of notes, warnings, and other messages and reuse them wherever they are needed. There is no need to copy and paste or duplicate the information.

There are two ways to create admonitions. You can create them as elements in a topic (see Admonitions (notes, warnings, tips, etc.) or you can create them as reusable pieces of content. Here, we are going to explain how to:

  • Create a reusable admonition

  • Insert a reusable admonition into a topic.

The following video shows how to create a reusable warning and insert it in a topic. You can use the same technique to create different types of admonitions, just select the appropriate option instead of warning. Alternatively, follow the instructions below.

  1. In the Content Manager, select the options menu ( ... ) for the folder that you want to contain your reusable admonition. If a suitable folder does not already exist, create a new one.

  2. Select Create Content.

  3. Enter a name for the admonition and select the appropriate type (Note, Warning, Caution, Danger, Notice, Important, or Tip).

    Paligo creates the admonition and adds it to the relevant folder.

  4. Select the admonition to open it in the editor and add the text and/or images you need it to include. Save the admonition when you have finished.

    admonition-safety-warning.gif
  5. Find a topic that you want to add the admonition to, and then open the topic in the editor.

  6. Place the cursor at a valid position for the admonition. This can be any position where text can be added. (Paligo will display an error message if you try to add an admonition in an invalid position).

  7. Select Insert > Component.

  8. Choose the reusable admonition that you want to add to the topic and select OK.

    The reusable admonition is added to the topic.

    reused-safety-warning.gif

To insert a reusable admonition, such as a warning or note, in a topic:

  1. Find a topic that you want to add the admonition to, and then open the topic in the editor.

  2. Place the cursor at a valid position for the admonition. This can be any position where text can be added. (Paligo will display an error message if you try to add an admonition in an invalid position).

  3. Select Insert > Component.

  4. Choose the reusable admonition that you want to add to the topic and select OK.

    The reusable admonition is added to the topic. For example, in the image below, a reusable warning admonition is added to a topic.

    reused-safety-warning.gif

You can add "regular" admonitions by selecting Insert and choosing an admonition. Regular admonitions are designed as "one-off" messages that will not be reused. However, it is quite possible that you will add a regular admonition to a topic and later realise that you need to use it again. In these situations, you can quickly convert the regular admonition into a reusable component.

To learn how to convert a regular admonition into a reusable component, watch the video or follow the instructions below:

  1. Open the topic that contains the regular admonition that you want to reuse, and select any part of the admonition.

  2. In the Element Structure Menu, select the top-level element of the admonition to display a menu. For example, if you have selected a warning admonition, select the warning element.

    select-admonition-element.png
  3. From the menu, select Create reusable component.

  4. Give the component a suitable name and choose a folder to store it in.

    convert-to-reusable-component-window.png
  5. Use Reuse the component at position option to choose whether you want to replace the existing regular admonition with the reusable version that Paligo will create.

  6. Select Ok to confirm and Paligo will create a reusable component that matches the admonition you selected in step 1.

To add the admonition to topics, open a topic in the editor and position the cursor at a valid position. Then select Insert > Component, and select the reusable admonition.