Template:Redirect/doc: Difference between revisions
(Created documentation showing usage and purpose of the template.) |
m (Nads moved page Template:RedirectHeader/doc to Template:Redirect/doc) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
==Purpose== | ==Purpose== | ||
The purpose of this template is to help disambiguate pages. It creates a small note | The purpose of this template is to help disambiguate pages which have an ambiguous redirect. It creates a small note that can have either point to another similar page or a disambiguation page. | ||
==Usage== | ==Usage== | ||
===One Parameter=== | ===One Parameter=== | ||
<code><nowiki>{{RedirectHeader|< | This version should be used when there are at least two other pages that the user may have intended to reach with the redirect. In this case, the template will create a link to the disambiguation page for that redirect. | ||
<code><nowiki>{{RedirectHeader| | <code><nowiki>{{RedirectHeader|<redirect>}}</nowiki></code> | ||
:{{RedirectHeader| | ====Example==== | ||
<code><nowiki>{{RedirectHeader|Example}}</nowiki></code> | |||
<code><nowiki>{{RedirectHeader|< | :{{RedirectHeader|Example}} | ||
===Three Parameters=== | |||
<code><nowiki>{{RedirectHeader| | This version should be used when there is exactly one other page that the user may have intended to reach with the redirect. In this case, the template will describe the difference between the two pages and will create a link to the other page. | ||
:{{RedirectHeader| | |||
<code><nowiki>{{RedirectHeader|<source_description>|<target_description>|<target>}}</nowiki></code> | |||
====Example==== | |||
<code><nowiki>{{RedirectHeader|Ghost|the NPC|Ghost (Event)}}</nowiki></code> | |||
:{{RedirectHeader|Ghost|the NPC|Ghost (Event)}} | |||
Latest revision as of 19:32, 9 February 2023
Purpose
The purpose of this template is to help disambiguate pages which have an ambiguous redirect. It creates a small note that can have either point to another similar page or a disambiguation page.
Usage
One Parameter
This version should be used when there are at least two other pages that the user may have intended to reach with the redirect. In this case, the template will create a link to the disambiguation page for that redirect.
{{RedirectHeader|<redirect>}}
Example
{{RedirectHeader|Example}}
- "Example" redirects here. For other uses, see Example_(disambiguation).
Three Parameters
This version should be used when there is exactly one other page that the user may have intended to reach with the redirect. In this case, the template will describe the difference between the two pages and will create a link to the other page.
{{RedirectHeader|<source_description>|<target_description>|<target>}}
Example
{{RedirectHeader|Ghost|the NPC|Ghost (Event)}}
- "Ghost" redirects here. For the NPC, see Ghost (Event).
