Template:Redirect category/doc
This is a documentation subpage for Template:Redirect category. It contains usage information, categories and other content that is not part of the original template page. |
This template should not be substituted. |
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|from=|to=|template=|parameters=|sortkey=}}
- 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:
The pages in this category are redirects. To add a redirect to this category, place {{[[Template:|]]}} on the second new line after #REDIRECT [[Target page name]] . Alias/shortcuts may also be used; for example: {{Rcat shell}} is a shortcut for {{Redirect category shell}} and may be used interchangeably. For more information, follow the template link. Never substitute rcat(s), nor place them on soft redirects.Also see the complete list of redirect templates and the redirect style guide. |
This is a maintenance category. It is used for maintenance of the Wikipedia project and is not part of the encyclopedia. It contains pages that are not articles, or it groups articles by status rather than subject. Do not include this category in content categories. This is a hidden category. It is not shown on its member pages, unless the corresponding user preference 'Show hidden categories' is set. This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. Pages are added to tracking categories through templates. |
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:|]]}} on the second new line after #REDIRECT [[Target page name]] . Alias/shortcuts may also be used; for example: {{Rcat shell}} is a shortcut for {{Redirect category shell}} and may be used interchangeably. For more information, follow the template link. Never substitute rcat(s), nor place them on soft redirects.Also see the complete list of redirect templates and the redirect style guide. |
This is a maintenance category. It is used for maintenance of the Wikipedia project and is not part of the encyclopedia. It contains pages that are not articles, or it groups articles by status rather than subject. Do not include this category in content categories. This is a hidden category. It is not shown on its member pages, unless the corresponding user preference 'Show hidden categories' is set. This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. Pages are added to tracking categories through templates. |
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:|]]}} on the second new line after #REDIRECT [[Target page name]] . Alias/shortcuts may also be used; for example: {{Rcat shell}} is a shortcut for {{Redirect category shell}} and may be used interchangeably. For more information, follow the template link. Never substitute rcat(s), nor place them on soft redirects.Also see the complete list of redirect templates and the redirect style guide. |
This is a maintenance category. It is used for maintenance of the Wikipedia project and is not part of the encyclopedia. It contains pages that are not articles, or it groups articles by status rather than subject. Do not include this category in content categories. This is a hidden category. It is not shown on its member pages, unless the corresponding user preference 'Show hidden categories' is set. This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. Pages are added to tracking categories through templates. |
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}} on the second new line after #REDIRECT [[Target page name]] . Alias/shortcuts may also be used; for example: {{Rcat shell}} is a shortcut for {{Redirect category shell}} and may be used interchangeably. For more information, follow the template link. Never substitute rcat(s), nor place them on soft redirects.Also see the complete list of redirect templates and the redirect style guide. |
This is a maintenance category. It is used for maintenance of the Wikipedia project and is not part of the encyclopedia. It contains pages that are not articles, or it groups articles by status rather than subject. Do not include this category in content categories. This is a hidden category. It is not shown on its member pages, unless the corresponding user preference 'Show hidden categories' is set. This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. Pages are added to tracking categories through templates. |
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 after #REDIRECT [[Target page name]] . Alias/shortcuts may also be used; for example: {{Rcat shell}} is a shortcut for {{Redirect category shell}} and may be used interchangeably. For more information, follow the template link. Never substitute rcat(s), nor place them on soft redirects.Also see the complete list of redirect templates and the redirect style guide. |
This is a maintenance category. It is used for maintenance of the Wikipedia project and is not part of the encyclopedia. It contains pages that are not articles, or it groups articles by status rather than subject. Do not include this category in content categories. This is a hidden category. It is not shown on its member pages, unless the corresponding user preference 'Show hidden categories' is set. This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. Pages are added to tracking categories through templates. |
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 after #REDIRECT [[Target page name]] , and when needed, place {{DEFAULTSORT:<sort key>}} on the first new line after the shell template. Alias/shortcuts may also be used; for example: {{Rcat shell}} is a shortcut for {{Redirect category shell}} and may be used interchangeably. For more information, follow the template link. Never substitute rcat(s), nor place them on soft redirects.Also see the complete list of redirect templates and the redirect style guide. |
This is a maintenance category. It is used for maintenance of the Wikipedia project and is not part of the encyclopedia. It contains pages that are not articles, or it groups articles by status rather than subject. Do not include this category in content categories. This is a hidden category. It is not shown on its member pages, unless the corresponding user preference 'Show hidden categories' is set. This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. Pages are added to tracking categories through templates. |
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 after #REDIRECT [[Target page name]] , and when needed, place {{DEFAULTSORT:<sort key>}} on the first new line after the shell template. Alias/shortcuts may also be used; for example: {{Rcat shell}} is a shortcut for {{Redirect category shell}} and may be used interchangeably. For more information, follow the template link. Never substitute rcat(s), nor place them on soft redirects.Also see the complete list of redirect templates and the redirect style guide. |
This is a maintenance category. It is used for maintenance of the Wikipedia project and is not part of the encyclopedia. It contains pages that are not articles, or it groups articles by status rather than subject. Do not include this category in content categories. This is a hidden category. It is not shown on its member pages, unless the corresponding user preference 'Show hidden categories' is set. This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. Pages are added to tracking categories through templates. |
{| id="shortcut" class="noprint" style="border: 1px solid #999; background: #fff; margin: 0 0 .5em 1em; text-align: center; padding: 5px; float: right; clear: right; font-size: smaller;"
|-
! Shortcut: |
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.
See also
Other category-header templates