Configuration / about.yml – iDashboard Documentation

Each bundle must include an about.yml file. This file tells iDashboard which settings to apply to the bundle.

You can refer to the example about.yml included in the bundle boilerplate mentioned in the previous article. An additional example is provided below, showing all available configuration options.

marketing_variant:
	print_background: bool
	name: string
    photos: int
    order: int
    size: string
    margins: int
    height: int
    width: int
    page_ranges: string
    prefer_css_page_size: bool
    landscape: bool

If multiple marketing variations are included in your bundle you can include them in your about.yml file as per the below:

marketing_variant1:
	name: Window Card 1
    photos: 1
    size: A4
    margins: 0 0 0 0
marketing_variant2:
	name: Window Card 2
    photos: 3
    size: A4
    margins: 0 0 0 0
marketing_variant3:
	name: Window Card 3
    photos: 4
    size: A4
    margins: 0 0 0 0

Print Background
Sets whether to print background graphics
Default: true

print_background: true

Name (Required)
The name of the marketing variant which is displayed to the end user

name: A4 Brochure - 1 Image

Photos (required)
The number of property photos required for the print marketing to be generated.
Example: If this number is set to 3 and the property has less than 3 images uploaded, the user will be unable to generate the marketing variant.

photos: 3

Order
If multiple variants are included in the bundle the order dictates in which order they are displayed to the user.
Default: 0

order: 0

Size (required)
The paper size of the marketing variant. Using A4 or A3 sizing is recommend, though all paper sizes are supported. If size is present, this will override any manual width and height items included in the configuration.

size: A4

Margins
Set the margins of the generated PDF. Margins follow the same style as when using them in CSS with the values representing top | right | bottom | left. If margins is not present the marketing variant will be generated with default margins.

margins: 0 0 0 0

Height
The height property can be used to set a custom height for the generated PDF of the marketing variant. This can be useful if you need to include bleeds or need the size of your PDF to be larger than the standard paper sizes.
Default: empty

height: 303mm

Width
The width property can be used to set a custom height for the generated PDF of the marketing variant. This can be useful if you need to include bleeds or need the size of your PDF to be larger than the standard paper sizes.
Default: empty

width: 216mm

Page Ranges
If your marketing variant generates multiple pages, the page_ranges option can be used to only include specific pages in the generated PDF.
Default: empty

page_ranges: 1-5

Prefer CSS Page Size
Give any CSS @page size declared in the page priority over what is declared in the width or height or size option.
Default: false

prefer_css_page_size: true

Landscape
Whether to generate the PDF in landscape orientation.
Default: false

landscape: true

Liquid