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
object_type String Will always be datastore_item
is_valid Boolean True if this contains at least one published calendar_entry
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
prepended list List containing any prepended calendar_entries.
fetched list List containing all of the calendar_entries that were fetched from the database (as opposed to prepended or appended).
appended list List containing any appended calendar_entries.
appended_unique list List containing any appended calendar_entries excluding any calendar_entries that are in either the list of prepended or fetched calendar_entries.
items list List containing all of the combined calendar_entries 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 calendar_entries specified.
size Integer The total number of calendar_entries 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 calendar_entries 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_entry will be included.
limit Integer The maximum number of items that were allowed to be in the list of fetched calendar_entries. May be 0 in some cases (such as when when there are no fetched calendar_entries.
start Integer The 1-based index of the first item in the list of fetched calendar_entries.
page Integer The 1-based index of the paginated results returned in the list of fetched calendar_entries, 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 calendar_entries
total_pages Integer

{% calendar_entry %}

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

{% calendar_entry
output_to_template
 
If included the calendar_entry will be output directly to the template.
var, set, or 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.
=
value
 
Should evaluate to a calendar_entry object, or the name or guid of a calendar_entry May use liquid filters.
%}
Fetches a single calendar_entry.

{% calendar_entries %}

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

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

arguments

prepend
 
May be a single calendar_entry, a list of calendar_entries, or the name or guid of a calendar_entry to be be included at the beginning of the calendar_entries.
append
 
May be a single calendar_entry, a list of calendar_entries, or the name or guid of a calendar_entry to be be included at the end of the calendar_entries.
exclude
 
May be a single calendar_entry, a list of calendar_entries, or the name or guid of a calendar_entry that should NOT be included in the fetched results. Has no affect on prepended or appended calendar_entries.
exclude_prepended
 
True to 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 to 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 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 calendar_entries as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting calendar_entries. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
filter
 
Only include calendar entries that match the given string filter
calendar
 
May include multiple calendars. Only include calendar entries with one of the given calendars
start_date
 
Only include calendar entries starting on or after start_date
end_date
 
Only include calendar entries ending on or before end_date
tag
 
May include multiple tags. Only include calendar entries with one of the given tags
author
 
May include multiple authors. Only include calendar entries with one of the given authors
folder
 
May include multiple folders. Only include calendar entries with one of the given folders
date_created_start
 
Only include calendar entries with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the calendar entry was first published.
date_created_end
 
Only include calendar entries with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the calendar entry was first published.
start
 
Set the 1-based index of the first calendar_entry to fetch.
page
 
Used to automatically calculate the first calendar_entry 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 calendar_entries 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 calendar_entries. 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 calendar_entries was first published. Unpublishing and republishing a calendar_entries 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 calendar_entries.

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" %}