Template:Cat/Documentation: Difference between revisions
Jump to navigation
Jump to search
Want an adless experience? Log in or Create an account.
No edit summary |
(add 'extra') |
||
Line 4: | Line 4: | ||
==Usage== | ==Usage== | ||
{{Usage|category|sort key}} | {{Usage|category|sort key|extra{{=}}}} | ||
{{Usage/Param|category|The name of the category you want to sort a page into}} | {{Usage/Param|category|The name of the category you want to sort a page into}} | ||
{{Usage/Param|sort key|Optional parameter if you want to change how a page is sorted. If you leave ''sort key'' blank, it'll automatically sort the page correctly into the category.|optional}} | {{Usage/Param|sort key|Optional parameter if you want to change how a page is sorted. If you leave ''sort key'' blank, it'll automatically sort the page correctly into the category.|optional|{{((}}PAGENAME{{))}}}} | ||
{{Usage/Param|extra|Use this optional named parameter to supply extra information to be used by certain templates.|optional}} | |||
==Advanced Usage== | ==Advanced Usage== |
Revision as of 17:27, June 21, 2020
This template is used on over 2500 pages. Take extra care when making changes, testing them in a sandbox first. If changes to this template require changes to pages that use it, you are responsible for making those changes. |
This template is used for categorizing pages.
Usage
{{Cat/Documentation| category | sort key | extra= }}
- category — The name of the category you want to sort a page into
- sort key — Optional parameter if you want to change how a page is sorted. If you leave sort key blank, it'll automatically sort the page correctly into the category. (Optional. Default: {{PAGENAME}})
- extra — Use this optional named parameter to supply extra information to be used by certain templates. (Optional.)
Advanced Usage
When used in templates to automatically apply a category to certain pages, some may be excluded by using {{Cat/Documentation| category | nocat=true }}. For example, to exclude the template itself from the category:
{{Cat|Category<noinclude>|nocat=true</noinclude>}}