Gallery

Gallery

{{ gallery }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published gallery
guid String The unique identifier for this gallery
value String Synonymn for guid
name text The name of the gallery
title text The title of the gallery
linked_title String A link to the gallery if it has a URL, or the escaped title if not
gallery_template_guid String The unique identifier of the template used to render this gallery
gallery_template template Reference to the related gallery template object
tags tags The list of tags associated with this gallery
authors authors The list of authors associated with this gallery
items list A list containing all of the gallery items in the current gallery
has_url Boolean True if the gallery has a URL
include_in_search Boolean Whether or not this gallery should be returned in on-site search results
domain_name text The domain name used by the URL for this gallery
url text The portion of the URL for this gallery following the domain name
full_url String The full URL for this gallery 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 gallery does not have a URL)
search_entity entity The entity that search results should be directed to (if this gallery does not have a URL)
folder_guid String The unique identifier for the folder that contains this gallery.
folder folder The folder that contains this gallery.
field_id String The identifier for this field
label String The label for this field
output String The default output that the gallery produces when output directly to the template. If the gallery has a gallery_template, it will be used to output the gallery, otherwise it will fall back to other default output, which may change at any time
data data Object containing the custom fields on this gallery
* String Specific custom fields may be accessed using {{ entity.fieldid }} or {{gallery['field-id']}}

{{ galleries }}

Contains multiple galleries.

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

{% galleries %}

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

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

arguments

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