Template:Retrieved/doc

This template implements -like behavior regarding online-retrieval information ("Retrieved ..."), especially as it applies in Cite web. It may be used with citation and external link templates that do not provide retrieval information, such as
 * Template:IMDb title
 * Template:Plain link
 * Template:Rotten Tomatoes
 * Template:URL

and others; however, see for recommended exceptions. This template and its documentation make use of guidelines.


 * Example&#58;


 * Generates&#58;

A Brad Pitt statement.

References

Usage


Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Leading and trailing spaces (&#160;) are trimmed from parameter values; therefore, parameters will not display if they are only populated by spaces. Delete unused parameters. See for important details.

Exceptions
This template be used when retrieval information is inapplicable, superfluous, or not recommended, such as in External links or Further reading sections, or with templates such as Official website. Please see WP:ELCITE.

Examples
Some examples may include the current date. If the date is not current, then the page.


 * Generates:
 * Generates:


 * Generates:
 * Generates:


 * Generates:
 * Generates:


 * Generates:
 * Generates:


 * Generates:
 * Generates:


 * Generates:
 * Generates:


 * Generates:
 * Generates:


 * Generates:
 * Generates:


 * Generates:
 * Generates:


 * – sp prepend,
 * Generates:
 * Generates:

Required

 * access-date: This parameter (or its alias accessdate) is required.

Deprecated

 * accessyear: Please use access-date (or accessdate) instead. Using this parameter will add the article to.

Description

 * prepend: Displays first, "Retrieved ...", when populated. It can be used to add leading punctuation and, relevant, information, such as online source format requirements (when not specified elsewhere). Note "Retrieved" always displays capitalized.
 * access-date: Full date source was accessed. Do not wikilink. Not checked for date-formatting errors. May be any one of Wikipedia's acceptable date formats, but please follow the format established in the article’s citations and/or references. Otherwise, please see MOS:DATEUNIFY and Help:Citation Style 1. This parameter is . Alias: accessdate.
 * via: Cites the online provider/publisher of the source’s accessed version. May be wikilinked. Include when different from the source’s original online provider/publisher, or when the version accessed is in a different format from the original.
 * registration or subscription: These parameters add a link note to specify online source has access requirements (WP:PAYWALL). Values display at 90% size, in grey, within parentheses.
 * If the online source requires registration, set y; superseded by subscription if both are set.
 * If the online source requires subscription: set y; supersedes registration if both are set. When this parameter is set, the article will be added to.
 * note: May be used to add a relevant editor comment regarding the link or source, such as embargo information etc. Value displays at 90% size, in grey, within parentheses.
 * append: Value displays by default, as a period (&#160;.&#160;) for trailing punctuation; if you wish to retain the default do not add this parameter, or if already present, delete it. Otherwise, it can be used to replace or remove trailing punctuation, and to add a quote from the source.

TemplateData
{	"params": { "prepend": { "label": "Prepend", "description": "Use it to add leading punctuation; displays before \"Retrieved ...\"", "type": "string" },		"access-date": { "aliases": [ "accessdate" ],			"label": "Source access date", "description": "The full date the source was accessed; do not wikilink", "type": "date", "required": true },		"via": { "label": "Via", "description": "Name of online provider if other than the publisher; also use when accessed version is in different format from the original; may be wikilinked", "type": "string" },		"registration": { "label": "Registration", "description": "For online sources that require registration, set to 'y'; superseded by subscription if both are set", "type": "string" },		"subscription": { "label": "Subscription", "description": "For online sources that require subscription, set to 'y'; supersedes registration if both are set", "type": "string" },		"note": { "label": "Link note", "description": "When required for clarification, add a brief note about the link/online source", "type": "string" },		"append": { "label": "Append", "description": "Trailing punctuation, displays by default, as a period; to remove, use this parameter without a value; to replace, use with desired value", "default": ".", "type": "string" }	},	"description": "This template adds online-retrieval information (\"Retrieved ...\") to external link templates that do not provide such facility.", "paramOrder": [ "prepend", "access-date", "via", "registration", "subscription", "note", "append" ] }