Difference between revisions of "Template:Dead link/doc"

Latest revision as of 22:04, 15 July 2015

Usage

Editors occasionally encounter dead links either within a paragraph or a reference citation.

Before considering whether to use the {{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}} templates have the facility for adding |archivedate= and |archiveurl= parameters for linking to an archive copy.

Using {{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 or template, leaving the original link intact. Not doing so will prevent detection from automated tools. If the citation contains multiple URLs (e.g. chapterurl and url) in a template, and only one is broken, you can use <!-- hidden text --> to explain which one is broken.

If the article uses clickable footnotes, then this tag 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, which is not recommended).

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.

Avoid using this template to identify dead external links that are not used as references for article content. Instead, dead external links should usually be removed. See the guideline for external links.

Common form (with current date)

{{Dead link|date=November 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. For the current date use date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}.

bot

Bot accounts specify the |bot= parameter as a sign that the tag was added by an automated process. Set as bot=<bot name>.

Notes:

• The date-substitution template may be used to automatically generate the date, e.g., {{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 |accessdate=22 September 2012}} {{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 |accessdate=22 September 2012}} {{Dead link}}</ref>
  → ^[2]

1. ↑ {{#invoke:citation/CS1|citation |CitationClass=web }} {{ safesubst:#invoke:Unsubst||date=__DATE__ |$B= {{#invoke:Category handler|main}}{{#invoke:Category handler|main}}^{[dead link]} }}
2. ↑ Template:Cite news {{ safesubst:#invoke:Unsubst||date=__DATE__ |$B= {{#invoke:Category handler|main}}{{#invoke:Category handler|main}}^{[dead link]} }}

Caveats

• Avoid using free links (e.g. http://www.example.org/{{Dead link}}) as software 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 {{Dead link}}, as they are often used to format text.

TemplateData

<templatedata> {

       "description": "A template to indicate that the preceding URL is dead",
       "params": {
               "date": {
                       "label": "Date",
                       "description": "The month and year the URL was found to be dead, like \"June 2013\"",
                       "type": "string",
                       "required": false
               },
               "bot": {
                       "label": "Bot name",
                       "description": "The name of the bot used to identify the dead link (not used by regular editors)",
                       "type": "string/wiki-user-name",
                       "required": false
               },
               "url": {
                       "label": "Wayback URL",
                       "description": "The dead URL, used only if there is a Wayback Machine archive",
                       "type": "string",
                       "required": false
               }
       }

} </templatedata>

See also

• {{Citation broken}} (inline) to be used when a reference suffers from a more severe problem than a mere broken link
• {{Citations broken}}
• {{Cleanup-bare URLs}} header
• {{NRIS dead link}}
• {{Registration required}} citation flag
• {{Subscription or libraries}} citation flag for when a subscription or library access may be required
• {{Subscription required}} citation flag
• {{Wayback}}
• {{WebCite}}
• What to do when a reference link goes dead

Dead link tools

• Checklinks
• DeadLinkBOT
• WebCiteBOT

Template:Inline tags