Template:Redirect category shell/doc

	This is a documentation subpage for Template:Redirect category shell. It contains usage information, categories and other content that is not part of the original template page.

	Notice This template supplements the redirect categorization done by adding rcats individually to redirects. This template should not be substituted nor should this template and most redirect category (rcat) templates be used to tag soft redirects.

This template is used to add one or more appropriate redirect category (rcat) templates, along with their parameters, to redirects. Additionally, this template automatically senses, describes, categorizes and changes protection levels when appropriate. A third important function is to help editors learn more about redirect categorization by use of the manifold sort. For more information see the page below and the main rcat index.

Purpose

As with the This is a redirect template, this template is based on a proposal to standardize redirect templates (rcats). Its basic purpose is to simplify the process of tagging and categorizing redirects.

Like the This is a redirect template, this shell template is also able to help newer contributors learn the redirect category system. Details of this part of the purpose of this shell template may be found in the When used alone section below.

Protection levels are automatically detected by this template by use of {{pp}} and {{pp-move}}. When edit protection or move protection (or both) is applied to a redirect that has been tagged with this template, the protection level is automatically detected, and the redirect will be tagged with a protection rcat and sorted to the appropriate protection-related category(ies). When protection is altered or removed, then the protection-related rcats and category(ies) will also be (automatically) changed or removed from the redirect.

Usage

Used by itself with no parameters, for example, {{Redirect category shell}} (and its alias {{Rcat shell}}), the template will appear as it does at the top of this page, and the redirect will populate Category:Miscellaneous redirects. That category will also be populated if the first parameter is left empty while rcats occupy the second parameter. This is useful when an editor adds rcats and yet feels unsure that there may be at least one other rcat with category that may be used to tag the redirect. Monitors of the Miscellaneous redirects category will then help decide if another rcat(s) is needed. Then the empty first parameter may be excluded by removing either the first or second pipe. That will remove the redirect from Category:Miscellaneous redirects. See below for more information.

This template may hold any number of different redirect category (rcat) templates, usually from one to seven. The choices for editors are listed at Wikipedia:Template index/Redirect pages both alphabetically and by function. Any of those rcats may be used either with their full template name, e.g., R from alternative language, or with an alias (shortcut redirect), which may be found in each rcat's documentation.

An unnamed parameter, |1=, has been introduced in this template and works as follows:

{{Redirect category shell|1=
{{rcat 1}}
{{rcat 2}}
{{rcat 3}}
{{rcat N}}
}}

or the |1= may be omitted:

{{Redirect category shell|
{{rcat 1}}
{{rcat 2}}
{{rcat 3}}
{{rcat N}}
}}

As with all templates that have unnamed (numbered) parameters, the numbers and equal signs may be omitted.

"N" represents the highest number of rcats that can be used in this template, and at this point the only limit would be any wiki markup ceiling that may exist. Usually, from one to seven rcats suffice; however, more rcats can be used if required.

The actual sequence of rcats is left to editors – there is no priority as to which rcat should be "first" and which rcats should "follow" in any particular order.

A second unnamed parameter, |2=, has also been introduced. This gives this template the same "help" functionality that is used in the This is a redirect template. If the first parameter is left "empty", then Category:Miscellaneous redirects will be populated:

{{Redirect category shell|1=|2=
{{rcat 1}}
{{rcat 2}}
{{rcat 3}}
{{rcat N}}
}}

or if a second pipe is placed directly after the first pipe, then that will accomplish the same manifold sort:

{{Redirect category shell||
{{rcat 1}}
{{rcat 2}}
{{rcat 3}}
{{rcat N}}
}}

Note the double pipe after the word "shell" above, which indicates an empty first parameter. Editors who monitor the Miscellaneous redirects category will come to the redirect and check, add or remove rcats as needed.

Also, when used by itself this template will appear as it does at the top of this page and populate the Miscellaneous redirects category:

{{Redirect category shell}}

Generally for good readability on the edit screen, this template is placed beginning on the third line of that screen as follows:

Line 1: #REDIRECT [[target page name)]]

 Line 2: (please leave this line blank for emphasis and ease of reading by editors)

Line 3: {{Redirect category shell|{{R from move}}{{R from shortcut}}

See also: section titled Mbox note below.

Parameters

In addition to the unnamed |1= and |2= parameters, there is a "hatnote" parameter, |h=, which provides an italicized TOP note when needed. For example:

{{Redirect category shell|h=This mangaka recently changed the spelling of her name.|
{{R from misspelling}}
}}

...uses the rcat {{R from misspelling}} and produces:

This page is a redirect.                 This mangaka recently changed the spelling of her name. From a misspelling: This is a redirect from a misspelling or typographical error. The correct form is given by the target of the redirect. This redirect is made available to aid searches. Pages that use this link should be updated to link directly to the target without the use of a piped link that hides the correct details. When appropriate, protection levels are automatically sensed, described and categorized.

An error box appears that illustrates what happens if an editor uses an rcat in the wrong namespace. Correct namespaces are found on individual rcat documentation pages. In addition to the error box, the redirect will not be sorted to the rcat's category; instead it will populate Category:Pages with templates in the wrong namespace! If an error box appears when an edit is previewed, then appropriate changes can be made before the redirect page is actually saved.

Also, note the pipe symbol (|) that follows the text in the |h= parameter. If this pipe is omitted, very unusual results will be seen when your edit is previewed or saved. Be sure to include that pipe at the very end of the text if the |h= parameter is used to form a hatnote.

Rcat parameters

In addition to this template's ability to act as a shell template for rcats, it accepts all of the parameters that rcats accept. Rcat parameters, when needed, will work in this template.

The position an rcat holds will have no effect on the parameters of other rcats that are used to tag a redirect. It does not matter if the relative position of the rcats changes for any reason, their individual parameters will continue to be effective. If more rcat parameters are used, then they work the same way.

When used alone

This template is designed to help contributors who are unfamiliar with categorizing redirects by enabling them to sort redirects into the monitored Category:Miscellaneous redirects category. Do not hesitate to use this important function to help with sorting redirects to correct and appropriate categories.

There are two ways to sort a redirect into the Miscellaneous redirects category. When this template is used without any rcats, it will perform the miscellaneous sort:

{{Redirect category shell}}...

Redirect category shell This page is a redirect. The following categories are used to track and monitor this redirect: Important – Please Read! This template should not be applied without parameters by bot nor by any automated or semi-automated process. It should not be used without parameters unless you want to learn how to categorize redirects. For editors who want to learn how to categorize redirects, this template is a learning tool. Only those editors who intend to return to the redirect to learn which rcats to use should apply this template without parameters, or with an empty first parameter! Manifold sort: If help is needed to determine appropriate categories, then this redirect populates Miscellaneous redirects. Monitors of that category will check this redirect and add or remove rcats as needed. When appropriate, protection levels are automatically sensed, described and categorized.

Also, if one or more rcats are known, but an editor is unsure that there might be one or more other rcats that are needed, then leave the first parameter blank (type two pipes together → ||):

{{Redirect category shell||
{{R from pseudonym}}
}}

Redirect category shell This page is a redirect. The following categories are used to track and monitor this redirect: Important – Please Read! This template should not be applied without parameters by bot nor by any automated or semi-automated process. It should not be used without parameters unless you want to learn how to categorize redirects. For editors who want to learn how to categorize redirects, this template is a learning tool. Only those editors who intend to return to the redirect to learn which rcats to use should apply this template without parameters, or with an empty first parameter! Manifold sort: If help is needed to determine appropriate categories, then this redirect populates Miscellaneous redirects. Monitors of that category will check this redirect and add or remove rcats as needed. From a pseudonym: This is a redirect from a pseudonym, for example the stage name of a performing artist or the pen name of a writer.. When appropriate, protection levels are automatically sensed, described and categorized.

Monitors of the Miscellaneous redirects category will check the redirect, add other rcats if needed and then remove the empty first parameter.

Other templates

This template may also carry and hold other templates within it. Even the {{DEFAULTSORT}} magic word and a sort key may be used either inside this template or below it. Another template commonly used within the Redirect category shell template is {{Italic title}} and its shortcut to format titles in italics. Some rcats such as {{R from book}} and {{R from film}} automatically format the redirect names in italics. Any appropriate template may be used within this shell template in the following manner:

{{Redirect category shell|
{{R from move}}
{{R from alternative name}}
{{Italic title}}
{{DEFAULTSORT:Hobbit, The}}
}}

Tracking categories

• Category:Redirect category shell without parameters

TemplateData

This template may be used to add one or more appropriate redirect category (rcat) templates, along with their parameters, to redirects. Additionally, this template automatically senses, describes, categorizes and changes protection levels when appropriate.

Template parameters

Parameter		Description	Type	Status
Redirect categories	1	1 or more redirect category templates. Example {{R from alternative name}}	Content	suggested
Redirect categories (more needed)	2	Same as Redirect categories, except that the redirect is also added to Category:Miscellaneous redirects.	Content	optional
Hatnote	h	A hatnote to display above the redirect categories.	Line	optional
No category	nocat	Don't add this redirect to Category:Miscellaneous redirects, even if Redirect categories has been left empty.	Boolean	optional
Category	category	The category to add this redirect to if the Redirect categories parameter is empty. Defaults to Category:Miscellaneous redirects. Example [[Category:Miscellaneous redirects]]	Line	optional