Template:Redirect/doc
 | This is a documentation subpage for Template:Redirect. It may contain usage information, categories and other content that is not part of the original template page. |
 | Using this template does not create a redirect. The following pages may have what you are looking for:
|
 | This template is used on approximately 54,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
Description and use
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
Template:Expand-section
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
TemplateData for Redirect
This template produces a hatnote similar to: "Foo" redirects here. For other uses, see [[Foo (disambiguation)]].
| 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 |
See also
- {{no redirect}}, {{-r}}
- {{is redirect}} — returns yes/<blank>
- Rcat functional index
