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

m (Fixing it up)
 
Line 54: Line 54:
  
 
{{Hidden begin |showhide=left |title=''type'', ''topic'' |bodystyle=font-size:105%;}}
 
{{Hidden begin |showhide=left |title=''type'', ''topic'' |bodystyle=font-size:105%;}}
<pre>{{Template category |topic=Battletech}}</pre>
+
<pre>{{Template category |type=meta |topic=Battletech}}</pre>
{{Template category |topic=Battletech}}
+
{{Template category |type=meta |topic=Battletech}}
 
{{Hidden end}}
 
{{Hidden end}}
  

Latest revision as of 23:57, 29 September 2022

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

Usage[edit]

Syntax[edit]

Basic
{{Template category
|description=
}}
Full
{{Template category
| type = 
| topic = 
| description = 
| ALTTEXT = 
| help = 
}}

Parameters and examples[edit]

The template may be used without any parameters.

With no parameters

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

type[edit]


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
  • 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.
type alone
{{Template category |type=sidebar}}

topic[edit]


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
topic alone
{{Template category |topic=Battletech}}
type, topic
{{Template category |type=meta |topic=Battletech}}

description[edit]


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}}
}}
description alone
{{Template category |description=This text is supplied by the ''description'' parameter.}}

help[edit]


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 category[edit]

Uses with a topic or description parameter are tracked:

TemplateData[edit]

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.

Template parameters

ParameterDescriptionTypeStatus
Typetype

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