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.

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 |topic= |description= |type= |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. United States for the Category:United States 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 · 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 = the [[United States]]
}}

This category is used for categorizing templates.
It should not contain media files or pages outside the template namespace (with some exceptions).

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

	This category is used for categorizing templates. It should not contain media files or pages outside the template namespace (with some exceptions).
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.

Example 3

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

	This category is used for categorizing templates. It should not contain media files or pages outside the template namespace (with some exceptions).
Here's a description without a preceding topic statement.

Example 4

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

	This category is used for categorizing templates. It should not contain media files or pages outside the template namespace (with some exceptions).
Templates aiding the creation and formatting of external links to topic databases.