View source for Template:Redirect category/doc

{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->__FORCETOC__

{{Distinguish|Template:Category redirect}}
{{nosubst}}

==Usage==
This template provides for a uniform header for use on all redirect categories. Its parameters allow modifications of the template's default output so that each header can be customized for the specific redirect category where it is being used. To use, copy the following syntax and paste it atop the redirect category intended for its use:

{{tlc|Redirect category|from{{=}}|to{{=}}|template{{=}}|parameters{{=}}|sortkey{{=}}}}

* Use {{para|from}} and (or) {{para|to}} to describe the purpose of the redirects in the category.
* The {{para|template}} parameter names the {{tl|Redirect category shell}} template in redirect categories.
* Use {{para|parameters}} to list the associated [[WP:RCAT|redirect template]] (rcat) used with the ''Redirect category shell'' template, along with its parameters.
* For {{para|sortkey}}, add "yes" for the header to include an instruction to use <nowiki>{{</nowiki>[[Template:DEFAULTSORT|DEFAULTSORT]]:<nowiki>}}</nowiki> in cases where appropriate.

Unused parameters may be removed or left, blank, in place; both conditions result in the template's rendering of the default output where each modification would otherwise occur. 

=== Examples ===

With the syntax unaltered, (left blank), as copied above; ie:
<pre>
{{Redirect category|from=|to=|template=|parameters=|sortkey=}}</pre>

The default output produces:

{{Redirect category|from=|to=|template=|parameters=|sortkey=}}

When {{para|from}} is used; for example, as:

<pre>
{{Redirect category|from=a subject that does not exist as a standalone article|to=|template=|parameters=|sortkey=}}</pre>

It produces:

{{Redirect category|from=a subject that does not exist as a standalone article|to=|template=|parameters=|sortkey=}}

Continuing the example, if {{para|to}} is also used; like shown:

<pre>
{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=|parameters=|sortkey=}}</pre>

It produces:

{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=|parameters=|sortkey=}}

When {{para|template}} is used; for example:

<pre>
{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=Rcat shell|parameters=|sortkey=}}</pre>

It produces:

{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=Rcat shell|parameters=|sortkey=}}

And with the specific {{tl|Rcat}} used in {{para|parameters}}; for example:

<pre>
{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=Rcat shell|parameters={{tl|R to article without mention}}|sortkey=}}</pre>

It produces:

{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=Rcat shell|parameters={{tl|R to article without mention}}|sortkey=}}

And if {{para|sortkey}} is set to "yes"; for example:

<pre>
{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=Rcat shell|parameters={{tl|R to article without mention}}|sortkey=yes}}</pre>

It produces:

{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=Rcat shell|parameters={{tl|R to article without mention}}|sortkey=yes}}

==== Adding a shortcut ====

One shortcut can be installed within the lower maintenance banner; for example:
<pre>
{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=Rcat shell|parameters={{tl|R to article without mention}}|sortkey=yes|shortcut=CAT:RAW}}
</pre>

It produces:

{{Redirect category|from=a subject that does not exist as a standalone article|to=an  article, or subsection thereof, where the subject could be described, but presently is not|template=Rcat shell|parameters={{tl|R to article without mention}}|sortkey=yes|shortcut=CAT:RAW}}

== Categorisation ==

This template adds categories to [[:Category:All redirect categories]], [[:Category:Hidden categories]] and [[:Category:Redirect tracking categories]].
:'''If the template is transcluded on a page outside of the category namespace, then that page will ''not'' be added to these categories and will be added to''' {{cat|Pages with templates in the wrong namespace}} '''''instead'''''.

=== Language categorisation ===

This template is also used within two templates that are found on language category pages.  When a language category is created, one of the following two templates (depending on whether the category is for "from" or "to" language redirects) should be used to provide useful information about the new category:
* {{tl|Redirect from alternative language category}}
* {{tl|Redirect to alternative language category}}
These two templates will also automatically categorize the page into the correct parent category.  See the edit page for {{cat|Redirects from Catalan-language terms}} for an example of template usage.

== See also ==

* [[Wikipedia:Template messages/Redirect pages]]
* {{tl|R template index}}

{{Namespace category}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Category namespace templates]]

}}</includeonly>