Calendar Entry

Calendar Entry

{{ calendar_entry }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published calendar_entry
guid String The unique identifier for this calendar_entry
value String Synonymn for guid
name text The name of the calendar_entry
title text The title of the calendar_entry
linked_title String A link to the calendar_entry if it has a URL, or the escaped title if not
image_guid String The unique identifier of the related image
image image Reference to the related image object
description html Short descriptive text shown with this item
calendar_guid String The unique identifier of the related calendar
calendar calendar Reference to the related calendar object
parent_calendar_entry_guid String The unique identifier of the parent calendar entry. Not currently used
calendar_entry calendar_entry Reference to the related calendar entry object. Not currently used
timezone timezone The timezone specified for this calendar entry, which should the timezone used by both the start and end dates
start_date datetime The date and time that this event will start (or started, if it is in the past)
all_day Boolean If true, specifies that this event lasts all day (no specific start/end times). It may still be a single or multi-day event
end_date datetime The date and time that this event will end (or ended, if it is in the past)
location text Text describing the location of the event
link url URL containing additional information about this event, typically used to direct users to an external page or to a page with additional information related to this event
tags tags The list of tags associated with this calendar_entry
authors authors The list of authors associated with this calendar_entry
has_url Boolean True if the calendar_entry has a URL
include_in_search Boolean Whether or not this calendar_entry should be returned in on-site search results
domain_name text The domain name used by the URL for this calendar_entry
url text The portion of the URL for this calendar_entry following the domain name
full_url String The full URL for this calendar_entry 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_entry does not have a URL)
search_entity entity The entity that search results should be directed to (if this calendar_entry does not have a URL)
folder_guid String The unique identifier for the folder that contains this calendar_entry.
folder folder The folder that contains this calendar_entry.
field_id String The identifier for this field
label String The label for this field
output String The default output that the calendar_entry 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 calendar entries themselves
data data Object containing the custom fields on this calendar_entry
* String Specific custom fields may be accessed using {{ entity.fieldid }} or {{calendar_entry['field-id']}}

{{ calendar_entries }}

Contains multiple calendar_entries.

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

{% calendar_entry %}

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

{% calendar_entries %}

{% calendar_entries
var|set|assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this calendar_entries is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this calendar_entries to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the calendar_entries will be output directly to the template.
=
prepend:value
 
Prepend the specified calendar_entries before the fetched results. All prepended input will be returned in the same order that it is input. Value may one or more calendar_entries, a guid, or a string.
append:value
 
Append the specified calendar_entries after the fetched results. All appended input will be returned in the same order that it is input. Value may one or more calendar_entries, a guid, or a string.
exclude:value
 
Prevent the specified calendar_entries from being included in the fetched results. Has no affect on prepended and appended items. Value may one or more calendar_entries, a guid, or a string.
exclude_prepended:true
 
Specifically exclude all prepended calendar_entries 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 calendar_entries 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 calendar_entries. 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

Calendar Entry time and formatting

Copy
{% if calendar_entry.start_date.date.is_future %} Event will start on {{calendar_entry.start_date | date: 'g' }} {% elsif calendar_entry.end_date.date.is_future %} Event is currently in progress {% else %} Event completed on {{calendar_entry.end_date | date: 'g' }} {% endif %}

Assign date add month and fetch calendar_entries

Copy
{% assign minDate = "now" | midnight %} {% assign maxDate = minDate | add_months: 1 %} {% calendar_entries output_to_template start_date:minDate end_date:maxDate limit:30 sort_by:"start_date" sort_direction:"asc" %}