View source for Template:Template category/doc

{{documentation subpage}}
<!---
 PLEASE ADD METADATA (categories, interwikis) TO THE <includeonly> SECTION AT THE
 BOTTOM OF THIS PAGE
---->
The {{tl|template category}} template should be placed at the top of categories that contain only template pages and their related subcategories.

==Usage==
===Full syntax===
<pre style="overflow:auto;">
{{template category
|type = 
|topic = 
|description = 
|help = 
|container =
}}
</pre>

===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. [[LIMSWiki:Backlog]] for the [[:Category:LIMSwiki backlog]] templates). See [[#Example 1|Example 1]], and [[#Example 2|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 2]], [[#Example 3|Example 3]], and [[#Example 4|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 1]], [[#Example 2|Example 2]], and [[#Example 4|Example 4 below]]. Currently, setting ''type'' to one of eleven values produces a preset note. The values are:
<center>'''ambox{{·}}campaignbox{{·}}conversion{{·}}external link{{·}}formatting{{·}}function<br/>infobox{{·}}meta{{·}}navbox{{·}}navigation{{·}}sidebar{{·}}stub{{·}}timeline{{·}}userbox</center>
: 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 [[:Category:Container categories|container categories]] by adding {{para|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|Example 3 below]]. 

== Examples ==
===Example 1===
<pre style="overflow:auto;">
{{template category
|type  = navbox
|topic = [[LIMSWiki:Backlog|editing backlogs]]
}}
</pre>
{{template category
|type  = navbox
|topic = [[LIMSWiki:Backlog|editing backlogs]]
}}
<br /><hr />

===Example 2===
<pre style="overflow:auto;">
{{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>
}}
</pre>
{{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>
}}
<br /><hr />

===Example 3===
<pre style="overflow:auto;">
{{template category
|description = Here's a ''description'' without a preceding ''topic'' statement.
|container = yes
}}
</pre>
{{template category
|description = Here's a ''description'' without a preceding ''topic'' statement.
|container = yes
}}
<br /><hr />

===Example 4===
<pre style="overflow:auto;">
{{template category
|type = external link
|description = '''Templates aiding the creation and formatting of external links to [[topic]] databases.'''
}}
</pre>
{{template category
|type = external link
|description = '''Templates aiding the creation and formatting of external links to [[topic]] databases.'''
}}
{{clear}}

==See also==
{{namespace category}}

<includeonly>
[[Category:Category namespace templates]]

</includeonly>