Template:Category header/doc

This is a documentation subpage for Template:Category header.

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

Usage

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

{{Category header|Content type|Description|Automatically added|Added by}}

Content type

This parameter will accept whether the category contains any combination of pages, images, and/or subcategories.

Description

This parameter will accept the subject of the category.

Automatically added

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.

Added by

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

Related

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

TemplateData

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