Template:Cite web/doc: Difference between revisions

From Guild of Archivists
(Created page with " <templatedata> { "params": { "url": { "label": "URL", "description": "The URL of the cited web page. This should always be the page's original URL, even if it is no...")
 
(Documented new archive-page param)
Line 36: Line 36:
"example": "https://web.archive.org/web/20100420005638/http://drcsite.org/home.php",
"example": "https://web.archive.org/web/20100420005638/http://drcsite.org/home.php",
"type": "url"
"type": "url"
},
"archive-page": {
"label": "Archive reference page name",
"description": "The name of a reference page on the wiki containing a copy of the web page's content. Use if the original page is no longer available and its content has been archived on the wiki.",
"example": "Reference:DRC, restoration progress updates",
"type": "wiki-page-name"
},
},
"archive-date": {
"archive-date": {
"label": "Archival date",
"label": "Archival date",
"description": "The date on which the page was archived. Required if archive-url is given.",
"description": "The date on which the page was archived. Required if archive-url or archive-page is given.",
"example": "April 20, 2010",
"example": "April 20, 2010",
"type": "string"
"type": "string"

Revision as of 20:49, 3 May 2021

This template is a way to ensure that web pages are cited using the appropriate citation formatting.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
URLurl

The URL of the cited web page. This should always be the page's original URL, even if it is no longer available - the URL of an archived copy can be provided in the archive-url parameter.

Example
http://drcsite.org/home.php
URLrequired
Page titletitle

The title of the cited web page.

Example
D'ni Restoration Council - Welcome
Stringrequired
Website namewebsite

The name of the website to which the cited page belongs.

Example
DRC Site
Stringrequired
Access dateaccess-date

The date on which the page was accessed. If archive-url is used, this should be the date on which the archived copy was accessed - the date on which the page was archived can be provided in the archive-date parameter.

Example
November 28, 2020
Stringrequired
Archive URLarchive-url

The URL of an archived version of the web page. Use if the original page is no longer available.

Example
https://web.archive.org/web/20100420005638/http://drcsite.org/home.php
URLoptional
Archive reference page namearchive-page

The name of a reference page on the wiki containing a copy of the web page's content. Use if the original page is no longer available and its content has been archived on the wiki.

Example
Reference:DRC, restoration progress updates
Page nameoptional
Archival datearchive-date

The date on which the page was archived. Required if archive-url or archive-page is given.

Example
April 20, 2010
Stringoptional