Document

Document

{{ document }}

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

{{ documents }}

Contains multiple documents.

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

{% document %}

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

{% documents %}

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