Template:Category handler/doc: Difference between revisions

(4 intermediate revisions by the same user not shown)

Line 1:

{{Template rating|details=~~Currently in-progress and used~~ for ~~[[Template:Template rating]]. This may be tested on other categorizing templates to determine whether any changes should be made~~.}}

{{Template rating|rating=ready|details=Functionally complete. See its corresponding module for more details.}}

~~{{lua}}~~

'''Template:Category handler''' is intended as a metatemplate that helps templates categorize pages. It also suppresses categories depending on the namespace or subpage.

== Usage ==

=== Usage ===

Categories are entered as unnamed parameters, as shown.

Line 27:

Line 26:

Typically, this template is used as part of another template, so use something like <code><nowiki>debug={{{debug|}}}</nowiki></code>, so that <code><nowiki>debug=1</nowiki></code> can be added to an instance of that template.

== Category suppression rules and use-cases ==

=== Category suppression rules and use-cases ===

By default, this metatemplate allows categories within the following namespaces: main, file, mediawiki, template, category, and module. Templates placed outside of those namespaces will not categorize those pages. Additionally, pages with the suffix /doc or /sandbox will not be categorized.

Line 37:

Line 36:

This template can be adjusted to allow or disallow suppression in different namespaces. The example below allows a template to add categories a page within the user namespace, but not templates or modules. Namespaces are delimited using either newlines or semicolons.

<code><nowiki>{{category handler | allowed_ns = user | ~~suppressed_ns~~ = template; module}}</nowiki></code>

<code><nowiki>{{category handler | allowed_ns = user | excluded_ns = template; module}}</nowiki></code>

=== Use-case: templates that categorize templates ===

Line 56:

Line 55:

</pre>

If placed on a template called SomeTemplate, the todo-category will contain these pages:

If placed on the /doc subpage for a template called SomeTemplate, the todo-category will contain these pages:

* Template:SomeTemplate (template page)

* Template:SomeTemplate/doc (template's documentation)

Since this template suppresses categories on /doc subpages, adding this template to Template:Todo prevents it from categorizing the documentation page, ~~meaning~~ only Template:SomeTemplate is categorized.

Since this template suppresses categories on /doc subpages, adding this template to Template:Todo prevents it from categorizing the documentation page, so only Template:SomeTemplate is categorized.

<pre>

@@ Line 1: / Line 1: @@
 {{dochead|header=metatemplate}}
-{{Template rating|details=Currently in-progress and used for [[Template:Template rating]]. This may be tested on other categorizing templates to determine whether any changes should be made.}}
+{{Template rating|rating=ready|details=Functionally complete. See its corresponding module for more details.}}
 {{clear}}
-{{lua}}
 '''Template:Category handler''' is intended as a metatemplate that helps templates categorize pages. It also suppresses categories depending on the namespace or subpage.
-== Usage ==
+=== Usage ===
 Categories are entered as unnamed parameters, as shown.
@@ Line 27: / Line 26: @@
 Typically, this template is used as part of another template, so use something like <code><nowiki>debug={{{debug|}}}</nowiki></code>, so that <code><nowiki>debug=1</nowiki></code> can be added to an instance of that template.
-== Category suppression rules and use-cases ==
+=== Category suppression rules and use-cases ===
 By default, this metatemplate allows categories within the following namespaces: main, file, mediawiki, template, category, and module. Templates placed outside of those namespaces will not categorize those pages. Additionally, pages with the suffix /doc or /sandbox will not be categorized.
@@ Line 37: / Line 36: @@
 This template can be adjusted to allow or disallow suppression in different namespaces. The example below allows a template to add categories a page within the user namespace, but not templates or modules. Namespaces are delimited using either newlines or semicolons.
-<code><nowiki>{{category handler | allowed_ns = user | suppressed_ns = template; module}}</nowiki></code>
+<code><nowiki>{{category handler | allowed_ns = user | excluded_ns = template; module}}</nowiki></code>
 === Use-case: templates that categorize templates ===
@@ Line 56: / Line 55: @@
 </pre>
-If placed on a template called SomeTemplate, the todo-category will contain these pages:
+If placed on the /doc subpage for a template called SomeTemplate, the todo-category will contain these pages:
 * Template:SomeTemplate (template page)
 * Template:SomeTemplate/doc (template's documentation)
-Since this template suppresses categories on /doc subpages, adding this template to Template:Todo prevents it from categorizing the documentation page, meaning only Template:SomeTemplate is categorized.
+Since this template suppresses categories on /doc subpages, adding this template to Template:Todo prevents it from categorizing the documentation page, so only Template:SomeTemplate is categorized.
 <pre>