Template:DW/Categoryheader/doc
More actions
- 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.
If you're done making changes, please refresh the text.
Please add categories and interwikis to Template:DW/Categoryheader/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.
{{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|pages|templates that produce message boxes|yes|[[Template:MessageBox]]}}
<templatedata> { "params": { "1": { "label": "Content type", "description": "This parameter will accept whether the category contains any combination of pages, images, and/or subcategories.", "type": "string", "required": true, "example": "pages and files", "suggested": true }, "2": { "label": "Subject", "description": "This parameter will accept the subject of the category.", "type": "string", "required": true, "suggested": true }, "3": { "label": "Automatically added", "description": "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.", "type": "boolean", "suggested": true }, "4": { "label": "Added by", "description": "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'.", "type": "string", "suggested": true }, "related": { "label": "Suppress \"related to\"", "description": "Set to \"no\" to suppress the \"related to\" text that is otherwise shown between \"Content type\" and \"Subject\"", "type": "boolean" } }, "format": "inline", "description": "This template displays a standardised sentence to be used on all category pages." } </templatedata>