Template:Categoryheader/doc

This is a documentation subpage for Template:Categoryheader. It contains usage information, categories, and other content that is not part of the original template page.

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

Usage

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

{{Categoryheader|1|2|3|4}}

The "related to" in the template's output can be suppressed by adding related=no as a parameter to the template.

Example

{{Categoryheader|mw.pages|the [[Theatre of Blood]]|yes|[[Template:Theatre of Blood]]}}

This category contains mw.pages related to the Theatre of Blood. This category is automatically added by Template:Theatre of Blood.

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. This template displays a standardised sentence to be used on all category mw.pages. Template parameters This template prefers inline formatting of parameters. Parameter Description Type Status Content type 1 This parameter will accept whether the category contains any combination of mw.pages, images, and/or subcategories. Example mw.pages and files String required Subject 2 This parameter will accept the subject of the category. String required Automatically added 3 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. Boolean suggested Added by 4 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'. String suggested Suppress "related to" related Set to "no" to suppress the "related to" text that is otherwise shown between "Content type" and "Subject" Boolean optional