Template:Redirect category/doc

Not to be confused with Template:Category redirect.

See also: Template:Redirect category shell

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:

{{Redirect category |text= |from= |to= |template= |parameters= |template2= |sortkey= |no_info= |soft_redirect= |not_maintenance= |shortcut= }}

Parameters

• Use |from= and/or |to= to describe the purpose of the redirects in the category.
• The |template= parameter names the {{Redirect category shell}} template in redirect categories.
• Use |parameters= to list the associated redirect template (rcat) used with the Redirect category shell template, along with its parameters.
• For |sortkey=, add Template:Kbd for the header to include an instruction to use {{DEFAULTSORT:}} 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:

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

The default output produces:

The pages in this category are redirects. To add a redirect to this category, place {{[[Template:|]]|(redirect template link)}} on the second new line (skip a line) after #REDIRECT [[Target page name]]. For more information follow the links. Never substitute redirect template(s), nor place them on soft redirects.
See also the complete list of redirect templates and the redirect style guide.

This is a maintenance category, used for maintenance of the Wiki. It is not part of the main contents and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.

This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. They are not part of the Wiki's categorization scheme.

• This category is hidden on its member pages—unless the corresponding user preference (Appearance → Show hidden categories) is set.
• These categories can be used to track, build and organize lists of pages needing "attention en masse" (for example, pages using deprecated syntax), or that may need to be edited at someone's earliest convenience.
• These categories also serve to aggregate members of several lists or sub-categories into a larger, more efficient list (discriminated by classifications).

When |from= is used; for example, as:

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

It produces:

The pages in this category are redirects from a subject that does not exist as a standalone article. To add a redirect to this category, place {{[[Template:|]]|(redirect template link)}} on the second new line (skip a line) after #REDIRECT [[Target page name]]. For more information follow the links. Never substitute redirect template(s), nor place them on soft redirects.
See also the complete list of redirect templates and the redirect style guide.

This is a maintenance category, used for maintenance of the Wiki. It is not part of the main contents and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.

This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. They are not part of the Wiki's categorization scheme.

• This category is hidden on its member pages—unless the corresponding user preference (Appearance → Show hidden categories) is set.
• These categories can be used to track, build and organize lists of pages needing "attention en masse" (for example, pages using deprecated syntax), or that may need to be edited at someone's earliest convenience.
• These categories also serve to aggregate members of several lists or sub-categories into a larger, more efficient list (discriminated by classifications).

Continuing the example, if |to= is also used; like shown:

{{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=}}

It produces:

The pages in this category are redirects 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. To add a redirect to this category, place {{[[Template:|]]|(redirect template link)}} on the second new line (skip a line) after #REDIRECT [[Target page name]]. For more information follow the links. Never substitute redirect template(s), nor place them on soft redirects.
See also the complete list of redirect templates and the redirect style guide.

This is a maintenance category, used for maintenance of the Wiki. It is not part of the main contents and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.

This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. They are not part of the Wiki's categorization scheme.

• This category is hidden on its member pages—unless the corresponding user preference (Appearance → Show hidden categories) is set.
• These categories can be used to track, build and organize lists of pages needing "attention en masse" (for example, pages using deprecated syntax), or that may need to be edited at someone's earliest convenience.
• These categories also serve to aggregate members of several lists or sub-categories into a larger, more efficient list (discriminated by classifications).

When |template= is used; for example:

{{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=}}

It produces:

The pages in this category are redirects 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. To add a redirect to this category, place {{Rcat shell|(redirect template link)}} on the second new line (skip a line) after #REDIRECT [[Target page name]]. For more information follow the links. Never substitute redirect template(s), nor place them on soft redirects.
See also the complete list of redirect templates and the redirect style guide.

This is a maintenance category, used for maintenance of the Wiki. It is not part of the main contents and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.

This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. They are not part of the Wiki's categorization scheme.

• This category is hidden on its member pages—unless the corresponding user preference (Appearance → Show hidden categories) is set.
• These categories can be used to track, build and organize lists of pages needing "attention en masse" (for example, pages using deprecated syntax), or that may need to be edited at someone's earliest convenience.
• These categories also serve to aggregate members of several lists or sub-categories into a larger, more efficient list (discriminated by classifications).

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

{{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=}}

It produces:

The pages in this category are redirects 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. To add a redirect to this category, place {{Rcat shell|{{R to article without mention}}}} on the second new line (skip a line) after #REDIRECT [[Target page name]]. For more information follow the links. Never substitute redirect template(s), nor place them on soft redirects.
See also the complete list of redirect templates and the redirect style guide.

This is a maintenance category, used for maintenance of the Wiki. It is not part of the main contents and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.

This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. They are not part of the Wiki's categorization scheme.

• This category is hidden on its member pages—unless the corresponding user preference (Appearance → Show hidden categories) is set.
• These categories can be used to track, build and organize lists of pages needing "attention en masse" (for example, pages using deprecated syntax), or that may need to be edited at someone's earliest convenience.
• These categories also serve to aggregate members of several lists or sub-categories into a larger, more efficient list (discriminated by classifications).

And if |sortkey= is set to "yes"; for example:

{{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}}

It produces:

The pages in this category are redirects 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. To add a redirect to this category, place {{Rcat shell|{{R to article without mention}}}} on the second new line (skip a line) after #REDIRECT [[Target page name]], and when needed, place {{DEFAULTSORT:<sort key>}} on the first new line after the shell template. For more information follow the links. Never substitute redirect template(s), nor place them on soft redirects.
See also the complete list of redirect templates and the redirect style guide.

This is a maintenance category, used for maintenance of the Wiki. It is not part of the main contents and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.

This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. They are not part of the Wiki's categorization scheme.

• This category is hidden on its member pages—unless the corresponding user preference (Appearance → Show hidden categories) is set.
• These categories can be used to track, build and organize lists of pages needing "attention en masse" (for example, pages using deprecated syntax), or that may need to be edited at someone's earliest convenience.
• These categories also serve to aggregate members of several lists or sub-categories into a larger, more efficient list (discriminated by classifications).

Adding a shortcut

One shortcut can be installed within the lower maintenance banner; for example:

{{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}}

It produces:

The pages in this category are redirects 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. To add a redirect to this category, place {{Rcat shell|{{R to article without mention}}}} on the second new line (skip a line) after #REDIRECT [[Target page name]], and when needed, place {{DEFAULTSORT:<sort key>}} on the first new line after the shell template. For more information follow the links. Never substitute redirect template(s), nor place them on soft redirects.
See also the complete list of redirect templates and the redirect style guide.

This is a maintenance category, used for maintenance of the Wiki. It is not part of the main contents and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.

This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. They are not part of the Wiki's categorization scheme.

• This category is hidden on its member pages—unless the corresponding user preference (Appearance → Show hidden categories) is set.
• These categories can be used to track, build and organize lists of pages needing "attention en masse" (for example, pages using deprecated syntax), or that may need to be edited at someone's earliest convenience.
• These categories also serve to aggregate members of several lists or sub-categories into a larger, more efficient list (discriminated by classifications).

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

• {{Redirect from alternative language category}}
• {{Redirect to alternative language category}}

These two templates will also automatically categorize the page into the correct parent category. See the edit page for Category:Redirects from Catalan-language terms for an example of template usage.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Redirect category in articles based on its TemplateData.

TemplateData for Redirect category

This template provides for a uniform header for use on all redirect categories.

Parameter		Description	Type	Status
Beginning text	text	Adds text to the beginning of the template message.	Content	optional
Redirects from	from	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	Content	suggested
Redirects to	to	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	Content	suggested
Shell template	template	Advanced: the shell template to use in the example invocation. Should be entered as the name of a template, without the "Template:" prefix. Default Redirect category shell	String	optional
Redirect template sample invocation	parameters	An example invocation of the redirect template for this category. Should be surrounded by {{tl}} or similar. Example {{tl|R to article without mention}}	Content	suggested
Display DEFAULTSORT notice	sortkey	Advanced: if "yes", adds note to use {{DEFAULTSORT:}} when appropriate.	String	optional
Suppress info	no_info	If "yes", removes the warning about not substituting redirect templates or placing them on soft redirects.	String	optional
Allow soft redirects	soft_redirect	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.	String	optional
Suppress maintenance categorization	not_maintenance	Advanced: if "yes", do not mark this category as a maintenance category.	String	optional
Shortcut	shortcut	A shortcut link for this category.	Page name	optional
Suppress maintenance categorization	nocat	Advanced: if "yes", do not mark this category as a maintenance category.	Unknown	optional
Suppress categorization as a redirect tracking category	fiction	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.	String	optional
template2	template2		Content	optional

Format: inline

See also

• Wikipedia:Template index/Redirect pages
• {{R template index}}