Template:Redirect category
{{Redirect category 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 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).
| Template documentation follows |
|---|
| Note: the template above may sometimes be partially or fully invisible. |
| Visit "Template:Redirect category/doc" to edit its documentation if it is available. (How does this work?) |
| This template is used on approximately 5,100 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
- Not to be confused with Template:Category redirect.
| This template should never be substituted – use {{Redirect category}}. |
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 yes 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:
{{[[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 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:
{{[[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 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:
{{[[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 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=Redirect category shell|parameters=|sortkey=}}
It produces:
{{Redirect category 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 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=Redirect category shell|parameters={{tl|R to article without mention}}|sortkey=}}
It produces:
{{Redirect category 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 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=Redirect category shell|parameters={{tl|R to article without mention}}|sortkey=yes}}
It produces:
{{Redirect category 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 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=Redirect category shell|parameters={{tl|R to article without mention}}|sortkey=yes|shortcut=CAT:RAW}}
It produces:
{{Redirect category 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 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:
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
TemplateData for Redirect category
| 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.
| Content | suggested |
| Redirects to | to | The sort of page that redirects with this category's template should redirect to.
| 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.
| String | optional |
| Redirect template sample invocation | parameters | An example invocation of the redirect template for this category. Should be surrounded by {{tl}} or similar.
| 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 redirect categorization | nocat | Advanced: if "yes", do not mark this category as a redirect 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 | |
See also
Other category-header templates
Category-heading templates | |
|---|---|
| By namespace | |
| Maintenance |
- Template:Redirect category invokes Module:Navbox using Lua.
Usage
This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.
The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.
Syntax
{{navbox
|state = uncollapsed, collapsed, plain, autocollapse (default)
|name = mandatory - name of the template
|style = optional - style for the whole table
|title = mandatory - navbox header
|gtitleN = optional - title of N-th group of items
|styleN = optional - style for groupN; i.e. text-align
|groupN = mandatory - list of groups of items
|fstyle = optional - style for footer ; i.e. text-align
|footer = optional - navbox footer
}}
- Groups: Currently there is no technical limit to the maximum number of groups.
- Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
- Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
- Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
- Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
- Line breaks: Line-breaks (
<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN. - Bullets: Create unordered lists with lines beginning with *.
- Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! (
{{!}}).
States
- Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
- Uncollapsed: Forces the navbox to be displayed.
- All of the navboxes in this documentation are in the uncollapsed state.
- Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
- Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Plain: Removes the "show/hide" link.
Sub-groups
- For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
- To create sub-groups within
{{navbox}}, certain parameters are to be included:- The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
- The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|gtype2 = Subgroup (mandatory)
|group2 =
{{navbox
|subgroup = yes (mandatory)
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Collapsible sub-groups
- For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
- To create collapsible sub-groups within
{{navbox}}, these parameters need to be included:- The parent navbox is almost always uncollapsed (state=uncollapsed).
- The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
- The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
- The nested collapsible navbox is forcefully collapsed (state=collapsed).
{{navbox
|state = uncollapsed
|name =
|gtype1 = Subgroup
|group1 =
{{navbox
|collapsible = yes
|state = collapsed
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Use of images
- The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
- Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.
Link and file share the same name
{{plink|Item}}
File name differs from the link
{{plink|Item|File}}
Link and file share the same name, but different text is desired to display
{{plink|Item|alt=Text}}
File name differs from the link and different text is desired to display
{{plink|Item|File|alt=Text}}
Categorising
Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.
There are 2 methods of categorising pages with navboxes:
The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.
Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.
Examples
To see the following navboxes in action, see Template:Navbox.
Single line navbox with centered list
{{navbox
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Navbox with standard footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|footer = Centered footer
}}
Navbox with styled footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|fstyle = text-align:right
|footer = Right-aligned footer
}}
Multiple line navbox
{{navbox
|name =
|title =
|gtitle1 = Group title 1
|group1 =
|gtitle2 = Group title 2
|group2 =
|gtitle3 = Group title 3
|group3 =
}}
Collapsed navbox
{{navbox
|state = collapsed
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox with Tnavbar
{{navbox
|state = plain
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox without Tnavbar
{{navbox
|state = plain
|title =
|style1 = text-align:center
|group1 =
}}
Complicated navbox
{{navbox
|state = uncollapsed
|name =
|title =
|gtitle1 = Level 1 Title 1
|group1 =
|gtitle2 = Level 1 Title 2
|group2 =
|gtitle3 = Level 1 Title 3
|group3 =
|gtitle4 = Level 1 Title 4
|group4 =
|gtitle5 = Level 1 Title 5
|gtype5 = Subgroup
|group5 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 2 Title 1
|group1 =
|gtitle2 = Level 2 Title 2
|group2 =
|gtitle3 = Level 2 Title 3
|gtype3 = Subgroup
|group3 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 3 Title 1
|group1 =
|gtitle2 = Level 3 Title 2
|group2 =
}}
|gtitle4 = Level 2 Title 4
|group4 =
}}
|gtitle6 = Level 1 Title 6
|group6 =
|gtitle7 = Level 1 Title 7
|group7 =
|fstyle =
|footer =
}}
Preventing unwanted documentation
The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).
Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.