document Properties

Field	Type	Description
object_type	string	"document"
is_valid	True\|False	True if this references a document or false if the document is null
guid	guid	The unique identifier for this document
path	string
filesize	number
name	text_field	The entity name. This field is primarily intended for internal use by website administrators to identify objects.
title	text_field
linked_title	html	A link to the document if it has a URL, or the escaped title if not.
folder_guid	text_field
folder	folder
has_url	boolean
site_domain_guid	text_field
ssl_mode	text_field
include_in_search	boolean
url	text_field
template_guid	text_field
template	template
canonical_url	url_field
browser_title	text_field
meta_description	textarea_field
meta_robots	textarea_field
keywords	textarea_field
full_url	string	The full URL of the page - including the scheme ("http://", "https://" or just "//"), the domain name, and the path.
visited	true/false	Whether or not the user has visited the document before 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).
custom	varies	Each document includes all of the custom properties defined by the template.
tags	tags	The list of tags associated with this document.
authors	authors	The list of authors associated with this document.
value	string	Synonymn for guid
output	html	The default output that the document produces when output directly to the template.
output_in_list	html	The default output that the document produces when output directly to the template as part of a list.

documents Summary

Contains multiple documents.

documents Properties

Field	Type	Description
object_type	string	"documents"
is_valid	true/false	true if this contains at least one document
prepended	list of documents	documents that will be listed at the beginning of the items list
fetched	list of documents	The primary list of documents to be included in the items list
appended	list of documents	documents that will be listed at the end of the items list
appended_unique	list of documents	documents that will be listed at the end of the items list, excluding any documents that are already included in either the prepended or fetched lists
items	list of documents	The full list of documents in the proper order and uniqueness, including prepended, fetched, and appended documents
size	number	The total number of items in the list of items, including prepended, fetched, and appended documents
limit	number	The maximum number of documents that could have been fetched dynamically from the database
start	number	The 1-based index of the first document that was (or would have been) dynamically fetched from the database
page	number	The 1-based index of the first "page" of documents that could have been fetched dynamically from the database - as determined by the start and limit properties
total_count	number	The total number of documents in the database that matched the provided filter parameters when fetching the list of fetched documents
total_pages	number	The total number of "pages" of results that matched the provided filter parameters when fetching the list of fetched documents - as determined by the total_count and limit properties
output	html	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

Methods

{% document %}

Fetch a single document.

{% document
[var|set|assign] new_variable_name
 
Specify a variable name in order to save the document to a variable. If not specified the document will be output to the template instead. The variable will be saved using the "var" behavior unless "set" or "assign" are specified.
output_to_template
 
If included, the document will be output directly to the template.
 = 
document|guid|string
%}

{% documents %}

Fetch a list of documents.

{% documents
[var|set|assign] new_variable_name
 
Specify a variable name in order to save the results to a variable. If not specified the results will be output to the template instead. The variable will be saved using the "var" behavior unless "set" or "assign" are specified.
output_to_template
 
If included, the results will be output directly to the template.
 = 
prepend:document|documents|guid|string
 
Prepend the specified documents before the fetched results. All prepended input will be returned in the same order that it is input.
append:document|documents|guid|string
 
Append the specified documents after the fetched results. All appended input will be returned in the same order that it is input.
exclude:document|documents|guid|string
 
Prevent the specified documents from being included in the fetched results. Has no affect on prepended and appended documents
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:25 
 
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 documents 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".
filter:string
 
Only return documents that match the given string filter
has_url:boolean
 
Filter results to only return documents for which has_url exactly matches the specified value.
template:template|templates|guid|string
 
Only return documents with one of these templates
include_in_search:boolean
 
Filter results to only return documents for which include_in_search exactly matches the specified value.
site_domain_guid:guid
 
Filter results to only return documents for which site_domain_guid exactly matches the specified value.
ssl_mode:string
 
Filter results to only return documents for which ssl_mode exactly matches the specified value.
tag:tag|tags|guid|string
 
Only return documents with one of these tags
author:author|authors|guid|string
 
Only return documents with one of these authors
folder:folder|folders|guid|string
 
Only return documents with one of these folders
date_created_start:datetime
 
Filter results to return documents for which date_created is greater than or equal to date_created_start.
date_created_end:datetime
 
Filter results to return documents for which date_created is less than or equal to date_created_end.
start:1
 
Set the 1-based index of the first document to fetch.
page:1
 
Automatically calculate the first document to fetch based on both of the "limit" and the 1-based "page" value. Ignored if "start" is set.
limit:25
 
Defines the maximum number of documents to be fetched. If not included, this will default to 10. Note that if "max_size" is specified then "limit" may be automatically lowered even if specified.
sort_by:"date_created"
 
Specify which field to sort the fetched results by. Has no affect on prepended or appended documents.

By default results will be sorted by relevance if there is a filter string and date_created (the date the item was first published) desc (newest first) if not.

Other Options include:

Name
Title
URL
BrowserTitle
relevance (based on which field matches the given filter and where in the field the match is found. When sorting by relevance sort_direction is irrelevant)
date_created (Equivalent to the date you first published this item. Unpublishing and republishing the item resets date_created to the current date)
random (By default using random sorting prevents fast caching of the page. Setting "cache_random:true" overrides this behavior and allows the page to be fast-cached anyway)
sort_direction:"desc"
 
Specify whether the fetched results should be sorted in asc (ascending) or desc (descending) order.
%}

If you do not include any filters or inputs other than prepended items, appended items, or max_size, then no additional items will be fetched. If you wish to fetch all items you must include at least one additional input (ie: "start:1")

{{ document }}

document Properties

documents Summary

documents Properties

Methods

{% document %}

{% documents %}