Template:Template category/doc

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

This template is used on approximately 32,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

Full syntax

{{Template category
| onright = 
| type = 
| container = 
| topic = 
| description = 
| ALTTEXT = 
| help = 
}}

Parameters

The template may be used without any parameters, i.e. as {{Template category}}.

With no parameters

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:

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:

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
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.

type alone

{{Template category |type=sidebar}}

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:

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.

Further examples of type's output appear in the examples below.

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).

topic alone

{{Template category |topic=the [[United States]]}}

Templates relating to the United States.

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:

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, topic

{{Template category |type=infobox |topic=the [[United States]]}}

Infobox templates relating to the United States.

The pages listed in this category are meant to be infobox 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:

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.

type, topic, description

{{Template category
| type = navbox
| topic = [[China]]
| description = <br />{{small|For templates relating specifically to the [[People's Republic of China|People's Republic of China (PRC)]] or the current [[Republic of China|Republic of China (ROC, "Taiwan")]], see, respectively, {{c|People's Republic of China templates}} and {{c|Republic of China (Taiwan) templates}}.}}
}}

Navbox templates relating to China.
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 Republic of China (Taiwan) templates.

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:

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 alone

{{Template category |description=This text is supplied by the ''description'' parameter.}}

This text is supplied by the description parameter.

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:

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.

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.

topic, onright

{{Template category
| topic = the [[United States]]
| onright = {{Commons category|United States|the United States}}{{Portal|United States}}
}}

Templates relating to the United States.

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:

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.

container alone

{{Template category |container=true}}

Note: Please do not add templates to this category; instead, use one of its subcategories.

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:

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:

{{Container category}} following {{Template category}}

{{Template category
| type = ''type''
| topic = ''[[topic]]''
| description = This text supplied by the ''description'' parameter.
}}
{{Container category}}

Templates relating to topic. This text supplied by the description parameter.

The pages listed in this category are meant to be type 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:

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.

This is a container category. Due to its scope, it should contain only subcategories.

help

Use help to replace the instructions on adding a template to the category (second paragraph of the "Further template category notes" section):

replace help text

{{Template category |help=This text supplied by the ''help'' parameter.}}

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.

This text supplied by the help parameter.

To omit the default instructions, set help to no:

omit help text

{{Template category |help=no}}

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.

Tracking

Uses with a topic or description parameter are tracked:

Category:Template:Template category with no topic or description (population: 37)

Purge this page to update the totals

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Template category

No description.

Template parameters
Parameter		Description	Type	Status
onright	`onright` `rhs`	no description	Unknown	optional
type	`type`	no description	Unknown	optional
container	`container`	no description	Unknown	optional
topic	`topic`	no description	Unknown	optional
description	`description` `1`	no description	Unknown	optional
ALTTEXT	`ALTTEXT`	no description	Unknown	optional
help	`help` `2`	no description	Unknown	optional
category	`category`	no description	Unknown	optional

Template:Template category/doc

Usage

Full syntax

Parameters

type

topic

description

onright

container

help

Tracking

TemplateData

See also

Other category-header templates