View source for Template:Redr/doc

{{documentation header}}
<!-- Documentation here -->
{{shortcut|Rcat|Useful redirect|UsefulRedirect|R|Rcat shell}}
This template should be used on redirect pages to classify redirects under particular redirect categories (rcats), such as, for example, [[:Category:Redirects from other capitalizations]].

== Usage ==
<code>{<nowiki/>{Redr|rcat}}</code>. For multiple reasons, <code>{<nowiki/>{Redr|rcat1|rcat2}}</code> '''Do <u>not</u>''' place any templates before the &#35;REDIRECT <nowiki>[[Link]]</nowiki>. Always place the template after the &#35;REDIRECT <nowiki>[[Link]]</nowiki>, to prevent breaking the redirect. It is recommended to leave a blank line between the redirect and the template for readability.

== Parameters ==
=== Named parameters ===
The template accepts the following named parameters:

{| class="wikitable"
|-
! Named Parameter !! Effect
|-
| {{P|nocat|1}} || Prevents {{tl|Redr/Reason}} from automatically adding any categories.
|-
| {{P|nl|1}} || Prevents {{tl|Redr/Reason}} from adding the text {{cd|* From a}} to the start of the redirect reason. You can use this to change the formatting of the list item or the text. For example, if you need it to start with {{cd|From an}}, {{cd|To a}}, or any other phrase, use {{P|nl|1}}.

This parameter also determines whether to put the redirect in {{cl|Redirects with reasons}} or {{cl|Miscellaneous redirects}}.
* If it is set, {{cl|Redirects with reasons}} is used.
* If it is not set, {{cl|Miscellaneous redirects}} is used.
|}

Un-named parameters get passed to {{tl|Redr/Reason}}.
* i.e. the parmaeters {{P|1}}, {{P|2}}, {{P|3}}, etc.

All of the examples below use un-named parameters.

== Examples ==
{{See also|Template:Redr/Reason}}
{{tcode|Redr|Not all redirects are useful, but some are.}}
;produces
{{Redr|Not all redirects are useful, but some are.|nocat=1}}

You might want to use {{p|nl|1}} to use custom reasons like the one above (see {{Slink|Extra examples}}).


----

<code>{<nowiki/>{Redr|singular}}</code>
;produces
{{Redr|singular|nocat=1}}

----

<code>{<nowiki/>{Redr|case}}</code> or <code>{<nowiki/>{Redr|capitalization}}</code>
;produces
{{Redr|case|nocat=1}}

----

<code>{<nowiki/>{Redr|achievement|subtopic}}</code> or <code>{<nowiki/>{Redr|advancement|subtopic}}</code>
;produces
{{Redr|advancement|subtopic|nocat=1}}
----
=== List of reasons ===
{{Redr/Reason/doc}}
=== Guide when to use this template ===
To use this template, place it AFTER the &#35;REDIRECT <nowiki>[[Link]]</nowiki>. Do NOT place the template before the &#35;REDIRECT <nowiki>[[Link]]</nowiki>, as this breaks the redirect as a whole. Here is a general guide on what to place (on the first column) and on the second column generally states when to insert the template. Since this is a general guide, there may be exceptions or other circumstances not listed.
{| class="wikitable"
! colspan="2" |Guide
|-
!Template!!When to use
|-
|{{t|Redr|plural}}
|When the redirect name is plural, and the target page is singular
|-
|{{t|Redr|singular}}
|When the redirect name is singular, and the target page is plural
|-
|{{t|Redr|case}}
|When the capitalization of the redirect is different. For example, if the target is [[Zombified Piglin]], [[Zombified piglin]] would be a valid redirect and adding {{t|R}} is useful, but {{fake redlink|ZoMbIfIeD pIgLiN}} would not be a valid redirect.
|-
|{{t|Redr|alt}}
|For alternative names which the style guide allows
|-
|{{t|Redr|move}}
|When a page’s old name has been moved to a new name, usually, a redirect is left behind to prevent breaking links. Add this template to the redirect.
|-
|{{t|Redr|subtopic}}
|Usually when a notable redirect targets a specific subsection of a page, mainly because such subtopic does not warrant its own page.
|-
|{{t|Redr|ign|subtopic}}
|When an in-game name of an block, entity, or item, like [[Acacia Boat]] does not warrant its own page, and is a subtopic, place this template to indicate both the “ign” reason and the “subtopic” reason.
|-
|{{t|Redr|historical}}
|When the redirect is a historical name pointing to the up-to-date target
|-
|{{t|Redr|version}}
|When the redirect is a short-term version name, usually excluding the edition. For example, [[20w51a]] to [[Java Edition 20w51a]]
|-
|{{t|Redr|diacritics}}
|Because readers should not be expected to type diacritics, add this template to redirects with the same name, but without diacritics.
|-
|{{t|Redr|subtopic|advancement}}
|For achievement or advancement redirects, state both the subtopic and achievement/advancement reason.
|}

=== Extra examples ===
The {{p|nl|1}} parameter is useful for custom redirect reasons.

{{tcode|Redr|Not all redirects are useful, but some are.|nl{{=}}1}}
;produces
{{Redr|Not all redirects are useful, but some are.|nl=1|nocat=1}}

----

{{tcode|Redr|caps|{{((}}[[template:Avoided double redirect|avoid double redirect]]|Clay Pot{{))}}|nl{{=}}1}}
;produces
{{Redr|caps|{{avoid double redirect|Clay Pot|noerror=1}}|nl=1|nocat=1}}


== See also ==
{{t|Redr/Reason}}

<includeonly>
<!-- Template categories/interwiki here -->
[[Category:Maintenance templates]]
[[Category:Redirect templates]]


</includeonly>
<noinclude>
<!-- Documentation categories/interwiki here -->

</noinclude>