Template:CategorizeManual/Documentation: Difference between revisions

Revision as of 08:24, 2 November 2022

Template:CategorizeManual is used to generate boilerplate text on categories that are populated via Templates.

It has two mandatory string parameters and one optional parameter.

1 must be a valid category. The broken bar character (¦) can be used to refine sorting.
2 is a string of descriptive text, explaining what is on the page.
3 can be used to override the default source suggestion.

It also has two optional named parameters:

hidden (default: false) — If set to true, invokes the __HIDDENCAT__ magic word.
key (default: {{PAGENAME}} — Sets the sort key.

When invoked from the Category namespace, the category is added to the category specified by the first parameter.

{{CategorizeManual|template|things and stuff}} returns:

This category includes templates that things and stuff.

Articles should not be added to this category manually, only via special configured Categorization Templates.

{{CategorizeManual|content|sentient intelligences|{{Template|Infobox Character}}}} returns:

This category includes content that sentient intelligences.

Articles should not be added to this category manually, only via Template:Infobox Character.

@@ Line 6: / Line 6: @@
 * {{Code|2}} is a string of descriptive text, explaining what is on the page.
 * {{Code|3}} can be used to override the default source suggestion.
-It also has one {{Parameter|optional|named}}:
+It also has two {{Parameter|optional|named}}s:
-* {{Code|hidden}} &mdash; If set to true, invokes the {{Code|<nowiki>__HIDDENCAT__</nowiki>}} magic word.
+* {{Code|hidden}} (default: {{Code|false}}) &mdash; If set to true, invokes the {{Code|<nowiki>__HIDDENCAT__</nowiki>}} magic word.
+* {{Code|key}} (default: {{Code|<nowiki>{{PAGENAME}}</nowiki>}} &mdash; Sets the sort key.
 ==Return==
 When invoked from the Category namespace, the category is added to the category specified by the first parameter.