Jump to content

From Noumenapedia

Template:Template category/doc

__EXPECTED_UNCONNECTED_PAGE__

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

Syntax

Basic

<syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

Basic topical
Syntax of {{Template category}}
No type Navbox Sidebar Stub

<syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

<syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

<syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

<syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

Full

<syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

Parameters and examples

The template may be used without any parameters.

With no parameters

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), {{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

<syntaxhighlight lang="wikitext">

Lua error in mw.title.lua at line 359: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal').

</syntaxhighlight>

Lua error in mw.title.lua at line 359: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal').

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.
type alone
<syntaxhighlight lang="wikitext"></syntaxhighlight>

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.
container alone
<syntaxhighlight lang="wikitext"></syntaxhighlight>
An alternative to using container is to place {{Container category}} after the {{Template category}} template:
{{Container category}} following {{Template category}}

<syntaxhighlight lang="wikitext">

</syntaxhighlight>

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
<syntaxhighlight lang="wikitext"></syntaxhighlight>
type, topic
<syntaxhighlight lang="wikitext"></syntaxhighlight>

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

<syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

description alone
<syntaxhighlight lang="wikitext"></syntaxhighlight>

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
<syntaxhighlight lang="wikitext"></syntaxhighlight>
To omit the default instructions, set help to no:
omit help text
<syntaxhighlight lang="wikitext"></syntaxhighlight>

Tracking categories

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Template category in articles based on its TemplateData.

TemplateData for Template category

<templatedata> { "params": { "onright": { "aliases": [ "rhs" ] }, "type": { "type": "string", "suggestedvalues": [ "ambox", "campaignbox", "category header", "conversion", "external link", "formatting", "function", "infobox", "meta", "module", "navigation", "sidebar", "stub", "sub", "timeline", "user" ] }, "container": { "label": "Is container category?", "description": "Whether or not the category is a \"container category\" meant to only contain subcategories", "type": "boolean" }, "topic": {}, "description": {}, "ALTTEXT": {}, "help": {}, "category": {} }, "description": "This template is used as a header for category pages that contain templates." } </templatedata>

See also

Other category-header templates