View source for Template:Redirect template/doc

{{Documentation subpage}}
{{High-risk| 1,840,000+ }}
{{Substitution|not}}
{{Lua|Module:Redirect template}}

This is a template for standardising redirect templates. The message produced by this template is intended to be transcluded onto redirect pages via redirect category ([[WP:RCAT|Rcat]]) templates.

When transcluded into the namespace indicated by a parameter, it categorises that page according to the parameter. 
==Usage==
Only use this template in other redirect templates for hard redirects.

The only links that should be present on a redirect page are the link to the target page, and category and interwiki links that apply to the redirect. Other links on redirect pages cause problems with "What links here".

This template should be used twice in a redirect template:

<code><nowiki>{{#ifeq:{{{embed}}}|yes|{{Redirect template}}|{{Redirect template}}}}</nowiki></code>

The first instance of this template will appear when used with the {{tl|This is a redirect}} template, whereas the second instance will appear when the redirect template is used individually:
* <code><nowiki>{{This is a redirect|from initialism}}</nowiki></code>
* <code><nowiki>{{R from initialism}}</nowiki></code>

===Parameters===
All the parameters should be used, except only one of either ''from'' or ''to'' needs to be used (both can be used) and ''printworthy'' should only be used where applicable.  All parameters except ''name'' should be used in both halves of the redirect template.  The parameters used in both halves should be identical (apart from a link in ''from'' or ''to'').

When the "This is a redirect" template is used, the parameter <code>|name=From example</code> adds the text "'''From example:'''" before "This is a redirect...". The text "From example" will be automatically linked to the redirect category that is populated by the redirect template. This "name" parameter should be used only in the first half of the redirect template.

The parameter <code>|from=another example</code> adds the text "from another example" after "This is a redirect". The parameter <code>|to=a third example</code> adds the text "to a third example" after "This is a redirect" (or after the ''from'' parameter if that is also used).  In the second half, one of these two parameters should contain a '''bolded''' link to the category that is populated by the redirect template.

The parameter <code>|info=This is extra information.</code> produces the text "This is extra information." after the first sentence, allowing extra information about the type of redirect to be displayed, if necessary. Too much extra information should be avoided, as it can be included on the corresponding category page instead.

The category parameters add pages with redirect templates using this template to categories. Use the parameter for the namespace the template will be used in:
* <code>|main category=Redirects from examples</code>,
* <code>|help category=</code>,
* <code>|portal category=</code>,
* <code>|talk category=</code> (for ''all'' talk namespaces),
* <code>|template category=</code>
* <code>|wikipedia category=</code> or
* <code>|user category=</code>.
* <code>|all category=</code> adds the category to pages in any namespace.
* Parameters for other namespaces do not exist because no hard redirects should exist to or from those namespaces.

A namespace parameter can be used in conjunction with <code>|other category=</code>.  This parameter will add its category to pages in any namespace other than the specified namespace parameter's category.

The category parameters in the second half should be wrapped in <code><nowiki><includeonly></includeonly></nowiki></code> tags to stop the redirect template itself from being placed in the categories or the {{tl|Incorrect redirect template}} message box appearing on the redirect template page. Do not "includeonly" the parameters in the first half, because it will prevent the link from being added to the text created by the ''name'' parameter.

The parameter <code>|printworthy=</code> (valid only for {{tl|Redirect template}}, not for {{tl|Redirect template/core}}) will categorise main namespace pages into [[:Category:Printworthy redirects]] or [[:Category:Unprintworthy redirects]] depending on whether the parameter equals "yes" or "no", respectively.

===Example===
<pre>
{{#ifeq:{{{embed}}}|yes
 |{{Redirect template
  |name=From an initialism
  |from=an initialism
  |to=a related topic, such as the expansion of the initialism
  |main category=Redirects from initialisms
 }}
 |{{Redirect template
  |from=an '''[[:Category:Redirects from initialisms|initialism]]'''
  |to=a related topic, such as the expansion of the initialism
<includeonly>
  |main category=Redirects from initialisms</includeonly>
 }}
}}<noinclude>
{{Documentation}} 
</noinclude>
</pre>

Used individually as in {{tl|R from initialism}} this produces:
{{R from initialism}}


Used with the {{tl|This is a redirect}} template this produces:

{{This is a redirect|rinit|nocat=true}}
::''<small>Note: Template "This is a redirect" detects protection levels – in this example it senses that "Redirect template" is template protected.  That notice does not appear when the documentation page is viewed, because that page is not protected from editing.</small>''

=== Incorrect usage ===
When an Rcat equipped with this template tags a redirect in the wrong namespace, the following notice will be seen on the redirect page:
{{Mbox
| type = content
| text = {{Error|The above [[WP:RCAT|Rcat]] should only be used to categorize redirects that are in the ''{{{1}}}'' namespace.}}}}
where '''''{{red|{{{1}}}}}''''' is replaced by a link to the namespace specified by the Rcat.

Also, the redirect will not populate the expected category of the Rcat.  The incorrectly tagged redirect will populate '''{{cat|Pages with templates in the wrong namespace}}, ''instead'''''.

=== Usage note ===
It was found at {{tl|CharR to list entry}} that the use of parser functions, <code><nowiki>{{#if:... {{#ifeq:...</nowiki></code>, etc., ''within'' this template may yield unexpected/undesired text on redirects.  If parameters are desired for an Rcat, place parser functions ''outside'' the '''Redirect template''' enclosed with <code><nowiki><includeonly> </includeonly></nowiki></code> tags.

=== Technical note ===
This template calls {{tl|Redirect template/core}}, which is used to prevent a [[wp:template loop|template loop]] caused by [[wp:printworthiness|printworthiness]] code.  For more information, see the [[Template talk:Redirect template#Extract the core into a subtemplate|talk page discussion]].

== See also ==
* {{tl|This is a redirect/Comparison}}
* [[Wikipedia:Template messages/Redirect pages]]
* [[Wikipedia:WikiProject Redirect/Style guide|WikiProject Redirect/Style guide]]

{{R template index}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
{{DEFAULTSORT:!}}
[[Category:All redirect templates|Redirect template]]
[[Category:Redirect templates| ]]
[[Category:Wikipedia metatemplates|Redirect template]]
[[Category:WikiProject Redirect templates|Redirect template]]

}}</includeonly>