PDF Export Styling yml

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
work_package Work package
Styling for the Work package section
See Work package
object
toc Table of content
Styling for the table of content of the PDF report export
See Table of content
object
cover Cover page
Styling for the cover page of the PDF report export
See Cover page
object
overview Overview
Styling for the PDF table export
See Overview
object

Alert

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

Border 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

Cover page

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

Cover page header

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

Cover page header border

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

Cover page hero

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
subheading The last block in the hero
See The last block in the hero
object

Font properties

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

Image caption

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

Margin 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

Markdown Styling

Styling for content of work package description and long text custom fields

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

Markdown blockquote

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

Markdown code

Styling to denote a word or phrase as code

Key: code

Example:

code:
  font: Consolas
  color: '880000'
Key Description Data type
See Font properties

Markdown code block

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

Markdown header

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

Markdown headless table

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

Markdown horizontal rule

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

Markdown image

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

Markdown ordered list

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

Markdown ordered list point

Key: ordered_list_point

Example:

ordered_list_point:
  template: "<number>."
  alphabetical: false
  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
Convert the list item number into a character, eg. a. b. c.
boolean
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

Markdown paragraph

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

Markdown table

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

Markdown task list point

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

Markdown unordered list

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

Markdown unordered list point

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

Overview

Styling for the PDF table export

Key: overview

Example:

overview:
  group_heading: {}
  table: {}
Key Description Data type
group_heading Overview group heading
Styling for the group level if grouping is activated
See Overview group heading
object
table Overview table
See Overview table
object

Overview group heading

Styling for the group level if grouping is activated

Key: group_heading

Example:

group_heading:
  size: 11
  styles:
    - bold
  margin_bottom: 10
Key Description Data type
See Font properties
See Margin properties

Overview table

Key: table

Example:

table:
  subject_indent: 0
  margin_bottom: 20
  cell:
    size: 9
    color: '000000'
    padding: 5
  cell_header:
    size: 9
    styles:
    - bold
  cell_sums:
    size: 8
    styles:
    - bold
Key Description Data type
subject_indent Indent subject
Indent by work package level in the subject cell
Examples: 10mm, 10
number or string
See Units
cell Table cell
Styling for a table value cell
See Table cell
object
cell_header Table header cell
Styling for a table header cell
See Table cell
object
cell_sums Table sum cell
Styling for a table sum cell
See Table cell
object
See Margin properties

Padding 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

Page footers

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

Page headers

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

Page heading

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

Page settings

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

Table cell

Styling for a table cell

Key: table_cell

Example:

table_cell:
  size: 9
  color: '000000'
  padding: 5
  border_width: 1
Key Description Data type
See Font properties
See Padding Properties
See Border Properties

Table header cell

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

Table of content

Styling for the table of content of the PDF report export

Key: toc

Example:

toc:
  subject_indent: 4
  indent_mode: stairs
  margin_top: 10
  margin_bottom: 20
  item:
    size: 9
    color: '000000'
    margin_bottom: 4
  item_level_1:
    size: 10
    styles:
    - bold
    margin_top: 4
    margin_bottom: 4
  item_level_2:
    size: 10
Key Description Data type
subject_indent Indention width
Indention width for TOC levels
Examples: 10mm, 10
number or string
See Units
indent_mode Indention mode
flat= no indention, stairs = indent on each level, third_level = indent only at 3th level
Valid values:
flat, stairs, third_level
string
item Table of content item
Default styling for TOC items on all levels.
use item_level_xas key for TOC items on levelx`.
See Table of content item
object
See Margin properties
item_level_1
item_level_2
item_level_x
See Table of content item level object

Table of content item

Default styling for TOC items on all levels.
use item_level_xas key for TOC items on levelx`.

Key: item

Example:

item:
  size: 9
  color: '000000'
  margin_bottom: 4
Key Description Data type
See Font properties
See Margin properties

Table of content item level

Key: item_level_x

Key Description Data type
See Font properties
See Margin properties

The first block in the hero

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

The last block in the hero

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

The main block in the hero

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

Work package

Styling for the Work package section

Key: work_package

Example:

work_package:
  margin_bottom: 20
  subject: {}
  subject_level_1: {}
  subject_level_2: {}
  subject_level_3: {}
  attributes_table: {}
  markdown_label: {}
  markdown_margin: {}
  markdown: {}
Key Description Data type
subject Work package subject
Styling for the Work package subject headline
See Work package subject
object
attributes_table Work package attributes
Styling for the Work package attributes table
See Work package attributes
object
markdown_label Work package markdown label
Label headline for work package description and long text custom fields
See Work package markdown label
object
markdown_margin Work package markdown margins
Margins for work package description and long text custom fields
See Work package markdown margins
object
markdown Markdown Styling
Styling for content of work package description and long text custom fields
See Markdown Styling
object
See Margin properties
subject_level_1
subject_level_2
subject_level_x
See Work package subject level object

Work package attributes

Styling for the Work package attributes table

Key: attributes_table

Example:

attributes_table:
  margin_bottom: 10
  cell:
    size: 9
    color: '000000'
    padding_left: 5
    padding_right: 5
    padding_top: 0
    padding_bottom: 5
    border_color: 4B4B4B
    border_width: 0.25
  cell_label:
    styles:
    - bold
Key Description Data type
cell Attribute value table cell
Styling for a table cell with attribute value
See Table cell
object
cell_label Attribute label table cell
Styling for a table cell with attribute label
See Table cell
object
See Margin properties

Work package markdown label

Label headline for work package description and long text custom fields

Key: markdown_label

Example:

markdown_label:
  size: 12
  styles:
    - bold
  margin_top: 2
  margin_bottom: 4
Key Description Data type
See Font properties
See Margin properties

Work package markdown margins

Margins for work package description and long text custom fields

Key: markdown_margin

Example:

markdown_margin:
  margin_bottom: 16
Key Description Data type
See Margin properties

Work package subject

Styling for the Work package subject headline

Key: subject

Example:

subject:
  size: 10
  styles:
    - bold
  margin_bottom: 10
Key Description Data type
See Font properties
See Margin properties

Work package subject level

Key: subject_level_x

Example:

subject_level_1:
  size: 14
  styles:
    - bold
subject_level_2:
  size: 13
  styles:
    - bold
subject_level_3:
  size: 12
  styles:
    - bold
Key Description Data type
See Font properties
See Margin properties

alert boxes (styled blockquotes)

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

Units

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)