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= |portal= |help= }}

Parameters

The following parameters that are all optional, may also be used:

type

Adds a note as to which type of template the category (but not necessarily its subcategories) is meant to contain, e.g.

{{template category |type=navbox}}

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 meant be type templates." appears.

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 Template:C). See Example 1 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 below.

portal

Adds a {{portal}}-style link to the right of any topic and/or description text. See Example 3 below

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 if the category is a container category by adding Template:Para to the template.

Examples

Example 1

{{template category
|type  = navbox
|topic = the [[United States]]
}}

Templates relating to the United States.  The pages listed in this category are meant to be navigational (navbox) templates. If subcategories exist for other types of templates (e.g. infoboxes) that relate to this topic, they should appear at the start of the subcategories listing immediately below this messagebox. 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 <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>
}}

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, Template:C and Template:C. The pages listed in this category are meant to be navigational (navbox) templates. If subcategories exist for other types of templates (e.g. infoboxes) that relate to this topic, they should appear at the start of the subcategories listing immediately below this messagebox. 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 <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.
|portal = United States
}}

Here's a description without a preceding topic statement. The pages listed in this category are templates. This page is part of Citywars General and not part of any course. 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 <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 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 <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.

---