Template:Categoryheader

Template documentation

This documentation is transcluded from Template:Categoryheader/doc. [edit] [history] [purge]

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

Example

{{Categoryheader|pages and images|the [[Avengers]]|yes|[[Template:Avengers]]}}

Output:

This category contains pages and images related to the Avengers. This category is automatically added by Template:Avengers.

Usage

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

{{Categoryheader|num1|num2|num3|num4|related=no}}

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. This parameter is optional.

Template 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 This template prefers inline formatting of parameters. Parameter Description Type Status Content type 1 What kind(s) of page this category contains Default pages Example images String required Description 2 A short description of what the pages in this category are related to Example items String required Automatically added 3 "yes" if this page is automatically added by some template(s), left blank otherwise Example yes Boolean optional Added by 4 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]] String optional 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 String optional