Template:Template category/doc

From Shadowrun Wiki
Revision as of 13:49, 29 April 2024 by Catrone3 (talk | contribs) (Created page with "{{Documentation subpage}} <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> {{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 =...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

[[Category:Template documentation pages{{#translation:}}]]

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

Parameters and examples

The template may be used without any parameters.

Template:Hidden begin

Page Module:Message box/cmbox.css has no content.

Template:Hidden end

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

Template:Hidden begin

{{Template category |type=sidebar}}

Page Module:Message box/cmbox.css has no content.

Template:Hidden end

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

Template:Hidden begin

{{Template category |topic=Battletech}}

Page Module:Message box/cmbox.css has no content.

Template:Hidden end

Template:Hidden begin

{{Template category |type=meta |topic=Battletech}}

Page Module:Message box/cmbox.css has no content.

Template:Hidden end

description


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

Template:Hidden begin

{{Template category
| type = navbox
| topic = Battletech
| description = <br />{{small|For templates relating specifically to Battletech}}
}}

Page Module:Message box/cmbox.css has no content.

Template:Hidden end

Template:Hidden begin

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

Page Module:Message box/cmbox.css has no content.

Template:Hidden end

help


Use help to replace the instructions on adding a template to the category (second paragraph of the "Further template category notes" section):

Template:Hidden begin

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

Page Module:Message box/cmbox.css has no content.

Template:Hidden end

To omit the default instructions, set help to no:

Template:Hidden begin

{{Template category |help=no}}

Page Module:Message box/cmbox.css has no content.

Template:Hidden end

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.

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