Template:Redirect

Template documentation[view] [edit] [history] [purge]

Shortcut

{{redir}}

This template uses Lua:

Module:Redirect hatnote

Description and use

This template produces a hatnote:

{{Redirect|Foo}} →

It is placed at the top of the resource 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

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) →

The |selfref=yes option marks the entire hatnote as a Wikiversity self-reference, causing it to be omitted when the page content is reused outside of Wikiversity (see {{self reference}} and w:MOS:SELFREF for more details).

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.

TemplateData for Redirect

This template produces a hatnote similar to: "Foo" redirects here. For other uses, see [[Foo (disambiguation)]].

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Redirecting page	`1`	Name of page that redirects here	Page name	required
Use 1	`2`	Displayed as: For Use 1, see ... If left empty, defaults to For other uses, see ...	Line	optional
Target 1	`3`	Page to link to. Default is [[PAGENAME (disambiguation)]].	Page name	optional
Use 2	`4`	Second use. Can be 'and' to give: For Use 1, see [[Target1]] and [[Target2]].	Line	optional
Target 2	`5`	Page to link second use to.	Page name	optional
Use 3	`6`	Third use. Can be 'and'.	Line	optional
Target 3	`7`	Page to link third use to.	Page name	optional
Custom text	`text`	Text to be appended to the end.	Line	optional
Is self-reference?	`selfref`	Set to yes to make this hatnote invisible on e.g. printed versions, for [[WV:SELFREF]]s Default no Auto value `yes`	Boolean	optional

v t e Hatnote templates
Hatnote Disambiguation Redirect
Generic	{{Hatnote}} {{Hatnote group}} {{Self-reference}}
For and about	{{For}} {{For-text}} (for custom text) {{For-multi}} (for multiple uses) {{About}} Variations: {{Other uses}} {{Other uses of}} {{Redirect-distinguish-for}} {{About-distinguish}} {{About-distinguish-text}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other storms}} {{Other places}} {{Other ships}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Redirect-distinguish-text}} {{Redirect-distinguish-for}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text) {{About-distinguish}} {{About-distinguish-text}} (for custom text) {{Redirect-distinguish}} {{Redirect-distinguish-text}} (for custom text) {{Redirect-distinguish-for}}
For use in sections	{{Main}} {{Main if exists}} {{Main list}} {{Further}} {{Further-text}} (for custom text) {{Further interlanguage link}} {{See also}} {{See also if exists}} {{See also-text}} (for custom text) {{For outline}} {{For timeline}}
Special	{{Broader}} {{For introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{About year}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}}
Category:Hatnote templates modules for lists hatnote templates for category pages