Template:Category handler/doc - Revision history

Ganaram inukshuk at 10:04, 29 October 2025

2025-10-29T10:04:08Z

← Older revision		Revision as of 10:04, 29 October 2025
Line 2:		Line 2:
	{{Template rating\|rating=ready\|details=Functionally complete. See its corresponding module for more details.}}		{{Template rating\|rating=ready\|details=Functionally complete. See its corresponding module for more details.}}
	{{clear}}		{{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.		'''Template:Category handler''' is intended as a metatemplate that helps templates categorize pages. It also suppresses categories depending on the namespace or subpage.

Ganaram inukshuk at 10:03, 29 October 2025

2025-10-29T10:03:42Z

← Older revision		Revision as of 10:03, 29 October 2025
Line 1:		Line 1:
	{{dochead\|header=metatemplate}}		{{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}}		{{clear}}
	{{lua}}		{{lua}}

Ganaram inukshuk at 10:00, 29 October 2025

2025-10-29T10:00:48Z

← Older revision		Revision as of 10:00, 29 October 2025
Line 5:		Line 5:
	'''Template:Category handler''' is intended as a metatemplate that helps templates categorize pages. It also suppresses categories depending on the namespace or subpage.		'''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.		Categories are entered as unnamed parameters, as shown.
Line 27:		Line 27:
	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.		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.		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.

Ganaram inukshuk: /* Use-case: templates that categorize templates */

2025-10-24T06:51:20Z

Use-case: templates that categorize templates

← Older revision		Revision as of 06:51, 24 October 2025
Line 56:		Line 56:
	</pre>		</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 (template page)
	* Template:SomeTemplate/doc (template's documentation)		* 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>		<pre>

Ganaram inukshuk: /* Category suppression rules and use-cases */ suppressed_ns -> excluded_ns (example code had the wrong name)

2025-10-24T06:48:36Z

Category suppression rules and use-cases: suppressed_ns -> excluded_ns (example code had the wrong name)

← Older revision		Revision as of 06:48, 24 October 2025
Line 37:		Line 37:
	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.		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 ===		=== Use-case: templates that categorize templates ===

Ganaram inukshuk: /* Category suppression rules and use-cases */

2025-10-24T04:04:45Z

Category suppression rules and use-cases

← Older revision		Revision as of 04:04, 24 October 2025
Line 31:		Line 31:
	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.		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 meant for categorizing /doc pages are unable to work with this template.		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 ===		=== Changing suppressed namespaces ===
Line 43:		Line 43:
	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.		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 ~~naive~~ implementation of that template will also categorize that template's /doc subpage.		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>		<pre>
Line 60:		Line 60:
	* Template:SomeTemplate/doc (template's documentation)		* Template:SomeTemplate/doc (template's documentation)

	Since this template suppresses categories on /doc subpages, 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, meaning only Template:SomeTemplate is categorized.

	<pre>		<pre>

Ganaram inukshuk: use-case

2025-10-23T23:46:16Z

use-case

@@ Line 27: / Line 27: @@
 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 ==
+== 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 within those namespaces will not categorize those pages.
+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.
+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 meant for categorizing /doc pages are unable to work with this template.
-Alternatively, 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.
+=== Changing suppressed namespaces ===
 <code><nowiki>{{category handler | allowed_ns = user | suppressed_ns = template; module}}</nowiki></code>
-Additionally, this metatemplate suppresses categories if the page has the following suffixes (subpages): doc or sandbox. This prevents templates from categorizing test or documentation pages, but not if the /doc page is transcluded. This means categorizing templates that categorize other templates will the template's main page, but not their /doc subpages. However, if a categorizing template's documentation is demonstrating its own use, this isn't enough, so adding <code><nowiki>debug=1</nowiki></code> is required to keep categorizing templates from erroneously categorizing themselves.
+=== Use-case: templates that categorize templates ===

Ganaram inukshuk: update dochead

2025-10-23T10:04:32Z

update dochead

← Older revision		Revision as of 10:04, 23 October 2025
Line 1:		Line 1:
	{{dochead}}		{{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\|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.}}
	{{clear}}		{{clear}}

Ganaram inukshuk at 00:53, 23 October 2025

2025-10-23T00:53:04Z

← Older revision		Revision as of 00:53, 23 October 2025
Line 23:		Line 23:
	: <code><nowiki>{{Category handler \| Abstract MOS patterns \| 8-tone scales \| debug=1 }}</nowiki></code>		: <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.

	==~~= Category suppression ===~~		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.

	By default, this metatemplate allows categories within the following namespaces: main, file, mediawiki, template, category, and module. Templates placed those namespaces will not categorize those pages.		== Category suppression ==

	~~Additionally~~, this metatemplate ~~suppresses~~ categories ~~if the page has~~ the following ~~suffixes (subpages)~~: ~~doc or sandbox. This prevents templates from categorizing test or documentation pages~~, ~~but not if the /doc page is transcluded. This means categorizing templates that categorize other templates will the template's main page~~, ~~but not their /doc subpages. However~~, ~~if a categorizing~~ template~~'s documentation is demonstrating its own use~~, ~~this isn't enough~~, ~~so adding <code><nowiki>debug=1</nowiki></code> is required to keep categorizing templates from erroneously categorizing themselves~~.		By default, this metatemplate allows categories within the following namespaces: main, file, mediawiki, template, category, and module. Templates placed within those namespaces will not categorize those pages.

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

			Alternatively, 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>

			Additionally, this metatemplate suppresses categories if the page has the following suffixes (subpages): doc or sandbox. This prevents templates from categorizing test or documentation pages, but not if the /doc page is transcluded. This means categorizing templates that categorize other templates will the template's main page, but not their /doc subpages. However, if a categorizing template's documentation is demonstrating its own use, this isn't enough, so adding <code><nowiki>debug=1</nowiki></code> is required to keep categorizing templates from erroneously categorizing themselves.

Ganaram inukshuk: template rating details

2025-10-22T09:54:05Z

template rating details

← Older revision		Revision as of 09:54, 22 October 2025
Line 1:		Line 1:
	{{dochead}}		{{dochead}}
	{{Template rating\|details=Currently in-progress and used for ~~one other template~~. ~~Category input~~ may be ~~adjusted~~.}}		{{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.}}
	{{clear}}		{{clear}}
	{{lua}}		{{lua}}