Form

Form

{{ form }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published form
guid String The unique identifier for this form
value String Synonymn for guid
name text The name of the form
title text The title of the form
linked_title String A link to the form if it has a URL, or the escaped title if not
redirect_url url URL to navigate to after a successful form submission
template_override_guid String The unique identifier of the template that should be used to output this form
template_override template The template that should be used to output this form
form_unique_identifier String A helper property containing a unique ID for this instance of this form. Every time this form is output - either from this instance or from multiple instances - it should have a different ID. Specifically, every time the form_end property is accessed the unique ID will be reset to a new value (thereby preventing conflicting javascript code and element identifiers)
form_start String A helper property to assist in creating the form markup. This property includes the form tag with the form_unique_identifier
form_end String A helper property to assist in creating the form markup. This property includes the end form tag as well as some javascript that will be used to assist in processing conditional fields, form validation, and form submissions
javascript String A helper property to assist in creating the form markup. This property includes all of the javascript that will be output from the form_end property. USE WITH CAUTION
javascript_field_config String A helper property to assist in creating the form markup. This property includes the field configurations for the javascript that will be output from the javascript property. USE WITH CAUTION
javascript_form_config String A helper property to assist in creating the form markup. This property includes the form configuration for the javascript that will be output from the javascript property. USE WITH CAUTION
form_submit_target String A helper property in case you decide to build and submit the form without using the form_start and form-end properties. This property contains the URL that the form must be submitted to in order to be recorded by Marketpath CMS as a form submission
fields list A list containing all of the form fields that are direct children of the current form.Note that any fields (or groups) that are part of a parent group will NOT be included in this list - they will be included as children of their parent group
has_url Boolean True if the form has a URL
include_in_search Boolean Whether or not this form should be returned in on-site search results
domain_name text The domain name used by the URL for this form
url text The portion of the URL for this form following the domain name
full_url String The full URL for this form including the scheme, domain name, and path
visited Boolean Whether or not the user has visited this URL previously in their current session. Note that this will always be false if the user has not allowed session permission (see the Permissions and Personalization documentation). Using this property prevents the page from being fast-cached
template_guid String The unique identifier for the template that would be used to respond to this URL
template template The template that would be used to respond to this URL
canonical_url url The canonical URL if this is not the original source of content for this URL
browser_title text The browser title to use for this URL
meta_description textarea The meta description for this URL
meta_robots text The meta robots for this URL
keywords textarea The SEO keywords for this URL
search_entity_guid String The unique identifier for the entity that search results should be directed to (if this form does not have a URL)
search_entity entity The entity that search results should be directed to (if this form does not have a URL)
folder_guid String The unique identifier for the folder that contains this form.
folder folder The folder that contains this form.
field_id String The identifier for this field
label String The label for this field
output String The default output that the form produces when output directly to the template. The default output may change at any time. Template developers should avoid using this and should handle the output of forms themselves
data data Object containing the custom fields on this form
* String Specific custom fields may be accessed using {{ entity.fieldid }} or {{form['field-id']}}

{{ forms }}

Contains multiple forms.

Name Type Description
output String The default output that the forms will produce when it is output directly to the template - using the "output_in_list" property of each form in the items list

{% form %}

{% form
var|set|assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this form is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this form to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the form will be output directly to the template.
=
%}

{% forms %}

{% forms
var|set|assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this forms is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this forms to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the forms will be output directly to the template.
=
prepend:value
 
Prepend the specified forms before the fetched results. All prepended input will be returned in the same order that it is input. Value may one or more forms, a guid, or a string.
append:value
 
Append the specified forms after the fetched results. All appended input will be returned in the same order that it is input. Value may one or more forms, a guid, or a string.
exclude:value
 
Prevent the specified forms from being included in the fetched results. Has no affect on prepended and appended items. Value may one or more forms, a guid, or a string.
exclude_prepended:true
 
Specifically exclude all prepended forms from the fetched results. If "unique:true" is specified this is the default behavior, although you may also specify "exclude_prepended:false" to allow any prepended items to be fetched along with other results anyway.
exclude_appended:true
 
Specifically exclude all appended forms from the fetched results. This is false by default - even if "unique:true" is specified - so that results are returned in the proper order.
unique:true
 
If set to true, each of the resulting lists (prepended, fetched, appended, and items) will be unique, although there may be duplicates between the prepended, fetched, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first, then fetched items, then appended items.
max_size:number
 
If specified, then the "items" list will only include up to the specified number of forms. The "limit" may be automatically lowered to only fetch the maximum number of articles that will be included in "items" following prepended items. Note that this may also impact both the "page" and "total_pages" values. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
%}

Examples

Save Id

Copy
...