Template:Template category

From Bogleheads
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

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

Usage

Full syntax

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

Parameters

The template may be used without any parameters, i.e. as {{Template category}}.

With no parameters

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

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
  • 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.
type alone
{{Template category |type=sidebar}}
Further examples of type's output appear in the examples below.

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. United States for the Category:United States templates).
topic alone
{{Template category |topic=the [[United States]]}}
type, topic
{{Template category |type=infobox |topic=the [[United States]]}}

description


Use description if a customised description is needed instead of – or, if topic also used, to follow – the default description above.
type, topic, description
{{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}}.}}
}}
description alone
{{Template category |description=This text is supplied by the ''description'' parameter.}}

onright


Use onright (or rhs) to place right-aligned boxes beside the template such as {{Portal}} (to provide link/s to related portal/s), {{Commons category}} (to provide a link to the same or a similarly-named Commons category), etc. If more than one box is included, ensure the widest one appears first (see example below) otherwise overlapping may occur.
topic, onright
{{Template category
| topic = the [[United States]]
| onright = {{Commons category|United States|the United States}}{{Portal|United States}}
}}

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.
container alone
{{Template category |container=true}}
An alternative to using container is to place {{Container category}} after the {{Template category}} template:
{{Container category}} following {{Template category}}
{{Template category
| type = ''type''
| topic = ''[[topic]]''
| description = This text supplied by the ''description'' parameter.
}}
{{Container category}}

help


Use help to replace the instructions on adding a template to the category (second paragraph of the "Further template category notes" section):
replace help text
{{Template category |help=This text supplied by the ''help'' parameter.}}
To omit the default instructions, set help to no:
omit help text
{{Template category |help=no}}

Tracking

Uses with a topic or description parameter are tracked:

Purge this page to update the totals

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Template category

No description.

Template parameters

ParameterDescriptionTypeStatus
Onrightonright rhs

no description

Unknownoptional
Typetype

no description

Unknownoptional
Containercontainer

no description

Unknownoptional
Topictopic

no description

Unknownoptional
Descriptiondescription 1

no description

Unknownoptional
ALTTEXTALTTEXT

no description

Unknownoptional
Helphelp 2

no description

Unknownoptional
Categorycategory

no description

Unknownoptional

See also

Other category-header templates