Template:Redirect

Template documentation

This documentation is  transcluded from Template:Redirect/doc. (Edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.

This template produces a  hatnote:

• {{Redirect|Foo}} →

It is placed at the top of the article or section that is  the primary topic of a redirect, and links to other topics that are ambiguous with the name of that redirect. This template is used instead of the generic {{for}} in order to reduce reader confusion.

An example would be when a user searches for the emperor Achilleus. However, the search term "Achilleus" redirects to the page titled Achilles (as in the mythical hero) because it is considered more likely the user were searching for the very well known hero than a relatively obscure emperor. Now, at the top of this Achilles page you will (among other things) find the following hatnote:

"Achilleus" redirects here. For the Roman emperor with this name, see Achilleus (Roman usurper).

That text is this template in action.

Parameters

Usage

{{Commons-inline|Commons-gallery-page-name}}

Commons gallery page name is optional: if missing, the template will look up the associated gallery in Wikidata. If that's missing, it will find associated category. If that's missing, it will finally fall back to Commons search.

Full syntax

{{Commons-inline
|list=                       wikitext for a list 
|links=                      wikitext to override default link 
|Commons-gallery-page-name= 
|extratext=                  extra text 
|search=                     string to search in Commons
|notrack=                    turn off tracking categories
|italic=                     italicize link text
}}

Examples

Normal

{{Commons-inline|Work}}

Media related to Work at Wikimedia Commons

Text override

Work is the link target and Puffle is the link label.

{{Commons-inline|Work|Puffle}}

Media related to Puffle at Wikimedia Commons

Full link override

{{Commons-inline|links=[[commons:Foo|]] and [[commons:Bar|]]}}

Media related to Foo and Bar at Wikimedia Commons

List format

{{Commons-inline|list=
* [[commons:Foo|Foo]]
* [[commons:Bar|Bar]]
* [[commons:Row|Row]]
* [[commons:Dee|Dee]]
}}

Related media at Wikimedia Commons:

• Foo
• Bar
• Row
• Dee

Another list format, including Commons templates

{{Commons-inline|list=
:[[c:Commons:Timed Text|Commons:Timed Text]]
:{{[[Commons:Template:Captions requested|Captions requested]]}}
}}

Related media at Wikimedia Commons:

Commons:Timed Text

{{Captions requested}}

Extra text

{{Commons-inline|Work|extratext= Extra text}}

Media related to Work at Wikimedia Commons Extra text

Force Commons search

{{Commons-inline|search=Work}}

Media related to Redirect at Wikimedia Commons

Turn off tracking categories (for use inside other templates)

{{Commons-inline|Work|notrack=1}}

Media related to Work at Wikimedia Commons

Tracking categories

Normal categories

• Category:Commons link from Wikidata (0)
• Category:Commons link is on Wikidata (0)

Maintenance categories

• Category:Commons link is defined as the pagename (0)
• Category:Commons link is locally defined (0)
• Category:Commons link is the pagename (0)
• Category:Inconsistent wikidata for Commons gallery (0)

A |text = option adds text to the end; note that this should only be used when truly necessary, when the other hatnote templates listed below don't suffice.

Examples

• {{Redirect|Foo}} →
• {{Redirect|REDIRECT||PAGE1}} →
• {{Redirect|REDIRECT|USE1|PAGE1}} →
• {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} →
• {{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}} →
• {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}} →
• {{Redirect|Achilleus|the Emperor with this name|Achilleus (emperor)|other uses|Achilles (disambiguation)}} (as used on the page Achilles) →

More complex uses

For more complex cases, other templates can be used:

• {{Redirect2}} (when there are two incoming redirects)
• {{Redirect-multi}} (for two or more redirects)
• {{Redirect-several}} (for several redirects, without listing each)
• {{Redirect-distinguish}}
• {{See Wiktionary}} with "redirect" field
• {{Technical reasons}}

TemplateData

This is the  TemplateData for this template used by TemplateWizard,  VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Redirect

{
	"params": {
		"1": {
			"label": "Redirecting page",
			"description": "Name of page that redirects here",
			"type": "wiki-page-name",
			"required": true
		},
		"2": {
			"label": "Use 1",
			"description": "Displayed as: For Use 1, see ... If left empty, defaults to For other uses, see ...",
			"type": "line",
			"required": false
		},
		"3": {
			"label": "Target 1",
			"description": "Page to link to. Default is [[PAGENAME (disambiguation)]].",
			"type": "wiki-page-name",
			"required": false
		},
		"4": {
			"label": "Use 2",
			"description": "Second use. Can be 'and' to give: For Use 1, see [[Target1]] and [[Target2]].",
			"type": "line",
			"required": false
		},
		"5": {
			"label": "Target 2",
			"description": "Page to link second use to.",
			"type": "wiki-page-name",
			"required": false
		},
		"6": {
			"label": "Use 3",
			"description": "Third use. Can be 'and'.",
			"type": "line",
			"required": false
		},
		"7": {
			"label": "Target 3",
			"description": "Page to link third use to.",
			"type": "wiki-page-name",
			"required": false
		},
		"text": {
			"label": "Custom text",
			"type": "line",
			"description": "Text to be appended to the end."
		}
	},
	"description": "This template produces a hatnote similar to:\n\n\"Foo\" redirects here. For other uses, see [[Foo (disambiguation)]].",
	"format": "inline"
}

See also

• {{no redirect}}, {{-r}}
•  Rcat functional index
• Template:Redirect

 Hatnote templates

{{{content}}}