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 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 (). Other types of allowable external links may benefit from use of the template, when such use is appropriate. Please see § Exceptions for recommended exceptions. This template and its documentation make use of Citation Style 1 guidelines, with variations.
- 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
For basic usage the template requires only the date the source was retrieved (|access-date=), which follows the static text "Retrieved". Insert this template right after the prerequisite link-providing template or when appropriate, after any other allowable external link. Ideally, this template's display should immediately follow the external link, allowing for preceding white space as needed (note the editable default for "Retrieved" is to appear capitalized). Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Delete unused parameters. The template uses Citation Style 1 presentation mode as the default; it may optionally use Citation Style 2 mode. Per common practice "link" in this documentation refers to the source's online location and "source" to the source's online content. 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}}. In general, do not use with stable or static external links e.g. links to online archives or repositories (however, it may be used when accessing archive snapshots). Please see WP:EL. The template is intended for sources accessible through live, legitimate external links; remove it when the link is inaccessible or unfit for any reason. See also WP:LR.
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) [info]
{{Retrieved/sandbox |access-info=registration |access-date=2025-01-03}}
. Retrieved 2025-01-03.
Access information (subscription) [info]
{{Retrieved/sandbox |access-info=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.
Source format (image) [info]
{{Retrieved/sandbox |format=[[JPEG]] |access-date=2025-01-03}}
- (JPEG). Retrieved 2025-01-03.
Link comment [info]
{{Retrieved/sandbox |access-date=2025-01-03 |note=brief link note}}
- Retrieved 2025-01-03 (brief link note).
Online provider information [info]
{{Retrieved/sandbox |access-date=2025-01-03 |via=Online Publisher}}
- Retrieved 2025-01-03 – via Online Publisher.
Presentation mode (Citation Style 2) [info]
{{Retrieved/sandbox |access-info=subscription |access-date=2025-01-03 |mode=cs2}}
- , retrieved 2025-01-03
Custom terminal punctuation (semicolon) [info]
{{Retrieved/sandbox |access-date=2025-01-03 |postscript=;}}
- Retrieved 2025-01-03;
No terminal punctuation [info]
{{Retrieved/sandbox |access-date=2025-01-03 |postscript=none}}
- Retrieved 2025-01-03
All parameters except |mode= [info]
{{Retrieved/sandbox |access-info=limited |prepend=. Saved 2025-01-03 |format=[[DWG]] |access-date=2025-01-03 |via=[[Wayback Machine]] |note=[[Snapshot (computer storage)|snapshot]] link |postscript=;}}
- . Saved 2025-01-03 (DWG). Retrieved 2025-01-03 – via Wayback Machine (snapshot link);
All parameters except |postscript= (Citation style 2) [info]
{{Retrieved/sandbox |access-info=limited |prepend=, saved 2025-01-03 |format=[[DWG]] |access-date=2025-01-03 |via=[[Wayback Machine]] |note=[[Snapshot (computer storage)|snapshot]] link |mode=cs2}}
- , saved 2025-01-03 (DWG), retrieved 2025-01-03 – via Wayback Machine (snapshot link)
Parameters
General notes
Depending on parameter usage, the template may display default presentation and formatting elements including static text, leading or trailing white space, and other punctuation.
Parameters should provide retrieval information specific to the accessed version of the source. Do not add an optional parameter if identical information is provided in the source's external link template, full citation, or other reference data (the access date is required regardless of such duplication). However parameter access-info should always be included wherever applicable, as relevant to further user action regarding source retrieval and wikitext verification.
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 basic template usage, insert only this parameter. Enter the full date the external link 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
- access-info: If the online source has access requirements or restrictions, include this parameter to add an indicative inline icon (includes tooltip). Ideally it should display immediately after the external link, preceded by a user-entered or pre-existing non-breaking space positioned before the template code. This parameter displays before the static text "Retrieved" [examples].
|access-info=registration– free registration is required; displays a gray lock icon.|access-info=limited– free access is limited e.g. based on number of views, or is time-limited, or is free only partially; displays the same gray lock icon as registration, but with different tooltip text.|access-info=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 specific to the accessed version, and only if necessary for clarity. This parameter displays before the static text "Retrieved" [example].
- note: Use to add a brief relevant comment specific to the accessed link. Displays (in parentheses) after the access date or parameter via [example].
Additional information: document format, online provider
- format: Use only when the accessed version has special format requirements or is in a different format from the original. Displays within parentheses. May be wikilinked. This parameter displays before the static text "Retrieved" [example].
- via: Use to cite the online provider specific to the source’s accessed version if said provider is different from the original provider or publisher. May be wikilinked. Includes the leading static text "via" preceded by a spaced en dash and followed by a space. Displays after the access date [example].
Display options: presentation mode, terminal punctuation
- mode: Use to change the default Citation Style 1 template presentation mode affecting element separators, terminal punctuation, and certain capitalization. To override default terminal punctuation regardless of mode use postscript [example], [more examples].
|mode=cs2– insert to switch to Citation Style 2 mode: the separator may include white space and/or a non-wrapping comma ( , ) or dash, terminal punctuation is omitted, and the static text "retrieved" is in lowercase.|mode=cs1– enter to switch back to the default Citation Style 1 mode: separating punctuation may include white space, a non-wrapping period ( . ) or a dash, terminal punctuation is a non-wrapping period, and the static text "Retrieved" is capitalized.
- postscript: Use to replace the presentation-mode default terminal punctuation. To remove terminal punctuation altogether, insert
|postscript=none[examples].
With short citations
Short citations (WP:SFN) may include external links as in-source locations and be subject to the same retrieval information requirements that apply to full citations. A full citation's retrieval information may not apply to specific in-source locations; an external link's state and content may vary depending on access date, or specific in-source locations may have different access requirements. This template may be used to complement select short citation-producing templates, e.g. {{harvnb}}. .
- Example:
A wikitext statement.<ref>{{harvnb|AuthorLast|2025|pp=[https://www.example.com 23–24]}}{{nbsp}}{{Retrieved/sandbox |access-info=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.
This example omits a period after {{harvnb}} as the access icon is directly relevant to the template's final visible item.
Error messages
Required access date is missing
{{Retrieved/sandbox |access-info=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; for additional use cases see the template's documentation
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Access information | access-info | Recommended when the source has access restrictions; use one of 'registration', 'subscription' or 'limited' (without the single quote marks), displays a relevant lock icon before "Retrieved" | String | optional |
| Source comment | prepend | Use only when additional citable information specific to the accessed version is needed for clarity; displays before "Retrieved" | String | optional |
| Format | format | Use only if the accessed version is in different format than the original, or has specific format requirements; may be wikilinked, displays before "Retrieved" | String | optional |
| Access date | access-date accessdate | The full date the external link was accessed; do not wikilink | Date | required |
| Online provider | via | Name of the accessed version's online provider if other than the publisher; may be wikilinked | String | optional |
| Link comment | note | When required for clarification, add a brief note specific to the accessed link | String | optional |
| Presentation mode | mode | Presentation mode affecting static text, parameter separators and terminal punctuation. Default is Citation Style 1 mode; use 'cs2' for Citation Style 2, or 'cs1' to switch back to default (ommit the single quote marks) | String | optional |
| Terminal punctuation | postscript | Insert desired value to replace presentation-mode default terminal punctuation; to remove terminal punctuation enter 'none' without the quote marks | String | optional |