Template:CategorizeManual/Documentation: Difference between revisions

Latest revision as of 14:09, 26 April 2024

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

Usage

It has two mandatory string parameters and one optional parameter.

1 must be a valid category.
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.

Return

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

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

This category includes templates that have things and stuff.

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

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

This category includes content that discuss sentient intelligences.

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

@@ Line 1: / Line 1: @@
 <includeonly>[[Category:Categorization Template]]</includeonly>
-{{Template|CategorizeContent}} is used to generate boilerplate text on {{Category|Content}} categories that are populated via {{Category|Template}}s.
+{{Template|CategorizeManual}} is used to generate boilerplate text on categories that are populated via {{Category|Template}}s.
 ==Usage==
-It has two {{Parameter|mandatory|string}} and one {{Parameter|optional}}.
+It has two {{Parameter|mandatory|string}}s and one {{Parameter|optional}}.
-* {{Code|1}} must be a valid category. The broken bar character ({{code|¦}}) can be used to refine sorting.
+* {{Code|1}} must be a valid category.
 * {{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 two {{Parameter|optional|named}}s:
+* {{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 {{Category|Content}}.
+When invoked from the Category namespace, the category is added to the category specified by the first parameter.
-{{Code|<nowiki>{{CategorizeManual|template|things and stuff}}</nowiki>}} returns: {{Return|{{CategorizeContent|template|things and stuff}}}}
+{{Code|<nowiki>{{CategorizeManual|template|have things and stuff}}</nowiki>}} returns: {{Return|{{CategorizeManual|template|have things and stuff}}}}
-{{Code|<nowiki>{{CategorizeManual|content|sentient intelligences|{{Template|Infobox Character}}}}</nowiki>}} returns: {{Return|{{CategorizeManual|content|sentient intelligences|{{Template|Infobox Character}}}}}}
+{{Code|<nowiki>{{CategorizeManual|content|discuss sentient intelligences|{{Template|Infobox Character}}}}</nowiki>}} returns: {{Return|{{CategorizeManual|content|discuss sentient intelligences|{{Template| Character}}}}}}