Template:Permanent dead link

^{[permanent dead link]}

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit "Template:Permanent dead link/doc" to edit its documentation if it is available. (How does this work?)

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

Usage

Common form (with current date): {{subst:Permanent dead link|date=October 2026}}

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=October 2026}}</ref>

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

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

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.

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[Edit template data]
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

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

Groups: Currently there is no technical limit to the maximum number of groups.
- Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
- Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
Bullets: Create unordered lists with lines beginning with *.
Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
Uncollapsed: Forces the navbox to be displayed.
- All of the navboxes in this documentation are in the uncollapsed state.
Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
- Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
Plain: Removes the "show/hide" link.

Sub-groups

For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
To create sub-groups within {{navbox}}, certain parameters are to be included:
- The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
- The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
- The parent navbox is almost always uncollapsed (state=uncollapsed).
- The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
- The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
- The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.

[1] "Web page title". Example.com. Retrieved 22 September 2012. ^{[permanent dead link]}

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

[1]

[2]

v • d • e Inline cleanup tags
Attribution
Clarity
Miscellaneous
Neutrality
Precision
Time-sensitivity
Verifiability
Wording
General advice

Template:Permanent dead link

Contents

Usage

Optional parameters

Examples

Caveats

TemplateData

See also

Dead link tools

Usage

Syntax

States

Sub-groups

Collapsible sub-groups

Use of images

Categorising

Examples

Single line navbox with centered list

Navbox with standard footer

Navbox with styled footer

Multiple line navbox

Collapsed navbox

Plain navbox with Tnavbar

Plain navbox without Tnavbar

Complicated navbox

Preventing unwanted documentation