Template:SC/Category header/doc

Template documentation (for the above template, sometimes hidden or invisible) [create]

This template doesn't have any documentation yet! Help out by writing some. There may also be documentation on Wikia Templates which can be copied.

This template currently doesn't have any documentation; you can create it if you know how the template is used. (What is this?)
If you're done making changes, please refresh the text.
Please add categories and interwikis to Template:SC/Category header/doc/doc. (View all subpages of this 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

<templatedata> { "params": { "1": { "label": "Content type", "description": "What kind(s) of page this category contains", "example": "images", "type": "string", "default": "pages", "required": true, "suggested": true }, "2": { "label": "Description", "description": "A short description of what the pages in this category are related to", "example": "items", "type": "string", "required": true, "suggested": true }, "3": { "label": "Automatically added", "description": "\"yes\" if this page is automatically added by some template(s), left blank otherwise", "example": "yes", "type": "boolean" }, "4": { "label": "Added by", "description": "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 ", "type": "string" }, "related": { "label": "Include \"related to\"", "description": "Set to \"no\" to suppress the \"related to\" text that is otherwise shown between \"content type\" and \"description\"", "example": "no", "type": "string", "default": "yes" } }, "description": "Adds a simple description of a category", "paramOrder": [ "1", "2", "3", "4", "related" ], "format": "inline" } </templatedata>