View source for Template:Redirect category/doc

{{Documentation subpage}}
{{High-use}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Distinguish|Template:Category redirect}}
{{See also|Template:Redirect category shell}}
{{Never substitute}}
{{Template shortcut|Rcat header}}
__FORCETOC__

==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:

<pre style="overflow:auto;">
{{Redirect category |text= |from= |to= |template= |parameters= |template2= |sortkey= |no_info= |soft_redirect= |not_maintenance= |shortcut= }}
</pre>

===Parameters===
* 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 {{kbd|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 style="overflow:auto;">
{{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 style="overflow:auto;">
{{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 style="overflow:auto;">
{{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 style="overflow:auto;">
{{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 style="overflow:auto;">
{{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 style="overflow:auto;">
{{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 style="overflow:auto;">
{{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.

== TemplateData ==
{{Format TemplateData|1=
<templatedata>
{
	"params": {
		"text": {
			"label": "Beginning text",
			"description": "Adds text to the beginning of the template message.",
			"type": "content"
		},
		"from": {
			"label": "Redirects from",
			"description": "The sort of redirect that the template for this category should be placed on.",
			"example": "a subject that does not exist as a standalone article",
			"type": "content",
			"suggested": true
		},
		"to": {
			"label": "Redirects to",
			"description": "The sort of page that redirects with this category's template should redirect to.",
			"example": "an article, or subsection thereof, where the subject could be described, but presently is not",
			"type": "content",
			"suggested": true
		},
		"template": {
			"label": "Shell template",
			"description": "Advanced: the shell template to use in the example invocation. Should be entered as the name of a template, without the \"Template:\" prefix.",
			"type": "string",
			"default": "Redirect category shell"
		},
		"parameters": {
			"label": "Redirect template sample invocation",
			"description": "An example invocation of the redirect template for this category. Should be surrounded by {{tl}} or similar.",
			"example": "{{tl|R to article without mention}}",
			"type": "content",
			"suggested": true
		},
		"sortkey": {
			"label": "Display DEFAULTSORT notice",
			"description": "Advanced: if \"yes\", adds note to use {{DEFAULTSORT:}} when appropriate.",
			"type": "string"
		},
		"no_info": {
			"label": "Suppress info",
			"description": "If \"yes\", removes the warning about not substituting redirect templates or placing them on soft redirects.",
			"type": "string"
		},
		"soft_redirect": {
			"label": "Allow soft redirects",
			"description": "Advanced: if \"yes\", indicates that this category's redirect can be used on soft redirects. This is rare, so you should check the template's documentation before adding it.",
			"type": "string"
		},
		"not_maintenance": {
			"label": "Suppress maintenance categorization ",
			"description": "Advanced: if \"yes\", do not mark this category as a maintenance category. ",
			"type": "string"
		},
		"shortcut": {
			"label": "Shortcut",
			"description": "A shortcut link for this category.",
			"type": "wiki-page-name"
		},
		"nocat": {
			"label": "Suppress maintenance categorization",
			"description": "Advanced: if \"yes\", do not mark this category as a maintenance category. "
		},
		"fiction": {
			"label": "Suppress categorization as a redirect tracking category",
			"description": "If \"yes\", suppresses the addition of this page to Category:Redirect tracking categories. This is useful if this page is already tagged with a subcategory of that category.",
			"type": "string"
		},
		"template2": {
			"type": "content"
		}
	},
	"paramOrder": [
		"from",
		"to",
		"parameters",
		"text",
		"shortcut",
		"fiction",
		"no_info",
		"soft_redirect",
		"not_maintenance",
		"sortkey",
		"nocat",
		"template",
		"template2"
	],
	"format": "inline",
	"description": "This template provides for a uniform header for use on all redirect categories."
}
</templatedata>}}

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

{{Other category-header templates}}
<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Category namespace templates]]
[[Category:Tracking templates]]
}}</includeonly>