Template:Redirect category/doc

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:


 * 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 "yes" for the header to include an instruction to use 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:

The default output produces:

When from is used; for example, as:

It produces:

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

It produces:

When template is used; for example:

It produces:

And with the specific Rcat used in parameters; for example:

It produces:

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

It produces:

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

It produces:

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 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: These two templates will also automatically categorize the page into the correct parent category. See the edit page for for an example of template usage.
 * Redirect from alternative language category
 * Redirect to alternative language category