Template:Retrieved/doc

This template implements Cat:Citation Style 1 templates-like behavior regarding online-retrieval information ("Retrieved ..."), especially as it applies 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; however, see Template:Slink for recommended exceptions. This template and its documentation make use of 引文格式1 guidelines.

Example:

A [[Brad Pitt]] statement.<ref>{{IMDb name|id=0000093|name=Brad Pitt}}. {{Retrieved|access-date=2024-11-11}}</ref>

===References===

{{Reflist}}

Generates:

A Brad Pitt statement.

References

Usage

{{Retrieved|prepend= |access-date= |via= |registration= |subscription= |note= |append= }}

|}

Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Leading and trailing spaces ( ) are trimmed from parameter values; therefore, parameters will not display if they are only populated by spaces. Delete unused parameters. See Template:Slink 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:ELCITE.

Examples

Some examples may include the current date. If the date is not current, then the page.

Today's date (ISO)

• {{Retrieved|access-date=2024-11-11}}

Generates: 喺 2024-11-11 搵到

Today's date (MDY)

• {{Retrieved|access-date=11月 11, 2024}}

Generates: 喺 11月 11, 2024 搵到

Using via

• {{Retrieved|access-date=2024-11-11|via=[[Internet Archive]]}}

Generates: 喺 2024-11-11 – via Internet Archive 搵到

Parameter values do not display when all-spaces

• {{Retrieved|prepend= |access-date=2024-11-11|via= }}

Generates: 喺 2024-11-11 搵到

Access requirements

• {{Retrieved|access-date=2024-11-11|registration=y}}

Generates: 喺 2024-11-11 (registration required) 搵到

• {{Retrieved|access-date=2024-11-11|subscription=y}}

Generates: 喺 2024-11-11 (subscription required) 搵到

Subscription access requirement overrides registration

• {{Retrieved|access-date=2024-11-11|registration=y|subscription=y}}

Generates: 喺 2024-11-11 (subscription required) 搵到

Link note

• {{Retrieved|access-date=2024-11-11|note=brief link note}}

Generates: 喺 2024-11-11 (brief link note) 搵到

No trailing punctuation

• {{Retrieved|access-date=2024-11-11|append= }}

Generates: 喺 2024-11-11

Leading and trailing punctuation, access requirement, link note, and quote

• {{Retrieved|prepend=.{{sp}}|access-date=2024-11-11|via=Restricted Source|subscription=y|note=brief link note|append=. "Brief quote from source";}}

 – note use of {{sp}} with |prepend=, in order to add a trailing space to the parameter's value

Generates: . 喺 2024-11-11 – via Restricted Source (subscription required) (brief link note). "Brief quote from source";

Parameters

Required

• Template:Bxt: This parameter (or its alias Template:Bxt) is required.

Deprecated

• Template:Xtd: Please use Template:Bxt (or Template:Bxt) instead. Using this parameter will add the article to Cat:Pages containing Retrieved template with deprecated parameters.

Description

• Template:Bxtn: Displays first, before "Retrieved ...", when populated. It can be used to add leading punctuation and brief, relevant, information, such as online source format requirements (when not specified elsewhere). Note "Retrieved" always displays capitalized.
• Template:Bxtn: Full date source was accessed. Do not wikilink. Not checked for date-formatting errors. May be any one of Wikipedia's , but please follow the format established in the article’s citations and/or references. Otherwise, please see and Help:Citation Style 1. This parameter is required. Alias: Template:Bxtn.
• Template:Bxtn: Cites the online provider/publisher of the source’s accessed version. May be wikilinked. Include when different from the source’s original online provider/publisher, or when the version accessed is in a different format from the original.
• Template:Bxtn or Template:Bxtn: These parameters add a link note to specify online source has access requirements (WP:PAYWALL). Values display at 90% size, in grey, within parentheses.
  • If the online source requires registration, set |registration=y; superseded by subscription if both are set.
  • If the online source requires subscription: set |subscription=y; supersedes registration if both are set. When this parameter is set, the article will be added to Cat:Pages containing links to subscription-only content.
• Template:Bxtn: May be used to add a brief relevant editor comment regarding the link or source, such as embargo information etc. Value displays at 90% size, in grey, within parentheses.
• Template:Bxtn: Value displays by default, as a period ( Template:Bxtn ) for trailing punctuation; if you wish to retain the default do not add this parameter, or if already present, delete it. Otherwise, it can be used to replace or remove trailing punctuation, and to add a brief quote from the source.

See also

• Template:Dead link

TemplateData

呢個係用喺呢個模嘅TemplateData解，用喺VisualEditor同埋其它工具度；睇吓呢個模嘅每月錯誤報告。

TemplateData for Retrieved嘅TemplateData

This template adds online-retrieval information ("Retrieved ...") to external link templates that do not provide such facility.

模參數

參數		描述	類	狀態
Prepend	prepend	Use it to add leading punctuation; displays before "Retrieved ..."	字串	可選
Source access date	access-date accessdate	The full date the source was accessed; do not wikilink	日子	必填
Via	via	Name of online provider if other than the publisher; also use when accessed version is in different format from the original; may be wikilinked	字串	可選
Registration	registration	For online sources that require registration, set to 'y'; superseded by subscription if both are set	字串	可選
Subscription	subscription	For online sources that require subscription, set to 'y'; supersedes registration if both are set	字串	可選
Link note	note	When required for clarification, add a brief note about the link/online source	字串	可選
Append	append	Trailing punctuation, displays by default, as a period; to remove, use this parameter without a value; to replace, use with desired value 預設 .	字串	可選