Team members that worked on this item. You can only select persons listed on your Team page, so if you want to add external contributors: add them to the team page first (can be unpublished).
| caption | Contributors |
| name | contributors_id |
| description | Team members that worked on this item. You can only select persons listed on your Team page, so if you want to add external contributors: add them to the team page first (can be unpublished). |
| type | superboxselect |
| category | _Connection |
| sortOrder | 3 |
| inputProperties | | selectType | resources | | stackItems | true | | parents | romanesco.team_container_id | | depth | 10 | | limitRelatedContext | false | | pageSize | 10 |
|
Connect any available static resource(s) to this page. Presently, this is not being shown in any template, so it's up to you to implement it as you see fit.
| caption | Attachments |
| name | links_attachment |
| description | Connect any available static resource(s) to this page. Presently, this is not being shown in any template, so it's up to you to implement it as you see fit. |
| type | superboxselect |
| category | _Connection |
| sortOrder | 60 |
| inputProperties | | selectType | resources | | stackItems | true | | depth | 10 | | limitRelatedContext | false | | where | [{"class_key:LIKE":"modStaticResource"},{"content_type:NOT IN":[1,4,5,9,10,11]},{"context_key:NOT IN":["hub","global"]}] | | pageSize | 20 |
|
Point to external sources, to add some scientific credibility to your content. You can automatically attach these links to content references by activating the setting under Navigation.
| caption | External links |
| name | links_external |
| description | Point to external sources, to add some scientific credibility to your content. You can automatically attach these links to content references by activating the setting under Navigation. |
| type | migxdb |
| category | _Connection |
| sortOrder | 50 |
| inputProperties | | configs | links_external:romanescobackyard |
|
Connect the related organization(s). If this list is empty, you need to create an Organizations container first and register its ID under System Settings.
| caption | Organization |
| name | organization_id |
| description | Connect the related organization(s). If this list is empty, you need to create an Organizations container first and register its ID under System Settings. |
| type | superboxselect |
| category | _Connection |
| sortOrder | 2 |
| inputProperties | | selectType | resources | | maxElements | 1 | | stackItems | true | | parents | romanesco.client_container_id | | depth | 10 | | limitRelatedContext | false | | pageSize | 10 |
|
Connect a person to this item. This list is populated with all the persons that are listed on your Team page.
| caption | Person |
| name | person_id |
| description | Connect a person to this item. This list is populated with all the persons that are listed on your Team page. |
| type | superboxselect |
| category | _Connection |
| sortOrder | 1 |
| inputProperties | | selectType | resources | | maxElements | 1 | | stackItems | false | | parents | romanesco.team_container_id | | depth | 10 | | limitRelatedContext | false | | pageSize | 10 |
|
Maintain a list of social media platforms through which visitors can connect with you.
| caption | Social platforms |
| name | social_connections |
| description | Maintain a list of social media platforms through which visitors can connect with you. |
| type | migxdb |
| category | _Connection |
| sortOrder | 20 |
| inputProperties | | configs | social_connect_resource:romanescobackyard |
|
Connect a MODX user to this item. Only active users will be shown.
| caption | MODX user |
| name | user_id |
| description | Connect a MODX user to this item. Only active users will be shown. |
| type | superboxselect |
| category | _Connection |
| sortOrder | 10 |
| inputProperties | | selectType | users | | maxElements | 1 | | depth | 10 | | pageSize | 10 |
|
Optional. This is the address where the messages appear to be sent from. Can be a non-existing address, like [email protected]. Defaults to emailsender system setting.
| caption | Autoresponder FROM address |
| name | fb_autoresponder_from |
| description | Optional. This is the address where the messages appear to be sent from. Can be a non-existing address, like [email protected]. Defaults to emailsender system setting. |
| type | email |
| category | _Autoresponder |
| sortOrder | 2 |
Optional. This is the name that will (probably) be visible in the recipients' inbox. Defaults to site_name system setting.
| caption | Autoresponder FROM name |
| name | fb_autoresponder_from_name |
| description | Optional. This is the name that will (probably) be visible in the recipients' inbox. Defaults to site_name system setting. |
| type | text |
| category | _Autoresponder |
| sortOrder | 3 |
The content of the email that will be sent. You can use placeholders here with the following syntax: . If you want to use your own HTML, see the template option below.
| caption | Autoresponse message |
| name | fb_autoresponder_message |
| description | The content of the email that will be sent. You can use placeholders here with the following syntax: . If you want to use your own HTML, see the template option below. |
| type | richtext |
| category | _Autoresponder |
| sortOrder | 11 |
Optional. This address will be used when recipient replies to this message directly. Defaults to respectively the client_email and emailsender system setting.
| caption | Autoresponder REPLY TO address |
| name | fb_autoresponder_reply_to |
| description | Optional. This address will be used when recipient replies to this message directly. Defaults to respectively the client_email and emailsender system setting. |
| type | email |
| category | _Autoresponder |
| sortOrder | 4 |
| caption | Autoresponse subject |
| name | fb_autoresponder_subject |
| type | text |
| category | _Autoresponder |
| sortOrder | 10 |
Name of the chunk containing the (HTML) email template. The default fbAutoresponder chunk only parses the autoresponse message above.
| caption | Autoresponder template |
| name | fb_autoresponder_template |
| description | Name of the chunk containing the (HTML) email template. The default fbAutoresponder chunk only parses the autoresponse message above. |
| type | text |
| category | _Autoresponder |
| sortOrder | 20 |
| defaultValue | fbAutoresponder |
IMPORTANT! For the autoresponder to know which email address to use, the Input (Email) field needs to be present in the form.
| caption | Autoresponder |
| name | fb_autoresponder_toggle |
| description | IMPORTANT! For the autoresponder to know which email address to use, the Input (Email) field needs to be present in the form. |
| type | option |
| category | _Autoresponder |
| sortOrder | 1 |
| inputOptionValues | On==1||Off==0 |
Page containing the ConfirmRegister snippet for email activation. Enter page ID or drag the page from the menu tree to this input field. Defaults to the activation_resource_id system setting.
| caption | Activation page |
| name | fb_activation_resource_id |
| description | Page containing the ConfirmRegister snippet for email activation. Enter page ID or drag the page from the menu tree to this input field. Defaults to the activation_resource_id system setting. |
| type | number |
| category | _Registration |
| sortOrder | 2 |
Whether or not new users need to activate their account via email. IMPORTANT! For the activation process to know which address to use, the Input (Email) field needs to be present in the form.
| caption | Activation |
| name | fb_activation_toggle |
| description | Whether or not new users need to activate their account via email. IMPORTANT! For the activation process to know which address to use, the Input (Email) field needs to be present in the form. |
| type | option |
| category | _Registration |
| sortOrder | 1 |
| inputOptionValues | After email confirmation==1||Immediately (Beware of spam!)==0 |
| defaultValue | 1 |
Number of minutes until the activation email expires. Defaults to 3 hours.
| caption | Activation TTL |
| name | fb_activation_ttl |
| description | Number of minutes until the activation email expires. Defaults to 3 hours. |
| type | number |
| category | _Registration |
| sortOrder | 5 |
| defaultValue | 180 |
If switched on, any extra fields in the form are added to the extended field in the user profile.
| caption | Extended user fields |
| name | fb_extended_toggle |
| description | If switched on, any extra fields in the form are added to the extended field in the user profile. |
| type | option |
| category | _Registration |
| sortOrder | 30 |
| inputOptionValues | No==0||Yes==1 |
Name of the form field that will receive the full name of the user. Handy when using email address as username. You can use the label name of the CB field here, or the input name in the HTML.
| caption | Fullname field |
| name | fb_fullname_field |
| description | Name of the form field that will receive the full name of the user. Handy when using email address as username. You can use the label name of the CB field here, or the input name in the HTML. |
| type | text |
| category | _Registration |
| sortOrder | 11 |
Name of the form field that will receive a password. If empty, a password will be generated instead. You can use the label name of the CB field here, or the input name in the HTML.
| caption | Password field |
| name | fb_password_field |
| description | Name of the form field that will receive a password. If empty, a password will be generated instead. You can use the label name of the CB field here, or the input name in the HTML. |
| type | text |
| category | _Registration |
| sortOrder | 12 |
Optional. A comma-separated list of user group names or IDs to add the newly-registered user to.
| caption | User groups |
| name | fb_usergroups |
| description | Optional. A comma-separated list of user group names or IDs to add the newly-registered user to. |
| type | text |
| category | _Registration |
| sortOrder | 20 |
Optional. The name of the form field that decides which user groups the new user will belong to. You can use the label name of the ContentBlock field here, or the name in the HTML.
| caption | User groups field |
| name | fb_usergroups_field |
| description | Optional. The name of the form field that decides which user groups the new user will belong to. You can use the label name of the ContentBlock field here, or the name in the HTML. |
| type | text |
| category | _Registration |
| sortOrder | 21 |
Name of the form field that will receive the username. You can use the label name of the CB field here, or the input name in the HTML. Tip: consider using the email address here..
| caption | Username field |
| name | fb_username_field |
| description | Name of the form field that will receive the username. You can use the label name of the CB field here, or the input name in the HTML. Tip: consider using the email address here.. |
| type | text |
| category | _Registration |
| sortOrder | 10 |
Stored uploads are saved in this folder. The path needs to be relative to the location of the assets_path setting. Please note that 6 will be parsed, but other placeholders wont.
| caption | Attachment path |
| name | fb_attachment_path |
| description | Stored uploads are saved in this folder. The path needs to be relative to the location of the assets_path setting. Please note that 6 will be parsed, but other placeholders wont. |
| type | text |
| category | _Settings - Advanced |
| sortOrder | 40 |
| defaultValue | ../uploads/_forms/6 |
Place any snippet / FastField call here that outputs a single email address. WARNING: populating this field will override the default recipient address, so test thoroughly!
| caption | Dynamic recipient address |
| name | fb_email_to_dynamic |
| description | Place any snippet / FastField call here that outputs a single email address. WARNING: populating this field will override the default recipient address, so test thoroughly! |
| type | textarea |
| category | _Settings - Advanced |
| sortOrder | 20 |
Prefix used by the chunks containing the HTML for the template rows. After this prefix follows an ID (i.e. fbEmailRow_28), connecting that chunk to the correct ContentBlocks field.
| caption | Email template row prefix |
| name | fb_email_tpl_prefix |
| description | Prefix used by the chunks containing the HTML for the template rows. After this prefix follows an ID (i.e. fbEmailRow_28), connecting that chunk to the correct ContentBlocks field. |
| type | text |
| category | _Settings - Advanced |
| sortOrder | 11 |
| defaultValue | fbEmailRow_ |
A snippet name (or comma separated list of names) to execute. They are run after the form is submitted, but before any emails are sent (or user is created). Useful for additional validation.
| caption | Hook(s) |
| name | fb_hooks |
| description | A snippet name (or comma separated list of names) to execute. They are run after the form is submitted, but before any emails are sent (or user is created). Useful for additional validation. |
| type | text |
| category | _Settings - Advanced |
| sortOrder | 3 |
A snippet name (or comma separated list of names) to execute. They are run after the form is fully submitted and all emails are sent. Useful for writing submitted values to the database.
| caption | Post-hook(s) |
| name | fb_posthooks |
| description | A snippet name (or comma separated list of names) to execute. They are run after the form is fully submitted and all emails are sent. Useful for writing submitted values to the database. |
| type | text |
| category | _Settings - Advanced |
| sortOrder | 3 |
A snippet name (or comma separated list of names). They are run before the form is initialised. Useful for prefilling form fields with existing data.
| caption | Pre-hook(s) |
| name | fb_prehooks |
| description | A snippet name (or comma separated list of names). They are run before the form is initialised. Useful for prefilling form fields with existing data. |
| type | text |
| category | _Settings - Advanced |
| sortOrder | 1 |
Place any element here that is able to decide where to redirect the user after form submission. If the result is empty, it falls back on the ID provided under general settings.
| caption | Dynamic redirect page |
| name | fb_redirect_dynamic |
| description | Place any element here that is able to decide where to redirect the user after form submission. If the result is empty, it falls back on the ID provided under general settings. |
| type | text |
| category | _Settings - Advanced |
| sortOrder | 21 |
A snippet name (or comma separated list of names) to execute. They are run when the form loads and all pre-hooks are finished. Useful for fetching session data.
| caption | Render hook(s) |
| name | fb_renderhooks |
| description | A snippet name (or comma separated list of names) to execute. They are run when the form loads and all pre-hooks are finished. Useful for fetching session data. |
| type | text |
| category | _Settings - Advanced |
| sortOrder | 2 |
Store data in session before redirecting the user to a confirmation / thank you page, or to another form (as part of a multi-page form). Use FormItRetriever to access the data again.
| caption | Store submitted data temporarily |
| name | fb_store_data |
| description | Store data in session before redirecting the user to a confirmation / thank you page, or to another form (as part of a multi-page form). Use FormItRetriever to access the data again. |
| type | option |
| category | _Settings - Advanced |
| sortOrder | 30 |
| inputOptionValues | No==0||Yes==1 |
If 'store data' is switched on, this specifies the number of seconds to store the submitted form data. Defaults to five minutes.
| caption | Temporary storage timeout |
| name | fb_store_time |
| description | If 'store data' is switched on, this specifies the number of seconds to store the submitted form data. Defaults to five minutes. |
| type | number |
| category | _Settings - Advanced |
| sortOrder | 31 |
| defaultValue | 300 |
The content of the activation email, if email type is Inline. Make sure it contains the placeholder for the confirmation link!
| caption | Activation email |
| name | fb_activation_email |
| description | The content of the activation email, if email type is Inline. Make sure it contains the placeholder for the confirmation link! |
| type | richtext |
| category | _Settings - Email |
| sortOrder | 20 |
Enter chunk name here if email type is Chunk, or an absolute file path if email type is File (you can use {core_path}, {base_path} or {assets_path} as placeholders here).
| caption | Activation email template |
| name | fb_activation_email_tpl |
| description | Enter chunk name here if email type is Chunk, or an absolute file path if email type is File (you can use {core_path}, {base_path} or {assets_path} as placeholders here). |
| type | text |
| category | _Settings - Email |
| sortOrder | 11 |
| caption | Activation email type |
| name | fb_activation_email_type |
| type | option |
| category | _Settings - Email |
| sortOrder | 10 |
| inputOptionValues | Inline (edit content below)==inline||Chunk (specify chunk name below)==modChunk||File (specify file path below)==file |
| defaultValue | inline |
Optional.
| caption | Email BCC address |
| name | fb_email_bcc |
| description | Optional. |
| type | email |
| category | _Settings - Email |
| sortOrder | 3 |
Optional.
| caption | Email CC address |
| name | fb_email_cc |
| description | Optional. |
| type | email |
| category | _Settings - Email |
| sortOrder | 2 |
Optional. Defaults to emailsender system setting.
| caption | Email FROM address |
| name | fb_email_from |
| description | Optional. Defaults to emailsender system setting. |
| type | email |
| category | _Settings - Email |
| sortOrder | 5 |
Optional. Defaults to site_name system setting.
| caption | Email FROM name |
| name | fb_email_from_name |
| description | Optional. Defaults to site_name system setting. |
| type | text |
| category | _Settings - Email |
| sortOrder | 6 |
| caption | Email subject |
| name | fb_email_subject |
| type | text |
| category | _Settings - Email |
| sortOrder | 10 |
Name of the chunk containing the (HTML) email template. You can replace the default with your own... Just make sure it contains the fbFormReport snippet call for listing the fields.
| caption | Email template |
| name | fb_email_template |
| description | Name of the chunk containing the (HTML) email template. You can replace the default with your own... Just make sure it contains the fbFormReport snippet call for listing the fields. |
| type | text |
| category | _Settings - Email |
| sortOrder | 10 |
| defaultValue | fbEmail |
Submitted forms will be sent to this address. If you leave this field empty, no emails will be sent. This may be what you want when using a custom hook for processing the form.
| caption | Email address recipient |
| name | fb_email_to |
| description | Submitted forms will be sent to this address. If you leave this field empty, no emails will be sent. This may be what you want when using a custom hook for processing the form. |
| type | email |
| category | _Settings - Email |
| sortOrder | 1 |
Validate fields just before the form is submitted, or when the visitor leaves the form field again (on blur).
| caption | Frontend validate on |
| name | fb_frontend_validate_on |
| description | Validate fields just before the form is submitted, or when the visitor leaves the form field again (on blur). |
| type | option |
| category | _Settings - General |
| sortOrder | 41 |
| inputOptionValues | Submit==submit||Blur==blur||System default==default |
| defaultValue | default |
Validate form input in the browser first, before submit. The javascript automatically picks up required settings and some field-specific properties and backend validation is still applied.
| caption | Frontend validation |
| name | fb_frontend_validation |
| description | Validate form input in the browser first, before submit. The javascript automatically picks up required settings and some field-specific properties and backend validation is still applied. |
| type | option |
| category | _Settings - General |
| sortOrder | 40 |
| inputOptionValues | On==1||Off==0||System default==default |
| defaultValue | default |
Enter the ID of the page, or drag the page from the menu tree to this input field.
| caption | Redirect page |
| name | fb_redirect_id |
| description | Enter the ID of the page, or drag the page from the menu tree to this input field. |
| type | number |
| category | _Settings - General |
| sortOrder | 20 |
Store uploads in designated folder (defined under Advanced). You may need to monitor and periodically clean up this folder in order to comply with GDPR retention policies.
| caption | Store submitted attachments |
| name | fb_store_attachments |
| description | Store uploads in designated folder (defined under Advanced). You may need to monitor and periodically clean up this folder in order to comply with GDPR retention policies. |
| type | option |
| category | _Settings - General |
| sortOrder | 31 |
| inputOptionValues | On==1||Off==0||System default==default |
| defaultValue | default |
JSON array of CSS selectors. Simulates multiple sequential click interactions.
| caption | Click selectors |
| name | backstop_click_selectors |
| description | JSON array of CSS selectors. Simulates multiple sequential click interactions. |
| type | ace |
| category | _Scenarios |
| sortOrder | 36 |
| defaultValue | [] |
Wait for x milliseconds before starting the test. This gives pages a little breathing space to adjust after page load (things like fonts, DOM manipulation, etc).
| caption | Delay |
| name | backstop_delay |
| description | Wait for x milliseconds before starting the test. This gives pages a little breathing space to adjust after page load (things like fonts, DOM manipulation, etc). |
| type | number |
| category | _Scenarios |
| sortOrder | 10 |
| defaultValue | 2000 |
JSON array of CSS selectors. These selectors are hidden from our analysis but retained in the original layout flow.
| caption | Hide selectors |
| name | backstop_hide_selectors |
| description | JSON array of CSS selectors. These selectors are hidden from our analysis but retained in the original layout flow. |
| type | ace |
| category | _Scenarios |
| sortOrder | 30 |
| defaultValue | [] |
JSON array of CSS selectors. Simulates multiple sequential hover interactions.
| caption | Hover selectors |
| name | backstop_hover_selectors |
| description | JSON array of CSS selectors. Simulates multiple sequential hover interactions. |
| type | ace |
| category | _Scenarios |
| sortOrder | 35 |
| defaultValue | [] |
JSON array of selector and string values. Simulates multiple sequential keypress interactions.
| caption | Key press selectors |
| name | backstop_keypress_selectors |
| description | JSON array of selector and string values. Simulates multiple sequential keypress interactions. |
| type | ace |
| category | _Scenarios |
| sortOrder | 40 |
| defaultValue | [] |
Percentage of diverging pixels allowed to pass test.
| caption | Mismatch threshold |
| name | backstop_mismatch_threshold |
| description | Percentage of diverging pixels allowed to pass test. |
| type | number |
| category | _Scenarios |
| sortOrder | 52 |
| defaultValue | 3 |
Wait for x milliseconds after interacting with hoverSelector or clickSelector. Ideal for use with a click or hover element transition.
| caption | Post interaction wait |
| name | backstop_post_interaction_wait |
| description | Wait for x milliseconds after interacting with hoverSelector or clickSelector. Ideal for use with a click or hover element transition. |
| type | number |
| category | _Scenarios |
| sortOrder | 50 |
| defaultValue | 300 |
Full site URL of the domain to compare with (the live domain for example). If you leave this empty, each page will be tested against an older version of itself.
| caption | Reference URL |
| name | backstop_reference_url |
| description | Full site URL of the domain to compare with (the live domain for example). If you leave this empty, each page will be tested against an older version of itself. |
| type | text |
| category | _Scenarios |
| sortOrder | 5 |
JSON array of CSS selectors. These selectors are removed from the DOM before screenshots are taken.
| caption | Remove selectors |
| name | backstop_remove_selectors |
| description | JSON array of CSS selectors. These selectors are removed from the DOM before screenshots are taken. |
| type | ace |
| category | _Scenarios |
| sortOrder | 31 |
| defaultValue | [] |
Chunk containing the JSON config used for each scenario.
| caption | Scenario template |
| name | backstop_scenario_tpl |
| description | Chunk containing the JSON config used for each scenario. |
| type | text |
| category | _Scenarios |
| sortOrder | 1 |
| defaultValue | backstopScenarioRow |
Enable if you want BackstopJS to find and take screenshots of all matching selectors.
| caption | Selector expansion |
| name | backstop_selector_expansion |
| description | Enable if you want BackstopJS to find and take screenshots of all matching selectors. |
| type | listbox |
| category | _Scenarios |
| sortOrder | 21 |
| inputOptionValues | On==true||Off==false |
| defaultValue | false |
Explicitly set the number of results that you expect to find with the selectors. If set to a value greater than 0, the test will fail if the number of results does not match this value.
| caption | Selector expect |
| name | backstop_selector_expect |
| description | Explicitly set the number of results that you expect to find with the selectors. If set to a value greater than 0, the test will fail if the number of results does not match this value. |
| type | number |
| category | _Scenarios |
| sortOrder | 22 |
JSON array of CSS specific selectors to capture. Defaults to the entire document if omitted. Use "viewport" to capture the viewport size.
| caption | Selectors |
| name | backstop_selectors |
| description | JSON array of CSS specific selectors to capture. Defaults to the entire document if omitted. Use "viewport" to capture the viewport size. |
| type | ace |
| category | _Scenarios |
| sortOrder | 20 |
| defaultValue | [] |
The maximum number of capturing screens to run in parallel. This value can be adjusted as needed to increase/decrease the amount of RAM required during a test.
| caption | Async capture limit |
| name | backstop_async_capture_limit |
| description | The maximum number of capturing screens to run in parallel. This value can be adjusted as needed to increase/decrease the amount of RAM required during a test. |
| type | number |
| category | _Testing |
| sortOrder | 30 |
| defaultValue | 3 |
The maximum number of compare screens to run in parallel. This value can be adjusted as needed to increase/decrease the amount of RAM required during a test.
| caption | Async compare limit |
| name | backstop_async_compare_limit |
| description | The maximum number of compare screens to run in parallel. This value can be adjusted as needed to increase/decrease the amount of RAM required during a test. |
| type | number |
| category | _Testing |
| sortOrder | 31 |
| defaultValue | 30 |
Choose which rendering engine to use. Puppeteer renders pages in headless Chrome, whereas Playwright also has the option to use Firefox or Webkit. See setting below.
| caption | Engine |
| name | backstop_engine |
| description | Choose which rendering engine to use. Puppeteer renders pages in headless Chrome, whereas Playwright also has the option to use Firefox or Webkit. See setting below. |
| type | listbox |
| category | _Testing |
| sortOrder | 10 |
| inputOptionValues | Puppeteer==puppeteer||Playwright==playwright |
| defaultValue | puppeteer |
Changing this only applies if engine is Playwright.
| caption | Browser |
| name | backstop_engine_browser |
| description | Changing this only applies if engine is Playwright. |
| type | listbox |
| category | _Testing |
| sortOrder | 11 |
| inputOptionValues | Chromium (Chrome, Edge, Brave)==chromium||Firefox||WebKit (Safari/iOS) |
| defaultValue | chromium |
Choose in what format to return the test results.
| caption | Report |
| name | backstop_report |
| description | Choose in what format to return the test results. |
| type | checkbox |
| category | _Testing |
| sortOrder | 20 |
| inputOptionValues | HTML (opens in browser)=="browser"||JSON=="json"||JUnit (for CI)=="CI" |
| defaultValue | "browser" |
| outputProperties | |
JSON array of screen size objects to test against.
| caption | Viewports |
| name | backstop_viewports |
| description | JSON array of screen size objects to test against. |
| type | ace |
| category | _Testing |
| sortOrder | 1 |
When filled in, this value will override the button text defined in the Overview ContentBlock. Keep in mind that if no button text is set in Overview CB, no button will be shown!
| caption | Link / button text |
| name | overview_link_text |
| description | When filled in, this value will override the button text defined in the Overview ContentBlock. Keep in mind that if no button text is set in Overview CB, no button will be shown! |
| type | text |
| category | _Overview - Content |
| sortOrder | 2 |
When filled in, this value will override the default subtitle (if subtitle is enabled in the Overview CB settings).
| caption | Subtitle |
| name | overview_subtitle |
| description | When filled in, this value will override the default subtitle (if subtitle is enabled in the Overview CB settings). |
| type | text |
| category | _Overview - Content |
| sortOrder | 1 |
Select an icon from the projects' icon font list. Check the style guide for available icons, or use the autocomplete search as you type.
| caption | Icon (Font) |
| name | overview_icon_font |
| description | Select an icon from the projects' icon font list. Check the style guide for available icons, or use the autocomplete search as you type. |
| type | listbox |
| category | _Overview - Icon |
| sortOrder | 10 |
| inputOptionValues | @CHUNK iconTVInputOptions |
| inputProperties | | typeAhead | true | | typeAheadDelay | 400 |
|
If an SVG icon is not available, you can also use an image file (preferably in PNG format). This image needs to be square.
| caption | Icon (Image) |
| name | overview_icon_img |
| description | If an SVG icon is not available, you can also use an image file (preferably in PNG format). This image needs to be square. |
| type | imageplus |
| category | _Overview - Icon |
| sortOrder | 5 |
| inputProperties | | targetWidth | 300 | | targetHeight | 300 | | allowAltTag | true | | allowCredits | true |
|
The recommended way for adding an icon is as an SVG graphic. This can be pretty much anything, but please make sure the SVG has a square aspect ratio (viewbox).
| caption | Icon (SVG) |
| name | overview_icon_svg |
| description | The recommended way for adding an icon is as an SVG graphic. This can be pretty much anything, but please make sure the SVG has a square aspect ratio (viewbox). |
| type | image |
| category | _Overview - Icon |
Mention the designer of this icon here, so they can be credited appropriately. You need to do this if you're using icons published under a CC license, for example from Noun Project.
| caption | Icon credit (SVG) |
| name | overview_icon_svg_credit |
| description | Mention the designer of this icon here, so they can be credited appropriately. You need to do this if you're using icons published under a CC license, for example from Noun Project. |
| type | text |
| category | _Overview - Icon |
| sortOrder | 1 |
This image doesn't have a fixed aspect ratio or any minimum dimensions. Use it as you see fit. Cropping is optional. Be aware that mixing aspect ratios will result in different image sizes!
| caption | Image (Free) |
| name | overview_img_free |
| description | This image doesn't have a fixed aspect ratio or any minimum dimensions. Use it as you see fit. Cropping is optional. Be aware that mixing aspect ratios will result in different image sizes! |
| type | imageplus |
| category | _Overview - Image |
| sortOrder | 10 |
| inputProperties | | allowAltTag | true | | allowCredits | true |
|
This is the default overview image, in a regular 4:3 aspect ratio.
| caption | Image (Landscape) |
| name | overview_img_landscape |
| description | This is the default overview image, in a regular 4:3 aspect ratio. |
| type | imageplus |
| category | _Overview - Image |
| sortOrder | 1 |
| inputProperties | | targetWidth | 500 | | targetHeight | 375 | | allowAltTag | true | | allowCredits | true |
|
This is an image with 21:9 aspect ratio, for use in headers or layout backgrounds.
| caption | Image (Panorama) |
| name | overview_img_pano |
| description | This is an image with 21:9 aspect ratio, for use in headers or layout backgrounds. |
| type | imageplus |
| category | _Overview - Image |
| sortOrder | 6 |
| inputProperties | | targetWidth | 1300 | | targetRatio | 2.33 | | allowAltTag | true | | allowCredits | true |
|
This is a standing image in 3:4 aspect ratio, best suited for floating left or right of content, or for display on mobile devices.
| caption | Image (Portrait) |
| name | overview_img_portrait |
| description | This is a standing image in 3:4 aspect ratio, best suited for floating left or right of content, or for display on mobile devices. |
| type | imageplus |
| category | _Overview - Image |
| sortOrder | 2 |
| inputProperties | | targetWidth | 300 | | targetHeight | 400 | | allowAltTag | true | | allowCredits | true |
|
This is an image in 1:1 aspect ratio, for use in cards, avatars or circular images.
| caption | Image (Square) |
| name | overview_img_square |
| description | This is an image in 1:1 aspect ratio, for use in cards, avatars or circular images. |
| type | imageplus |
| category | _Overview - Image |
| sortOrder | 3 |
| inputProperties | | targetWidth | 300 | | targetHeight | 300 | | allowAltTag | true | | allowCredits | true |
|
This SVG graphic can be used as alternative to regular (pixel based) images. For layout consistency, make sure all SVGs in this Overview share the same aspect ratio.
| caption | Image (SVG) |
| name | overview_img_svg |
| description | This SVG graphic can be used as alternative to regular (pixel based) images. For layout consistency, make sure all SVGs in this Overview share the same aspect ratio. |
| type | image |
| category | _Overview - Image |
| sortOrder | 20 |
Mention the designer of this icon here, so they can be credited appropriately. You need to do this if you're using icons published under a CC license, for example from Noun Project.
| caption | Image credit (SVG) |
| name | overview_img_svg_credit |
| description | Mention the designer of this icon here, so they can be credited appropriately. You need to do this if you're using icons published under a CC license, for example from Noun Project. |
| type | text |
| category | _Overview - Image |
| sortOrder | 21 |
This is an image with widescreen proportions, in 16:9 aspect ratio.
| caption | Image (Wide) |
| name | overview_img_wide |
| description | This is an image with widescreen proportions, in 16:9 aspect ratio. |
| type | imageplus |
| category | _Overview - Image |
| sortOrder | 5 |
| inputProperties | | targetWidth | 800 | | targetHeight | 450 | | allowAltTag | true | | allowCredits | true |
|
DEPRECATED. Please fill in the complete URL (including http(s)://).
| caption | Facebook page |
| name | social_facebook |
| description | DEPRECATED. Please fill in the complete URL (including http(s)://). |
| type | text |
| category | _Social |
| sortOrder | 3 |
DEPRECATED. Only fill in the account name (the part after https://github.com/).
| caption | Github account |
| name | social_github |
| description | DEPRECATED. Only fill in the account name (the part after https://github.com/). |
| type | text |
| category | _Social |
| sortOrder | 20 |
DEPRECATED. Only fill in the account name (the part after https://instagram.com/).
| caption | Instagram profile |
| name | social_instagram |
| description | DEPRECATED. Only fill in the account name (the part after https://instagram.com/). |
| type | text |
| category | _Social |
| sortOrder | 4 |
DEPRECATED. Please fill in the complete URL (including http(s)://).
| caption | LinkedIn profile |
| name | social_linkedin |
| description | DEPRECATED. Please fill in the complete URL (including http(s)://). |
| type | text |
| category | _Social |
| sortOrder | 2 |
DEPRECATED. Please fill in the complete URL (including http(s)://).
| caption | Pinterest board |
| name | social_pinterest |
| description | DEPRECATED. Please fill in the complete URL (including http(s)://). |
| type | text |
| category | _Social |
| sortOrder | 5 |
DEPRECATED. A mobile phone number connected to an active WhatsApp account. If entered, visitors can start a chat directly from the website. Format as number, without any leading zeros.
| caption | WhatsApp number |
| name | social_whatsapp |
| description | DEPRECATED. A mobile phone number connected to an active WhatsApp account. If entered, visitors can start a chat directly from the website. Format as number, without any leading zeros. |
| type | number |
| category | _Social |
| sortOrder | 11 |
DEPRECATED. Predefined text for the message that the visitor can send. You can use placeholders here to include some information about the referring page.
| caption | WhatsApp message |
| name | social_whatsapp_text |
| description | DEPRECATED. Predefined text for the message that the visitor can send. You can use placeholders here to include some information about the referring page. |
| type | textarea |
| category | _Social |
| sortOrder | 12 |
DEPRECATED. Please fill in the complete URL (including http(s)://).
| caption | Youtube channel |
| name | social_youtube |
| description | DEPRECATED. Please fill in the complete URL (including http(s)://). |
| type | text |
| category | _Social |
| sortOrder | 10 |
comments_toggle
Enable or disable comments. This value is inherited on child pages.
Assigned to templates
Referring patterns