| This is a documentation subpage for Template:Template category. It may contain usage information, categories and other content that is not part of the original template page. |
__EXPECTED_UNCONNECTED_PAGE__
| This template is used on approximately 36,000 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. |
{{Template category}} should be placed at the top of categories that contain template pages and their related subcategories. This template populates Category:Wikipedia template categories.
Usage
Syntax
- Basic
<syntaxhighlight lang="wikitext" style="overflow:auto;">
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
</syntaxhighlight>
- Basic topical
| No type | Navbox | Sidebar | Stub |
|---|---|---|---|
|
<syntaxhighlight lang="wikitext" style="overflow:auto;"> The pages listed in this category are templates.
This page is part of Wikipedia's administration and not part of the encyclopedia.
Further template category notes
This category contains pages in the template namespace. It should not be used to categorize articles or pages in other namespaces. To add a template to this category:
</syntaxhighlight> |
<syntaxhighlight lang="wikitext" style="overflow:auto;"> The pages listed in this category are meant to be navigation templates.
This page is part of Wikipedia's administration and not part of the encyclopedia.
Further template category notes
This category contains pages in the template namespace. It should not be used to categorize articles or pages in other namespaces. To add a template to this category:
</syntaxhighlight> |
<syntaxhighlight lang="wikitext" style="overflow:auto;"> The pages listed in this category are meant to be sidebar templates.
This page is part of Wikipedia's administration and not part of the encyclopedia.
Further template category notes
This category contains pages in the template namespace. It should not be used to categorize articles or pages in other namespaces. To add a template to this category:
</syntaxhighlight> |
<syntaxhighlight lang="wikitext" style="overflow:auto;"> The pages listed in this category are meant to be stub templates.
This page is part of Wikipedia's administration and not part of the encyclopedia.
Further template category notes
This category contains pages in the template namespace. It should not be used to categorize articles or pages in other namespaces. To add a template to this category:
</syntaxhighlight> |
- Full
<syntaxhighlight lang="wikitext" style="overflow:auto;">
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
</syntaxhighlight>
Parameters and examples
The template may be used without any parameters.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
The following, however, may be used to make the template more informative:
onright
- Use onright (or rhs) to place right-aligned boxes beside the template such as {{Portal}} (to provide link/s to related portal/s), {{Commons category}} (to provide a link to the same or a similarly-named Commons category), etc. If more than one box is included, ensure the widest one appears first (see example below) otherwise overlapping may occur.
<syntaxhighlight lang="wikitext">
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
</syntaxhighlight>
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
type
- Setting type to one of the following values adds a preset note as to which type of template the category (but not necessarily its subcategories) is meant to contain. The values are:
- ambox
- campaignbox
- (category header
- category heading
- catheader
- cat header
- cathead)
- conversion
- external link
- formatting
- function
- infobox
message- meta
- module
- (navigation
- navigational
- navbox)
- sidebar
- stub
- sub
- timeline
- (user
- userbox)
- If type is set to something other than one of these values, the default "The pages listed in this category are templates" note appears unmodified.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
container
- Set container as true, yes, etc. to identify the category as a container category, i.e. a category meant to contain only subcategories. A note requesting that no templates are added to the template category is then included. The category is automatically added to Category:Container categories.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
- An alternative to using container is to place {{Container category}} after the {{Template category}} template:
<syntaxhighlight lang="wikitext">
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
</syntaxhighlight>
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
topic
- Use topic to add a default description ending "...relating to topic", where topic is usually a wikilink to the main article associated with the category (e.g. United States for the Category:United States templates).
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
description
- Use description if a customised description is needed instead of – or, if topic also used, to follow – the default description above.
<syntaxhighlight lang="wikitext" style="overflow:auto;">
For templates relating specifically to the People's Republic of China (PRC) or the current Republic of China (ROC, "Taiwan"), see, respectively, People's Republic of China templates and Taiwan templates.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
</syntaxhighlight>
For templates relating specifically to the People's Republic of China (PRC) or the current Republic of China (ROC, "Taiwan"), see, respectively, People's Republic of China templates and Taiwan templates.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
- If the template has a separate documentation page (usually called "Template:template name/doc"), add
- [[Template:Template category/doc]]
- to the <includeonly> section at the bottom of that page. Otherwise, add
- <noinclude>[[Template:Template category/doc]]</noinclude>
- to the end of the template code, making sure it starts on the same line as the code's last character.
help
- Use help to replace the instructions on adding a template to the category (second paragraph of the "Further template category notes" section):
- To omit the default instructions, set help to no:
Tracking categories
TemplateData
TemplateData for Template category
<templatedata> { "params": { "onright": { "aliases": [ "rhs" ] }, "type": { "type": "string", "suggestedvalues": [ "ambox", "campaignbox", "category header", "conversion", "external link", "formatting", "function", "infobox", "meta", "module", "navigation", "sidebar", "stub", "sub", "timeline", "user" ] }, "container": { "label": "Is container category?", "description": "Whether or not the category is a \"container category\" meant to only contain subcategories", "type": "boolean" }, "topic": {}, "description": {}, "ALTTEXT": {}, "help": {}, "category": {} }, "description": "This template is used as a header for category pages that contain templates." } </templatedata>
See also
Other category-header templates