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 (). The template may accompany other allowable external links when such usage is appropriate. Please see § Exceptions for recommended usage exceptions. This template and its documentation make use of Citation Style 1 guidelines, with variations. Per common practice, "link" refers to a source's online location and "source" to its online content.
Note: All examples in this documentation use this page's current timestamp to autoformat dates. Tomorrow's date may temporarily display as a result, depending on the local timezone, time of day and Wikipedia system settings. To apply the current timestamp manually, the page. See also below.
- 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 full date the source was retrieved (|access-date=<fulldate>) which displays after the static text "Retrieved" (see § Access date).
Insert this template next to the prerequisite external link-providing template or when appropriate, after any other allowable external link. Ideally, this template's output 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; optional parameters will be ignored when their names are misspelled or unrecognized. Dependent parameters are ignored if the prerequisite parameter is not used. 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. The template provides limited error handling options.
See § Parameters for important details.
Exceptions
Do not use this template when either the link or the source is inaccessible or unfit for any reason. Use only with wikitext-supporting sources (free or restricted) that are retrievable through working, legitimate external links. See Wikipedia:Link rot.
The template should also 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 online archive snapshots). Please see Wikipedia:External links.
Examples
The examples in this section use the ISO date format (YYYY-MM-DD or Year-Month-Day) to enter access dates; per the template default they display access dates in the entered format, except where otherwise stated as "autoformatted" or in the all-parameter example (by employing parameter df). See also Note above.
Basic usage [info]
{{retrieved/sandbox |access-date=2025-01-03}}
- Retrieved 2025-01-03.
Basic usage with autoformatted access date display (dmy) [info]
{{retrieved/sandbox |access-date=2025-01-03 |df=dmy}}
- Retrieved 3 January 2025.
Basic usage with autoformatted access date display ("short" mdy) [info]
{{retrieved/sandbox |access-date=2025-01-03 |df=smdy}}
- Retrieved Jan 3, 2025.
Access information (registration) [info]
{{retrieved/sandbox |access-info=registration |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.
Online provider information [info]
{{retrieved/sandbox |access-date=2025-01-03 |via=OnlinePublisherName}}
- Retrieved 2025-01-03 – via OnlinePublisherName.
Link comment [info]
{{retrieved/sandbox |access-date=2025-01-03 |note=brief link note}}
- Retrieved 2025-01-03 (brief link note).
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
Optional presentation mode (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=archive [[Snapshot (computer storage)|snapshot]] link |mode=cs2}}
- , saved 2025-01-03 (DWG), retrieved 2025-01-03 – via Wayback Machine (archive snapshot link)
All parameters
{{retrieved/sandbox |access-info=limited |nopun=y |prepend=(saved 3-January-2025) |format=[[DWG]] |access-date=2025-01-03 |df=dmy |via=[[Wayback Machine]] |note=archive [[Snapshot (computer storage)|snapshot]] link |mode=cs2 |postscript=;}}
- (saved 3-January-2025) (DWG), retrieved 3 January 2025 – via Wayback Machine (archive snapshot link);
Parameters
General notes
Depending on parameter usage, the template's output may display default presentation and formatting elements including static text, white space and additional punctuation.
Dependent parameters are described under their prerequisite parameters, as are parameter options.
Parameters should provide information specific to the retrieved version of the source or to the specific access link. 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 duplication). However, always include parameter access-info wherever applicable, as it is relevant to reader decisions regarding retrieval.
Incorrect usage of some parameters may suppress display of related template elements; see descriptions below, and § Error messages.
Required
The only required parameter is access-date or its alias accessdate.
Dependent
The parameter nopun requires use of parameter prepend.
Description
Access date
- access-date: This parameter (or its alias accessdate) is required – its omission or incorrect entry will produce an error message and will suppress all other template output. For basic usage, insert only this parameter. Enter the full date the external link: (a) was successfully accessed and (b) correctly targeted content supporting the related wikitext. Do not wikilink. When used correctly it will display as entered, after the static text "Retrieved". Use any one of Wikipedia's full-date acceptable date formats but please follow the format, if any, established in the article’s citations and/or references (WP:DATEUNIFY). The ancillary optional parameter df may be added to correctly autoformat display of the access date; [examples]
- Partial access dates (missing any of day, month or four-digit year) are strongly discouraged; they will produce inaccurate access date display or will suppress it with an error message.
- Access dates that do not conform to full-date acceptable date formats will produce an error. See following point.
- Some formatting errors may be avoided by using the recommended parameter df; there are caveats, see Note below.
- Tomorrow's date will display as access date without error; access dates further in the future will display an error message instead of the access date.
Access information
- access-info: If the online source has access requirements or restrictions, use one of the options below to add an indicative inline icon (includes tooltip). Ideally it should display immediately after the external link, and a user-entered or pre-existing non-breaking space, positioned before the template code. This parameter displays first, before any other output. Invalid options will silently suppress the inline icon; if error-handling parameter err is used a related error message will be displayed. See also § General notes; [example]
|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 only partially free; 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 edited page 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 retrieved version, only if necessary for clarity. This parameter may display first, or after the parameter access-info; [example].
- nopun: prepend-dependent parameter. Set
|nopun=y, any other input is ignored. Removes the default presentation mode punctuation autoinserted between access-info and prepend, leaving a single space as separator; [example].
- nopun: prepend-dependent parameter. Set
- note: Use to add a brief relevant comment specific to the accessed link. May be wikilinked. Displays in parentheses after the access date or parameter via; [example].
Additional information: source format, online provider
- format: Use only when the retrieved 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 of the source’s specific accessed version if other than 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: date format, presentation mode, terminal punctuation
- df: This recommended parameter autoformats the display of access-date, irrespective of the way it is entered by the user. Will correctly display the access date in one of the full-date acceptable date formats depending on the options below (partial dates are not supported). Invalid options are silently ignored and will prevent autoformatting; if error-handling parameter err is used a related error message will be displayed. Except in the all-numeric Year-Month-Day (YYYY-MM-DD) option, days display without zero-padding (i.e. 8 December 2024 instead of 08 December 2024). Please follow the display format, if any, established in the article’s citations and/or references (WP:DATEUNIFY); [examples]
|df=ymdor|df=iso– displays as the all-numeric Year-Month-Day (YYYY-MM-DD or ISO date).|df=dmy– displays as Day Month Year.|df=sdmy– displays as Day Month Year but with "short" (abbreviated) month name.|df=mdy– displays as Month Day, Year.|df=smdy– displays as Month Day, Year but with "short" (abbreviated) month name.
- Note: Parameter df formats the output (display) of access-date, not its input. Ambiguous input such as partial access dates may be misinterpreted; because of mediawiki software defaults, a partial access date may display as the current full date.
- mode: Use to change the template presentation mode, affecting autoinserted element separators, terminal punctuation and certain capitalization; the default is Citation Style 1 mode. Invalid options silently suppress all presentation elements except static text; if error-handling parameter err is used, the static text "Retrieved" will also be suppressed and an error message will be displayed. To override default terminal punctuation regardless of mode use postscript; [example]
|mode=cs2– insert to switch to Citation Style 2 mode: the separator may include white space and/or a non-wrapping comma ( , ) or en dash ( – ), terminal punctuation is omitted, and the static text "retrieved" is in lowercase.|mode=cs1– the default presentation mode; enter to explicitly state, or to switch back to, the Citation Style 1 mode: the separator may include white space and/or a non-wrapping period ( . ) or en dash, terminal punctuation is a non-wrapping period, and the static text "Retrieved" is capitalized.
- postscript: Use to replace the presentation mode's default terminal punctuation; insert
|postscript=noneto remove terminal punctuation altogether; [examples].
Error message handling
- err: Set
|err=yto display all error messages produced by optional parameters. Any other input is ignored. Handling of individual or single-parameter error messages is not supported. See § Error messages; [examples].
With short citations
Short citations (WP:SFN) may include external links as in-source locations and be subject to the same retrieval information guidelines applying to full citations.[a] 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.
In the example below, {{harvnb}} output is followed by a non-breaking space to provide continuity and context to the output of {{retrieved}}.
- 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.
- ^ The full citation's retrieval information may not apply to short citations. Specific in-source locations may have different access and/or retrieval requirements. Depending on either the full or short citation's access date, the state of external links or of the source's content and relevance may vary.
Error messages
Error messages generated by access date-related errors are always displayed. Absent or incorrectly entered access date is fatal, and will suppress all other template output.
Errors related to optional parameters are silent (not displayed) by default; they may be shown by using parameter err. Display of optional parameter error messages may suppress related template elements.
There is no error handling for individual parameters; error messages display for all optional parameters, or none.
Examples
Examples involving optional parameter errors use the all-parameters example from the correct examples section above.
Access date information is missing or not entered correctly (parameter name)
{{retrieved/sandbox |access-info=subscription |date=2025-01-03 |via=OnlinePublisherName}}
Access date format is not valid (missing punctuation)
{{retrieved/sandbox |access-info=subscription |access-date=Jan 3 2025 |via=OnlinePublisherName}}
Access date is partial or incorrect
{{retrieved/sandbox |access-info=subscription |access-date=01-2025 |via=OnlinePublisherName}}
Access date is beyond tomorrow's date
{{retrieved/sandbox |access-info=subscription |access-date=2025-01-05 |via=OnlinePublisherName}}
Access information option not valid
{{retrieved/sandbox |access-info=free |nopun=y |prepend=(saved 3-January-2025) |format=[[DWG]] |access-date=2025-01-03 |df=dmy |via=[[Wayback Machine]] |note=archive [[Snapshot (computer storage)|snapshot]] link |mode=cs2 |postscript=;}}
- (saved 3-January-2025) (DWG), retrieved 3 January 2025 – via Wayback Machine (archive snapshot link);
Access information option not valid, and error messages on
{{retrieved/sandbox |access-info=free |nopun=y |prepend=(saved 3-January-2025) |format=[[DWG]] |access-date=2025-01-03 |df=dmy |via=[[Wayback Machine]] |note=archive [[Snapshot (computer storage)|snapshot]] link |mode=cs2 |postscript=; |err=y}}
- !
{{retrieved}}: Parameter access-info – option not valid [info] ! (saved 3-January-2025) (DWG), retrieved 3 January 2025 – via Wayback Machine (archive snapshot link);
- !
Access date display option not valid, and error messages on
{{retrieved/sandbox |access-info=registration |nopun=y |prepend=(saved 3-January-2025) |format=[[DWG]] |access-date=2025-01-03 |df=US |via=[[Wayback Machine]] |note=archive [[Snapshot (computer storage)|snapshot]] link |mode=cs2 |postscript=; |err=y}}
- (saved 3-January-2025) (DWG), retrieved 2025-01-03 !
{{retrieved}}: Parameter df – option not valid [info] ! – via Wayback Machine (archive snapshot link);
Presentation mode option not valid, and error messages on
{{retrieved/sandbox |access-info=limited |nopun=y |prepend=(saved 3-January-2025) |format=[[DWG]] |access-date=2025-01-03 |df=ymd |via=[[Wayback Machine]] |note=archive [[Snapshot (computer storage)|snapshot]] link |mode=cs |postscript=; |err=y}}
- (saved 3-January-2025) (DWG) !
{{retrieved}}: Parameter mode – option not valid [info] ! 3 January 2025 – via Wayback Machine (archive snapshot link);
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 first, as related lock icon | String | optional |
| Source comment | prepend | Use only when additional citable information specific to the retrieved version is needed for clarity; displays first, or after 'Access information' | String | optional |
| Source comment option | nopun | Use to suppress the autoinserted punctuation before the source comment - set to 'y' (no quote marks); requires 'Source comment'
| Boolean | optional |
| Source format | format | Use only if the retrieved 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 (a) was successfully accessed, and (b) targeted relevant wikitext-supporting content. Displays as entered; do not wikilink. Use 'Access date format' to autoformat the entered date in allowable display options | Date | required |
| Access date format | df | Allowable access date display options; use 'ymd' or 'iso' for all-numeric Year-Month-Day; 'dmy' for Day Month Year; 'mdy' for Month Day, Year; 'sdmy' for Day Month Year with abbreviated month name; 'smdy' for Month Day, Year with abbreviated month name (omit the single quote marks) | String | suggested |
| Online provider | via | Name of the accessed version's online provider if other than the publisher; may be wikilinked, displays after the access date | String | optional |
| Link comment | note | When required for clarification, add a brief note specific to the accessed link, may be wikilinked; displays after the access date (or 'Online provider' if used) | 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 or to explicitly state the default (ommit the single quote marks) | String | optional |
| Terminal punctuation | postscript | Insert desired value to replace the presentation mode's default terminal punctuation; to remove terminal punctuation enter 'none' without the quote marks | String | optional |
| Error message display | err | Displays all error messages related to non-required parameters when set to 'y' (without quote marks); may suppress display of error-related template elements
| Boolean | optional |