Template:Tracking category/doc: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Documentation subpage}} == Usage == ; Basic syntax Use the basic syntax {{tl|Tracking category}} on a category page to designate it as a tracking category. This template places the category into {{Cat|Tracking categories}} and {{Cat|Hidden categories}}, which causes the category to be hidden on its member pages, and produces the following message box on the category page: {{Tracking category|category=no}} {{fcb|#ce33ff|Note}}: You do not need...") |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 13: | Line 13: | ||
=== Parameters === | === Parameters === | ||
There | There are two parameters. | ||
; {{para|category}} | ; {{para|category}} | ||
| Line 19: | Line 19: | ||
: The syntax '''<code><nowiki>{{Tracking category|category=no}}</nowiki></code>''' will prevent a category page from being added to {{Cat|Tracking categories}}. | : The syntax '''<code><nowiki>{{Tracking category|category=no}}</nowiki></code>''' will prevent a category page from being added to {{Cat|Tracking categories}}. | ||
: The syntax '''<code><nowiki>{{Tracking category|category=[[Category:Some other category]]}}</nowiki></code>''' will add the category page to '''Category:Some other category''' instead of {{Cat|Tracking categories}}. | : The syntax '''<code><nowiki>{{Tracking category|category=[[Category:Some other category]]}}</nowiki></code>''' will add the category page to '''Category:Some other category''' instead of {{Cat|Tracking categories}}. | ||
; {{para|about}} | |||
: This is where you can add a short message talking about the purpose of the category you are tracking. | |||
: The syntax '''<code><nowiki>{{Tracking category|about=message}}</nowiki></code>''' will add your message in {{tl|Smallcaps}} at the bottom of the banner. | |||
== TemplateData == | == TemplateData == | ||
| Line 28: | Line 32: | ||
"label": "Category", | "label": "Category", | ||
"description": "Used to prevent the addition of Category:Tracking categories and optionally add a different category instead.", | "description": "Used to prevent the addition of Category:Tracking categories and optionally add a different category instead.", | ||
"type": "string", | |||
"required": false | |||
}, | |||
"about": { | |||
"label": "About", | |||
"description": "Used to add text about why the category exists.", | |||
"type": "string", | "type": "string", | ||
"required": false | "required": false | ||
| Line 39: | Line 49: | ||
<!-- Categories below this line, please --> | <!-- Categories below this line, please --> | ||
[[Category:General use templates]] | |||
[[Category:General | |||
}}}}</includeonly> | }}}}</includeonly> | ||
Latest revision as of 02:37, 20 August 2023
|
It contains usage information, categories and other content that is not part of the original template page.
|
|---|
Usage
- Basic syntax
Use the basic syntax {{Tracking category}} on a category page to designate it as a tracking category. This template places the category into Category:Tracking categories and Category:Hidden categories, which causes the category to be hidden on its member pages, and produces the following message box on the category page:
|
This is a tracking category .
It is used to build and maintain lists of pages, primarily for the lists themselves and their use in article and category maintenance. Please do not remove this notice. This is a hidden category.
|
|---|
Note: You do not need to add the __HIDDENCAT__ to the category, the template automatically does that. This template is only to be used on the Category namespace (ns=14).
- Full syntax
{{Tracking category
Parameters
There are two parameters.
|category=- Used to prevent the addition of Category:Tracking categories and optionally add a different category instead.
- The syntax
{{Tracking category|category=no}}will prevent a category page from being added to Category:Tracking categories. - The syntax
{{Tracking category|category=[[Category:Some other category]]}}will add the category page to Category:Some other category instead of Category:Tracking categories.
|about=- This is where you can add a short message talking about the purpose of the category you are tracking.
- The syntax
{{Tracking category|about=message}}will add your message in {{Smallcaps}} at the bottom of the banner.
TemplateData
Designates a category as a tracking category and automatically puts it in the hidden category.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Category | category | Used to prevent the addition of Category:Tracking categories and optionally add a different category instead. | String | optional |
| About | about | Used to add text about why the category exists. | String | optional |