Template:Permanent dead link/doc

This is a documentation subpage for Template:Permanent dead link.
It may contain usage information, categories and other content that is not part of the original template page.

Usage

This template is identical to {{Dead link}} but with the |fix-attempted=yes parameter already specified. In other words, it is a shortcut of writing down {{Dead link|fix-attempted=yes}}.

This template is used to mark dead links, either within a paragraph or within a reference citation. Marking dead links signals to editors and to WP:Link rot bots that this link needs to be replaced with an archive link.

Before considering whether to use the {{Permanent dead link}} template it is often useful to make a search for an archive copy of the dead link and thereby avoid using the tag altogether. All {{cite xxx}} templates have the facility for adding |archive-date= and |archive-url= parameters for linking to an archive copy. Non-{{cite xxx}} citations can use {{webarchive}}.

Using {{Permanent dead link}} will place a note by the URL and add the article to one of the Category:Articles with dead external links categories.

Append this template directly after the link (after the link code's terminating ] if you are using wikitext), or, if you are using a {{cite xxx}} template, directly after the {{cite xxx}} transclusion (not inside it), but inside the reference, if any, i.e. before the </ref>, in all cases leaving the original link intact:

<ref>{{cite web|url=http://www.example.org|title=The Example Website|access-date=22 September 2012}}{{Permanent dead link|date=December 2024}}</ref>

For bare links, leave a space after the end of the URL and the template:

* http://www.example.org {{Permanent dead link|date=December 2024}}

Otherwise automated tools can have trouble determining where the URL ends, because it will ambiguously contain url-encoding and wiki-encoding mixed together.

Not following these syntax rules might hinder detection by automated tools. If the citation contains multiple URLs (e.g. chapter-url and url) in a template, and only one is broken, you can use wiki comments like  to explain which one is broken.

If the article uses clickable footnotes, then this template should be placed just before the </ref> that contains the dead link. The notice will then correctly appear in the reference section instead of in the body of the text, and so WP:Link rot bots can properly find and fix the link.

If you are placing this template inside a <ref> </ref> reference, do not leave any substitution template such as {{subst:CURRENTMONTHNAME}} or {{subst:CURRENTYEAR}}, because substitutions fail inside ref tags.

Avoid using this template when the reference is fully adequate without the link. In this case, simply remove the link. For example, if a {{cite journal}} template is used with a DOI, remove the |url= parameter.

Common form (with current date)

{{Permanent dead link|date=December 2024}}

Optional parameters

url: Provides a history of the linked page via the Wayback Machine. Set only if history actually exists, as otherwise it is misleading to users and editors.
date: The date parameter consists of the full English name of the current month with initial capital, a space, and the year, not full dates; e.g., "January 2013", but not "jan13". Any deviation from these two rules will result in an "invalid date parameter" error.

Notes:

The date-substitution template may be used to automatically generate the date, e.g., {{Permanent dead link|{{subst:DATE}}}}. See Help:Substitution for more information.
The date= parameter need not be added by the editor: if not entered, a bot will soon add it.

Examples

<ref>{{cite web |url=http://www.example.org |title=Web page title |website=Example.com |access-date=22 September 2012}} {{Permanent dead link |date=September 2012}}</ref>
→ ^[1]
<ref>{{cite news |title=Sorrell accuses Murdoch of panic buying |author=Plunkett, John |url=http://media.guardian.co.uk/site/story/0,14173,1601858,00.html |newspaper=[[The Guardian]] |date=27 October 2005 |access-date=22 September 2012}} {{Permanent dead link}}</ref>
→ ^[2]

^ "Web page title". Example.com. Retrieved 22 September 2012. ^{[permanent dead link‍]}
^ Plunkett, John (27 October 2005). "Sorrell accuses Murdoch of panic buying". The Guardian. Retrieved 22 September 2012. ^{[permanent dead link‍]}

Caveats

Avoid using free links (e.g. http://www.example.org/{{Permanent dead link}}), as software that is unable to handle templates may read an incorrect link. Add brackets if necessary.
Avoid complicated formatting. Nesting inside a template is generally not supported well.
Avoid using [ ] { | } < > characters between the end of the external link and {{Permanent dead link}}, as they are often used to format text.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Permanent dead link in articles based on its TemplateData.

TemplateData for Permanent dead link

A template to indicate that the preceding URL is dead

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Month and year	`date`	The month and year the URL was found to be dead, like "June 2013" Auto value `{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}`	String	suggested
Wayback URL	`url`	The dead URL, used only if there is a Wayback Machine archive	URL	optional