Template:Webarchive/doc

undefined 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, , and.

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

Example:
 * Produces:
 * Produces:

Example 2:
 * Produces:
 * Produces:

It is also common to include a title

Example 3:


 * Produces:
 * Produces:

Multiple URLs
The template optionally supports multiple URLs (up to 10) for linking to multiple archiving services for the same source link. The first url argument is url then url2 .. url10. Each URL can have its own date and title argument, thus date2 .. date10 and title2 .. title10.

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

Secondary options


 * nolink: If set to any value (including blank such as nolink) the wiki-link for the archive service will not be displayed. For example if Wayback Machine was previously linked in an article, it won't be linked again.


 * format: This is a special option to support the merger of . It may be deprecated in the future. Because CS1|2 templates do not currently support more than 1 archive link, this template will tack on additional archive links to the end of a CS1|2 template output. It takes two values: addlarchives or 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.


 * origurl: This is the original URL and this argument should not be used unless you know what you're doing. This option is not recommended because it is redundant, not needed by the template and creates error-prone interactions with other link rot tools. For example given the original URL  it is already contained in the archive URLs:
 * Wayback: https://web.archive.org/web/YYYYMMDDhhmmss/http://www.example.com
 * Webcite: http://www.webcitation.org/5eWaHRbn4?url=http://www.example.com (more info at Using WebCite)
 * Archive.is: http://archive.is/YYYYMMDDhhmmss/http://www.example.com (more info at Using Archive.is)
 * Archive services that have the option for long-form URLs, like the above examples, should use that (most do) instead of origurl. See RfC which discusses the policy of disallowing URL-shortening which can be used to hide blacklisted websites. In the rare instances when an archive service only has shortened URLs available, the original URL can be stored in the origurl argument. Another reason not to use this argument unless necessary is because other link-rot tools (bots, edit scripts etc) may try to "save" the URL - which is presumably dead - by converting it to an archive URL, adding a dead link tag or even messing with the archive URL. Note that the argument is not used by the template it's only for storage.

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)


 * Single link at Wayback with date only


 * Single link at WebCite with no date and no title


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


 * Multi-link at Wayback with dates only


 * Multi-link at Wayback with titles only

Tracking categories
The template has a number of hidden tracking categories which may be added (via Module:Webarchive):


 * – links to Wayback Machine
 * – links to WebCite
 * – links to Archive.is
 * – links to known archive sites that don't have their own tracking category
 * – 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
 * – soft errors that don't prevent the template from working but leave a red message
 * – errors typically requiring human intervention

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.

Configuration: verifydates

The template can verify that Wayback (or WebCite) dates in the URL portion match the date in the date argument. If the dates don't match it will leave 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.

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

{   "description": "A template for linking to offsite archives such as Wayback, WebCite, Archive.is, etc.. ", "params": { "url": { "label": "Archive URL", "description": "URL to the archive.", "type": "string", "example": "https://web.archive.org/web/20160101000000/http://example.com", "required": true },       "date": { "label": "Archive date", "description": "Date of the archive.", "type": "string", "example": "January 1, 2016", "suggested": true },       "title": { "label": "Archive title", "description": "Title (or text) displayed on the Wiki page for the link.", "type": "string", "suggested": true, "example": "Example website", "default": "Date argument, or the word 'Archive'" },       "nolink": { "label": "Wikilink", "description": "Wikilink to the archive's page in the rendering. Any value including blank means no wikilink.", "type": "string" },       "format": { "label": "Format of template rendering.", "description": "For multi-URL instances, render display in one of two formats.", "type": "string" }   } }