View source for Template:Category redirect/doc

<noinclude>{{pp-protected|small=yes}}</noinclude>{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{nosubst}}
{{Bot use warning|bots={{U|JJMC89 bot}} and {{U|RussBot}}}}
{{Distinguish|Template:Redirect category}}
{{For|the Wikipedia policy on redirecting categories|WP:CATRED}}
{{tsh|Catred|Catr}}

== Instructions ==

Example: To redirect from [[:Category:Authors]] to [[:Category:Writers]], simply add the following to [[:Category:Authors]]:
:<syntaxhighlight lang="wikitext" inline>{{Category redirect|Writers}}</syntaxhighlight> or
:<syntaxhighlight lang="wikitext" inline>{{Category redirect|Category:Writers}}</syntaxhighlight> with optional namespace prefix

This template adds category pages to [[:Category:Wikipedia soft redirected categories]].

If a category redirect exists but is not likely to be useful (see criteria in [[WP:Category redirects that should be kept]]), start a discussion at [[WP:CFD]].

In the case of redirects that are [[template:resolve category redirect|resolved]] or otherwise used by other templates, consider also adding the template {{tl|R from category navigation}} and/or {{tl|R from template-generated category}} as the unnamed second parameter. For example, on [[:Category:16th-century Czech people]]:
<div style="margin-left:1.6em;"><syntaxhighlight lang="wikitext">{{Category redirect | 16th-century people from Bohemia | {{R from category navigation}} }}</syntaxhighlight></div>

If more than one "R from" templates are applicable, as on [[:Category:Years of the 19th century in Sri Lanka]], do <strong>not</strong> use a pipe between the two. They should both be included in the second parameter:
<div style="margin-left:1.6em;"><syntaxhighlight lang="wikitext">{{Category redirect | Years of the 19th century in Ceylon | {{R from category navigation}} {{R from template-generated category}} }}</syntaxhighlight></div>

If a category redirect is intended to be kept when the above templates are not applicable, e.g. for alternative spellings, then add {{para|keep|yes}} to suppress a deletion link that is usually displayed to administrators. It is not necessary to specify this when using the "R from" templates, because this function is switched on by their presence. It is <strong>not</strong> automatically enabled when a Wikidata item is attached to the category (see [[#Redirects with Wikidata items|the next section]]), because caching issues often prevent the link from showing up when the category redirect was a temporary addition. If such a redirect should be kept, add {{para|keep|yes}}.

=== Redirects with Wikidata items ===
Redirects with Wikidata items are automatically categorized as such; there is no need to manually add {{t|soft redirect with Wikidata item}}. For an example, see [[:Category:Fictional schoolchildren]].

=== Templates in the target name ===
Note that the use of multiple templates in the target name, or templates with any parameters, will prevent the redirect from being resolved by {{t|Resolve category redirect}}, as will the character <code>|</code>. Category redirects which cannot be resolved are tracked in [[:Category:Wikipedia soft redirected categories which are not resolved correctly]].

For more information, see [[Template:Resolve category redirect#Templates]].

== Errors ==
Non-empty categories will be listed at {{cl|Wikipedia non-empty soft redirected categories|count=yes}}.

Additionally, [[:Category:Wikipedia category-redirect box parameter needs fixing]] tracks five different errors with the category redirect box itself:
* Infinite loops of length one will be listed at {{cl|Wikipedia soft redirected categories which target themselves‎|count=yes}}
* Redirects with non-existent targets will be listed at {{cl|Wikipedia soft redirected categories whose target does not exist‎|count=yes}}
* Templates with unknown parameters will be listed at {{cl|Pages using category redirect with unknown parameters|count=yes}}
* Category redirects which are not correctly resolved via {{t|resolve category redirect}} will be listed at {{cl|Wikipedia soft redirected categories which are not resolved correctly|count=yes}}
* Double category redirects will be listed at {{cl|Double-redirected categories|count=yes}}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Destination category",
			"description": "Category that this category should redirect to (Category: prefix is optional)",
			"example": "Category:Writers",
			"type": "wiki-page-name",
			"required": true
		},
		"2": {
			"label": "Redirect categories",
			"description": "This parameter is for various {{redirect template}}s",
			"example": "{{R from category navigation}}",
			"type": "string"
		},
		"nocat": {
			"description": "If \"true\", suppresses categorization. This should only be used for examples.",
			"example": "yes",
			"type": "boolean",
			"default": "false"
		},
		"keep": {
			"description": "If \"true\", hides the link for admins to delete the category if empty. This feature is automatically enabled if any {{redirect templates}} are supplied.",
			"type": "boolean",
			"default": "false"
		}
	},
	"description": "Marks category as a soft-redirect",
	"format": "inline",
	"paramOrder": [
		"1",
		"2",
		"nocat",
		"keep"
	]
}
</templatedata>

== See also ==
* [[Template:Category redirect/core]]
* [[Template:Category disambiguation]]
* [[Template:Resolve category redirect]]
* [[Wikipedia:Template index/Category namespace]]

<includeonly>{{sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Redirect templates]]
[[Category:Category namespace templates]]
[[Category:Soft redirect templates]]
}}</includeonly>