Difference between revisions of "Template:Template category/doc"

Latest revision as of 12:09, 7 March 2020

This template uses material from the Wikipedia template Template:Template category/doc, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors).

Error creating thumbnail: /bin/bash: rsvg-convert: command not found

{{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.

Template:TOC limit

Usage

Full syntax

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

Parameters

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

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
• conversion
• external link
• formatting
• function
• message
• meta
• navbox
• navigation
• 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.

{{Template category |type=sidebar}}

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 w:wikilink to the main article associated with the category (e.g. w:United States for the Category:United States templates).

{{Template category |topic=the [[w:United States]]}}

{{Template category |type=infobox |topic=the [[w:United States]]}}

description

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

{{Template category
| type = navbox
| topic = [[w:China]]
| description = <br />{{small|For templates relating specifically to the [[w:People's Republic of China|People's Republic of China (PRC)]] or the current [[w:Republic of China|Republic of China (ROC, "Taiwan")]], see, respectively, {{c|People's Republic of China templates}} and {{c|Republic of China (Taiwan) templates}}.}}
}}

{{Template category |description=This text is supplied by the ''description'' parameter.}}

onright

Use this 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.

{{Template category
| topic = the [[w: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.

{{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 = ''[[w:topic|topic]]''
| description = This text supplied by the ''description'' parameter.
}}
{{Container category}}

Error creating thumbnail: /bin/bash: rsvg-convert: command not found

Templates relating to topic. This text supplied by the description parameter. The pages listed in this category are meant to be type templates. 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.

This is a container category. It should contain only subcategories.

Template:Category other

help

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

See also

Template:Other category-header templates