Difference between revisions of "Template:Categorybox/Documentation"
From PCGamingWiki, the wiki about fixing PC games
m (added stuff from the documentation template) |
m (updated docs) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | This is an automated template in the likes of | + | This is an automated template in the likes of {{T|Seriesbox}} that creates a floating list of member pages of a category. |
'''Real-world examples''' | '''Real-world examples''' | ||
| Line 5: | Line 5: | ||
'''Related templates''' | '''Related templates''' | ||
| − | * | + | * {{T|Categorybox}} - Automated template for use with defined categories. |
| − | * | + | * {{T|Categorybox/custom}} - Custom template for use with categories or situations that require manual definition (functions more similar to {{T|Seriesbox}}). |
| − | * | + | * {{T|Categorybox/row}} - Row template used by both {{T|Categorybox}} and {{T|Categorybox/custom}}. |
'''Syntax''' | '''Syntax''' | ||
| Line 15: | Line 15: | ||
# Name of the category to query | # Name of the category to query | ||
# Custom title of the sidebar (the category name will be used if left blank). | # Custom title of the sidebar (the category name will be used if left blank). | ||
| − | + | #* Note that the custom title will still automatically link to the category page. | |
| + | # Custom options, of any of the following: | ||
| + | #* {{code|subcategoriesonly}} - Limits the query to only fetch the actual subcategories defined below a main category. This is used to circumvent the behavior of Semantic MediaWiki of returning pages in subcategories as if they belonged in the parent category itself. | ||
'''Usage''' | '''Usage''' | ||
Latest revision as of 20:14, 28 April 2020
This is an automated template in the likes of {{Seriesbox}} that creates a floating list of member pages of a category.
Real-world examples
- The Category:Graphics API have one defined, which is then transcluded unto the various member pages through transclusion using
{{:Category:Graphics API}}.
Related templates
- {{Categorybox}} - Automated template for use with defined categories.
- {{Categorybox/custom}} - Custom template for use with categories or situations that require manual definition (functions more similar to {{Seriesbox}}).
- {{Categorybox/row}} - Row template used by both {{Categorybox}} and {{Categorybox/custom}}.
Syntax
{{Categorybox|Category Name|Custom Title}}
Parameters
- Name of the category to query
- Custom title of the sidebar (the category name will be used if left blank).
- Note that the custom title will still automatically link to the category page.
- Custom options, of any of the following:
subcategoriesonly- Limits the query to only fetch the actual subcategories defined below a main category. This is used to circumvent the behavior of Semantic MediaWiki of returning pages in subcategories as if they belonged in the parent category itself.
Usage
{{Categorybox|Graphics API}}creates the right-aligned sidebar here below, by querying Category:Graphics API.
{{Categorybox|Games in pre-alpha state|Example #2}}adding a second parameter will set that text as a custom title.
- In this example it queries Category:Games in pre-alpha state.
| No pages meet these criteria. |