Template:Template category/doc

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

{{Template category
|description=
}}

Basic topical

Syntax of {{Template category}}

No type	Navbox	Sidebar	Stub
{{Template category |topic= }}	{{Template category |type=navbox |topic= }}	{{Template category |type=sidebar |topic= }}	{{Template category |type=stub |topic= }}

Full

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

Parameters and examples

The template may be used without any parameters.

Expand

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.

Expand

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:

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.

Expand

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.

Expand

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

---

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.

Expand

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.

Expand

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. The category is automatically added to  Category:Container categories.

Expand

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.

Expand

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:

Expand

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

Expand

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.

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

Expand

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.

Expand

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.

Expand

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.

Expand

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.

Expand

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 [[Taiwan|Republic of China (ROC, "Taiwan")]], see, respectively, {{c|People's Republic of China templates}} and {{c|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 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.

Expand

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.

Expand

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.

Expand

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.

help

---

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

Expand

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.

Expand

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:

Expand

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.

Expand

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 category

Uses with a topic or description parameter are tracked:

• Category:Template:Template category with no topic or description (3)

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

{
	"params": {
		"onright": {
			"aliases": [
				"rhs"
			]
		},
		"type": {},
		"container": {},
		"topic": {},
		"description": {
			"aliases": [
				"1"
			]
		},
		"ALTTEXT": {},
		"help": {
			"aliases": [
				"2"
			]
		},
		"category": {}
	},
	"description": "This template is used as a header for category pages that contain templates."
}

See also

 Other category-header templates