List Styling (PDF)
For PDF outputs, use a PDF Layout to style your lists and procedures. Each PDF Layout has a Lists category that contains subcategories. There are subcategories for General (applies to all lists), Unordered lists (bullet lists), Ordered lists (numbered lists), Simple lists, and Procedures.
We recommend that you start by styling the General list settings. Then use the other subcategories to style the specific types of list, such as procedure and unordered list.
Tip
When styling lists, it is a good idea to create a test topic that contains each type of list. Then use the preview feature in the Layout Editor to see the effect of any changes. In the Layout editor, select Choose document and select your test topic. When you make a change to a list setting, select Save and then Update preview. The preview will show the effect of the change you made.
For details on the preview feature, see Preview a PDF Publication in Layout Editor).
To learn how to style the different types of lists for PDFs, see:
PDF Layouts have General list settings that apply to many types of list. For example, if you set the spacing in the General list settings, the same spacing will apply to ordered lists, bullet lists, and procedures. The idea is that you set your General preferences for all lists and then use the other subcategories to define the settings for each type of list.
To set your preferences for all lists:
-
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 Lists category and then select the General subcategory.
-
Set the amount of space above and below each list. This spacing applies to entire lists, not the list items inside the lists.
Use:
-
Margin before list blocks to set the amount of space above each list
-
Margin after list blocks to set the amount of space below each list.
For both settings, enter a value that is relative to the body font size, for example, 1.5 to add a space that is 1.5 times larger than the font size. Do not include units of measurement, enter the value only.
-
-
Set the amount of space above and below each list item in lists that have normal list spacing.
Use:
-
Space before list items in normal lists to set the space above each list item
-
Space after list items in normal lists to set the space below each list item.
For both settings, enter a value that is relative to the body font size, for example, 1.5 to add a space that is 1.5 times larger than the font size. Do not include units of measurement, enter the value only.
-
-
Set the amount of space above and below each list item in lists that have compact list spacing.
Use:
-
Space before list items in compact lists to set the space above each list item
-
Space after list items in compact lists to set the space below each list item.
For both settings, enter a value that is relative to the body font size, for example, 1.5 to add a space that is 1.5 times larger than the font size. Do not include units of measurement, enter the value only.
-
-
Choose your preferred behavior for the Space-after (optimum) for paragraphs inside list items or procedure steps setting. By default, this setting applies to block elements inside a list item or step, with the exception of the last block element. For example, if you have a step that contains three paragraphs, the space-after will apply to the first and second paragraphs, but not the third. This is for compliance with the XSL FO specification.
Use the Apply selected space after property for last block child elements in lists setting to control the behavior.
Choose:
-
Enabled to apply the space-after (optimum) to all block elements inside a step or list item, including the last block.
-
Disabled to keep the default behavior, where the space-after (optimum) does not apply to the last block inside a step or list item.
-
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 preferred amount of space after paragraphs and other block elements that are inside a list item or step. Enter the amount and its units of measurement in the Space-after (optimum) for paragraphs inside list items or procedure steps field. For example, 0.6em.
Note
By default, Paligo does not apply the spacing after the last block element inside the list item or step. To change this behavior, set Apply selected space after property for last block child elements in lists to Enabled (see previous step).
-
Set the Left margin for list blocks. This is an indent to move the list in from the regular starting position. Enter the amount and include the units of measurement, for example, 3em.
-
Set the Font family for list titles. This is the style of lettering for each list's
title
element.Choose a typeface from the list of available fonts.
Note
The effect of font-related settings, such as weight and style, varies depending on the font family.
Note
By default, lists do not have a
title
element, but you can add one manually if required (see Add Elements ). -
Set the Font size for list titles. This is the size of the text in each list's
title
element (if atitle
element is in place). -
Set the Font weight for list titles. This sets the boldness of the font. The effect varies depending on what font-family is set for list titles.
-
Set the Font style for list titles.
Choose from:
-
Set the Font variant for list titles to Normal for regular sized, mixed case letters or Small-caps for smaller, upper-case letters.
-
Use Color for list titles to apply a custom color to the text in the title.
-
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).
-
-
-
-
Set the Capitalization for list titles. This controls whether title characters are shown in upper case, lower case, or a combination of the two.
-
Set the Letter-spacing for list titles. This is the amount of horizontal spacing between each letter in the title.
To increase the amount of spacing, enter:
-
A relative amount and units of measurement, for example, 0.2rem
-
An absolute amount and units of measurement, for example, 1px
To decrease the amount of spacing, enter a negative relative or absolute amount, for example, -1px.
-
-
Select Save.
You have now defined the default settings for lists. If you want different styling for each type of list, define that styling in the Unordered lists, Ordered lists, Simple lists, and Procedures subcategories. Any settings you define in those subcategories will take priority over the settings in the General subcategory.
When you use this Layout to publish to PDF, Paligo will apply your choices when it creates the PDF output file.
You can use the role
attribute to adjust the list label width and alignment for individual lists. This way you override the default Layout Editor settings.
If you have sublists, these will inherit the width and alignment from the parent list (but can be overridden with the role
attribute if needed).
Note
The qandaset
also have labels that will inherit the label alignment if there is an ancestor list.
However, it will not inherit the width, since width of the list label for the qandaset
has a complex logic to set the width depending on type, descending labels and more.
You cannot set the default alignment or width for qandaset
in the Layout Editor, but you can use the role attribute to set the label alignment for an individual
quandaset: role=”label-align:end;”
To set the list label for an individual numbered list:
-
Select the topic or component in the Content Manager to open it in the Editor.
-
Position the cursor in the numbered list.
-
Select the orderedlist in the Element Structure Menu and choose Go to element.
-
Add the
role
attribute in the Element Attributes Panel. -
Enter
label-width:2em;label-align:end;
as value. -
Change the number in
label-width:2em;
to adjust the space between the list label and list item text.The default width is
1.75em
. -
Replace "end" in
label-align:end;
to adjust the list label positioning.The default alignment is
start
. -
Select Save.
For PDF outputs, use your PDF Layout to style the ordered lists in your content.
Note
Ordered lists are affected by the styles in the General and Ordered Lists subcategories of the Lists settings.
To learn about the General settings, see Set the General Preferences for Lists (PDF).
-
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 Lists category and then select the Ordered lists subcategory.
-
Use Distance between start of label and content to set the margin between the number and the text for the list item.
Enter the value as an integer or a decimal number, followed by its unit of measurement. You can use any of these units:
-
cm (centimeters)
-
mm (millimeters)
-
in (inches)
-
pt (points)
-
pc (picas)
-
px (pixels)
-
em (relative to font size)
Examples: 1.5em, 12pt, 1cm.
Note
Ordered lists can also have their label styling defined in an attribute on each individual list. The attribute styling takes priority over the Layout settings (see Style List Labels Individually (PDF)).
-
-
Set the Label alignment. This positions the label (number) for list items within the label space.
In the diagram, A is the Distance between start of label and content and B is the label space. The shaded area labelled C is the default amount of space Paligo includes automatically. The alignment applies to the space labelled B.
Choose from:
Note
Ordered lists can also have their label styling defined in an attribute on each individual list. The attribute styling takes priority over the Layout settings (see Style List Labels Individually (PDF)).
-
Choose whether you want to use language-specific numbering.
By default, Paligo uses 1,2,3, and a, b, c for sub-procedures. Some languages use different characters for numbering. Use the Render ordered list and procedure item labels in language-specific number system setting to control which numbers and letters are used.
Choose:
-
Enable to use language-specific numbers and letters
-
Disable to use 1,2, 3, and a, b, c numbers and letters
-
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.
-
-
Select Save.
When you use this Layout to publish to PDF, Paligo will apply your choices.
For PDF outputs, use your PDF Layout to style the unordered lists in your content. Unordered lists are also called bullet lists or itemized lists. They use the itemizedlist
element in Paligo XML (see Create a List or Procedure).
Note
Bullet lists are affected by the styles in the General and Unordered lists subcategories of the Lists settings. The Unordered lists settings take priority over the General settings.
To learn about the General settings, see Set the General Preferences for Lists (PDF).
-
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 Lists category and then select the Unordered lists subcategory.
-
Set the Distance between start of label and content. This is shown as A in the following diagram.
Enter the value as an integer or a decimal number, followed by its unit of measurement. You can use any of these units:
-
cm (centimeters)
-
mm (millimeters)
-
in (inches)
-
pt (points)
-
pc (picas)
-
px (pixels)
-
em (relative to font size)
Examples: 1.5em, 12pt, 1cm.
-
-
Set the Label alignment. This positions the label (bullet) for list items within the label space.
In the diagram, A is the Distance between start of label and content and B is the label space. The shaded area labelled C is the default amount of space Paligo includes automatically. The alignment applies to the space labelled B.
Choose from:
-
Use Label color to set the color of the bullet point.
-
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 Label font size to set the size of the bullet icon.
Enter the value and the units of measurement in the field. For example, 1.4em.
Note
Increasing the size of the bullet point can cause the text in the list item to become misaligned with the bullet point. For this reason, we recommend that you only change the bullet size by a small amount.
-
Use Label line height to set the amount of space between the items in the bullet list.
Enter the value and the units of measurement in the field. For example, 2em.
-
Use Bullet types to set the style of the bullet labels. Enter the term for the style of bullet you want at each level and separate them with commas. For example:
disk, circle, square
This means that the top-level of a bullet list will use a disk, the second level will use a circle, and the third level will use a square.
You can use the following bullet types: none, disk (bullet), circle (white bullet), square (black small square), white small square, endash, emdash, +, -, and most of the characters in the Zapf Dingbats font family. You can copy the character from https://www.unicode.org/charts/PDF/U2700.pdf. Do not use the code, just copy the actual icon and paste it into the field on the Layout.
-
Select Save.
When you publish with this Layout, Paligo will apply your choices to the bullet lists in your PDF output.
Use the settings in your PDF Layout to style simple lists for PDF outputs. Simple lists are lists that you create by inserting the simplelist
element, where each list item is a member
(see Create a Simple List).
Note
The simple list settings only apply to simple lists that have the type
attribute with a value of inline.
To style a simplelist
for PDF outputs, use the settings on your PDF Layout.
-
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 Lists category and then select the Simple lists subcategory.
-
Set the Simplelist inline separator. This is the character that will appear between each item (member) in the list. By default, Paligo uses a comma.
Either:
-
Leave the default character, a comma, in place
-
Enter a different character to use instead of the comma
-
Clear the field completely to set the Layout to inherit the inline separator from the base Layout.
You can learn about Layouts inheriting their values from Base Layouts in Layout Relationships - Base, New, Duplicate.
-
-
Set the Simplelist inline separator length. This defines the amount of space between each list item (member) in the list.
Enter a value and its units of measurement, for example, 8pt. You can also use relative values, such as em.
-
Select Save.
When you publish with this Layout, Paligo will apply your choices to the simple lists (that are set to type
: inline) in the PDF output.
For PDF outputs, use your PDF Layout to style the procedures in your content.
Note
Procedures are affected by the styles in the General and Procedures subcategories of the Lists settings. The Procedures settings take priority over the General settings.
To learn about the General settings, see Set the General Preferences for Lists (PDF).
-
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 Lists category and then select the Procedures subcategory.
-
Set the Distance between start of label and content. This is shown as A in the following diagram.
Enter the value as an integer or a decimal number, followed by its unit of measurement. You can use any of these units:
-
cm (centimeters)
-
mm (millimeters)
-
in (inches)
-
pt (points)
-
pc (picas)
-
px (pixels)
-
em (relative to font size)
Examples: 1.5em, 12pt, 1cm.
-
-
Set the Label alignment. This positions the label (number) for list items within the label space.
In the diagram, A is the Distance between start of label and content and B is the label space. The shaded area labelled C is the default amount of space Paligo includes automatically. The alignment applies to the space labelled B.
Choose from:
-
Set the Label font weight. This is the line thickness for the step number.
-
Choose whether you want Numbering for single-step procedures.
By default, a procedure with a single step will use a bullet point instead of a number. If you prefer, you can set it to use a number.
Choose from:
-
Enable to use a number
-
Disable to use a bullet point
-
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.
Note
Lists and procedures are designed to have many steps. If you have a single-step list or procedure, consider making it a regular paragraph instead.
-
-
Set the Font family for procedure titles. This is the style of lettering for the procedure's
title
element.Choose a typeface from the list of available fonts.
Note
By default, procedures do not have a
title
element, but you can add one manually if required (see Add Elements ). -
Set the Font size for procedure titles. This is the size of the text in the procedure's
title
element (if atitle
element is in place). -
Set the Font weight for procedure titles. This sets the thickness of the characters in the procedure titles.
-
Set the Font style for procedure titles.
Choose from:
-
Set the Font variant for procedure titles to normal for regular sized, mixed case letters or small-caps for smaller, upper-case letters.
-
Use Color for procedure titles to apply a custom color to the text in the title.
-
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).
-
-
-
-
Set the Capitalization for procedure titles. This controls whether characters are shown in upper case, lower case, or a combination of the two.
-
Set the Letter spacing for procedure titles. This is the amount of horizontal spacing between each letter.
To increase the amount of spacing, enter:
-
A relative amount and units of measurement, for example, 0.2rem
-
An absolute amount and units of measurement, for example, 1px
To decrease the amount of spacing, enter a negative relative or absolute amount, for example, -1px.
-
-
Select Save.
When you publish with this Layout, Paligo will apply your chosen settings.
For PDF outputs, you can swap out the regular bullet "disc" character for another character. For instructions, see Style an Unordered List (PDF).
For PDF outputs, use the PDF Layout to change the spacing in and around a list. This includes margins, space above and below the list as well as spacing above and below each list item or step. For details, see Set the General Preferences for Lists (PDF).
For PDF outputs, use the PDF Layout to change the styling of list titles and procedure titles. For details, see Set the General Preferences for Lists (PDF).
To control the numbering in ordered lists, use the following attributes:
-
To start an ordered list at a specific number, select the
orderedlist
element and give it thestartingnumber
attribute. Set the value to the starting number you want. For details, see Set Starting Number. -
To get an ordered list to continue its numbering from the previous ordered list, select the
orderedlist
element and give it thecontinuation
attribute. Set the value to continues. For details, see Set Starting Number. -
To get a procedure to continue the numbering from a parent procedure, select the
procedure
element and give it therole
attribute. Set the value to reuse-range. This is useful if you want to reuse a procedure inside another procedure. For example, if you have some common steps saved in an informal topic and you insert the informal topic into another procedure.For details, see Reuse a Sequence of List Items.