You can draw the reader's attention to information by using admonitions, such as warning, caution, danger, tip and note. These are special pieces of content that stand out from the rest of your content and often have a special 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.
Warning Icon
There are two ways to create admonitions (Note, Warning, Caution, Danger, Notice, Important, or Tip). You can create them as elements in a topic, see Admonitions or you can create them as reusable pieces of content.
It is the same technique to create different types of admonitions, just select the appropriate admonition type..
Watch this video on how to create a reusable warning and insert it into a topic. Alternatively, follow the instructions below.
To create a reusable admonition:
-
Select the Dotted menu (... ) to the right of the folder that is to contain the content in the Content Manager.
If a suitable folder does not already exist, you can create a new one (Create Folder).
-
Select Create content.
-
Name the content.
-
Select the type of content to be created.
The checkbox for topic is preselected.
-
Select the Languages that you want to translate to later.
The original content will be labelled with the Source Language.
-
Select OK.
-
Select the admonition to open it in the Editor
-
Add the text and / or images you need it to include.
-
Select Save.
-
Open topic that you want to add the admonition to in the Editor.
-
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).
-
Select the Insert tab in the Toolbar.
-
Select Component.
-
Select the reusable admonition that you want to add to the topic.
-
Select OK.
The reusable admonition is added to the topic.
To insert a reusable admonition, such as a warning or note, in a 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.
-
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).
-
Select the Insert tab in the Toolbar.
-
Select Component.
-
Select the reusable admonition.
-
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.
-
Select Save.
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 realize that you need to use it again. In these situations, you can quickly convert the regular admonition into a reusable component.
Watch this video on how to convert the admonition or follow the instructions below.
To convert a regular admonition into a reusable component:
-
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 any part of the admonition.
-
Select the top-level element of the admonition in the Element Structure Menu and choose Convert to reusable component..
For example, if you have selected a warning admonition, select the warning element.
-
Enter a suitable name and select a folder to store it in.
-
Use Reuse the component at position checkbox to keep it in its position otherwise it will be removed.
-
Select OK.
To reuse the admonition, see Insert Component.
Comments
0 comments
Article is closed for comments.