Difference between revisions of "Template:Template category/doc"
Sarna News
m (Fixing it up) |
m (Fixing it up) |
||
| Line 16: | Line 16: | ||
<pre style="overflow:auto;"> | <pre style="overflow:auto;"> | ||
{{Template category | {{Template category | ||
| − | |||
| type = | | type = | ||
| topic = | | topic = | ||
| Line 33: | Line 32: | ||
The following, however, may be used to make the template more informative: | The following, however, may be used to make the template more informative: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
====''type''==== | ====''type''==== | ||
| Line 60: | Line 42: | ||
<pre>{{Template category |type=sidebar}}</pre> | <pre>{{Template category |type=sidebar}}</pre> | ||
{{Template category |type=sidebar}} | {{Template category |type=sidebar}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{Hidden end}} | {{Hidden end}} | ||
| Line 112: | Line 66: | ||
{{Template category | {{Template category | ||
| type = navbox | | type = navbox | ||
| − | | topic = | + | | topic = Battletech |
| − | | description = <br />{{small|For templates relating specifically to | + | | description = <br />{{small|For templates relating specifically to Battletech}} |
}} | }} | ||
</pre> | </pre> | ||
{{Template category | {{Template category | ||
| type = navbox | | type = navbox | ||
| − | | topic = | + | | topic = Battletech |
| − | | description = <br />{{small|For templates relating specifically to | + | | description = <br />{{small|For templates relating specifically to Battletech}} |
}} | }} | ||
{{Hidden end}} | {{Hidden end}} | ||
| Line 153: | Line 107: | ||
{ | { | ||
"params": { | "params": { | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
"type": {}, | "type": {}, | ||
| − | |||
"topic": {}, | "topic": {}, | ||
"description": { | "description": { | ||
| Line 177: | Line 125: | ||
} | } | ||
</templatedata> | </templatedata> | ||
| − | |||
| − | |||
| − | |||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other|| | ||
Revision as of 23:35, 29 September 2022
 | This is a documentation subpage for Template:Template category. It may contain usage information, categories and other content that is not part of the original template page. |
{{Template category}} should be placed at the top of categories that contain template pages and their related subcategories.
Contents
Usage
Syntax
- Basic
{{Template category
|description=
}}
- Full
{{Template category
| type =
| 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 an administrative page only, and not to be seen as an article.
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:
|
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
- (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
{{Template category |type=sidebar}}
| The pages listed in this category are meant to be sidebar templates.
This page is an administrative page only, and not to be seen as an article.
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:
|
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]]}}
| Templates relating to the United States. The pages listed in this category are templates.
This page is an administrative page only, and not to be seen as an article.
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:
|
type, topic
{{Template category |type=infobox |topic=the [[United States]]}}
| Infobox templates relating to the United States. The pages listed in this category are meant to be infobox templates.
This page is an administrative page only, and not to be seen as an article.
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:
|
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 = Battletech
| description = <br />{{small|For templates relating specifically to Battletech}}
}}
| Navbox templates relating to Battletech. For templates relating specifically to Battletech The pages listed in this category are meant to be navigation templates.
This page is an administrative page only, and not to be seen as an article.
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:
|
description alone
{{Template category |description=This text is supplied by the ''description'' parameter.}}
| This text is supplied by the description parameter. The pages listed in this category are templates.
This page is an administrative page only, and not to be seen as an article.
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:
|
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.}}
| The pages listed in this category are templates.
This page is an administrative page only, and not to be seen as an article.
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. This text supplied by the help parameter. |
- To omit the default instructions, set help to no:
omit help text
{{Template category |help=no}}
|
Tracking category
Uses with a topic or description parameter are tracked:
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.
TemplateData for Template category
This template is used as a header for category pages that contain templates.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Type | type | 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 |