模板:Webarchive/doc檢視原始碼檢視歷史

本文件是Template:Webarchive的文件子頁面（見模板頁自身）。
本頁包含用法資訊、分類和其他非原模板頁面的內容。

此模板在39,000個頁面+中使用，修改會造成廣泛的影響。請先在模板的/sandbox或者/testcases子頁面或在自己的zh-cn:用户页; zh-tw:使用者頁面; zh-hk:用戶頁;測試。修改前請考慮至討論頁討論變更。

40px

此模板目前缺乏相關使用說明。請知曉此模板目的及使用方法的編輯者協助編寫說明文件。
本模板可能使用了參數，若無完整的使用說明將不便於他人了解、引用、維護與修改。

本模板使用Lua語言：

Module:Webarchive

{{Webarchive/doc}}用於增加Wayback Machine、WebCite（：WebCite）等網頁存檔站點（：List of Web archiving initiatives）的鏈接。

此模板是{{wayback}}、{{webcite}}、{{memento}}和{{cite archives}}的替代品。

用法

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

Example:

{{webarchive |url=https://web.archive.org/web/20160801000000/http://example.com |date=2016-08-01}}

Produces: 網際網路檔案館的存檔，存檔日期2016-08-01.

Example 2:

{{webarchive |url=http://www.webcitation.org/5eWaHRbn4?url=http://www.example.com/ |date=2009-02-12}}

Produces: WebCite（：WebCite）的存檔，存檔日期2009-02-12

It is also common to include a |title=

Example 3:

{{webarchive |url=http://www.webcitation.org/5eWaHRbn4?url=http://www.example.com/ |date=2009-02-12 |title=Page title}}

Produces: Page title，存檔於WebCite（：WebCite）（存檔日期 2009-02-12）

多個URL

選項

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 {{cite archives}}. 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: |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.

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 http://www.example.com it is already contained in the archive URLs:

Wayback: |url=https://web.archive.org/web/YYYYMMDDhhmmss/http://www.example.com

Webcite: |url=http://www.webcitation.org/5eWaHRbn4?url=http://www.example.com (more info at Using WebCite)

Archive.is: |url=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)

{{webarchive |url=https://web.archive.org/web/20160801000000/http://example.com |date=2016-08-01|title=Page title}}

Page title，存檔於網際網路檔案館（存檔日期 2016-08-01）

Single link at Wayback with date only

{{webarchive |url=https://web.archive.org/web/20160801000000/http://example.com |date=2016-08-01}}

網際網路檔案館的存檔，存檔日期2016-08-01.

Single link at WebCite with no date and no title

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

WebCite（：WebCite）的存檔，存檔日期2012-05-27

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=2016-08-01|url2=https://web.archive.org/web/20160901/http://example.com |title2=Page2 title |date2=2016-09-01}}

Page title，存檔於網際網路檔案館（存檔日期 2016-08-01）. 其他存檔：Page2 title.

Multi-link at Wayback with dates only

{{webarchive |url=https://web.archive.org/web/20160801/http://example.com |date=2016-08-01|url2=https://web.archive.org/web/20160901/http://example.com |date2=2016-09-01}}

網際網路檔案館的存檔，存檔日期2016-08-01. 其他存檔：2016-09-01.

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}}

Page title，存檔於網際網路檔案館（存檔日期 2016-08-01）. 其他存檔：Page2 title.

跟蹤分類

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

Category:Webarchive模板wayback鏈接（3,023） – links to Wayback Machine
Category:Webarchive模板webcite鏈接（18） – links to WebCite
Category:Webarchive模板archiveis鏈接（248） – links to Archive.is
Category:Webarchive模板其他存檔站點（11） – links to known archive sites that don't have their own tracking category
Category:Webarchive模板未知存檔站點（3） – 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
Category:Webarchive模板警告（10） – soft errors that don't prevent the template from working but leave a red message
Category:Webarchive模板錯誤（5） – errors typically requiring human intervention

模板維護

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 effect 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

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

模板參數
參數		描述	類型	狀態
Archive URL	`url`	URL to the archive. 預設空的範例 https://web.archive.org/web/20160101000000/http://example.com 自動值空的	字串	必填
Archive date	`date`	Date of the archive. 預設空的範例 January 1, 2016 自動值空的	字串	建議
Archive title	`title`	Title (or text) displayed on the Wiki page for the link. 預設 Date argument, or the word 'Archive' 範例 Example website 自動值空的	字串	建議
Wikilink	`nolink`	Wikilink to the archive's page in the rendering. Any value including blank means no wikilink. 預設空的範例空的自動值空的	字串	選填
Format of template rendering.	`format`	For multi-URL instances, render display in one of two formats. 預設空的範例空的自動值空的	字串	選填