Template:Redirect/doc - Revision history

Orangestar at 18:28, 13 June 2024

2024-06-13T18:28:15Z

← Older revision		Revision as of 18:28, 13 June 2024
Line 11:		Line 11:

	==Description and use==		==Description and use==
	This template produces a [[Wikipedia:Hatnote\|hatnote]]:		This template produces a [[wikipedia:Wikipedia:Hatnote\|hatnote]]:
	* {{tlx\|Redirect\|Foo}} → {{Redirect\|Foo}}		* {{tlx\|Redirect\|Foo}} → {{Redirect\|wikipedia:Foo}}

	It is placed at the top of the article or section that is [[wikipedia:WP:PRIMARYREDIRECT\|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 {{tl\|for}} in order to reduce reader confusion.		It is placed at the top of the article or section that is [[wikipedia:WP:PRIMARYREDIRECT\|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 {{tl\|for}} in order to reduce reader confusion.

	An example would be when a user searches for the emperor [[Achilleus (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:		An example would be when a user searches for the emperor [[wikipedia:Achilleus (emperor)\|Achilleus]]. However, the search term "Achilleus" redirects to the page titled [[wikipedia:Achilles\|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)]].''		: ''"Achilleus" redirects here. For the Roman emperor with this name, see [[wikipedia:Achilleus (Roman usurper)\|Achilleus (Roman usurper)]].''

	That text is this template in action.		That text is this template in action.
Line 26:		Line 26:

	== Examples ==		== Examples ==
	* {{tlx\|Redirect\|Foo}} → {{Redirect\|Foo}}		* {{tlx\|Redirect\|Foo}} → {{Redirect\|wikipedia:Foo}}
	* {{tlx\|Redirect\|REDIRECT<nowiki>\|\|</nowiki>PAGE1}} → {{Redirect\|REDIRECT\|\|PAGE1}}		* {{tlx\|Redirect\|REDIRECT<nowiki>\|\|</nowiki>PAGE1}} → {{Redirect\|REDIRECT\|\|wikipedia:PAGE1}}
	* {{tlx\|Redirect\|REDIRECT\|USE1\|PAGE1}} → {{Redirect\|REDIRECT\|USE1\|PAGE1}}		* {{tlx\|Redirect\|REDIRECT\|USE1\|PAGE1}} → {{Redirect\|REDIRECT\|USE1\|wikipedia:PAGE1}}
	* {{tlx\|Redirect\|REDIRECT\|USE1\|PAGE1\|USE2\|PAGE2\|USE3\|PAGE3}} → {{Redirect\|REDIRECT\|USE1\|PAGE1\|USE2\|PAGE2\|USE3\|PAGE3}}		* {{tlx\|Redirect\|REDIRECT\|USE1\|PAGE1\|USE2\|wikipedia:PAGE2\|USE3\|PAGE3}} → {{Redirect\|REDIRECT\|USE1\|wikipedia:PAGE1\|USE2\|wikipedia:PAGE2\|USE3\|wikipedia:PAGE3}}
	* {{tlx\|Redirect\|REDIRECT\|USE1\|PAGE1\|and\|PAGE2}} → {{Redirect\|REDIRECT\|USE1\|PAGE1\|and\|PAGE2}}		* {{tlx\|Redirect\|REDIRECT\|USE1\|wikipedia:PAGE1\|and\|wikipedia:PAGE2}} → {{Redirect\|REDIRECT\|USE1\|wikipedia:PAGE1\|and\|wikipedia:PAGE2}}
	* {{tlx\|Redirect\|REDIRECT\|USE1\|PAGE1\|USE2\|PAGE2\|and\|PAGE3}} → {{Redirect\|REDIRECT\|USE1\|PAGE1\|USE2\|PAGE2\|and\|PAGE3}}		* {{tlx\|Redirect\|REDIRECT\|USE1\|PAGE1\|USE2\|PAGE2\|and\|PAGE3}} → {{Redirect\|REDIRECT\|USE1\|wikipedia:PAGE1\|USE2\|wikipedia:PAGE2\|and\|wikipedia:PAGE3}}
	* {{tlx\|Redirect\|Achilleus\|the Emperor with this name\|Achilleus (emperor)\|other uses\|Achilles (disambiguation)}} (as used on the page [[Achilles]]) → {{Redirect\|Achilleus\|the Emperor with this name\|Achilleus (emperor)\|other uses\|Achilles (disambiguation)}}		* {{tlx\|Redirect\|Achilleus\|the Emperor with this name\|Achilleus (emperor)\|other uses\|Achilles (disambiguation)}} (as used on the page [[wikipedia:Achilles]]) → {{Redirect\|Achilleus\|the Emperor with this name\|wikipedia:Achilleus (emperor)\|other uses\|wikipedia:Achilles (disambiguation)}}

	The {{para\|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 {{tl\|self reference}} and [[MOS:SELFREF]] for more details).		The {{para\|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 {{tl\|self reference}} and [[wikipedia:MOS:SELFREF]] for more details).

	== More complex uses ==		== More complex uses ==
Line 42:		Line 42:
	* {{tl\|Redirect-several}} (for several redirects, without listing each)		* {{tl\|Redirect-several}} (for several redirects, without listing each)
	* {{tl\|Redirect-distinguish}}		* {{tl\|Redirect-distinguish}}
	*{{tl\|See Wiktionary}} with "redirect" field		* {{tl\|See Wiktionary}} with "redirect" field
	* {{tl\|Technical reasons}}		* {{tl\|Technical reasons}}

Line 114:		Line 114:
	* {{tl\|no redirect}}, {{tlf\|-r}}		* {{tl\|no redirect}}, {{tlf\|-r}}
	* {{tl\|is redirect}}, returns yes/<blank>		* {{tl\|is redirect}}, returns yes/<blank>
	*{{tl\|Shortcut}}, for creating redirects primarily within the Wikipedia namespace that uses shorter names (e.g. [[MOS:SMALLCAPS]] or [[wikipedia:WP:AN]]).		*{{tl\|Shortcut}}, for creating redirects primarily within the Wikipedia namespace that uses shorter names (e.g. [[wikipedia:MOS:SMALLCAPS]] or [[wikipedia:WP:AN]]).
	*[[Wikipedia:Template_index/Redirect_pages#List_of_redirects_by_function\|Rcat functional index]]		*[[wikipedia:Wikipedia:Template_index/Redirect_pages#List_of_redirects_by_function\|Rcat functional index]]

	* {{Commons-inline\|short=true\|Template:Redirect}} at [[:commons:Main Page\|Wikimedia Commons]].

	~~{{Hatnote templates\|state = expanded}}~~

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Orangestar: Text replacement - "[[WP:" to "[[wikipedia:WP:"

2024-06-13T17:57:01Z

Text replacement - "[[WP:" to "[[wikipedia:WP:"

← Older revision		Revision as of 17:57, 13 June 2024
Line 3:		Line 3:
	{{tsh\|redir}}		{{tsh\|redir}}
	{{notice\|1=Using this template does '''not''' create a redirect. The following pages may have what you are looking for:		{{notice\|1=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 [[WP:Common sense\|generally]] follow regarding redirects.		* [[Wikipedia:Redirect]] is the official Wikipedia guideline on redirects. The page focuses on the rules and standards that the Wikipedia community has agreed to [[wikipedia:WP:Common sense\|generally]] follow regarding redirects.
	* [[Help:Redirect]] is a how-to page that focuses on the technical aspects of redirects. It instructs editors on how redirects work and how to handle them without causing errors.		* [[Help:Redirect]] is a how-to page that focuses on the technical aspects of redirects. It instructs editors on how redirects work and how to handle them without causing errors.
	* [[Template:R template index\|R template index]] contains a large list of templates that are used in order to tag and categorize redirects.		* [[Template:R template index\|R template index]] contains a large list of templates that are used in order to tag and categorize redirects.
Line 14:		Line 14:
	* {{tlx\|Redirect\|Foo}} → {{Redirect\|Foo}}		* {{tlx\|Redirect\|Foo}} → {{Redirect\|Foo}}

	It is placed at the top of the article or section that is [[WP:PRIMARYREDIRECT\|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 {{tl\|for}} in order to reduce reader confusion.		It is placed at the top of the article or section that is [[wikipedia:WP:PRIMARYREDIRECT\|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 {{tl\|for}} in order to reduce reader confusion.

	An example would be when a user searches for the emperor [[Achilleus (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:		An example would be when a user searches for the emperor [[Achilleus (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:
Line 99:		Line 99:
	"selfref": {		"selfref": {
	"label": "Is self-reference?",		"label": "Is self-reference?",
	"description": "Set to yes to make this hatnote invisible on e.g. printed versions, for [[WP:SELFREF]]s",		"description": "Set to yes to make this hatnote invisible on e.g. printed versions, for [[wikipedia:WP:SELFREF]]s",
	"type": "boolean",		"type": "boolean",
	"default": "no",		"default": "no",
Line 114:		Line 114:
	* {{tl\|no redirect}}, {{tlf\|-r}}		* {{tl\|no redirect}}, {{tlf\|-r}}
	* {{tl\|is redirect}}, returns yes/<blank>		* {{tl\|is redirect}}, returns yes/<blank>
	*{{tl\|Shortcut}}, for creating redirects primarily within the Wikipedia namespace that uses shorter names (e.g. [[MOS:SMALLCAPS]] or [[WP:AN]]).		*{{tl\|Shortcut}}, for creating redirects primarily within the Wikipedia namespace that uses shorter names (e.g. [[MOS:SMALLCAPS]] or [[wikipedia:WP:AN]]).
	*[[Wikipedia:Template_index/Redirect_pages#List_of_redirects_by_function\|Rcat functional index]]		*[[Wikipedia:Template_index/Redirect_pages#List_of_redirects_by_function\|Rcat functional index]]

Orangestar: 1 revision imported

2024-06-13T17:30:38Z

1 revision imported

← Older revision		Revision as of 17:30, 13 June 2024
(No difference)

en>SWinxy: Copy selfref documentation text from Template:For/doc; see that page's edit history for attribution

2024-04-10T21:17:30Z

Copy selfref documentation text from Template:For/doc; see that page's edit history for attribution

New page

{{About-distinguish2|a hatnote template|{{tl|No redirect}}, {{tl|Talk page of redirect}}, {{tl|WikiProject Redirect}}, {{tl|Wiktionary redirect}}, or {{tl|R avoided double redirect}} }}
{{Documentation subpage}}
{{tsh|redir}}
{{notice|1=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 [[WP:Common sense|generally]] follow regarding redirects.
* [[Help:Redirect]] is a how-to page that focuses on the technical aspects of redirects. It instructs editors on how redirects work and how to handle them without causing errors.
* [[Template:R template index|R template index]] contains a large list of templates that are used in order to tag and categorize redirects.
}}
{{high-use| 38806 }}
{{lua|Module:Redirect hatnote}}

==Description and use==
This template produces a [[Wikipedia:Hatnote|hatnote]]:
* {{tlx|Redirect|Foo}} → {{Redirect|Foo}}

It is placed at the top of the article or section that is [[WP:PRIMARYREDIRECT|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 {{tl|for}} in order to reduce reader confusion.

An example would be when a user searches for the emperor [[Achilleus (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 ==
{{expand-section}}
A {{para|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 ==
* {{tlx|Redirect|Foo}} → {{Redirect|Foo}}
* {{tlx|Redirect|REDIRECT<nowiki>||</nowiki>PAGE1}} → {{Redirect|REDIRECT||PAGE1}}
* {{tlx|Redirect|REDIRECT|USE1|PAGE1}} → {{Redirect|REDIRECT|USE1|PAGE1}}
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} → {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}} → {{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}} → {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}
* {{tlx|Redirect|Achilleus|the Emperor with this name|Achilleus (emperor)|other uses|Achilles (disambiguation)}} (as used on the page [[Achilles]]) → {{Redirect|Achilleus|the Emperor with this name|Achilleus (emperor)|other uses|Achilles (disambiguation)}}

The {{para|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 {{tl|self reference}} and [[MOS:SELFREF]] for more details).

== More complex uses ==
For more complex cases, other templates can be used:
* {{tl|Redirect2}} (when there are two incoming redirects)
* {{tl|Redirect-multi}} (for two or more redirects)
* {{tl|Redirect-several}} (for several redirects, without listing each)
* {{tl|Redirect-distinguish}}
*{{tl|See Wiktionary}} with "redirect" field
* {{tl|Technical reasons}}

== TemplateData ==
{{TemplateData header}}
<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."
},
"selfref": {
"label": "Is self-reference?",
"description": "Set to yes to make this hatnote invisible on e.g. printed versions, for [[WP:SELFREF]]s",
"type": "boolean",
"default": "no",
"autovalue": "yes"
}
},
"description": "This template produces a hatnote similar to:\n\n\"Foo\" redirects here. For other uses, see [[Foo (disambiguation)]].",
"format": "inline"
}
</templatedata>

==See also==
* {{tl|no redirect}}, {{tlf|-r}}
* {{tl|is redirect}}, returns yes/<blank>
*{{tl|Shortcut}}, for creating redirects primarily within the Wikipedia namespace that uses shorter names (e.g. [[MOS:SMALLCAPS]] or [[WP:AN]]).
*[[Wikipedia:Template_index/Redirect_pages#List_of_redirects_by_function|Rcat functional index]]

* {{Commons-inline|short=true|Template:Redirect}} at [[:commons:Main Page|Wikimedia Commons]].

{{Hatnote templates|state = expanded}}

<includeonly>{{Sandbox other||
[[Category:Redirect formatting templates|Redirect]]
[[Category:Disambiguation and redirection templates]]
[[Category:Hatnote templates]]

}}</includeonly>