Use the PDF Layout's Admonition settings (General, Graphical, and Nongraphical) to change the appearance of notes, warnings, cautions, and other admonitions.
Before you start editing the admonition styles, we recommend you read Which Admonition Parts Can You Style?.
What parts of an admonition can you customize for your PDF outputs? Find out in this article.
The PDF layout has Admonitions settings for styling the notes, cautions, and other admonitions in your PDF outputs. Use the settings to style the various parts of an admonition:
-
The spacing around the admonition
-
The icon for graphical admonitions
-
The title
-
The body text
-
The admonition box (the container that the icon, title, and text are inside).
The Admonitions settings are divided into three categories:
-
General
The General settings apply to all admonitions in your PDF output. It is here that you tell Paligo to use graphical or nongraphical admonitions.
-
Graphical
The Graphical settings only apply to admonitions if the layout is set to use graphical admonitions (which it is by default).
Graphical admonitions have a box that, by default, contains two columns. The left-side column is narrower and contains an icon that represents the type of admonition. The right-side column contains the title and body text.
-
Nongraphical
The Nongraphical settings only apply to admonitions when you have set the layout to use non-graphical admonitions.
Non-graphical admonitions have a single column with a title, body text and no icon.
You will need to use the settings in the General category and one of the other categories, depending on whether you want graphical or nongraphical admonitions.
The General admonition styles are designed to apply to graphical and non-graphical admonitions. You should set your general preferences and then use the Graphical or Nongraphical settings to apply further styles for those types of admonition.
-
Select Layout in the top menu.
-
Select the PDF Layout you are going to use for publishing. Alternatively, create a new one (see Create a Layout).
-
Select the Admonitions category and then select the General subcategory.
-
Choose whether the admonitions will use graphical icons.
Set Use graphics in admonitions to:
-
Enabled to include a graphical icon in admonitions. For styling, Paligo will use a combination of the admonition General and admonition Graphical settings. It will ignore the Nongraphical settings.
-
Disabled for admonitions without graphical icons. For styling, Paligo will use a combination of the admonition General and admonition Nongraphical settings. It will ignore the Graphical settings.
-
Default to inherit the value for this setting from the base Layout. The base Layout is either a built-in Layout provided by Paligo or another custom Layout, see Layout Relationships - Base, New, Duplicate.
-
-
Choose whether Paligo will add a
title
to any admonition that does not already have atitle
. Set Use auto-title in admonitions to:-
Activate to get Paligo to generate a title. The title is the name of the admonition type, for example, Note, and is translated automatically into the relevant languages.
-
Deactivate to prevent Paligo from generating titles automatically.
-
Default to inherit the value for this setting from the base Layout. The base Layout is either a built-in Layout provided by Paligo or another custom Layout, see Layout Relationships - Base, New, Duplicate.
-
-
Set the Default font family for admonition text. This is the style of lettering for each admonition's main body content.
Choose a typeface from the list of available fonts.
-
Set the Default font size for admonition text. This is the size of the main body text in each admonition.
-
Set the Default font size for admonition title. This is the size of the text in each admonition's
title
element. -
Set the Capitalization for admonition title. This controls whether title characters are shown in upper case, lower case, or a combination of the two.
-
Set the left and right margins for the main body text of your admonitions.
-
Margin-left for admonitions body
Use to set a left-side indent for the body text of admonitions. Enter a value and its units of measurement, for example, 16pt.
-
Margin-right for admonitions body
Use to set a right-side indent for the body text of admonitions. Enter a value and its units of measurement, for example, 16pt.
-
-
Set the margins for the admonition titles.
-
Margin-left for admonition title
Use to set a left-side indent for the title of admonitions. Enter a value and its units of measurement, for example, 16pt.
-
Margin-right for admonition title
Use to set a right-side indent for the title of admonitions. Enter a value and its units of measurement, for example, 16pt.
-
-
Use the following settings to set a background color for each type of admonition.
-
Background color for 'Note'
-
Background color for 'Notice'
-
Background color for 'Warning'
-
Background color for 'Danger'
-
Background color for 'Caution'
-
Background color for 'Tip'
-
Background color for 'Important'
-
Clear the Use default color checkbox to select a color of your own choice.
-
Set the color either by:
-
Entering an RGBA code for the color you want (1).
-
Selecting the Color square to display the color selector (2).
-
Choose the color with the spectrum bar (3).
-
Control the transparency with the opacity bar (4).
-
Choose the color shade with the main color panel (5).
-
-
-
-
Use the following settings to set the text color for the various types of admonition.
-
Font color for 'Note'
-
Font color for 'Notice'
-
Font color for 'Warning'
-
Font color for 'Danger'
-
Font color for 'Caution'
-
Font color for 'Tip'
-
Font color for 'Important'
Again, clear the Use default color checkbox for each color that you want to set. Use the color box to display the color selector and choose the color you want.
-
-
Select Save.
You have now set the General settings for your admonitions. If you have chosen to use graphical admonitions, you can apply more settings in the Graphical category. If you have chosen to use non-graphical admonitions, you can apply more settings in the Nongraphical category. The General settings take priority over the Graphical and Nongraphical settings.
When you use this Layout to publish to PDF, Paligo will apply your choices to the admonitions in your content.
If you have set Paligo to generate graphical admonitions, it will apply the styling choices from the General settings and the Graphical settings. The General settings take priority over the Graphical settings.
Here, we explain how to use the Graphical settings.
Note
To learn how to set Paligo to generate graphical admonitions, see Set the General Styles for Admonitions. That article also explains how to use the General settings.
To set the Graphical styles:
-
Select Layout in the top menu.
-
Select the PDF Layout you are going to use for publishing. Alternatively, create a new one (see Create a Layout).
-
Select the Admonitions category and then select the Graphical subcategory.
-
Use Background color for Graphical admonitions to choose one color for all graphical admonitions.
-
Clear the Use default color checkbox to select a color of your own choice.
-
Set the color either by:
-
Entering an RGBA code for the color you want (1).
-
Selecting the Color square to display the color selector (2).
-
Choose the color with the spectrum bar (3).
-
Control the transparency with the opacity bar (4).
-
Choose the color shade with the main color panel (5).
-
-
Note
Paligo will only use the color you select here if the General category has the background colors set to default.
For example, let's say you select the General category and set Background color for 'Caution' to orange. You then go into the Graphical category and set Background color for graphical admonitions to blue. When you publish, your caution admonitions will have an orange background, as the General category takes priority over the Graphical category.
-
-
Use these settings to define the amount of space above and below graphical admonitions:
-
Space-before (optimum) for graphical admonitions
Use to set a preferred amount of space above graphical admonitions. This setting does not apply to admonitions inside lists and procedures.
-
Space-after (optimum) for graphical admonitions
Use to set a preferred amount of space below graphical admonitions. This setting does not apply to admonitions inside lists and procedures.
-
Space-before (optimum) for graphical admonitions in list items and steps
Use to set a preferred amount of space above graphical admonitions that appear in a list or procedure.
-
Space-after (optimum) for graphical admonitions in list items and steps
Use to set a preferred amount of space below graphical admonitions that appear in a list or procedure.
For all of these settings, enter a scaling value. Paligo uses the value in relation to the size of body text in your PDF. For example, if you enter 2.5, Paligo will add spacing that is 2.5 times bigger than the body text size. If you enter 0.5, Paligo will add spacing that is half the size of the body text.
Paligo will try to apply the preferred amount of space, but in some cases may need to use less. For example, a page break might result in Paligo applying different spacing.
-
-
Use the following settings to define the amount of space inside the graphical admonitions. This is the "padding".
-
Padding-top for graphical admonitions
Enter the amount of space between the top of the admonition box and the top of the title (or body text if there is no title). Enter a value and the units of measurement, for example, 2em.
-
Padding-bottom for graphical admonitions
Enter the amount of space between the bottom of the admonition box and the bottom of the body text. Enter a value and its units of measurement, for example, 2em.
-
-
Use these settings to set margins for graphical admonitions. The margins apply to the whole admonition, not just the content inside it.
-
Margin-left for graphical admonitions
Sets the left-side indent for all graphical admonitions.
-
Margin-right for graphical admonitions
Sets the right-side indent for all graphical admonitions.
For both settings, enter a value and the units of measurement, for example, 2cm.
Note
When setting a margin, consider the amount of space available on the page of your PDF.
-
-
Use the Margin-left for graphical admonition icon setting to control the position of the admonition icons. Enter a value and the units of measurement, for example, 1.5em. Paligo applies the margin from the default position of an icon.
-
Set the Border width for graphical admonitions. This is the thickness of the border line around the edge of the admonition box. It applies to all types of admonition, such as note, caution, and warning.
Enter a value and the units of measurement, for example, 0.5pt.
-
Choose the Border style for graphical admonitions from the list. The options are:
-
Set the Border color for graphical admonitions.
Again, to choose your own color, clear the Use default color checkbox and then use the color selector to set the color.
-
Use the Border radius for graphical admonitions setting to set the amount of curve on the corners of the border box. Set it to 0pt for no curves or enter a value and a unit of measurement to add curves. For example, you could use 10pt to give the box curved corners.
-
Use Admonition icon width to set the size of the admonition icons.
Enter a value and the units of measurement, for example, 24pt. Paligo will set the width of the icon image container and will scale the image to fit. When it scales the image, Paligo keeps the aspect ratio so that the image is not stretched in height or width.
-
Use the following settings to upload an icon graphic for each type of admonition. We recommend that you use graphics that are square and the same size (or close to) that you want them to be in your output.
-
Icon for 'Note'
-
Icon for 'Notice'
-
Icon for 'Warning'
-
Icon for 'Danger'
-
Icon for 'Caution'
-
Icon for 'Important'
-
Icon for 'Tip'
For each setting, select the Upload button to display an image upload dialog. Drag the image file on to the dialog.
-
-
Select Save.
When you use this Layout to publish to PDF, Paligo will apply your choices.
If you have set Paligo to generate nongraphical admonitions, it will apply the styling choices from the General settings and the Nongraphical settings. The General settings take priority over the Nongraphical settings.
Here, we explain how to use the Nongraphical settings.
Note
To learn how to set Paligo to generate nongraphical admonitions, see Set the General Styles for Admonitions. That article also explains how to use the General settings.
To set the Nongraphical styles:
-
Select Layout in the top menu.
-
Select the PDF Layout you are going to use for publishing. Alternatively, create a new one (see Create a Layout).
-
Select the Admonitions category and then select the Nongraphical subcategory.
-
Choose whether Paligo should allow an admonition to have a user-defined title and an auto-generated title.
In the General settings for admonitions, there is a Use auto-title in admonitions setting. When it is set to Activate, Paligo will generate automatic titles for your admonitions, such as "Note" and "Caution". The auto-generated titles will replace any existing titles, by default. But if you prefer, you can set Paligo to include both auto-generated titles and manually-added titles.
Set the Allow both user-defined title and auto-generated title setting to:
-
Enabled to allow a user-defined title and an auto-generated title
-
Disabled to only allow one title. If Use auto-title in admonitions is set to Activate, Paligo will generate titles for your admonitions. Any existing titles are ignored.
-
Default to inherit the value for this setting from the base Layout. The base Layout is either a built-in Layout provided by Paligo or another custom Layout, see Layout Relationships - Base, New, Duplicate.
-
-
Use Background color for nongraphical admonitions to choose one color for all nongraphical admonitions.
-
Clear the Use default color checkbox to select a color of your own choice.
-
Set the color either by:
-
Entering an RGBA code for the color you want (1).
-
Selecting the Color square to display the color selector (2).
-
Choose the color with the spectrum bar (3).
-
Control the transparency with the opacity bar (4).
-
Choose the color shade with the main color panel (5).
-
-
Note
Paligo will only use the color you select here if the General category has the background colors set to default.
For example, let's say you select the General category and set Background color for 'Caution' to orange. You then go into the Nongraphical category and set Background color for graphical admonitions to blue. When you publish, your caution admonitions will have an orange background, as the General category takes priority over the Nongraphical category.
-
-
Set the amount of space above (before) and below (after) the nongraphical admonitions.
-
Space-before (optimum) for nongraphical admonitions
-
Space-after (optimum) for nongraphical admonitions
Enter an amount, relative to the body font size in the following fields. For example, 1.2. Do not include any units of measurement as the size is always relative to the body font size.
-
-
Set the amount of padding for nongraphical admonitions. The padding is the internal margin between the content in the admonition and the boundaries of the admonition box.
Enter an amount and the units of measurement in the following fields:
-
Padding-top for nongraphical admonitions
Use to set the amount of space above the title of nongraphical admonitions. This space applies to the body text if there is no title.
-
Padding-bottom for nongraphical admonitions
Use to set the amount of space below the body text of nongraphical admonitions.
-
-
Use the margin settings to set left and right indents for nongraphical admonitions. The margins apply to the admonitions as a whole, not the content inside it.
-
Margin-left for nongraphical admonitions
Sets the left-side indent for all nongraphical admonitions.
-
Margin-right for nongraphical admonitions
Sets the right-side indent for all nongraphical admonitions.
For both settings, enter a value and the units of measurement, for example, 2cm.
-
-
Select Save.
When you use this Layout to publish to PDF, Paligo will apply your chosen settings.
Learn how to control the spacing for admonitions in PDF outputs. Set the margins and the padding to control the space inside an admonition.
To control the spacing around admonitions in PDF outputs, use the margin settings in the PDF layout. The layout also has padding settings for controlling the spacing inside the admonition.
-
Select Layout in the top menu.
-
Select the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select Admonitions.
-
Select General.
-
Use these settings to define the side margins for the text inside your admonitions:
-
Margin-left for admonitions body
Use to set a left-side indent for the body text of admonitions. Enter a value and its units of measurement, for example, 16pt.
-
Margin-right for admonitions body
Use to set a right-side indent for the body text of admonitions. Enter a value and its units of measurement, for example, 16pt.
For both settings, enter a value and include the units of measurement, for example, 16pt. Paligo applies the indent from the default position of the body text.
-
-
Use these settings to define the side margins for the titles in your admonitions:
-
Margin-left for admonition title
Use to set a left-side indent for the title of admonitions. Enter a value and its units of measurement, for example, 16pt.
-
Margin-right for admonition title
Use to set a right-side indent for the title of admonitions. Enter a value and its units of measurement, for example, 16pt.
For both settings, enter a value and include the units of measurement, for example, 16pt. Paligo applies the indent from the default position of the title.
-
-
Select Graphical.
-
Use these settings to define the amount of space above and below graphical admonitions:
-
Space-before (optimum) for graphical admonitions
Use to set a preferred amount of space above graphical admonitions. This setting does not apply to admonitions inside lists and procedures.
-
Space-after (optimum) for graphical admonitions
Use to set a preferred amount of space below graphical admonitions. This setting does not apply to admonitions inside lists and procedures.
-
Space-before (optimum) for graphical admonitions in list items and steps
Use to set a preferred amount of space above graphical admonitions that appear in a list or procedure.
-
Space-after (optimum) for graphical admonitions in list items and steps
Use to set a preferred amount of space below graphical admonitions that appear in a list or procedure.
For all of these settings, enter a scaling value. Paligo uses the value in relation to the size of body text in your PDF. For example, if you enter 2.5, Paligo will add spacing that is 2.5 times bigger than the body text size. If you enter 0.5, Paligo will add spacing that is half the size of the body text.
Paligo will try to apply the preferred amount of space, but in some cases may need to use less. For example, a page break might result in Paligo applying different spacing.
-
-
Use the following settings to define the amount of space inside the graphical admonitions. This is the "padding".
-
Padding-top for graphical admonitions
Enter the amount of space between the top of the admonition box and the top of the title (or body text if there is no title). Enter a value and the units of measurement, for example, 2em.
-
Padding-bottom for graphical admonitions
Enter the amount of space between the bottom of the admonition box and the bottom of the body text. Enter a value and its units of measurement, for example, 2em.
-
-
Use these settings to set margins for graphical admonitions. The margins apply to the whole admonition, not just the content inside it.
-
Margin-left for graphical admonitions
Sets the left-side indent for all graphical admonitions.
-
Margin-right for graphical admonitions
Sets the right-side indent for all graphical admonitions.
For both settings, enter a value and the units of measurement, for example, 2cm.
-
-
Use the Margin-left for graphical admonition icon setting to control the position of the admonition icons. Enter a value and the units of measurement, for example, 1.5em. Paligo applies the margin from the default position of an icon.
-
Select Nongraphical.
-
Use the spacing settings to adjust the positioning of the title and body text of your nongraphical admonitions. The settings work in the same way as the similarly named settings in the Graphical category, except that they apply to the nongraphical admonitions instead.
-
Space-before (optimal) for nongraphical admonitions
Use to set a preferred amount of space above non-graphical admonitions.
-
Space-after (optimal) for nongraphical admonitions
Use to set a preferred amount of space below non-graphical admonitions.
-
Padding-top for nongraphical admonitions
Use to set the amount of space above the title of nongraphical admonitions. This space applies to the body text if there is no title.
-
Padding-bottom for nongraphical admonitions
Use to set the amount of space below the body text of nongraphical admonitions.
-
Margin-left for nongraphical admonition
Use to set the left-side indent of nongraphical admonitions. This applies to the whole admonition.
-
Margin-right for nongraphical admonition
Use to set the right-side indent of nongraphical admonition. This applies to the whole admonition.
-
-
Select Save.
To learn about using the other PDF layout settings to style admonitions, see Admonition Styling (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.
Learn how to style the body text in admonitions for PDF outputs. Choose the font and set the size and color.
Admonitions have body text that provides the user with information. Typically, the body text is in para
elements, but you can also include lists and other types of content. We recommend that you keep admonitions short and concise.
To style the body text for PDF outputs, use the settings on the PDF layout:
-
Select Layout in the top menu.
-
Select the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select Admonitions.
-
Select General.
-
Use the following settings to style the text for admonitions:
-
Default font family for admonition text - Choose the typeface that Paligo will use for admonition text by default. Select the typeface from the list of available fonts.
-
Default font size for admonition text - Set the default size of the admonition text. Enter a value and the units of measurement, for example, 12pt.
-
-
Use the following settings to set the color for your admonition text. The color applies to the title and the body text.
-
Font color for 'Note'
-
Font color for 'Notice'
-
Font color for 'Warning'
-
Font color for 'Danger'
-
Font color for 'Caution'
-
Font color for 'Tip'
-
Font color for 'Important'
-
-
Clear the Use default color checkbox to select a color of your own choice.
-
Set the color either by:
-
Entering an RGBA code for the color you want (1).
-
Selecting the Color square to display the color selector (2).
-
Choose the color with the spectrum bar (3).
-
Control the transparency with the opacity bar (4).
-
Choose the color shade with the main color panel (5).
-
-
-
Select Save.
Tip
To learn:
-
How to indent admonition body text, see Set the Admonition Spacing for PDF.
-
About using the other PDF layout settings to style admonitions, see Admonition Styling (PDF).
Comments
0 comments
Article is closed for comments.