Teamplaid:Webarchive/documentation

This is a documentation subpage for Teamplaid:Webarchive.
It contains usage information, categories and other content that is not part of the original teamplaid page.

This template is used on a very large number of pages.
To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them.

Teamplaid:Info

Uses Lua:

{{Webarchive/documentation}} is for linking to web archiving services such as the Wayback Machine, WebCite and all other web archiving services.

This template is a replacement for {{wayback}}, {{webcite}}, {{memento}} and {{cite archives}}.

Ùsaid - Usage

In most cases the template needs only two arguments, the archive |url= and archive |date=.

Eisimpleir - Example

{{Webarchive |url=https://web.archive.org/web/20160801000000/http://example.com |date=1 August 2016}}

Produces: Archived 1 An Lùnastal 2016 at the Wayback Machine

Eisimpleir 2- Example 2

{{Webarchive |url=https://www.webcitation.org/5eWaHRbn4?url=http://www.example.com/ |date=12 February 2009}}

Produces: Archived 12 dhen Ghearran 2009 at WebCite

It is also common to include a |title=

Eisimpleir 3- Example 3

{{Webarchive |url=https://www.webcitation.org/5eWaHRbn4?url=http://www.example.com/ |date=12 February 2009 |title=Page title}}

Produces: Page title at WebCite (archived 12 dhen Ghearran 2009)

Ioma URLan - Multiple URLs

Roghainnean - Options

Prìomh roghainnean - Main options

url..url10: The URL(s) to the archive service. There should always be a |url= which counts as the first url. Each |url#= can have its own numbered corresponding |date#= and |title#=. Matching of URL with date and title is done by numbers, not position. Numbers do not need to be in sequence, for example |url2= followed by |url5= works.

date..date10: The date the page was archived. The date format displayed is the same as entered. If |date= is missing the template will make a best effort to find the date by decoding the archive URL (wayback and webcite for example provide this data in the URL), and will display the date in iso format by default. However including a date is recommended for date formatting reasons, and because other tools may not have the ability to decode the date from the URL.

title..title10: The text displayed for the link. If no |title= is provided then |date= is displayed. Otherwise |title= takes precedence if both are set.

Roghainnean dàrnach - Secondary options

nolink: If set to any value, the archive service name will not be wikilinked.

format: This is a special option to support the merger of {{cite archives}}. It may be deprecated in the future. Because CS1|2 templates do not currently support more than one archive link, this template will tack on additional archive links to the end of a CS1|2 template output. It takes two values: |format=addlarchives or |format=addlpages. Addlarchives will display output appropriate for linking to multiple web archiving services. Addlpages will display output appropriate for linking to multiple pages at the same archive.

Eisimpleirean - Examples

The number of possible examples is extensive depending on the mix of options. Some common cases follow. For more extensive testing see the testcases page.

Single link at Wayback with date and title (recommended method)

{{Webarchive |url=https://web.archive.org/web/20160801101852/http://example.com |date=August 1, 2016 |title=Page title}}

Produces: Page title at the Wayback Machine (archived An Lùnastal 1, 2016)

Single link at Wayback with date only

{{Webarchive |url=https://web.archive.org/web/20160801101852/http://example.com |date=August 1, 2016}}

Produces: Archived An Lùnastal 1, 2016, at the Wayback Machine

Single link at Wayback with no date and no title

{{Webarchive |url=https://web.archive.org/web/20160801101852/http://example.com}}

Produces: Archived 2016-08-01 at the Wayback Machine

Single link at WebCite with no date and no title

{{Webarchive |url=https://www.webcitation.org/5eWaHRbn4?url=http://www.example.com}}

Produces: Archived 2009-02-12 at WebCite

Single link at Archive.is with no date and no title

{{Webarchive |url=https://archive.is/2016.08.08-112330/http://example.com}}

Produces: Archived 2016-08-08 at Archive.today

Multi-link at Wayback with dates and titles (recommended method)

{{Webarchive |url=https://web.archive.org/web/20160801/http://example.com |title=Page title |date=August 1, 2016 |url2=https://web.archive.org/web/20160901/http://example.com |title2=Page2 title |date2=September 1, 2016}}

Produces: Page title at the Wayback Machine (archived An Lùnastal 1, 2016^{[Timestamp length]}). Additional archives: Page2 title.

Multi-link at Wayback with dates only

{{Webarchive |url=https://web.archive.org/web/20160801/http://example.com |date=August 1, 2016 |url2=https://web.archive.org/web/20160901/http://example.com |date2=September 1, 2016}}

Produces: Archived An Lùnastal 1, 2016^{[Timestamp length]}, at the Wayback Machine. Additional archives: September 1, 2016.

Multi-link at Wayback with titles only

{{Webarchive |url=https://web.archive.org/web/20160801/http://example.com |title=Page title |url2=https://web.archive.org/web/20160901/http://example.com |title2=Page2 title}}

Produces: Page title at the Wayback Machine (archived 2016-08-01^{[Timestamp length]}). Additional archives: Page2 title.

Additional archives format:

{{Webarchive |format=addlarchives |url=https://www.webcitation.org/5eWaHRbn4?url=http://www.example.com/ |date=12 February 2009}}

Produces: Additional archives: 12 dhen Ghearran 2009.

Additional pages format:

{{Webarchive |format=addlpages |url=https://www.webcitation.org/5eWaHRbn4?url=http://www.example.com/ |url2=https://web.archive.org/web/20160901/http://example.com |date=12 February 2009}}

Produces: Additional pages archived on 12 dhen Ghearran 2009: Page 1, Page 2.

Roinnean-seòrsa tracaidh - Tracking categories

The template has a number of hidden tracking categories which may be added (via Mòideal:Webarchive):

Roinn-seòrsa:Webarchive template wayback links (9): links to Wayback Machine
Roinn-seòrsa:Webarchive template webcite links (2): links to WebCite
Roinn-seòrsa:Webarchive template archiveis links (2): links to Archive.is
Roinn-seòrsa:Webarchive template other archives (0): links to known archive sites that don't have their own tracking category
Roinn-seòrsa:Webarchive template unknown archives (0): the template doesn't recognize the archive URL; this may indicate an error in the data; or the template itself needs updating to reflect a new archive site
Roinn-seòrsa:Webarchive template warnings (2): soft errors that do not prevent the template from working but leave a red message
Roinn-seòrsa:Webarchive template errors (0): errors typically requiring human intervention

A' cumail suas teamplaid - Template maintenance

The following can be done to maintain the template.

Monitor tracking categories

The tracking categories for "warnings" and "errors" can be monitored to alert for any problems in the data.
The tracking category for "unknown archives" may indicate a problem in the data; for example an editor used the source URL instead of the archive URL in the |url= field.

Monitor template argument usage

This tool shows which instances of the template are using which arguments—it shows for example that |access-date= is being used by five instances in five articles. Since this is an error (the template does not support |access-date=) those five template instances should be fixed to remove the |access-date=.

Configuration: verifydates

The template can verify that dates in URLs for Wayback, WebCite, and Archive.is match the date in the |date= argument. If the dates do not match it will display the date from the URL, add a red warning message "date mismatch", and add the article to the warning tracking category.

Because the verification function adds some overhead to the template, it can optionally be globally disabled by setting the variable "verifydates = no" (see the Module source in function p.Webarchive()). Note that after setting to "yes", it can take a week or more for the tracking category to be fully populated. Set to "yes" if you are searching for problems in the data that need fixing (they'll show up in the tracking category).

Configuration: maxurls

The max number of URLs is 10 but this can be changed by setting the "maxurls" variable in the p.Webarchive() function. This is a global variable that will affect all instances of the template, use with caution. Reducing the number will increase the template speed and reduce resource use.

Teamplaid-dàta - TemplateData

What is this? See https://www.mediawiki.org/wiki/Help:TemplateData

A template for linking to offsite archives such as Wayback, WebCite, Archive.is, etc..

Paramadairean na teamplaide[Stiùirich an TemplateData]
Paramadair		Tuairisgeul	Seòrsa	Staid
Archive URL	`url`	URL to the archive. Ball-eisimpleir https://web.archive.org/web/20160101000000/http://example.com	Sreang	riatanach
Archive date	`date`	Date of the archive. Ball-eisimpleir January 1, 2016	Sreang	molta
Archive title	`title`	Title (or text) displayed on the Wiki page for the link. Bun-roghainn Date argument, or the word 'Archive' Ball-eisimpleir Example website	Sreang	molta
Wikilink	`nolink`	Wikilink to the archive's page in the rendering. Any value including blank means no wikilink.	Sreang	roghainneil
Format of template rendering.	`format`	For multi-URL instances, render display in one of two formats.	Sreang	roghainneil