Template:Retrieved/sandbox

Retrieved 12 September 2024.

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 be used to complement shortened footnote-producing templates such as {{harvnb}} and similar (see below). 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. Per common practice "link" in this documentation refers to the source's online location and "source" to the source's online content.

Example:

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

===References===

{{reflist}}

Generates:

A Brad Pitt statement.

References

Usage

Full parameter set in horizontal format

{{retrieved/sandbox |access-info= |prepend= |format= |access-date= |df= |via= |note= |mode= |postscript= }}

Syntax and presentation

For basic usage the template requires only the date the source was retrieved (|access-date=), which displays in the editable default format Day Month Year after 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. See § Parameters for important details.

Exceptions

This template is intended for wikitext-supporting content accessible through relevant, live, legitimate external links; do not use (or optionally remove) when the link is inaccessible or unfit for any reason. See also WP:LR.

The 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.

Examples

Some examples may include the current date. If the date is not current, please the page. The examples below use the optional ISO (ymd) date format for the access date; unless otherwise stated, they also display in this format instead of the default dmy format.

Basic usage with default date format (dmy) [info]

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

Retrieved 12 September 2024.

Basic usage with optional date format (ISO/ymd date) [info]

• {{retrieved/sandbox |access-date=2024-09-12 |df=ymd}}

Retrieved 2024-09-12.

Basic usage with optional date format ("short" mdy) [info]

• {{retrieved/sandbox |access-date=2024-09-12 |df=smdy}}

Retrieved Sep 12, 2024.

Access information (registration) [info]

• {{retrieved/sandbox |access-info=registration |access-date=2024-09-12 |df=iso}}

. Retrieved 2024-09-12.

Access information (subscription) [info]

• {{retrieved/sandbox |access-info=subscription |access-date=2024-09-12 |df=ymd}}

. Retrieved 2024-09-12.

Source comment (version info, with default date format) [info]

• {{retrieved/sandbox |prepend=Revised |access-date=2024-09-12}}

Revised. Retrieved 12 September 2024.

Source format (image) [info]

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

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

Online provider information [info]

• {{retrieved/sandbox |access-date=2024-09-12 |df=ymd |via=Online Publisher}}

Retrieved 2024-09-12 – via Online Publisher.

Link comment [info]

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

Retrieved 2024-09-12 (brief link note).

Custom terminal punctuation (semicolon) [info]

• {{retrieved/sandbox |access-date=2024-09-12 |df=ymd |postscript=;}}

Retrieved 2024-09-12⁠;

No terminal punctuation [info]

• {{retrieved/sandbox |access-date=2024-09-12 |df=ymd |postscript=none}}

Retrieved 2024-09-12

All parameters (Citation Style 1, stated) [info]

• {{retrieved/sandbox |access-info=limited |prepend=. Saved 2024-09-12 |format=[[DWG]] |access-date=2024-09-12 |df=ymd |via=[[Wayback Machine]] |note=[[Snapshot (computer storage)|snapshot]] link |mode=cs1 |postscript=none}}

. Saved 2024-09-12 (DWG)⁠. Retrieved 2024-09-12 – via Wayback Machine (snapshot link)

All parameters (Citation Style 2, default date format stated) [info]

• {{retrieved/sandbox |access-info=limited |prepend=, saved 2024-09-12 |format=[[DWG]] |access-date=2024-09-12 |df=dmy |via=[[Wayback Machine]] |note=[[Snapshot (computer storage)|snapshot]] link |mode=cs2 |postscript=;}}

, saved 2024-09-12 (DWG)⁠, retrieved 12 September 2024 – 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 duplication). However parameter access-info should always be included wherever applicable, as it is relevant to user decisions regarding the source's retrieval.

Required

The only required parameter is access-date or its alias accessdate.

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 will produce an error message. For basic template usage, insert only this parameter. Enter the full date the external link was: (a) successfully accessed and (b) correctly targeted content supporting the related wikitext. Do not wikilink. Displays after the static text "Retrieved". The default, editable date format (per Citation Style 1) is Day Month Year (dmy), but please follow the format established in the article’s citations and/or references, if any. To select a different date format use parameter df (date format). See also WP:DATE and WP:DATEUNIFY [examples]
  • Incomplete access dates (e.g. missing the day or the month) may produce inaccurate date display or errors.
  • When the entered access date's timestamp (00:00:00 UTC) is later than the largest positive UTC offset date-timestamp (DTS UTC+14 hours) an error message will be produced (note however that up to tomorrow's date may be entered without error).

Access information

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

• 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" (see also § General notes) [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: source format, online provider

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

• 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: date format, presentation mode, terminal punctuation

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

• df: Use to change the default Citation Style 1 access date format Day Month Year used by access-date [examples], [more examples]
  • |df=ymd or |df=iso – insert to switch to numeric year-month-date (ISO date) format.
  • |df=mdy – insert to switch to Month Day, Year format.
  • |df=smdy – insert to switch to Month Day, Year format but with "short" (abbreviated) month name.
  • |df=dmy – the default access date format (Day Month Year).
  • |df=sdmy – the default access date format (Day Month Year) but with "short" (abbreviated) month name.

• 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 [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 – the default presentation mode; enter to switch back to Citation Style 1 mode: the separator may include white space and/or a non-wrapping period ( . ) or 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}}. See Template:Harvnb § Adding a URL for the page or location.

Example:

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

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


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

{{refend}}

Generates:

A wikitext statement.

Notes

References

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

In this example {{harvnb}} is followed by a non-breaking space, to provide the correct display and context relative to the output of {{retrieved}}.

Error messages

Access date is missing

• {{retrieved/sandbox |access-info=subscription |via=Online Publisher}}
  

! Template {{retrieved}}: Parameter access-date is required !

Access date too far in the future

• {{retrieved/sandbox |access-info=subscription |access-date=2024-09-14 |df=ymd |note=brief link note}}
  

. Retrieved ! Invalid access date ({{retrieved}}) [info] ! (brief link note).

See also

• Template:Dead link

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 see the template's documentation

Template parameters[Edit template data]

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
Source 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 (a) successfully accessed, and (b) targeted the relevant wikitext-supporting online content; displays as Day Month Year (dmy). See 'Access date format' for date display options; do not wikilink	Date	required
Access date format	df	Optional access date display format, default is 'dmy' (Day Month Year); use 'ymd' or 'iso' for numeric year-month-date, 'mdy' for Month Day, Year, 'smdy' for Month Day, Year with abbreviated month name, 'sdmy' for Day Month Year with abbreviated month name (omit the single quote marks)	String	optional
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

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.