Template:Retrieved/sandbox

Retrieved 2024-12-28⁠.

Template documentation

This 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

Template:IMDb title

Template:Plain link

Template:Rotten Tomatoes

Template:URL

and others; it may also complement shortened footnote-producing templates such as {{harvnb}} and similar (see below). The template may accompany other allowable external links when such usage is appropriate. Its application may assist verifiability, however this template is not a tool for validating wikitext or discovering sources, and is not an alternative to citations of online material. Please see § Exceptions for recommended usage exceptions.

This template and its documentation use Citation Style 1 guidelines, with variations. Per common practice, "link" refers to a source's online location and "source" to its online content. The examples use the current date; if the date is not current the page.

Example:

A [[Brad Pitt]] statement.<ref>{{IMDb name|id=0000093|name=Brad Pitt}}. {{retrieved/sandbox |access-date=2024-12-28}}</ref>

===References===
{{reflist}}

Generates:

A Brad Pitt statement.

References

Usage

Full parameter set in horizontal format

Listed by importance {{retrieved/sandbox |access-date= |access-info= |df= |source-info= |format= |via= |note= |mode= |postscript= |err= |nopun= }} Listed by display order {{retrieved/sandbox |err= |mode= |access-info= |nopun= |source-info= |format= |df= |access-date= |via= |note= |postscript= }}

Syntax and presentation

For basic use, only the full date the source was retrieved is required (|access-date=<fulldate>); it 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.
Depending on the parameters used, default presentation and formatting elements including static text, white space and additional punctuation may be displayed.
All parameter names must be in lowercase; optional parameters are ignored when they are misspelled or unrecognized. Dependent and conditional parameters are ignored if their prerequisite parameter(s) or conditions are absent.
Copy a blank version from the box above to use. Insert 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. The template applies only to wikitext-supporting sources (free or restricted) that are retrievable through working, legitimate external links. See Wikipedia:Link rot.
Additionally, the template should 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). See Wikipedia:External links.

Quickfill examples: basic usage with today's date autoinserted

The examples below autoinsert today's date in full-date acceptable date formats via the available "quickfill" options. Copy and paste the suitable example code to use. For details, see § Access date. Consider adding parameter access-info when applicable.

All-numeric Year-Month-Day (ISO date) [info]

• {{retrieved/sandbox |access-date=ymd}}
• {{retrieved/sandbox |access-date=iso}}

Retrieved 2024-12-28⁠.

Day Month Year [info]

• {{retrieved/sandbox |access-date=dmy}}

Retrieved 28 December 2024⁠.

Month Day, Year [info]

• {{retrieved/sandbox |access-date=mdy}}

Retrieved December 28, 2024⁠.

Day AbbreviatedMonth Year [info]

• {{retrieved/sandbox |access-date=sdmy}}

Retrieved 28 Dec 2024⁠.

AbbreviatedMonth Day, Year [info]

• {{retrieved/sandbox |access-date=smdy}}

Retrieved Dec 28, 2024⁠.

More examples: user-inserted access date, additional options

The examples in this section use the ISO date format (YYYY-MM-DD or Year-Month-Day) to enter access dates; by default they display access dates in the entered format except where stated as "autoformatted" and in the all-parameter example (via parameter df).

Basic usage [info]

• {{retrieved/sandbox |access-date=2024-12-28}}

Retrieved 2024-12-28⁠.

Basic usage with autoformatted access date display (dmy) [info]

• {{retrieved/sandbox |access-date=2024-12-28 |df=dmy}}

Retrieved 28 December 2024⁠.

Access information (registration) [info]

• {{retrieved/sandbox |access-info=registration |access-date=2024-12-28}}

⁠. Retrieved 2024-12-28⁠.

Source information (version) [info]

• {{retrieved/sandbox |source-info=Revised |access-date=2024-12-28}}

Revised⁠. Retrieved 2024-12-28⁠.

Source format (image) [info]

• {{retrieved/sandbox |format=[[JPEG]] |access-date=2024-12-28}}

(JPEG)⁠. Retrieved 2024-12-28⁠.

Online provider information [info]

• {{retrieved/sandbox |access-date=2024-12-28 |via=[[OnlinePublisherName]]}}

Retrieved 2024-12-28 – via OnlinePublisherName⁠.

Link note [info]

• {{retrieved/sandbox |access-date=2024-12-28 |note=brief link note}}

Retrieved 2024-12-28 (brief link note)⁠.

No terminal punctuation [info]

• {{retrieved/sandbox |access-date=2024-12-28 |postscript=none}}

Retrieved 2024-12-28

Optional presentation mode (Citation Style 2) [info]

• {{retrieved/sandbox |access-info=registration |source-info=revised |format=[[JPEG]] |access-date=2024-12-28 |via=[[OnlinePublisherName]] |note=brief link note |mode=cs2}}

⁠, revised (JPEG)⁠, retrieved 2024-12-28 – via OnlinePublisherName (brief link note)⁠

All parameters

• {{retrieved/sandbox |access-info=registration |nopun=y |source-info=(revised) |format=[[JPEG]] |access-date=2024-12-28 |df=dmy |via=[[OnlinePublisherName]] |note=brief link note |mode=cs2 |postscript=; |err=y}}

(revised) (JPEG)⁠, retrieved 28 December 2024 – via OnlinePublisherName (brief link note)⁠;

Parameters

General notes

Dependent parameters and parameter options are described under their prerequisite parameters. Parameter options must be entered in lowercase.
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, 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 parameter descriptions below, and § Errors and error messages.

Requirements and constraints

• Parameter access-date or its alias accessdate is required.
• Parameter df (access date autoformat) is ignored when the access date is "quickfilled".
• Parameter nopun (specific punctuation instance) is dependent on parameter source-info.

Description

Access date

See also: Help:Citation Style 1 § Access date and Template:Cite web § Date

• access-date: This parameter (or its alias accessdate) is required – its omission or incorrect entry will result in an error message and will suppress all other template output. For basic usage include just this parameter; autoinsert today's date or manually enter a full date. Either case requires a date when the external link (a) was successfully accessed and (b) targeted content supporting the related wikitext. Do not wikilink. Displays after the static text "Retrieved". Except in the all-numeric Year-Month-Day (YYYY-MM-DD) format, days should be entered without zero-padding (i.e. 8 November 2024 instead of 08 November 2024); zero-padded days and months are required in the all-numeric format. Use any one of Wikipedia's full-date acceptable date formats, but please select the acceptable format (if any) established in the edited page's citations or references (WP:DATEUNIFY). The ancillary optional parameter df may be added to autoformat the display of manually entered access dates

Autoinsert today's date: Enter one of the "quickfill" options [examples]

• |access-date=ymd or |access-date=iso – displays as the all-numeric Year-Month-Day (YYYY-MM-DD or ISO date).
• |access-date=dmy – displays as Day Month Year.
• |access-date=mdy – displays as Month Day, Year.
• |access-date=sdmy – displays as Day Month Year but with "short" (abbreviated) month name.
• |access-date=smdy – displays as Month Day, Year but with "short" (abbreviated) month name.

Manually insert a date: Enter a full date [examples]

• Partial access dates (missing any of day, month or four-digit year) are strongly discouraged; they produce inaccurate access date display, or suppress it with an error message.
• Access dates that do not conform to one of the allowed full-date formats (also described in the quickfill options list) will generate an error message.
• Tomorrow's date will display as access date without error; access dates that are 2 or more days in the future will result in an error message instead.⁠
• Some formatting errors may be avoided by using the recommended parameter df.

Access information

See also: Template:Cite web § Subscription or registration required

• 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); see applicability detail in § General notes above. This parameter's value displays first, before any other normal template output. Ideally it should display immediately after the external link and a non-breaking space. Invalid options will silently suppress the inline icon/tooltip; if error-handling parameter err is used an error message will be displayed; [example]

Options:

• |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 information, link note

• source-info: Use for additional citable information specific to the retrieved version of the source, only if necessary for clarity. Displays after the output of parameter access-info if it exists, or first if it doesn't; [example]
  • nopun: source-info-dependent parameter. Set |nopun=y (any other input is ignored). Removes the default presentation mode punctuation autoinserted between the outputs of parameters access-info and source-info, leaving a single space as their separator; [example].

• note: Use to add a brief relevant note specific to the accessed link. May be wikilinked. Displays in parentheses after the access date, or the output of parameter via if it exists; [example].

Additional information: source format, online provider

See also: Help:Citation Style 1 § External links and Template:Cite web § Publisher

• format: Use only when the retrieved version has special format requirements or is in a different format from the original. May be wikilinked. Displays within parentheses, before the static text "Retrieved"; [example].

• via: Use to cite the online provider of the source’s accessed version if other than the original provider or publisher. May be wikilinked. The parameter's output 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

See also: Template:Cite web §§ Date​ and Display options

• df: Use this parameter to autoformat the output of parameter access-date. Works only when the access date is manually entered. Will correctly display it in a full-date acceptable date format according to the options below (partial dates are not supported). When the access date is quickfilled this parameter is silently ignored; it is also silently ignored when an invalid option is used. Both cases prevent autoformatting; if error-handling parameter err is included, relevant error messages will be displayed. Use of df is recommended when applicable – please follow any acceptable date-display format established in the edited page’s citations and/or references (WP:DATEUNIFY); [example]

Options: |df= options are identical to parameter access-date "quickfill" options in name and function (see there for descriptions)

• [ ymd/iso | dmy | mdy | sdmy | smdy ]

Note: Parameter df affects the output of parameter access-date; ambiguous input in access-date – such as a partial date – may be misinterpreted, producing unintended results.

• mode: Use to change the template presentation mode, which determines autoinserted element separators, terminal punctuation and certain capitalization; the default is Citation Style 1 mode. Invalid options silently suppress mode-related punctuation; 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 parameter postscript; [example]

Options:

• |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 all-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.

Note: Depending on other included parameters, mode's effect may display first, either as an error message or in the initial-letter case of "Retrieved".

• postscript: Use to replace the presentation mode's default terminal punctuation; insert desired value, or set |postscript=none to remove terminal punctuation altogether; [example].

Error message handling

• err: Set |err=y (any other input is ignored) to display all error messages produced by optional-parameter errors. Handling of individual or per-parameter errors is not supported. Depending on the parameter(s) in error, using err may cause the relevant error message(s) to display before any other template output. See also § Errors and error messages; [examples].

Use case: 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. 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 (via {{nbsp}}) to provide continuity and context to the output of {{retrieved}}.

Example:

A wikitext statement.<ref>{{harvnb|AuthorLast|2024|pp=[https://www.example.com 23–24]}}{{nbsp}}{{retrieved/sandbox |access-info=subscription |access-date=2024-12-28}}</ref>

===Notes===
{{reflist}}

===References===
{{refbegin}}
* {{cite journal |author-last=AuthorLast |date=December 2024 |title=ArticleTitle |journal=JournalName |issue=5 |pages=21–35 |url=https://example.com |url-access=limited |access-date=2024-12-28}}
{{refend}}

Generates:

A wikitext statement.

Notes

References

• AuthorLast (December 2024). "ArticleTitle". JournalName (5): 21–35. Retrieved 2024-12-28.

Errors and error messages

Error messages generated by access date-related errors are always displayed, and the edited page is added to Category:Template Retrieved errors. If parameter access-date/accessdate is absent, mislabeled, or empty the error is fatal and will suppress all other template output.
Errors related to optional parameters are silent by default; parameter err may be used to display error messages for parameters access-info, df and mode. No messages are generated by parameter nopun and err errors. The remaining optional parameters have no defined error state.
Error conditions and/or error messages may suppress display of related template elements.
There is no error handling for individual optional parameters; error messages display for all message-enabled optional parameters, or none.

Examples

Examples involving optional-parameter errors use the all-parameters example from § More examples above.

Access date information is missing or not entered correctly (parameter name)

• {{retrieved/sandbox |access-info=subscription |date=2024-12-28 |via=OnlinePublisherName}}
  

! {{retrieved}}: Parameter access-date/accessdate is missing or is incorrectly entered [⁠info⁠] !

Access date format is not valid (missing punctuation)

• {{retrieved/sandbox |access-info=subscription |access-date=Dec 28 2024 |via=OnlinePublisherName}}
  

⁠. Retrieved Dec 28 2024 ! {{retrieved}}: Access date format is invalid [⁠info⁠] ! – via OnlinePublisherName⁠.

Access date is partial or incorrect

• {{retrieved/sandbox |access-info=subscription |access-date=12-2024 |via=OnlinePublisherName}}
  

⁠. Retrieved ! {{retrieved}}: Partial or incorrect access date [⁠info⁠] ! – via OnlinePublisherName⁠.

Access date is beyond tomorrow's date

• {{retrieved/sandbox |access-info=subscription |access-date=2024-12-30 |via=OnlinePublisherName}}
  

⁠. Retrieved ! {{retrieved}}: Invalid future access date [⁠info⁠] ! – via OnlinePublisherName⁠.

Access information option not valid

• {{retrieved/sandbox |access-info=free |nopun=y |source-info=(revised) |format=[[JPEG]] |access-date=2024-12-28 |df=dmy |via=[[OnlinePublisherName]] |note=brief link note |mode=cs2 |postscript=;}}

(revised) (JPEG)⁠, retrieved 28 December 2024 – via OnlinePublisherName (brief link note)⁠;

Access information option not valid, and error messages on

• {{retrieved/sandbox |access-info=free |nopun=y |source-info=(revised) |format=[[JPEG]] |access-date=2024-12-28 |df=dmy |via=[[OnlinePublisherName]] |note=brief link note |mode=cs2 |postscript=; |err=y}}

! {{retrieved}}: Parameter access-info – option not valid [⁠info⁠] ! (revised) (JPEG)⁠, retrieved 28 December 2024 – via OnlinePublisherName (brief link note)⁠;

Access date autoformatting is superfluous, and error messages on

• {{retrieved/sandbox |access-info=registration |nopun=y |source-info=(revised) |format=[[JPEG]] |access-date=iso |df=dmy |via=[[OnlinePublisherName]] |note=brief link note |mode=cs2 |postscript=; |err=y}}

(revised) (JPEG)⁠, retrieved 2024-12-28 ! {{retrieved}}: Parameter df – superfluous use (autoinserted access date) [⁠info⁠] ! – via OnlinePublisherName (brief link note)⁠;

Access date autoformatting option not valid, and error messages on

• {{retrieved/sandbox |access-info=registration |nopun=y |source-info=(revised) |format=[[JPEG]] |access-date=2024-12-28 |df=US |via=[[OnlinePublisherName]] |note=brief link note |mode=cs2 |postscript=; |err=y}}

(revised) (JPEG)⁠, retrieved 2024-12-28 ! {{retrieved}}: Parameter df – option not valid [⁠info⁠] ! – via OnlinePublisherName (brief link note)⁠;

Presentation mode option not valid, and error messages on

• {{retrieved/sandbox |access-info=registration |nopun=y |source-info=(revised) |format=[[JPEG]] |access-date=2024-12-28 |df=dmy |via=[[OnlinePublisherName]] |note=brief link note |mode=cs |postscript=; |err=y}}

(revised) (JPEG)⁠ ! {{retrieved}}: Parameter mode – option not valid [⁠info⁠] ! 28 December 2024 – via OnlinePublisherName (brief link note)⁠;

See also

• Template:Access-date – a wrapper of this template, quickly provides only the access date and accepts the quickfill options
• Template:Dead link – a maintenance template for dead or inaccessible links

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Retrieved in articles based on its 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 and details see the template's documentation. Parameters listed by order of importance

Template parameters[Edit template data]

Parameter		Description	Type	Status
Access date	access-date accessdate	The full date the external link (a) was successfully accessed, and (b) targeted relevant wikitext-supporting content. Do not wikilink. To autoinsert today's date enter a quickfill option (all-lowercase): '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). Otherwise enter a full date, displays as entered; 'Access date format' may be used to autoformat the entered date	Date	required
Access information	access-info	Recommended when the source has access restrictions. Select the relevant list option; it displays first, as a related lock icon Suggested values registration limited subscription	Content	optional
Access date format	df	Access date display-autoformat options for manually entered dates; they are identical to 'Access date' quickfill options in name and function. Deselect this parameter when using autoinserted access dates; recommended otherwise. Select one of the list options Suggested values ymd iso dmy mdy sdmy smdy	String	suggested
Source information	source-info	Use only when additional citable information specific to the retrieved version is needed for clarity; displays after 'Access information' if it exists, or first if it doesn't	String	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 in parentheses before "Retrieved"	String	optional
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 note	note	When required for clarification, add a brief note specific to the accessed link, may be wikilinked; displays in parentheses after the access date (or 'Online provider' if it exists)	String	optional
Presentation mode	mode	Presentation mode affecting static text, parameter separators and terminal punctuation. Default is Citation Style 1 mode; from the list, select 'cs2' for Citation Style 2, or 'cs1' to switch back to, or to explicitly state the default Suggested values cs2 cs1	String	optional
Terminal punctuation	postscript	Insert desired value to replace the presentation mode's default terminal punctuation, which is either a period (mode 'cs1') or nothing (mode 'cs2'); to remove terminal punctuation altogether enter 'none' without the quote marks	String	optional
Error message display	err	Displays all error messages related to non-required parameters; may suppress display of error-related template elements. Preset to 'y' (true). Deselect this parameter if not desired Auto value y	Boolean	optional
Source info punctuation	nopun	When applicable, use to suppress the autoinserted punctuation (but not the space) between 'Access information' and 'Source information'. Requires 'Source information'. Preset to 'y' (true). Deselect this parameter if not desired Auto value y	Boolean	optional

Footnotes

The above documentation is transcluded from Template:Retrieved/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Subpages of this template.