Template:Redirect/doc

This is a documentation subpage for Template:Redirect.It contains usage information, categories, and other content that is not part of the original template page.

Template:Redirect invokes function redirect in Module:Redirect hatnote using Lua.

This template produces a hatnote:

• {{Redirect|Foo}} →
  "Foo" redirects here. For other uses, see Foo (disambiguation).

Its purpose is to reduce confusion by helping users get to their intended page if they were redirected to another page while, for example, searching for a topic. An example would be when a user searches for Roberts Space Industries (as in the publisher), but ends up on the page titled Roberts Space Industries (as in the in-game company) after being redirected. A |text= option adds text to the end; note that this should be only used when truly necessary, and the other hatnote templates listed below don't suffice.

Examples

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

TemplateData

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.

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