Getting Started

Notes, warnings, and tips

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, tips, etc.).

The admonition elements include note, important, notice, caution, warning, danger and tip. You can add them from the Insert tab or by using keyboard shortcuts. For example, you can add a tip by pressing and and T on Mac or Ctrl and Alt and T on Windows.

For more information, see Editor Toolbar and keyboard shortcuts

Add a note, warning, or tip

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

  1. Select the Insert tab.

  2. Select the Admonitions option (the warning icon) admonitions_button.png.

  3. Choose the type of admonition you want to create from the list.

    insert-admonition.png

The appropriate admonition is added to your content, ready for you to add your message.

note-example.png

Alternatively, you can use this technique to add an admonition:

  1. Place your cursor where you want to add the admonition.

    Note

    If you want to place an admonition after a paragraph, you must place the cursor after the paragraph and before the next element.

    cursor_position.png
  2. Press Alt and Enter (Windows) or Command and Enter (Mac) to access the Element list.

  3. Select the type of admonition that you want to add, for example, Warning. (You can search for the admonition by name, if required).

Note

You can add most types of element inside an admonition element. For example, you can add text, images, tables, etc.

Converting notes, warnings, and tips

It is easy to change one type of admonition to another. 

  1. Select the admonition element that you want to change into a different type of admonition. For example, select the note element. 

    select-admonition-element.png

    Tip

    Use the Element Structure Menu (1) to make sure that you have the admonition element selected. The admonition element should be the last element shown.

  2. Select the Insert tab.

  3. Select the Admonitions option (the warning icon) admonitions_button.png.

  4. Choose the type of admonition you want to create from the list.

Change the style of notes, warnings, and tips

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

For HTML/HTML5 outputs, you can use CSS to customise the appearance.

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

  1. Select Layout.

  2. Select the PDF layout that you use for publishing the content.

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

    change-admonitions-pdf.png
  4. Select Save.

Titles for notes, warnings, and tips

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 (but your title will not be translated automatically).

To add a title:

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

  2. Press Alt and Enter (Windows) or Option ⌥ and Enter (Mac) to display the Element context menu.

    admonition-title-context-menu.png
  3. Select the Title option.

  4. Enter the text for the title.

  5. Select Save.