1. Home
  2. Docs
  3. Liquid
  4. Getting Started
  5. Custom Marketing Settings

Custom Marketing Settings

Each marketing variation can include custom settings to allow users to add custom text, or set options specific to the marketing variation they are generating. These options can include text fields, checkboxes, and select fields.

Custom settings need to be added to the section of the YML file relating to that marketing variation. An example on how to add custom settings is provided below.

marketing_variant:
	name: A4 Portrait - 1 Image
    photos: 1
    order: 0
    size: A4
    margins: 0 0 0 0
    options:
    	showBanner:
      		name: Custom Header
      		order: 7
      		type: select
      		options:
        		0_none: "Default"
        		1_auction: "Auction"
        		2_justleased: "Just Leased"
        		3_justlisted: "Just Listed"
        		4_justsold: "Just Sold"
        		5_pricereduced: "Price Reduced"
        		6_undercontract: "Under Contract"
        		7_forsale: "For Sale"
        		8_forlease: "For Lease"
        		9_forrent: "For Rent"
        		10_openhome: "Open Home"
    

The example provided will add a custom select field with the name Custom Header, and if additional options were included it would be displayed as the 7th setting for that marketing variant.

The option can then be referenced in your liquid template file like so:

{{ option.ShowBanner }}
justsold

Or assigned to a variable to be used in your template like so:

{% assign banner = option.showBanner %}
...
{{ banner }}
openhome

Text Field

An example for adding a custom text field is below:

...
	options:
    	optionName:
        	name: Custom Price
            type: textbox
            default: This is default text

Checkbox

The checkbox field will return a boolean value. An example for adding a custom checkbox setting is below:

...
	options:
    	optionName:
        	name: Show Main Image
            type: checkbox
            checked: true

Select

The seclect field will return the option value as a string. An example for adding a custom select setting is below.

...
	options:
    	optionName:
        	name: Custom Banner
            type: select
            options:
            	0_none: "Default"
        		1_auction: "Auction"
        		2_justleased: "Just Leased"
        		3_justlisted: "Just Listed"
        		4_justsold: "Just Sold"