Template:Template category/doc

{{Template category}} should be placed at the top of categories that contain template pages and their related subcategories. This template populates Category:Template categories.

Usage

Syntax

Basic

{{Template category
|description=
}}

Basic topical

Syntax of {{Template category}}

No type	Navbox	Sidebar	Stub
{{Template category |topic= }}	{{Template category |type=navbox |topic= }}	{{Template category |type=sidebar |topic= }}	{{Template category |type=stub |topic= }}

Full

{{Template category
| onright = 
| type = 
| container = 
| topic = 
| description = 
| ALTTEXT = 
| help = 
}}

Parameters and examples

The template may be used without any parameters.

With no parameters

The pages listed in this category are templates.

This page is part of BattleTechWiki'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.

To add a template to this category:

• If the template has a separate documentation page (usually called "Template:template name/doc"), add
•  [[Template:Template category/doc]]
• to the <includeonly> section at the bottom of that page. 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 code's last character.

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

onright

---

Use onright (or rhs) to place right-aligned boxes beside the template such as {{Portal}} (to provide link/s to related portal/s). If more than one box is included, ensure the widest one appears first (see example below) otherwise overlapping may occur.

type

---

Setting type to one of the following 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
• (category header
• category heading
• catheader
• cat header
• cathead)
• conversion
• external link
• formatting
• function
• infobox
• message
• meta
• module
• (navigation
• navigational
• navbox)
• sidebar
• stub
• sub
• timeline
• (user
• 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.

container

---

Set container as true, yes, etc. 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. The category is automatically added to Category:Container categories.

An alternative to using container is to place {{Container category}} after the {{Template category}} template:

topic

---

Use topic to add a default description ending "...relating to topic", where topic is usually a wikilink to the main article associated with the category (e.g. Federated Suns for the Category:Federated Suns Characters).

description

---

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

help

---

Use help to replace the instructions on adding a template to the category (second paragraph of the "Further template category notes" section):

To omit the default instructions, set help to no:

Tracking category

Uses with a topic or description parameter are tracked:

• Category:Template:Template category with no topic or description (145)

TemplateData

TemplateData for Template category

This template is used as a header for category pages that contain templates.

Template parameters

Parameter		Description	Type	Status
Onright	onright rhs	no description	Unknown	optional
Type	type	no description	Unknown	optional
Container	container	no description	Unknown	optional
Topic	topic	no description	Unknown	optional
Description	description 1	no description	Unknown	optional
ALTTEXT	ALTTEXT	no description	Unknown	optional
Help	help 2	no description	Unknown	optional
Category	category	no description	Unknown	optional