Catrone3: Created page with "{{Documentation subpage}} {{tlx|Template category}} should be placed at the top of categories that contain template pages and their related subcategories. == Usage == ===Syntax=== ; Basic

 {{Template category |description= }}

; Full

 {{Template category | type =  | topic =  | description =  | ALTTEXT =  | help =..."

2024-04-29T18:49:15Z

Created page with "{{Documentation subpage}}  {{tlx|Template category}} should be placed at the top of categories that contain template pages and their related subcategories. == Usage == ===Syntax=== ; Basic <pre style="overflow:auto;"> {{Template category |description= }} </pre> ; Full <pre style="overflow:auto;"> {{Template category | type = | topic = | description = | ALTTEXT = | help =..."

New page

{{Documentation subpage}}


{{tlx|Template category}} should be placed at the top of categories that contain template pages and their related subcategories.

== Usage ==
===Syntax===
; Basic
<pre style="overflow:auto;">
{{Template category
|description=
}}
</pre>

; Full
<pre style="overflow:auto;">
{{Template category
| type =
| topic =
| description =
| ALTTEXT =
| help =
}}
</pre>

==Parameters and examples==
The template may be used without any parameters.

{{Hidden begin |showhide=left |title=With no parameters |bodystyle=font-size:105%;}}
{{Template category}}
{{Hidden end}}

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

====''type''====
<hr/>
: 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:
:: '''{{hlist |ambox |category header |category heading |catheader |cat header |cathead |campaignbox |conversion |external link |formatting |function |infobox |module |meta |navigation |navigational |navbox |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.

{{Hidden begin |showhide=left |title=''type'' alone |bodystyle=font-size:105%;}}
<pre>{{Template category |type=sidebar}}</pre>
{{Template category |type=sidebar}}
{{Hidden end}}

====''topic''====
<hr/>
: 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

{{Hidden begin |showhide=left |title=''topic'' alone |bodystyle=font-size:105%;}}
<pre>{{Template category |topic=Battletech}}</pre>
{{Template category |topic=Battletech}}
{{Hidden end}}

{{Hidden begin |showhide=left |title=''type'', ''topic'' |bodystyle=font-size:105%;}}
<pre>{{Template category |type=meta |topic=Battletech}}</pre>
{{Template category |type=meta |topic=Battletech}}
{{Hidden end}}

====''description''====
<hr/>
: Use ''description'' if a customised description is needed instead of – or, if ''topic'' also used, to follow – the default description above.

{{Hidden begin |showhide=left |title=''type'', ''topic'', ''description'' |bodystyle=font-size:105%;}}
<pre style="overflow:auto;">
{{Template category
| type = navbox
| topic = Battletech
| description = <br />{{small|For templates relating specifically to Battletech}}
}}
</pre>
{{Template category
| type = navbox
| topic = Battletech
| description = <br />{{small|For templates relating specifically to Battletech}}
}}
{{Hidden end}}

{{Hidden begin |showhide=left |title=''description'' alone |bodystyle=font-size:105%;}}
<pre>{{Template category |description=This text is supplied by the ''description'' parameter.}}</pre>
{{Template category |description=This text is supplied by the ''description'' parameter.}}
{{Hidden end}}

====''help''====
<hr/>
: Use ''help'' to replace the instructions on adding a template to the category (second paragraph of the "Further template category notes" section):

{{Hidden begin |showhide=left |title=replace ''help'' text |bodystyle=font-size:105%;}}
<pre>{{Template category |help=This text supplied by the ''help'' parameter.}}</pre>
{{Template category |help=This text supplied by the ''help'' parameter.}}
{{Hidden end}}

: To omit the default instructions, set ''help'' to ''no'':

{{Hidden begin |showhide=left |title=omit ''help'' text |bodystyle=font-size:105%;}}
<pre>{{Template category |help=no}}</pre>
{{Template category |help=no}}
{{Hidden end}}

== Tracking category==
Uses with a topic or description parameter are tracked:
* {{clc|Template:Template category with no topic or description}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
"params": {
"type": {},
"topic": {},
"description": {
"aliases": [
"1"
]
},
"ALTTEXT": {},
"help": {
"aliases": [
"2"
]
},
"category": {}
},
"description": "This template is used as a header for category pages that contain templates."
}
</templatedata>

<includeonly>{{Sandbox other||

[[Category:Category namespace templates]]
[[Category:Tracking templates]]
}}</includeonly>

Template:Template category/doc - Revision history