Plugins:FeedGeneratorElements

<< Back to Dashboard | << Plugins Viewer

Feed Generator Elements

This entry contains a complete list of all the ColdBox feedGenerator elements available for use. If you are after general information or tutorials on how to use the feedGenerator plug-in please visit the Feed Generator document instead.

Metadata (channel)

Base Elements

These are the bread and butter elements of your feed. They are used to describe and identify your feed.

Element	sub-Element	Type	Required	Description	More
description		string	required	Sentence or paragraph describing the feed	link
link		string	required	The URL to the HTML website corresponding to the feed	link
title		string	required	The name of the feed	link
category		array		Words used for the classification of the feed	link
	domain	string		Taxonomy of the categorization
	tag	string	required	Feed categorization
copyright		string		Feed copyright notice	link
image		struct		A logo or image related to the feed which will be displayed in the feed reader	link
	description	string		Brief description of the image
	link	string	required	URL to go to if the image is clicked
	title	string	required	The name of the image
	url	string	required	Online location of the image
	height	numeric		Image height in pixels
	width	numeric		Image width in pixels
language		string		WC3 or Netscape defined language code	link
lastbuilddate		string		Date and time the feed was last compiled, usually should contain a #now()# CFML function	link
managingeditor		string		E-mail address of the feed editor. An e-mail address must be provided but you can include a name in brackets example: joeblogs@example.com (Joe Blogs)	link
pubdate		string		Date and time the feed in its current form was published	link
webmaster		string		E-mail address of the technical manager of the feed. An e-mail address must be provided but you can include a name in brackets example: joeblogs@example.com (Joe Blogs)	link

Extension Elements

These are metadata (channel) elements that have been included by the use of RSS extensions. You are welcome to use any or all of these elements in your feeds. They will not conflict with any of the RSS base elements and ColdBox will handle all the code requirements behind the scenes.

Element	sub-Element	sub-Element	Type	Required	Description	More
atomselfLink			string		URL pointing to the feed	link
commonslicense			list		List of URLs pointing to the Creative Commons licenses in use by the feed	link
dcmiterm			struct		Dublin Core Metadata Element Set is a collection of 15 broad and generic elements used for resource description	link
	[term]		string		Multiple [term]s are allowed but they must be named one of the following; contributor, coverage, creator, date, description, format, identifier, language, publisher, relation, rights, source, subject, title, type. Please read the element set documentation for more detailed information on the purpose of these terms
itunes			struct		Apple iTunes extension used for media files and podcasts	link
	block		string		If set as 'yes' this element prevents the podcast appearing in the iTunes podcast directory	link
	category		string		Apple iTunes specific categories for the podcast	link
	explicit		string		Indicate whether or not the podcast contains explicit material, must be either 'clean','yes','no'	link
	image		string		URL pointing to the artwork for the podcast	link
	keywords		list		A comma separated list of up to 12 keywords used in podcast searches	link
	new_feed_url		string		URL pointing to the podcast. Only use this element when you need to tell the Apple iTunes Podcast directory to update your URL	link
	owner		struct		Owner or author of the podcast	link
		email	string		Owner's e-mail address
		name	string		Owner's name
	subtitle		string		A short description of the podcast which displays best if it is only a few words long	link
	summary		string		Description of the podcast which can be up to 4000 characters long	link
opensearch			struct		OpenSearch is the collection of simple elements for the purpose of sharing search results	link
	autodiscovery		string		URL to an OpenSearch description document	link
	itemsperpage		numeric		Number of search results returned per page	link
	startindex		numeric		Index of the first search result in the current set of search results	link
	totalresults		numeric		Number of search results available for the current search	link
opensearchQuery			array		OpenSearch Query element can be used to define a specific search request that can be performed by a search client	link
	role		string	required	Query interpretation, must be either 'request','example','related','correction','subset','superset'	link
	title		string		Description of the request
	totalResults		numeric		Expected number of results to be found if the search request were made
	searchTerms		list		Search keywords
	count		numeric		Number of search results per page desired by the search client
	startIndex		numeric		Index of the first search result desired by the search client
	startPage		numeric		Page number of the set of search results desired by the search client
	language		string		Search engine supports search results in the specified language
	inputEncoding		string		Search requests encoded with the specified character encoding
	outputEncoding		string		Search responses encoded with the specified character encoding

Obsolete Elements

The following are also metadata (channel) elements, but these are rarely used and are only supported for completion sake.

Element	sub-Element	Type	Required	Description	More
cloud		struct		A long outdated RSS monitoring service	link
	domain	string	required	URLs of RSS documents that the client seeks to monitor
	path	string	required	Client remote procedure call path
	port	numeric	required	Client TCP port
	protocol	string	required	Online location of the image
	registerProcedure	string	required	Name of the remote procedure the cloud should call
rating		string		PICS rating for the feed	link
skipdays		list		A list of days (represented as English values, Sunday,Monday ...) during the week which the feed is not updated	link
skiphours		list		A list of hours during the day which the feed is not updated	link
textInput		struct		The purpose of this element is not documented but it is meant to enable people to submit text queries using a CGI interface	link
	description	string	required	The purpose of the form
	link	string	required	URL to the CGI script that is handling the query
	name	string	required	The form name
	title	string	required	Labels the form button used to submit the query
ttl		numeric		Number of minutes to cache the data before a feed reader requests it again	link

Items

The following elements are used to display the content and links belonging to the individual items within your feed.

Base Elements

* Each item only requires either a description or a title element.
# Enclosures require all three enclosure elements, but enclosures themselves are not required in a feed item

Element	Type	Required	Description	More
description	string	required*	The item synopsis or the full item content	link
title	string	required*	The name of the item	link
author	string		The e-mail address for the author of the item	link
category_domain	list		A list containing the taxonomy of each individual categorization listed with category_tag	link
category_tag	list		A list of categorizations tagged for the item	link
comments	string		URL to the reader comments page for the item	link
enclosure_length	list	required#	A list containing file attachment sizes, in bytes	link
enclosure_type	list	required#	A list containing file attachment MIME types	link
enclosure_url	list	required#	A list containing URLs pointing to file attachments	link
link	string		URL to the HTML edition of the item	link
guid_string	string		String that uniquely identifies the item	link
guid_permalink	boolean		State whether the unique identifier guid_string is a permanent URL, either 'true','false'	link
pubDate	string		Item published time date	link
source_title	string		Title of the RSS feed where the item has been sourced or reproduced from	link
source_url	string		URL to a RSS feed where the item has been sourced or reproduced from	link

Extension Elements

These are item elements that have been included with the use of RSS extensions. You are welcome to use any or all of these elements in your feeds. They will not conflict with any of the RSS base elements, while ColdBox will handle all the code requirements behind the scene.

Element	Type	Required	Description	More
atomselfLink	string		URL pointing to the item	link
commonslicense	string		List of URLs pointing to the Creative Commons licenses in use by the item	link
content_encoded	string		Used as an alternative to the description element. Text contained in here will be treated as character data, not mark-up	link
dcmiterm_[term]	string		Multiple dcmiterm_[term]s are allowed but they must be named one of the following; contributor, coverage, creator, date, description, format, identifier, language, publisher, relation, rights, source, subject, title, type. Please read the element set documentation for more detailed information on the purpose of these terms	link
itunes_author	string		Author of the podcast episode	link
itunes_block	string		If set as 'yes' this element prevents the podcast episode appearing in the iTunes podcast directory	link
itunes_duration	string		The play time length of the podcast episode	link
itunes_explicit	string		Either 'clean','yes','no'; Used to indicate whether or not the podcast contains explicit material	link
itunes_keywords	list		Up to 12 comma separated, keywords used in podcast episode searches	link
itunes_subtitle	string		Short description of the podcast which displays best if it is only a few words long	link
itunes_summary	string		Description of the podcast which can be up to 4000 characters long	link
slash_comments	numeric		Total number of comments	link
slash_hit_parade	list		A list of the total number of comments for the past 7 days, this element can be ignored	link
slash_department	string		Used by Slashdot for one-liner humour, this element can be ignored	link
slash_section	string		A simplified, single word replacement for category, this element can be ignored	link