docs/system-admin-guide/design/pdf-export-styles/meeting/README.md
This document describes the style settings format for the PDF Export styling file.
| Key | Description | Data type |
|---|---|---|
page | Page settings | |
| Properties to set the basic page settings | ||
| See Page settings | object | |
page_logo | Page logo | |
| Styling for logo image in the page header. | ||
| See Page logo | object | |
page_header | Page headers | |
| See Page headers | object | |
page_footer | Page footers | |
| See Page footers | object | |
page_heading | Page heading | |
| The main page title heading | ||
| See Page heading | object | |
page_subtitle | Page heading | |
| The main page title heading | ||
| See Page heading | object | |
cover | Cover page | |
| Styling for the cover page of the PDF report export | ||
| See Cover page | object | |
notes | Agenda item notes | |
| Styling for Meeting agenda item notes | ||
| See Agenda item notes | object | |
outcome | Agenda item outcome | |
| Styling for Meeting agenda item outcome | ||
| See Agenda item outcome | object | |
heading | Heading | |
| Styling for the heading of the PDF meeting export | ||
| See Heading | object | |
agenda_item | Agenda item | |
| Styling for a agenda item of the PDF meeting export | ||
| See Agenda item | object | |
agenda_section | Agenda section | |
| Styling for a agenda section of the PDF meeting export | ||
| See Agenda section | object | |
participants | Participants | |
| Styling for the participants table | ||
| See Participants | object | |
attachments | Attachments | |
| Styling for the attachments table | ||
| See Attachments | object |
Styling for a agenda item of the PDF meeting export
Key: agenda_item
Example:
agenda_item: {}
| Key | Description | Data type |
|---|---|---|
title_cell | Agenda item title table cell | |
| Styling for a table cell with the agenda item title | ||
| See Table cell | object | |
title | Font properties | |
| Properties to set the font style | ||
| See Font properties | object | |
subtitle | Font properties | |
| Properties to set the font style | ||
| See Font properties | object | |
title_margin | Margin properties | |
| Properties to set margins | ||
| See Margin properties | object | |
indent | Indent width | |
| Indent for agenda item notes | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
hr | Horizontal rule between agenda items | |
| See Horizontal rule between agenda items | object |
Styling for Meeting agenda item notes
Key: notes
Example:
notes:
markdown_margin: {}
markdown: {}
| Key | Description | Data type |
|---|---|---|
markdown_margin | Agenda item notes markdown margins | |
| Margins for agenda item notes | ||
| See Agenda item notes markdown margins | object | |
markdown | Markdown Styling | |
| Styling for markdown content of agenda item notes | ||
| See Markdown Styling | object | |
| … | See Margin properties |
Margins for agenda item notes
Key: markdown_margin
Example:
markdown_margin:
margin_bottom: 16
| Key | Description | Data type |
|---|---|---|
| … | See Margin properties |
Styling for Meeting agenda item outcome
Key: outcome
Example:
outcome:
indent: 15
markdown_margin: {}
markdown: {}
| Key | Description | Data type |
|---|---|---|
title | Agenda item outcome title | |
| See Agenda item outcome title | object | |
symbol | Agenda item outcome symbol | |
| See Agenda item outcome symbol | object | |
indent | Indent width | |
| Indent for agenda item notes | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
markdown_margin | Agenda item outcome markdown margins | |
| Margins for agenda item outcome | ||
| See Agenda item outcome markdown margins | object | |
markdown | Markdown Styling | |
| Styling for markdown content of agenda item notes | ||
| See Markdown Styling | object | |
| … | See Margin properties |
Margins for agenda item outcome
Key: markdown_margin
Example:
markdown_margin:
margin_bottom: 16
| Key | Description | Data type |
|---|---|---|
| … | See Margin properties |
Key: symbol
| Key | Description | Data type |
|---|---|---|
| … | See Font properties |
Key: title
| Key | Description | Data type |
|---|---|---|
| … | See Font properties | |
| … | See Margin properties |
Styling for a agenda section of the PDF meeting export
Key: agenda_section
Example:
agenda_section: {}
| Key | Description | Data type |
|---|---|---|
title_cell | Agenda section title table cell | |
| Styling for a table cell with the agenda section title | ||
| See Table cell | object | |
title | Font properties | |
| Properties to set the font style | ||
| See Font properties | object | |
subtitle | Font properties | |
| Properties to set the font style | ||
| See Font properties | object | |
title_margins | Margin properties | |
| Properties to set margins | ||
| See Margin properties | object |
Styling to denote a quote as alert box
Key: alert
Example:
ALERT:
alert_color: f4f9ff
border_color: f4f9ff
border_width: 2
no_border_right: true
no_border_left: false
no_border_bottom: true
no_border_top: true
| Key | Description | Data type |
|---|---|---|
background_color | Color | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
alert_color | Color | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
| … | See Font properties | |
| … | See Border Properties | |
| … | See Padding Properties | |
| … | See Margin properties |
Key: alerts
| Key | Description | Data type |
|---|---|---|
NOTE | Alert | |
| Styling to denote a quote as alert box | ||
| See Alert | object | |
TIP | Alert | |
| Styling to denote a quote as alert box | ||
| See Alert | object | |
WARNING | Alert | |
| Styling to denote a quote as alert box | ||
| See Alert | object | |
IMPORTANT | Alert | |
| Styling to denote a quote as alert box | ||
| See Alert | object | |
CAUTION | Alert | |
| Styling to denote a quote as alert box | ||
| See Alert | object |
Styling for the attachments table
Key: attachments
Example:
margin_bottom: 12
cell:
size: 10
padding_left: 0
no_border: true
| Key | Description | Data type |
|---|---|---|
cell | Attachments table cell | |
| Styling for a table cell with a attachment name | ||
| See Table cell | object | |
| … | See Margin properties |
Properties to set borders
Key: border
Example:
border_color: F000FF
border_color_top: 000FFF
border_color_bottom: FFF000
no_border_left: true
no_border_right: true
border_width: 0.25mm
border_width_left: 0.5mm
border_width_right: 0.5mm
| Key | Description | Data type |
|---|---|---|
border_width | Border width | |
| One value for border line width on all sides | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
border_width_left | Border width left | |
| Border width only on the left side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
border_width_top | Border width top | |
| Border width only on the top side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
border_width_right | Border width right | |
| Border width only on the right side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
border_width_bottom | Border width bottom | |
| Border width only on the bottom side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
border_color | Border color | |
| One value for border color on all sides | ||
Example: F0F0F0 | string | |
border_color_left | Border color left | |
| Border color only on the left side | ||
Example: F0F0F0 | string | |
border_color_top | Border color top | |
| Border color only on the top side | ||
Example: F0F0F0 | string | |
border_color_right | Border color right | |
| Border color only on the right side | ||
Example: F0F0F0 | string | |
border_color_bottom | Border color bottom | |
| Border color only on the bottom side | ||
Example: F0F0F0 | string | |
no_border | Disable borders | |
| Turn off borders on all sides | boolean | |
no_border_left | Disable border left | |
| Turn off border on the left sides | boolean | |
no_border_top | Disable border top | |
| Turn off border on the top sides | boolean | |
no_border_right | Disable border right | |
| Turn off border on the right sides | boolean | |
no_border_bottom | Disable border bottom | |
| Turn off border on the bottom sides | boolean |
Properties to set vertical and horizontal alignment of table cells
Key: cell_alignment
Example:
align: center
valign: middle
| Key | Description | Data type |
|---|---|---|
align | Horizontal alignment | |
| Set the horizontal alignment of the content in a cell | ||
Example: center | ||
| Valid values: | ||
left, center, right | string | |
valign | Vertical alignment | |
| Border width only on the left side | ||
Example: middle | ||
| Valid values: | ||
top, center, middle, bottom | string |
Styling for the cover page of the PDF report export
Key: cover
Example:
cover:
header: {}
footer: {}
hero: {}
| Key | Description | Data type |
|---|---|---|
header | Cover page header | |
| Styling for the cover page header | ||
| See Cover page header | object | |
footer | Cover page footer | |
| Styling for the cover page footer | ||
| See Cover page footer | object | |
hero | Cover page hero | |
| Styling for the hero banner at the bottom at the cover page | ||
| See Cover page hero | object |
Styling for the cover page footer of the PDF report export
Key: cover_footer
Example:
footer:
offset: 20
size: 10
color: 064e80
| Key | Description | Data type |
|---|---|---|
offset | Offset position from page bottom | |
| A number >= 0 and an optional unit | ||
Example: 30 | number or string | |
| See Units | ||
| … | See Font properties |
Styling for the cover page header of the PDF report export
Key: cover_header
Example:
header:
logo_height: 25
border: {}
| Key | Description | Data type |
|---|---|---|
spacing | Minimum spacing between logo and page header text | |
| A number >= 0 and an optional unit | ||
Example: 20 | number or string | |
| See Units | ||
offset | Offset position from page top | |
| A number >= 0 and an optional unit | ||
Example: 6.5 | number or string | |
| See Units | ||
logo_height | Height of the logo in the page header | |
| A number >= 0 and an optional unit | ||
Example: 25 | number or string | |
| See Units | ||
border | Cover page header | |
| Styling for the cover page header | ||
| See Cover page header border | object | |
| … | See Font properties |
Styling for the cover page header border of the PDF report export
Key: cover_header_border
Example:
border:
color: d3dee3
height: 1
offset: 6
| Key | Description | Data type |
|---|---|---|
spacing | Minimum spacing between logo and page header text | |
| A number >= 0 and an optional unit | ||
Example: 20 | number or string | |
| See Units | ||
offset | Offset position from page top | |
| A number >= 0 and an optional unit | ||
Example: 6 | number or string | |
| See Units | ||
height | Line height of the border | |
| A number >= 0 and an optional unit | ||
Example: 25 | number or string | |
| See Units | ||
color | Line color of the border | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
| … | See Font properties |
Styling for the hero banner at the bottom at the cover page
Key: cover_hero
Example:
header:
padding_right: 150
padding_top: 120
title: {}
heading: {}
subheading: {}
| Key | Description | Data type |
|---|---|---|
padding_right | Padding right | |
| Padding only on the right side of the hero banner | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
padding_top | Padding top | |
| Padding only on the top side of the hero banner | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
title | The first block in the hero | |
| See The first block in the hero | object | |
heading | The main block in the hero | |
| See The main block in the hero | object | |
dates | The dates block in the hero | |
| See The dates block in the hero | object | |
subheading | The last block in the hero | |
| See The last block in the hero | object |
Properties to set the font style
Key: font
Example:
font: OpenSans
size: 10
character_spacing: 0
styles: []
color: '000000'
leading: 2
| Key | Description | Data type |
|---|---|---|
font | string | |
size | A number >= 0 and an optional unit | |
Examples: 10mm, 10 | number or string | |
| See Units | ||
character_spacing | A number >= 0 and an optional unit | |
Examples: 10mm, 10 | number or string | |
| See Units | ||
leading | A number >= 0 and an optional unit | |
Examples: 10mm, 10 | number or string | |
| See Units | ||
color | Color | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
styles | Example: [bold] | |
| Valid values: | ||
bold, italic, underline, strikethrough, superscript, subscript | array of string |
Key: html_table
Example:
table:
auto_width: true
header:
background_color: F0F0F0
no_repeating: true
size: 12
cell:
background_color: 000FFF
size: 10
| Key | Description | Data type |
|---|---|---|
auto_width | Automatic column widths | |
Table columns should fit the content, equal spacing of columns if value is false | boolean | |
header | Table header cell | |
| Styling for a table header cell | ||
| See Table header cell | object | |
cell | Table cell | |
| Styling for a table cell | ||
| See Table cell | object | |
| … | See Margin properties | |
| … | See Border Properties |
Styling for the heading of the PDF meeting export
Key: heading
Example:
heading:
size: 12
styles:
- bold
margin_bottom: 10
| Key | Description | Data type |
|---|---|---|
hr | Horizontal rule before headings | |
| See Horizontal rule before headings | object | |
| … | See Font properties | |
| … | See Margin properties |
Key: hr
Example:
border:
color: 6E7781
height: 1.5
| Key | Description | Data type |
|---|---|---|
height | Line height of the horizontal rule | |
| A number >= 0 and an optional unit | ||
Example: 1 | number or string | |
| See Units | ||
color | Line color of the horizontal rule | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
| … | See Margin properties |
Key: hr
Example:
border:
color: D0D7DE
height: 1
| Key | Description | Data type |
|---|---|---|
height | Line height of the horizontal rule | |
| A number >= 0 and an optional unit | ||
Example: 1 | number or string | |
| See Units | ||
color | Line color of the horizontal rule | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
| … | See Margin properties |
Styling for the caption below an image
Key: caption
| Key | Description | Data type |
|---|---|---|
align | Valid values: | |
left, center, right, justify | string | |
| … | See Font properties | |
| … | See Padding Properties |
Properties to set margins
Key: margin
Example:
margin: 10mm
margin_top: 15mm
| Key | Description | Data type |
|---|---|---|
margin | Margin | |
| One value for margin on all sides | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
margin_left | Margin left | |
| Margin only on the left side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
margin_right | Margin right | |
| Margin only on the right side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
margin_top | Margin top | |
| Margin only on the top side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
margin_bottom | Margin bottom | |
| Margin only on the bottom side | ||
Examples: 10mm, 10 | number or string | |
| See Units |
Styling a clickable link
Key: link
Example:
link:
color: '000088'
| Key | Description | Data type |
|---|---|---|
| … | See Font properties |
Styling for markdown content of agenda item notes
Key: markdown
Example:
markdown:
font: {}
header: {}
header_1: {}
header_2: {}
header_3: {}
paragraph: {}
unordered_list: {}
unordered_list_point: {}
ordered_list: {}
ordered_list_point: {}
task_list: {}
task_list_point: {}
link: {}
code: {}
blockquote: {}
codeblock: {}
table: {}
| Key | Description | Data type |
|---|---|---|
font | Font properties | |
| Properties to set the font style | ||
| See Font properties | object | |
paragraph | Markdown paragraph | |
| A block of text | ||
| See Markdown paragraph | object | |
table | Markdown table | |
| See Markdown table | object | |
html_table | HTML table | |
| See HTML table | object | |
headless_table | Markdown headless table | |
| Tables without or empty header rows can be styled differently. | ||
| See Markdown headless table | object | |
code | Markdown code | |
| Styling to denote a word or phrase as code | ||
| See Markdown code | object | |
codeblock | Markdown code block | |
| Styling to denote a paragraph as code | ||
| See Markdown code block | object | |
link | Markdown Link | |
| Styling a clickable link | ||
| See Markdown Link | object | |
image | Markdown image | |
| Styling of images | ||
| See Markdown image | object | |
hrule | Markdown horizontal rule | |
| Styling for horizontal lines | ||
| See Markdown horizontal rule | object | |
header | Markdown header | |
| Default styling for headers on all levels. | ||
use header_x as key for header level x. | ||
| See Markdown header | object | |
blockquote | Markdown blockquote | |
| Styling to denote a paragraph as quote | ||
| See Markdown blockquote | object | |
ordered_list | Markdown ordered list | |
| Default styling for ordered lists on all levels. | ||
use ordered_list_x as key for ordered list level x. | ||
| See Markdown ordered list | object | |
ordered_list_point | Markdown ordered list point | |
| Default styling for ordered list points on all levels. | ||
use ordered_list_point_x as key for ordered list points level x. | ||
| See Markdown ordered list point | object | |
unordered_list | Markdown unordered list | |
| Default styling for unordered lists on all levels. | ||
use unordered_list_x as key for unordered list level x. | ||
| See Markdown unordered list | object | |
unordered_list_point | Markdown unordered list point | |
| Default styling for unordered list points on all levels. | ||
use unordered_list_point_x as key for unordered list points level x. | ||
| See Markdown unordered list point | object | |
task_list | Markdown task list | |
| See Markdown unordered list | object | |
task_list_point | Markdown task list point | |
| See Markdown task list point | object | |
alerts | Alert boxes (styled blockquotes) | |
| See Alert boxes (styled blockquotes) | object | |
ordered_list_point_1 | ||
ordered_list_point_2 | ||
ordered_list_point_x | Markdown ordered list point level | |
| See Markdown ordered list point | object | |
ordered_list_1 | ||
ordered_list_2 | ||
ordered_list_x | Markdown ordered list level | |
| See Markdown ordered list | object | |
unordered_list_point_1 | ||
unordered_list_point_2 | ||
unordered_list_point_x | Markdown unordered list point level | |
| See Markdown unordered list point | object | |
unordered_list_1 | ||
unordered_list_2 | ||
unordered_list_x | Markdown unordered List Level | |
| See Markdown unordered list | object | |
header_1 | ||
header_2 | ||
header_x | Markdown header level | |
| See Markdown header | object |
Styling to denote a paragraph as quote
Key: blockquote
Example:
blockquote:
background_color: f4f9ff
size: 14
styles:
- italic
color: 0f3b66
border_color: b8d6f4
border_width: 1
no_border_right: true
no_border_left: false
no_border_bottom: true
no_border_top: true
| Key | Description | Data type |
|---|---|---|
background_color | Color | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
| … | See Font properties | |
| … | See Border Properties | |
| … | See Padding Properties | |
| … | See Margin properties |
Styling to denote a word or phrase as code
Key: code
Example:
code:
font: Consolas
color: '880000'
| Key | Description | Data type |
|---|---|---|
| … | See Font properties |
Styling to denote a paragraph as code
Key: codeblock
Example:
codeblock:
background_color: F5F5F5
font: Consolas
size: 8
color: '880000'
padding: 3mm
margin_top: 2mm
margin_bottom: 2mm
| Key | Description | Data type |
|---|---|---|
background_color | Color | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
| … | See Font properties | |
| … | See Padding Properties | |
| … | See Margin properties |
Key: header
Example:
header:
styles:
- bold
padding_top: 2mm
padding_bottom: 2mm
header_1:
size: 14
styles:
- bold
- italic
header_2:
size: 12
styles:
- bold
| Key | Description | Data type |
|---|---|---|
| … | See Font properties | |
| … | See Padding Properties |
Tables without or empty header rows can be styled differently.
Key: headless_table
Example:
headless_table:
auto_width: true
cell:
style: underline
background_color: 000FFF
| Key | Description | Data type |
|---|---|---|
auto_width | Automatic column widths | |
Table columns should fit the content, equal spacing of columns if value is false | boolean | |
cell | Table cell | |
| Styling for a table cell | ||
| See Table cell | object | |
| … | See Margin properties | |
| … | See Border Properties |
Styling for horizontal lines
Key: hrule
Example:
hrule:
line_width: 1
| Key | Description | Data type |
|---|---|---|
line_width | Sets the stroke width of the horizontal rule | |
| A number >= 0 and an optional unit | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
| … | See Margin properties |
Styling of images
Key: image
Example:
image:
max_width: 50mm
margin: 2mm
margin_bottom: 3mm
align: center
caption:
align: center
size: 8
| Key | Description | Data type |
|---|---|---|
max_width | Maximum width of the image | |
| A number >= 0 and an optional unit | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
align | Alignment | |
| How the element should be aligned | ||
Example: center | ||
| Valid values: | ||
left, center, right | string | |
caption | Image caption | |
| Styling for the caption below an image | ||
| See Image caption | object | |
| … | See Margin properties |
Key: ordered_list
Example:
ordered_list:
spacing: 2mm
point_inline: false
| Key | Description | Data type |
|---|---|---|
spacing | Spacing | |
| Additional space between list items | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
point_inline | Inline Point | |
| Do not indent paragraph text, but include the point into the first paragraph | boolean | |
| … | See Font properties | |
| … | See Padding Properties |
Key: ordered_list_point
Example:
ordered_list_point:
template: "<number>."
list_style_type: decimal
spacing: 0.75mm
spanning: true
| Key | Description | Data type |
|---|---|---|
spacing | A number >= 0 and an optional unit | |
Examples: 10mm, 10 | number or string | |
| See Units | ||
alphabetical | Alphabetical bullet points | |
(deprecated; use list_style_type) Convert the list item number into a character, eg. a. b. c. | boolean | |
list_style_type | List style type | |
The style of the list bullet points, eg. decimal, lower-latin, upper-roman | ||
| Valid values: | ||
decimal, lower-latin, lower-roman, upper-latin, upper-roman | string | |
spanning | Spanning | |
| Use the width of the largest bullet as indention. | boolean | |
template | Template | |
customize what the prefix should contain, eg. (<number>) | string | |
| … | See Font properties |
A block of text
Key: paragraph
Example:
paragraph:
align: justify
padding_bottom: 2mm
| Key | Description | Data type |
|---|---|---|
align | Valid values: | |
left, center, right, justify | string | |
| … | See Font properties | |
| … | See Padding Properties |
Key: table
Example:
table:
auto_width: true
header:
background_color: F0F0F0
no_repeating: true
size: 12
cell:
background_color: 000FFF
size: 10
| Key | Description | Data type |
|---|---|---|
auto_width | Automatic column widths | |
Table columns should fit the content, equal spacing of columns if value is false | boolean | |
header | Table header cell | |
| Styling for a table header cell | ||
| See Table header cell | object | |
cell | Table cell | |
| Styling for a table cell | ||
| See Table cell | object | |
| … | See Margin properties | |
| … | See Border Properties |
Key: task_list_point
Example:
task_list_point:
checked: "☑"
unchecked: "☐"
spacing: 0.75mm
| Key | Description | Data type |
|---|---|---|
checked | Checked sign | |
| Sign for checked state of a task list item | string | |
unchecked | Unchecked sign | |
| Sign for unchecked state of a task list item | string | |
spacing | Spacing | |
| Additional space between point and list item content | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
| … | See Font properties |
Key: unordered_list
Example:
unordered_list:
spacing: 1.5mm
padding_top: 2mm
padding_bottom: 2mm
| Key | Description | Data type |
|---|---|---|
spacing | Spacing | |
| Additional space between list items | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
| … | See Font properties | |
| … | See Padding Properties |
Key: unordered_list_point
Example:
unordered_list_point:
sign: "•"
spacing: 0.75mm
| Key | Description | Data type |
|---|---|---|
sign | Sign | |
| The 'bullet point' character used in the list | string | |
spacing | Spacing | |
| Space between point and list item content | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
| … | See Font properties |
Properties to set paddings
Key: padding
Example:
padding: 10mm
padding_top: 15mm
| Key | Description | Data type |
|---|---|---|
padding | Padding | |
| One value for padding on all sides | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
padding_left | Padding left | |
| Padding only on the left side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
padding_right | Padding right | |
| Padding only on the right side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
padding_top | Padding top | |
| Padding only on the top side | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
padding_bottom | Padding bottom | |
| Padding only on the bottom side | ||
Examples: 10mm, 10 | number or string | |
| See Units |
Key: page_footer
Example:
page_footer:
offset: -30
size: 8
| Key | Description | Data type |
|---|---|---|
offset | Offset position from page bottom | |
| A positive or negative number and an optional unit | ||
Example: -30 | number or string | |
| See Units | ||
spacing | Minimum spacing between different page footers | |
| A number >= 0 and an optional unit | ||
Example: 8 | number or string | |
| See Units | ||
| … | See Font properties |
Key: page_header
Example:
page_header:
align: left
offset: 20
size: 8
| Key | Description | Data type |
|---|---|---|
align | Alignment | |
| How the element should be aligned | ||
Example: center | ||
| Valid values: | ||
left, center, right | string | |
offset | Offset position from page top | |
| A positive or negative number and an optional unit | ||
Example: -30 | number or string | |
| See Units | ||
| … | See Font properties |
The main page title heading
Key: page_heading
Example:
page_heading:
size: 14
styles:
- bold
margin_bottom: 10
| Key | Description | Data type |
|---|---|---|
| … | See Font properties | |
| … | See Margin properties |
Styling for logo image in the page header.
Key: page_logo
Example:
page_logo:
height: 20
align: right
| Key | Description | Data type |
|---|---|---|
height | Height of the image | |
| A number >= 0 and an optional unit | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
align | Alignment | |
| How the element should be aligned | ||
Example: center | ||
| Valid values: | ||
left, center, right | string | |
offset | Offset position from page top | |
| A positive or negative number and an optional unit | ||
Example: -30 | number or string | |
| See Units |
Properties to set the basic page settings
Key: page
Example:
page:
page_size: EXECUTIVE
margin_top: 60
margin_bottom: 60
margin_left: 36
margin_right: 36
page_break_threshold: 200
link_color: 175A8E
| Key | Description | Data type |
|---|---|---|
link_color | Link color | |
| Set the color of clickable links | ||
Example: F0F0F0 | string | |
page_layout | Page layout | |
| The layout of a page | ||
Example: portrait | ||
| Valid values: | ||
portrait, landscape | string | |
page_size | Page size | |
| The size of a page | ||
Example: EXECUTIVE | ||
| Valid values: | ||
EXECUTIVE, TABLOID, LETTER, LEGAL, FOLIO, A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, B0, B1, B2, B3, B4, B5, B6, B7, B8, B9, B10, C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, RA0, RA1, RA2, RA3, RA4, SRA0, SRA1, SRA2, SRA3, SRA4, 4A0, 2A0 | string | |
page_break_threshold | Page break threshold | |
| If there is a new section, start a new page if space less than the threshold is available | ||
Examples: 10mm, 10 | number or string | |
| See Units | ||
| … | Default font settings | |
| See Font properties | ||
| … | Page margins | |
| See Margin properties |
Styling for the participants table
Key: participants
Example:
margin_bottom: 12
cell:
size: 10
padding_left: 0
no_border: true
| Key | Description | Data type |
|---|---|---|
status | Status | |
| Styling for the status text in the participants table | ||
| See Font properties | object | |
cell | Participant table cell | |
| Styling for a table cell with a participant name | ||
| See Table cell | object | |
| … | See Margin properties |
Styling for a table cell
Key: table_cell
Example:
table_cell:
size: 9
color: '000000'
padding: 5
border_width: 1
| Key | Description | Data type |
|---|---|---|
background_color | Color | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
| … | See Font properties | |
| … | See Padding Properties | |
| … | See Border Properties | |
| … | See Cell alignment properties |
Styling for a table header cell
Key: table_header
Example:
table_header:
size: 9
styles:
- bold
| Key | Description | Data type |
|---|---|---|
background_color | Color | |
| A color in RRGGBB format | ||
Example: F0F0F0 | string | |
no_repeating | boolean | |
| … | See Font properties | |
| … | See Padding Properties | |
| … | See Border Properties | |
| … | See Cell alignment properties |
Key: dates
Example:
heading:
spacing: 10
max_height: 20
size: 32
color: 414d5f
styles:
- bold
| Key | Description | Data type |
|---|---|---|
max_height | Maximum height of the block | |
| A number >= 0 and an optional unit | ||
Example: 30 | number or string | |
| See Units | ||
spacing | Minimum spacing between dates and subheading | |
| A number >= 0 and an optional unit | ||
Example: 10 | number or string | |
| See Units | ||
| … | See Font properties |
Key: title
Example:
title:
max_height: 30
spacing: 10
font: SpaceMono
size: 10
color: 414d5f
| Key | Description | Data type |
|---|---|---|
spacing | Minimum spacing between title and heading | |
| A number >= 0 and an optional unit | ||
Example: 10 | number or string | |
| See Units | ||
max_height | Maximum height of the block | |
| A number >= 0 and an optional unit | ||
Example: 30 | number or string | |
| See Units | ||
| … | See Font properties |
Key: subheading
Example:
subheading:
max_height: 30
size: 10
color: 414d5f
styles:
- italic
| Key | Description | Data type |
|---|---|---|
max_height | Maximum height of the block | |
| A number >= 0 and an optional unit | ||
Example: 30 | number or string | |
| See Units | ||
| … | See Font properties |
Key: heading
Example:
heading:
spacing: 10
size: 32
color: 414d5f
styles:
- bold
| Key | Description | Data type |
|---|---|---|
spacing | Minimum spacing between heading and subheading | |
| A number >= 0 and an optional unit | ||
Example: 10 | number or string | |
| See Units | ||
| … | See Font properties |
available units are
mm - Millimeter, cm - Centimeter, dm - Decimeter, m - Meter
in - Inch, ft - Feet, yr - Yard
pt - Postscript point (default if no unit is used)