Template:Template category/doc

The {{template category}} template should be placed at the top of categories that contain only template pages and their related subcategories.

Usage

Full syntax

{{template category
|type = 
|topic = 
|description = 
|help = 
|container =
}}

Parameters

The following optional parameters may be used:

topic

Adds the default description "Templates relating to topic." — where topic is usually a wikilink to the main article associated with the category (e.g. CannaQAWiki:Backlog for the Category:CannaQAWiki backlog templates). See Example 1, and Example 2 below.

description

Use this if a customised description is needed, instead of (or, if topic also used, to follow) the default description above. See Example 2, Example 3, and Example 4 below.

type

Adds a note as to which type of template the category (but not necessarily its subcategories) is meant to contain. See Example 1, Example 2, and Example 4 below. Currently, setting type to one of eleven values produces a preset note. The values are:

ambox · campaignbox · conversion · external link · formatting · function
infobox · meta · navbox · navigation · sidebar · stub · timeline · userbox

If type is set to something other than one of these values, the default message: "The pages listed in this category are templates." appears.

help

Use this to provide customised instructions rather than the default explanation as to how to add a template to the category.

container

Use this for container categories by adding |container=yes to the template. The message: "Do not add templates to this category: instead, use the appropriate sub-category." will appear. See Example 3 below.

Examples

Example 1

{{template category
|type  = navbox
|topic = [[CannaQAWiki:Backlog|editing backlogs]]
}}

Navbox templates relating to editing backlogs.  The pages listed in this category are meant to be navigation templates. 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 include a template in this category, add [[Template:Template category/doc]] to the <includeonly> section at the bottom of the template's /doc subpage if such a page exists. 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 last character of the code.

---

Example 2

{{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}}.</small>
}}

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. 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 include a template in this category, add [[Template:Template category/doc]] to the <includeonly> section at the bottom of the template's /doc subpage if such a page exists. 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 last character of the code.

---

Example 3

{{template category
|description = Here's a ''description'' without a preceding ''topic'' statement.
|container = yes
}}

Here's a description without a preceding topic statement. The pages listed in this category are templates. This page is part of CannaQAwiki'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. Do not add templates to this category: instead, use the appropriate sub-category.

---

Example 4

{{template category
|type = external link
|description = '''Templates aiding the creation and formatting of external links to [[topic]] databases.'''
}}

Templates aiding the creation and formatting of external links to topic databases. The pages listed in this category are meant to be templates providing external links. 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 include a template in this category, add [[Template:Template category/doc]] to the <includeonly> section at the bottom of the template's /doc subpage if such a page exists. 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 last character of the code.

See also

Other category header templates

Namespaces

• Main: {{Set category}} · {{Stub category}} · {{Parent-only stub category}} · {{Regional stub category}}
• File: {{File template notice}} · {{Media template notice}}
• Help: {{Help category}}
• Portal: {{Portal category}}
• Template: {{Template category}}
• User: {{User category}} · {{Sockpuppet category}}

Maintenance

• {{All included}}
• {{Container category}}
• {{Category diffuse}}
• {{Distinguished subcategory}}
• {{Empty category}}
• {{Recent changes category}}
• {{Redirect category}}
• {{Very large}}
• {{Wikipedia category}}