Template:Redirect/doc

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

 * (as used on the page Achilles) →
 * (as used on the page Achilles) →
 * (as used on the page Achilles) →
 * (as used on the page Achilles) →
 * (as used on the page Achilles) →
 * (as used on the page Achilles) →
 * (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
 * Technical reasons

TemplateData
{	"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" }