Template:Usurped/doc
 | This is a documentation subpage for Template:Usurped. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 15,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
usurped is for displaying square and bare archive URLs, when the underlying source URL has been usurped.
- Square URL:
{{usurped|1=[https://web.archive.org/web/2011010101/http://usurped-domain.com Example]}} - Bare URL:
{{usurped|1=https://web.archive.org/web/2011010101/http://usurped-domain.com}}
The template wraps it so future processes are aware it is a usurped domain. This prevents tools like IABot, reFill and Citation bot (and humans) from converting square or bare archive URLs into a CS1|2 template and thus accidentally re-activating the usurped URL.
It is important to use 1= otherwise any "=" in the URL itself will cause a problem.
When to use
[edit]- When the dead URL needs to be preserved as part of WP:DEADREF.
- See WP:ELDEAD for more information about usage in External link sections.
How to use
[edit]If a usurped URL is bare or square, and is also an archive, wrap it in {{usurped}} as follows:
{{usurped|1=[https://web.archive.org/web/2011010101/http://usurped-domain.com Example]}}
{{usurped|1=https://web.archive.org/web/2011010101/http://usurped-domain.com}}
If a usurped URL has no archive available, the URL or citation should be deleted entirely from Wikipedia as non-verifiable per WP:V. If the citation would be verifiable without a URL simply delete the URL; otherwise, delete the entire citation.
If the usurped URL is in a CS1|2 template such as {{cite web}} simply change |url-status=usurped and add an archive URL to |archive-url=
If a CS1|2 template and no archive is available, the URL or citation should be deleted entirely from Wikipedia as non-verifiable per WP:V. If the citation would be verifiable without a URL simply delete the URL; otherwise, delete the entire citation.
Decision tree of the above steps: WP:USURPURL
Conversion to CS1|2
[edit]It is recommended to convert citations using {{usurped}} to CS1|2 eg. {{cite web}} where it makes sense. Add |url-status=usurped and the archive URL to |archive-url=
This template will add a tag to a source, notifying readers that this source has been usurped.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Reference | 1 | The reference that will have a usurped tag.
| String | required |