Template:Tracking category/doc
Appearance
This is a documentation subpage for Template:Tracking category. It may contain usage information, categories and other content that is not part of the original template page. |
This template should not be substituted. |
Usage
[edit source]- 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, 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 a list or lists of pages—primarily for the sake of the lists themselves and their use in resources and category maintenance. It is not part of the categorization scheme for learners.
More information:
|
Administrators: Please do not delete this category as empty! This category may be empty occasionally or even most of the time. |
- Note
This template is only for use in the category namespace (ns=14). Using it on any page in any other namespace will add the page to Category:Pages with templates in the wrong namespace and produce the following error message box on the category page:
The above template should only be transcluded in the Category namespace(s). |
- Full syntax
{{Tracking category |template= |text= |container= |1= |category= }}
Parameters
[edit source]- template
- Used to add text with the name of the template that populates the tracking category. Do not include "Template:" before the template name.
- The syntax
{{Tracking category|template=Template name}}
produces:
It is used to build and maintain a list or lists of pages that use {{Template name}}—primarily for the sake of the lists themselves and their use in resources and category maintenance. It is not part of the categorization scheme for learners.
More information:
|
Administrators: Please do not delete this category as empty! This category may be empty occasionally or even most of the time. |
- text
- Used to add extra text to the template. The text will be shown in the visible (unfolded) part of the template.
- The syntax
{{Tracking category|text=Extra text goes here.}}
produces:
This is a tracking category. It is used to build and maintain a list or lists of pages—primarily for the sake of the lists themselves and their use in resources and category maintenance. It is not part of the categorization scheme for learners.Extra text goes here. More information:
|
Administrators: Please do not delete this category as empty! This category may be empty occasionally or even most of the time. |
- container
- Use to further designate the category as a container category.
- The syntax
{{Tracking category|container=yes}}
adds the category page to Category:Container categories and produces:
This is a tracking category. It is used to build and maintain a list or lists of pages—primarily for the sake of the lists themselves and their use in resources and category maintenance. It is not part of the categorization scheme for learners.
More information:
|
This is a container category. Due to its scope, it should contain only subcategories. |
Administrators: Please do not delete this category as empty! This category may be empty occasionally or even most of the time. |
- delete-empty
- Used to stop the {{Possibly empty category}} template from being transcluded.
- The syntax
{{Tracking category|delete-empty=yes}}
will removed the banner
This is a tracking category. It is used to build and maintain a list or lists of pages—primarily for the sake of the lists themselves and their use in resources and category maintenance. It is not part of the categorization scheme for learners.
More information:
|
- unnamed parameter 1
- When used with
|container=yes
, this parameter will add content below the container category message box. When used without|container=yes
, this parameter is ignored. - The syntax
{{Tracking category|container=yes|This content is added below the container category message box.}}
produces:
This is a tracking category. It is used to build and maintain a list or lists of pages—primarily for the sake of the lists themselves and their use in resources and category maintenance. It is not part of the categorization scheme for learners.
More information:
|
This is a container category. Due to its scope, it should contain only subcategories. |
This content is added below the container category message box.
Administrators: Please do not delete this category as empty! This category may be empty occasionally or even most of the time. |
- Due to the current coding of the template this is limited to a single paragraph with SPAN style formatting.
- 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.
See also
[edit source]Supporting templates
[edit source]- {{Cmbox}}
- {{Collapse top}} and {{Collapse bottom}}
- {{Category other}}
- {{Single namespace}}
Other category-header templates
[edit source]