Template:Template category/doc

__NOWYSIWYG__

Purpose
 should be placed at the top of categories that contain template pages and their related subcategories.

Usage


Parameters
The template may be used without any parameters, i.e. as.

The following, however, may be used to make the template more informative:

type

 * Setting type to one of (currently) eleven 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 · conversion · external link · formatting · function · meta · navbox · navigation · sidebar · stub · timeline · 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.


 * Further examples of type's output appear in the examples below.

topic

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

description

 * Use this if a customised description is needed instead of – or, if topic also used, to follow – the default description above.



rhs {{smaller|(r{{small|{{thinsp}}}}ighthand s{{small|{{thinsp}}}}ide)}}

 * Use this to place right-aligned boxes beside the template, such as portal (to provide a link or links to related portal or portals) and/or Commons category (to provide a link to the same or a similarly-named category at the Commons). If more than one box is included, ensure the widest one appears first (see example below) otherwise overlapping may occur.

container

 * Set container to "true" (without quotemarks) 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.


 * An alternative to using container is to place Parent category after the Template category template:

help

 * Use this to replace the default instructions as to how to add a template to the category (see the "Further template category notes" section) or, if set to nothing, remove them.