Template:Category handler/doc: Difference between revisions

(10 intermediate revisions by the same user not shown)

Line 1:

{{Template rating|details=~~Currently in-progress and used~~ for ~~one other template. Category input may be adjusted~~.}}

{{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 23:

Line 22:

: <code><nowiki>{{Category handler | Abstract MOS patterns | 8-tone scales | debug=1 }}</nowiki></code>

disables categories. ~~Typical use~~ as part of another template ~~should instead~~ 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.

disables categories.

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 ===

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.

This metatemplate is meant primarily for templates used within those namespaces. Use of this metatemplate is not required for templates with basic categorizing rules, or templates meant to be placed within other namespaces, such as the user namespace. Additionally, specialized templates, such as those meant for categorizing /doc pages, are unable to work with this template.

=== Changing suppressed namespaces ===

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 | excluded_ns = template; module}}</nowiki></code>

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

Templates are sometimes added to template documentation, such as [[Template:Todo]], which categorizes that page under a specific todo-task. Typically, such templates are added to a template's /doc page to be transcluded onto that template's page, instead of within the <code><nowiki><noinclude></noinclude></nowiki></code> block of a template's page.

For example, adding <code><nowiki>{{Todo|inline=1|add documentation}}</nowiki></code> to a template's documentation adds that template to [[:Category:Todo:add documentation]], but a naïve implementation of that template will also categorize that template's /doc subpage.

<pre>

{{#if: {{{inline|}}} | {{Mbox

| type = notice

| icon = Icon-Todo.png

| text = '''Todo:''' {{#if: {{{1|}}}| {{{1}}} }}

{{#if: {{{comment|}}}}}

}}

{{#if: {{{1|}}} | [[Category:Todo:{{trim|{{{1}}}}}]] | [[Category:Todo]] }}

</pre>

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, so only Template:SomeTemplate is categorized.