Calendar

Calendar

{{ calendar }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published calendar
guid String The unique identifier for this calendar
value String Synonymn for guid
name text The name of the calendar
title text The title of the calendar
linked_title String A link to the calendar if it has a URL, or the escaped title if not
timezone timezone The default timezone for events in this calendar
has_url Boolean True if the calendar has a URL
include_in_search Boolean Whether or not this calendar should be returned in on-site search results
domain_name text The domain name used by the URL for this calendar
url text The portion of the URL for this calendar following the domain name
full_url String The full URL for this calendar 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 calendar does not have a URL)
search_entity entity The entity that search results should be directed to (if this calendar does not have a URL)
folder_guid String The unique identifier for the folder that contains this calendar.
folder folder The folder that contains this calendar.
field_id String The identifier for this field
label String The label for this field
output String The default output that the calendar 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 calendars themselves
data data Object containing the custom fields on this calendar
* String Specific custom fields may be accessed using {{ entity.fieldid }} or {{calendar['field-id']}}

{{ calendars }}

Contains multiple calendars.

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this contains at least one published calendar
output String The default output that the calendars will produce when it is output directly to the template - using the "output_in_list" property of each calendar in the items list
prepended list List containing any prepended calendars.
fetched list List containing all of the calendars that were fetched from the database (as opposed to prepended or appended).
appended list List containing any appended calendars.
appended_unique list List containing any appended calendars excluding any calendars that are in either the list of prepended or fetched calendars.
items list List containing all of the combined calendars from the prepended, fetched, and appended lists. If unique is true, this list will not contain any duplicates. If max_size is set, this list will not contain more than the number of calendars specified.
size Integer The total number of calendars in the items list, including prepended, fetched, and appended lists, and respecting the unique and max_size properties.
max_size Integer If set, this is the maximum number of items that will be returned in the items list and the maximum number of items that will be included when this calendars object is enumerated as a list. When not set, this value will be 0.
unique Boolean When true, the items list will not contain any duplicates. Only the first instance of each calendar will be included.
limit Integer The maximum number of items that were allowed to be in the list of fetched calendars. May be 0 in some cases (such as when when there are no fetched calendars.
start Integer The 1-based index of the first item in the list of fetched calendars.
page Integer The 1-based index of the paginated results returned in the list of fetched calendars, which is calculated from the start and limit parameters. Useful for paginated results.
total_count Integer The 1-based index of the first item in the list of fetched calendars
total_pages Integer

{% calendar %}

{% calendar output_to_template? [var, set, or assign]? variable? output_to_template? = value %}

{% calendar
output_to_template
 
If included the calendar will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this calendar is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this calendar to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the calendar will be output directly to the template.
=
value
 
Should evaluate to a calendar object, or the name or guid of a calendar May use liquid filters.
%}
Fetches a single calendar.

{% calendars %}

{% calendars output_to_template? [var, set, or assign]? variable? output_to_template? = arguments %}

{% calendars
output_to_template
 
If included the calendars will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this calendars is stored on. "var" is the default behavior.
variable
output_to_template
 
If included the calendars will be output directly to the template.
=
arguments
 
Key:value pairs. May use the variable arguments syntax.
%}

arguments

prepend
 
May be a single calendar, a list of calendars, or the name or guid of a calendar to be be included at the beginning of the calendars.
append
 
May be a single calendar, a list of calendars, or the name or guid of a calendar to be be included at the end of the calendars.
exclude
 
May be a single calendar, a list of calendars, or the name or guid of a calendar that should NOT be included in the fetched results. Has no affect on prepended or appended calendars.
exclude_prepended
 
True to specifically exclude all prepended calendars 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 to specifically exclude all appended calendars 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 to remove duplicates from each of the resulting lists (prepended, fetched, appended, and items), 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
 
The maximum number of items to be included in the "items" list. If there are any prepended or appended items, this will automatically lower the "limit" to only fetch as many calendars as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting calendars. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
filter
 
Only include calendars that match the given string filter
folder
 
May include multiple folders. Only include calendars with one of the given folders
date_created_start
 
Only include calendars with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the calendar was first published.
date_created_end
 
Only include calendars with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the calendar was first published.
start
 
Set the 1-based index of the first calendar to fetch.
page
 
Used to automatically calculate the first calendar to fetch based on both the "limit" and the 1-based "page" value. Defaults to 1, but is ignored if "start" is set.
limit
 
The maximum number of calendars to fetch. Defaults to 10. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.
sort_by
 
Specify which property to sort the results by. Has no affect on prepended or appended calendars. By default, results will be sorted by relevance if there is a filter string and date_created desc (newest first) if not. Options include:
  • relevance: only applies when there is a filter string. When sorting by relevance sort_direction is ignored.
  • date_created: the date each calendars was first published. Unpublishing and republishing a calendars resets date_created to the current date.
  • random: results will be returned in a random order, which prevents the page from being fast-cached. Setting cache_random:true overrides this behavior and allows the page to be fast-cached anyway.
  • name
  • title
  • url
  • browser_title
sort_direction
 
asc or desc.
cache_random
 
True to allow the results to be cached when sort_by is "random".
Fetches a list of calendars.