Jump to content

Template:Redirect/doc

From Wikipedia, the free encyclopedia

Description and use

This template produces a hatnote:

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

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 Wikipedia self-reference, causing it to be omitted when the page content is reused outside of Wikipedia (see {{self reference}} and MOS:SELFREF for more details).

More complex uses

For more complex cases, other templates can be used:

TemplateData

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

TemplateData for Redirect

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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Redirecting page1

Name of page that redirects here

Page namerequired
Use 12

Displayed as: For Use 1, see ... If left empty, defaults to For other uses, see ...

Lineoptional
Target 13

Page to link to. Default is [[PAGENAME (disambiguation)]].

Page nameoptional
Use 24

Second use. Can be 'and' to give: For Use 1, see [[Target1]] and [[Target2]].

Lineoptional
Target 25

Page to link second use to.

Page nameoptional
Use 36

Third use. Can be 'and'.

Lineoptional
Target 37

Page to link third use to.

Page nameoptional
Custom texttext

Text to be appended to the end.

Lineoptional
Is self-reference?selfref

Set to yes to make this hatnote invisible on e.g. printed versions, for [[WP:SELFREF]]s

Default
no
Auto value
yes
Booleanoptional


See also