Template:Categoryheader

Revision as of 21:39, 19 February 2020 by Banri (talk | contribs) (Created page with "<includeonly>This category contains {{{1}}}{{#if:{{{2|}}}|{{#ifeq:{{lc:{{{related|}}}}}|no||{{sp}}related to}}{{sp}}{{{2}}}}}. {{#if:{{{3|}}}|This category is automatically ad...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Template documentation
This documentation is transcluded from Template:Categoryheader/doc. [edit] [purge]

This template displays a standardised sentence to be used on all category pages.

Usage

This template can be used by entering the following onto a category page.

{{Categoryheader|num1|num2|num3|num4}}

num1

This parameter will accept whether the category contains any combination of pages, images, and/or subcategories. Note that the words "num1" must be deleted.

num2

This parameter will accept the subject of the category. Note that the words "num2" must be deleted.

num3

This parameter will accept the word "yes", if the category in question is automatically added to a page via a template. Leave this parameter blank if the category is not automatically added. Note that the words "num3" must be deleted.

num4

This parameter will accept the names of the templates that automatically are added by a template. This parameter will only display if the third parameter is "yes". Note that the words "num4" must be deleted.

related

Setting this parameter to no suppresses the "related to" text that is otherwise shown between num1 and num2 in the output.

Data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

Adds a simple description of a category

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Content type1

What kind(s) of page this category contains

Default
pages
Example
images
Stringrequired
Description2

A short description of what the pages in this category are related to

Example
items
Stringrequired
Automatically added3

"yes" if this page is automatically added by some template(s), left blank otherwise

Example
yes
Booleanoptional
Added by4

The template(s) that automatically add pages to this category. Should be left blank unless the "automatically added" parameter was set to "yes"

Example
[[Template:Fact]]
Stringoptional
Include "related to"related

Set to "no" to suppress the "related to" text that is otherwise shown between "content type" and "description"

Default
yes
Example
no
Stringoptional