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.

Using this template does not create a redirect. The following pages may have what you are looking for:

Wikipedia:Redirect is the official Wikipedia guideline on redirects. The page focuses on the rules and standards that the Wikipedia community has agreed to generally follow regarding redirects.
Help:Redirect is a how-to page that focuses on the technical aspects of templates. It instructs editors on how redirects work and how to handle them without causing errors.
R template index contains a large list of templates that are used in order to tag and categorize redirects.

This template is used on approximately 37,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Redirect hatnote

This template produces a hatnote:

{{Redirect|Foo}} →

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 Achilleus (as in the emperor), but ends up on the page titled Achilles (as in the mythical hero) 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}} →
{{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) →

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Redirect

<templatedata> { "params": { "1": { "label": "Redirecting page", "description": "Name of page that redirects here", "type": "wiki-page-name", "required": true }, "2": { "label": "Use1", "description": "Displayed as: For Use1, see ... If left empty, defaults to For other uses, see ...", "type": "string", "required": false }, "3": { "label": "Target1", "description": "Page to link to. Default is PAGENAME (disambiguation).", "type": "wiki-page-name", "required": false }, "4": { "label": "Use2", "description": "Second use. Can be 'and' to give: For Use1, see Target1 and Target2", "type": "string", "required": false }, "5": { "label": "Target2", "description": "Page to link second use to.", "type": "wiki-page-name", "required": false }, "6": { "label": "Use3", "description": "Third use, can be 'and'", "type": "string", "required": false }, "7": { "label": "Target3", "description": "Page to link third use to.", "type": "wiki-page-name", "required": false },

       "text": {

"label": "Custom text", "type": "string", "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" } </templatedata>

Related templates

Other websites

Media related to Template:Redirect at Wikimedia Commons at Wikimedia Commons.

v t e Hatnote templates
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic	{{Hatnote}} {{Selfref}} (for self-references)
For and about	{{For}} {{For2}} (for custom text) {{For multi}} (for multiple uses) {{About}} Variations: {{Other uses}} {{Other uses of}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other places}} {{Other ships}} {{Other hurricanes}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text too) {{Redirect-distinguish}} {{Redirect-distinguish2}} (for custom text) {{Redirect-distinguish6}} {{About-distinguish}} {{About-distinguish2}} (for custom text)
For use in sections	{{Main}} {{Further}} {{Further2}} (for custom text) {{Further ill}} {{See also}} {{See also if exists}} {{For outline}}
Special	{{Broader}} {{See introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{Year dab}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}} {{Other MeSH codes}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages

v t e Template messages
Main namespace	General Cleanup Disputes Hatnotes Infoboxes Links External link templates Linking country articles Lists Main page Section Sources of articles Standard boxes Translation
Other namespaces	Compact TOC Category File Talk Template User Userboxes User talk Wikipedia WikiProject banners
All namespaces	Deletion Formatting Maintenance Merging Moving Navigation Redirect pages Functional index Splitting Wikimedia sister projects
Navboxes with templates	Archive Articles for deletion Birth, death and age Button Category header Citation and verifiability Citation Style 1 Deletion review Editnotice Hatnotes Help desk Inline cleanup Introduction cleanup IPA Math Notice and warnings Organization infoboxes Proposed article mergers Protection Quotation Redirects Search Semantics Speedy deletion Notices String-handling Sup and sub-related Top icon Transwiki maintenance Unicode User Talk Pages User noticeboard notices Userboxes User rights Userspace linking Userspace Disclaimers Wikibreak WikiLove
Related topics	Template documentation Examples of templates Maintenance template removal Requested templates Template help Template namespace
Search
Category