Template:Retrieved/sandbox
Retrieved 2025-01-03.
 | This is the template sandbox page for Template:Retrieved (diff). See also the companion subpage for test cases. |
Template documentationThis template implements Citation Style 1 template-like behavior regarding online-retrieval information ("Retrieved ..."), mainly as it is applied in {{Cite web}}. It may be used with citation and external link templates that do not provide retrieval information, such as
and others; it may also be used to complement shortened footnote-producing templates such as {{harvnb}} and similar. Please see § Exceptions for recommended exceptions. This template and its documentation make use of Citation Style 1 guidelines.
- Example:
A [[Brad Pitt]] statement.<ref>{{IMDb name|id=0000093|name=Brad Pitt}}. {{Retrieved/sandbox|access-date=2025-01-03}}</ref>
===References===
{{reflist}}- Generates:
Usage
|
|
Syntax and presentation
Insert right after the pre-requisite link-providing template. Ideally, this template's display should immediately follow the external link, allowing for preceding white space as needed (note the static text "Retrieved" is always capitalized). Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Delete unused parameters. Depending on usage, parameters may display default presentation/formatting elements, including static text, leading or trailing punctuation and/or white space. The template displays a period as the (editable) default, non-wrapping terminal punctuation. In its most basic usage the template requires only the date the source was retrieved (|access-date=). See § Parameters for important details.
Exceptions
This template may not 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:EL.
Examples
Some examples may include the current date. If the date is not current, please the page.
{{Retrieved/sandbox |access-date=2025-01-03}}
- Retrieved 2025-01-03.
Basic usage (MDY) [info]
{{Retrieved/sandbox |access-date=January 3, 2025}}
- Retrieved January 3, 2025.
Access information (registration required) [info]
{{Retrieved/sandbox |link-access=registration |access-date=2025-01-03}}
. Retrieved 2025-01-03.
Access information (subscription required) [info]
{{Retrieved/sandbox |link-access=subscription |access-date=2025-01-03}}
. Retrieved 2025-01-03.
Source comment (version info) [info]
{{Retrieved/sandbox |prepend=Revised |access-date=2025-01-03}}
- Revised. Retrieved 2025-01-03.
Custom terminal punctuation (semicolon) [info]
{{Retrieved/sandbox |access-date=2025-01-03 |append=;}}
- Retrieved 2025-01-03;
No terminal punctuation [info]
{{Retrieved/sandbox |access-date=2025-01-03 |append= }}
- Retrieved 2025-01-03
Source format (image) [info]
{{Retrieved/sandbox |format=[[JPEG]] |access-date=2025-01-03}}
- (JPEG). Retrieved 2025-01-03.
Source provider information [info]
{{Retrieved/sandbox |access-date=2025-01-03 |via=Online Publisher}}
- Retrieved 2025-01-03 – via Online Publisher.
Link comment [info]
{{Retrieved/sandbox |access-date=2025-01-03 |note=brief link note}}
- Retrieved 2025-01-03 (brief link note).
All parameters
{{Retrieved/sandbox |link-access=limited |prepend=(draft) |format=[[DWG]] |access-date=2025-01-03 |via=Online Publisher |note=brief link note |append=;}}
- (draft) (DWG). Retrieved 2025-01-03 – via Online Publisher (brief link note);
Parameters
Parameters link-access, prepend and format, display before the static text "Retrieved". Depending on usage, a non-wrapping period ( . ) followed by a space, may be auto-inserted at the end of their displayed value(s).
Required
The only required parameter is access-date or its alias accessdate.
Description
Access date
- access-date: This parameter (or its alias accessdate) is required – its omission will produce an error message. For the most basic template usage, insert only this parameter. Leading white space is added by default. Enter the full date the 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 [examples].
Access information
- link-access: If the online source has limited access or access requirements, include this parameter to add an indicative link icon (includes tooltip). Ideally it should display immediately after the external link, with {{Retrieved}} preceded by a user-inserted or pre-existing non-breaking space. The parameter displays before the static text "Retrieved" [examples].
|link-access=registration. Free registration is required. Displays a gray lock icon.|link-access=limited. Free access is limited e.g. based on number of views, is time-limited, or is partially free. Displays the same gray lock icon as registration, but with different tooltip text.|link-access=subscription. Paid subscription is required (WP:PAYWALL). Displays a red lock icon. When set, the article will be added to Category:Pages containing links to subscription-only content.
Source comment, link comment
- prepend: Use for additional citable information about the source. Should only be added if necessary for clarity and if the information is not indicated elsewhere. When the parameter link-access is also used, a leading white space is added by default. The parameter displays before the static text "Retrieved" [example].
- note: May be used to add a brief relevant comment regarding the link, such as embargo information etc. The parameter displays a leading space, with the comment text in parentheses, after the access date or parameter via [example].
Additional information: document format, online provider
- format: When the accessible version has special format requirements, or is in a different format from the original, its format may be indicated by this parameter if not specified elsewhere. Displays within parentheses. May be wikilinked. When parameter link-access or prepend is also used, a leading space is added by default. The parameter displays before the static text "Retrieved" [example].
- via: May be used to cite the online provider of the source’s accessed version. May be wikilinked. Includes the leading static text "via" preceded by a spaced en dash and followed by a space. Insert this parameter only when the online provider is not the source’s original provider or publisher. Displays after the access date [example].
Terminal punctuation
- append: Displays by default as a period ( . ) for non-wrapping terminal punctuation; to retain the default do not add this parameter, or if already present, delete it. Otherwise, it may be used to replace or remove terminal punctuation. To remove terminal punctuation, use the parameter without a value [examples].
With short citations
Short citations (WP:SFN) may include external links as in-source locations and may be subject to the same requirement that applies to full citations regarding online retrieval information. A full citation's retrieval information may not apply to specific in-source locations; a dynamic external link's state and content may differ depending on access date, or specific link locations may have different access requirements. This template may be used to complement select short citation-producing templates, e.g. {{harvnb}}. See Template:Harvnb § Adding a URL for the page or location.
- Example:
A wikitext statement.<ref>{{harvnb|AuthorLast|2025|pp=[https://www.example.com 23–24]}}{{nbsp}}{{Retrieved/sandbox |link-access=subscription |access-date=2025-01-03}}</ref>
===Notes===
{{reflist}}
===References===
{{refbegin}}
* {{cite journal |author-last=AuthorLast |date=January 2025 |title=ArticleTitle |journal=JournalName |issue=5 |pages=21–35 |url=https://example.com |url-access=limited |access-date=2025-01-03}}
{{refend}}- Generates:
Notes
- ^ AuthorLast 2025, pp. 23–24 . Retrieved 2025-01-03.
References
- AuthorLast (January 2025). "ArticleTitle". JournalName (5): 21–35. Retrieved 2025-01-03.
Error messages
Required access date is missing
{{Retrieved/sandbox |link-access=subscription |via=Online Publisher}}
- ! Template
{{Retrieved}}: Parameter access-date is required !
- ! Template
See also
TemplateData
TemplateData for Retrieved
This template adds online-retrieval information ("Retrieved ...") to external link templates that do not provide such facility.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Link access requirement | link-access | Recommended when the link has access requirements; displays a lock icon before "Retrieved"
| Line | optional |
| Source comment | prepend | Use only when additional brief citable information about the source is needed; displays before "Retrieved" | String | optional |
| Source format | format | Use if source is in different format than the original, or has format requirements; may be wikilinked, displays before "Retrieved" | String | optional |
| Source access date | access-date accessdate | The full date the source was accessed; do not wikilink | Date | required |
| Via | via | Name of online provider if other than the publisher; may be wikilinked | String | optional |
| Link comment | note | When required for clarification, add a brief note about the external link | String | optional |
| Terminal punctuation | append | Displays by default, as a period; to remove, use this parameter without a value; to replace, use with desired value
| String | optional |