Template:Template rating/doc - Revision history

Ganaram inukshuk at 10:59, 6 February 2026

2026-02-06T10:59:42Z

← Older revision		Revision as of 10:59, 6 February 2026
Line 9:		Line 9:
	: The rating of template or module.		: The rating of template or module.

	; <code>namespace</code> (~~required; default is based on~~ <code><nowiki>{{ARTICLESPACE}}</nowiki></code>)		; <code>namespace</code> (automatically detected using <code><nowiki>{{ARTICLESPACE}}</nowiki></code>)
	: The namespace of the page. For normal use, this is automatically detected and does not need to be entered manually.		: The namespace of the page. For normal use, this is automatically detected and does not need to be entered manually.

	; <code>pagename</code> (~~required; default is based on~~ <code><nowiki>{{PAGENAME}}</nowiki></code>)		; <code>pagename</code> (automatically detected using <code><nowiki>{{PAGENAME}}</nowiki></code>)
	: The name of the page. For normal use, this is automatically detected and does not need to be entered manually.		: The name of the page. For normal use, this is automatically detected and does not need to be entered manually.

Ganaram inukshuk: clarify when some params are used; module namespace detection is automatic, so there's no need to enter the namespace manually; added a quick copy to see how it looks

2026-02-05T21:31:51Z

clarify when some params are used; module namespace detection is automatic, so there's no need to enter the namespace manually; added a quick copy to see how it looks

← Older revision		Revision as of 21:31, 5 February 2026
Line 19:		Line 19:

	; <code>replacement</code> (required if <code>rating=replaced</code>)		; <code>replacement</code> (required if <code>rating=replaced</code>)
	: The name of the replacement template or module.		: The name of the replacement template or module, if the current template or module is being replaced by a new one.

	; <code>delete</code> (~~optional~~; default <code>false</code>)		; <code>delete</code> (required if <code>rating=replaced</code> or <code>rating=deprecated</code>; default <code>false</code>)
	: Whether to delete the template or module.		: Whether to delete the template or module, if the current template or module is being either replaced or deprecated. Deprecated templates and modules are generally kept for archival and historical purposes, but those that have seen little use (such as those made for testing or with experimental features) may be deleted instead.

	; <code>debug</code> (optional; default <code>false</code>)		; <code>debug</code> (optional; default <code>false</code>)
	: Whether to disable categories for [[Template:Category handler]].		: Whether to disable categories for [[Template:Category handler]]. For normal use, this should be left unchanged.

			=== Quick copy (essential params only) ===

			<pre>{{Template rating
			\| rating =
			\| details =
			\| replacement =
			\| delete =
			}}</pre>

	=== Usage ===		=== Usage ===

	The following examples assumes use for a template. ~~For use with~~ module ~~documentation, add <code>~~namespace ~~= Module</code>~~.		The following examples assumes use for a template. Usage within the module namespace is automatically detected.

	'''Draft template'''		'''Draft template'''

Ganaram inukshuk: /* Usage */

2026-02-05T02:39:30Z

Usage

← Older revision		Revision as of 02:39, 5 February 2026
Line 29:		Line 29:
	=== Usage ===		=== Usage ===

	The following examples assumes use for a template.		The following examples assumes use for a template. For use with module documentation, add <code>namespace = Module</code>.

	'''Draft template'''		'''Draft template'''

ArrowHead294 at 20:34, 4 February 2026

2026-02-04T20:34:03Z

← Older revision		Revision as of 20:34, 4 February 2026
Line 1:		Line 1:
	{{dochead\|mod=aaa}}{{wikipedia}}		{{dochead\|mod=aaa}}{{substitute\|no}}{{clear}}{{wikipedia}}
	'''{{ARTICLEROOTPAGENAME}}''' is used to denote the rating of a template or module, namely denoting whether or not it can be used. This template is placed within the documentation page of a template, not its <code><nowiki><noinclude></noinclude></nowiki></code> block.		'''{{ARTICLEROOTPAGENAME}}''' is used to denote the rating of a template or module, namely denoting whether or not it can be used. This template is placed within the documentation page of a template, not its <code><nowiki><noinclude></noinclude></nowiki></code> block.

Ganaram inukshuk: /* Usage */

2025-10-31T08:45:45Z

Usage

← Older revision		Revision as of 08:45, 31 October 2025
Line 40:		Line 40:
	'''Ready template'''		'''Ready template'''

	'''Ready''' denotes a template that is ready for use on the wiki. The use of this template is not necessary for most templates, as a template without any other indicators is assumed to be a ready ~~tempalte~~.		'''Ready''' denotes a template that is ready for use on the wiki. The use of this template is not necessary for most templates, as a template without any other indicators is assumed to be a ready template.

	<code><nowiki>{{Template rating\|Sometemplate\|rating=ready\|details=Other details go here.}}</nowiki></code>		<code><nowiki>{{Template rating\|Sometemplate\|rating=ready\|details=Other details go here.}}</nowiki></code>
Line 47:		Line 47:
	'''Broken template'''		'''Broken template'''

	'''Broken''' denotes a template that is not functioning properly and is currently being fixed.		'''Broken''' denotes a template that is not functioning properly and is currently being fixed. For templates that work but are undergoing refactoring, use the '''draft''' rating.

	<code><nowiki>{{Template rating\|Sometemplate\|rating=broken\|details=Other details go here.}}</nowiki></code>		<code><nowiki>{{Template rating\|Sometemplate\|rating=broken\|details=Other details go here.}}</nowiki></code>

Ganaram inukshuk at 09:59, 29 October 2025

2025-10-29T09:59:35Z

← Older revision		Revision as of 09:59, 29 October 2025
Line 1:		Line 1:
	{{dochead\|mod=aaa}}{{wikipedia}}		{{dochead\|mod=aaa}}{{wikipedia}}
	'''{{ARTICLEROOTPAGENAME}}''' is used to denote the rating of a template or module, namely denoting whether or not it can be used.		'''{{ARTICLEROOTPAGENAME}}''' is used to denote the rating of a template or module, namely denoting whether or not it can be used. This template is placed within the documentation page of a template, not its <code><nowiki><noinclude></noinclude></nowiki></code> block.

	Despite the name, this template can also be used on Lua modules.		Despite the name, this template can also be used on Lua modules' documentation pages.

	=== Parameters ===		=== Parameters ===

Ganaram inukshuk: /* Parameters */

2025-10-29T09:56:57Z

Parameters

← Older revision		Revision as of 09:56, 29 October 2025
Line 10:		Line 10:

	; <code>namespace</code> (required; default is based on <code><nowiki>{{ARTICLESPACE}}</nowiki></code>)		; <code>namespace</code> (required; default is based on <code><nowiki>{{ARTICLESPACE}}</nowiki></code>)
	: The namespace of the page. For normal use, this ~~should~~ be ~~either Template or Module~~.		: The namespace of the page. For normal use, this is automatically detected and does not need to be entered manually.

			; <code>pagename</code> (required; default is based on <code><nowiki>{{PAGENAME}}</nowiki></code>)
			: The name of the page. For normal use, this is automatically detected and does not need to be entered manually.

	; <code>details</code> (optional)		; <code>details</code> (optional)

Ganaram inukshuk at 09:54, 29 October 2025

2025-10-29T09:54:08Z

← Older revision		Revision as of 09:54, 29 October 2025
Line 1:		Line 1:
	{{dochead}}		{{dochead\|mod=aaa}}{{wikipedia}}
	'''~~Template:Template rating~~''' is used to denote ~~one~~ of ~~several states for~~ a template or module:		'''{{ARTICLEROOTPAGENAME}}''' is used to denote the rating of a template or module, namely denoting whether or not it can be used.

	* Draft - the ~~template or module is a work-in-progress or is a mockup of a proposed template. Unless otherwise stated~~, ~~it should not be used~~		Despite the name, this template can also be used on Lua modules.
	* Ready - the template or module is ready to be used.
	* Broken - the template ~~or module is currently broken and is currently being fixed, and should not~~ be used ~~unless it's for testing.~~
	* Replaced - the template or module has been deprecated, and has a replacement.
	* Deprecated - the template or module has been deprecated, and has no replacement.

	~~Despite the name, this template can also be used on lua modules.~~		=== Parameters ===

	'''Draft template''' - ~~for testing new templates and~~, ~~sometimes, rewriting existing~~ templates.		; <code>rating</code> (required; default <code>draft</code>)
			: The rating of template or module.

			; <code>namespace</code> (required; default is based on <code><nowiki>{{ARTICLESPACE}}</nowiki></code>)
			: The namespace of the page. For normal use, this should be either Template or Module.

			; <code>details</code> (optional)
			: Any details about the template or module in question.

			; <code>replacement</code> (required if <code>rating=replaced</code>)
			: The name of the replacement template or module.

			; <code>delete</code> (optional; default <code>false</code>)
			: Whether to delete the template or module.

			; <code>debug</code> (optional; default <code>false</code>)
			: Whether to disable categories for [[Template:Category handler]].

			=== Usage ===

			The following examples assumes use for a template.

			'''Draft template'''

			'''Ready''' denotes a template that is work-in-progress, or templates that are being rewritten or refactored.

			<code><nowiki>{{Template rating\|Sometemplate\|rating=draft\|details=Other details go here.}}</nowiki></code>
	{{Template rating\|Sometemplate\|rating=draft\|namespace=Template\|details=Other details go here.\|debug=1}}		{{Template rating\|Sometemplate\|rating=draft\|namespace=Template\|details=Other details go here.\|debug=1}}

	'''Ready template''' ~~- for templates~~ that ~~are~~ ready; the ~~absence~~ of this template ~~implies~~ a template is ready~~, so this isn't strictly required~~.		'''Ready template'''

			'''Ready''' denotes a template that is ready for use on the wiki. The use of this template is not necessary for most templates, as a template without any other indicators is assumed to be a ready tempalte.

			<code><nowiki>{{Template rating\|Sometemplate\|rating=ready\|details=Other details go here.}}</nowiki></code>
	{{Template rating\|Sometemplate\|rating=ready\|namespace=Template\|details=Other details go here.}}		{{Template rating\|Sometemplate\|rating=ready\|namespace=Template\|details=Other details go here.}}

	'''Broken template''' ~~- for templates with~~ broken ~~functionality that requires rewriting~~		'''Broken template'''

			'''Broken''' denotes a template that is not functioning properly and is currently being fixed.

			<code><nowiki>{{Template rating\|Sometemplate\|rating=broken\|details=Other details go here.}}</nowiki></code>
	{{Template rating\|Sometemplate\|rating=broken\|namespace=Template\|details=Other details go here.\|debug=1}}		{{Template rating\|Sometemplate\|rating=broken\|namespace=Template\|details=Other details go here.\|debug=1}}

	'''Replaced template~~, archived~~''' ~~- for templates~~ that have been ~~replaced~~ by ~~another~~, ~~and shouldn~~'~~t be deleted. Deprecated templates that have been used extensively should NOT be deleted~~ as it makes viewing past revisions of pages ~~harder to do~~.		'''Replaced template'''

			'''Replaced''' denotes a template that should no longer be used and have been superseded by a new template. By default, deprecated templates are ''not'' nominated for deletion, as deleting a deprecated template makes viewing past revisions of transcluding pages much more difficult.

			<code><nowiki>{{Template rating\|Sometemplate\|rating=replaced\|replacement=Somenewtemplate\|details=Other details go here.}}</nowiki></code>
	{{Template rating\|Sometemplate\|rating=replaced\|namespace=Template\|replacement=Somenewtemplate\|details=Other details go here.\|debug=1}}		{{Template rating\|Sometemplate\|rating=replaced\|namespace=Template\|replacement=Somenewtemplate\|details=Other details go here.\|debug=1}}

	~~'''Replaced~~ template, ~~delete''' -~~ for ~~templates that have been replaced~~ by ~~another, but the original should be deleted~~. ~~This is meant for templates that were never used extensively (or a draft template that was never made ready) and can be safely deleted~~.		If a template has not been extensively used, it may be nominated for deletion by adding <code>delete=1</code>.

			<code><nowiki>{{Template rating\|Sometemplate\|rating=replaced\|replacement=Somenewtemplate\|details=Other details go here.\|delete=1}}</nowiki></code>
	{{Template rating\|Sometemplate\|rating=replaced\|namespace=Template\|replacement=Somenewtemplate\|details=Other details go here.\|debug=1\|delete=1}}		{{Template rating\|Sometemplate\|rating=replaced\|namespace=Template\|replacement=Somenewtemplate\|details=Other details go here.\|debug=1\|delete=1}}

	'''Deprecated template~~, archived~~''' ~~- for templates~~ that ~~have been~~ deprecated ~~without a replacement, and shouldn't be deleted~~.		'''Deprecated template'''

			'''Deprecated''' denotes a template that should no longer be used and has no replacement.

			<code><nowiki>{{Template rating\|Sometemplate\|rating=deprecated\|details=Other details go here.}}</nowiki></code>
	{{Template rating\|Sometemplate\|rating=deprecated\|namespace=Template\|details=Other details go here.\|debug=1}}		{{Template rating\|Sometemplate\|rating=deprecated\|namespace=Template\|details=Other details go here.\|debug=1}}

	'''~~Deprecated template~~, delete~~''' - for templates that have been~~ deprecated ~~without a replacement, and should be deleted~~.		As with replaced templates, deprecated templates are ''not'' nominated for deletion by default. To nominate it for deletion, add <code>delete=1</code>.

			<code><nowiki>{{Template rating\|Sometemplate\|rating=deprecated\|details=Other details go here.\|delete=1}}</nowiki></code>
	{{Template rating\|Sometemplate\|rating=deprecated\|namespace=Template\|details=Other details go here.\|debug=1\|delete=1}}		{{Template rating\|Sometemplate\|rating=deprecated\|namespace=Template\|details=Other details go here.\|debug=1\|delete=1}}

	'''Incorrect options'''		'''Incorrect options and categories'''

			This template uses [[Template:Category handler]], which categories templates and modules using this template in the appropriate categories, except those with a rating of ''ready''. Categories are not enabled on /doc or /sandbox pages.

			In addition to this, this template detects whether it's in the incorrect namespace, such as when used on User namespace pages, and can detect whether it has an unrecognized rating.

			<code><nowiki>{{Template rating\|Sometemplate\|rating=aaa}}</nowiki></code>
	{{Template rating\|Sometemplate\|rating=aaa\|namespace=User}}		{{Template rating\|Sometemplate\|rating=aaa\|namespace=User}}

	~~{{Todo\|inline~~=~~1\|add documentation}}~~		=== See also ===
			* [[Template:Deprecated template]], a template added to a deprecated template's code, to be used in conjunction with this template

Ganaram inukshuk at 01:23, 24 October 2025

2025-10-24T01:23:19Z

Ganaram inukshuk at 04:59, 23 October 2025

2025-10-23T04:59:20Z

← Older revision		Revision as of 04:59, 23 October 2025
Line 34:		Line 34:
	{{Template rating\|Sometemplate\|rating=aaa\|namespace=User}}		{{Template rating\|Sometemplate\|rating=aaa\|namespace=User}}

	{{Todo\|inline=1\|~~Add~~ documentation}}		{{Todo\|inline=1\|add documentation}}

← Older revision		Revision as of 01:23, 24 October 2025
Line 10:		Line 10:
	Despite the name, this template can also be used on lua modules.		Despite the name, this template can also be used on lua modules.

	'''Draft template'''		'''Draft template''' - for testing new templates and, sometimes, rewriting existing templates.
	{{Template rating\|Sometemplate\|rating=draft\|namespace=Template\|details=Other details go here.\|debug=1}}		{{Template rating\|Sometemplate\|rating=draft\|namespace=Template\|details=Other details go here.\|debug=1}}

	'''Ready template'''		'''Ready template''' - for templates that are ready; the absence of this template implies a template is ready, so this isn't strictly required.
	{{Template rating\|Sometemplate\|rating=ready\|namespace=Template\|details=Other details go here.}}		{{Template rating\|Sometemplate\|rating=ready\|namespace=Template\|details=Other details go here.}}

	'''Broken template'''		'''Broken template''' - for templates with broken functionality that requires rewriting
	{{Template rating\|Sometemplate\|rating=broken\|namespace=Template\|details=Other details go here.\|debug=1}}		{{Template rating\|Sometemplate\|rating=broken\|namespace=Template\|details=Other details go here.\|debug=1}}

	'''Replaced template, archived'''		'''Replaced template, archived''' - for templates that have been replaced by another, and shouldn't be deleted. Deprecated templates that have been used extensively should NOT be deleted as it makes viewing past revisions of pages harder to do.
	{{Template rating\|Sometemplate\|rating=replaced\|namespace=Template\|replacement=Somenewtemplate\|details=Other details go here.\|debug=1}}		{{Template rating\|Sometemplate\|rating=replaced\|namespace=Template\|replacement=Somenewtemplate\|details=Other details go here.\|debug=1}}

	'''Replaced template, delete'''		'''Replaced template, delete''' - for templates that have been replaced by another, but the original should be deleted. This is meant for templates that were never used extensively (or a draft template that was never made ready) and can be safely deleted.
	{{Template rating\|Sometemplate\|rating=replaced\|namespace=Template\|replacement=Somenewtemplate\|details=Other details go here.\|debug=1\|delete=1}}		{{Template rating\|Sometemplate\|rating=replaced\|namespace=Template\|replacement=Somenewtemplate\|details=Other details go here.\|debug=1\|delete=1}}

	'''Deprecated template, archived'''		'''Deprecated template, archived''' - for templates that have been deprecated without a replacement, and shouldn't be deleted.
	{{Template rating\|Sometemplate\|rating=deprecated\|namespace=Template\|details=Other details go here.\|debug=1}}		{{Template rating\|Sometemplate\|rating=deprecated\|namespace=Template\|details=Other details go here.\|debug=1}}

	'''Deprecated template, delete'''		'''Deprecated template, delete''' - for templates that have been deprecated without a replacement, and should be deleted.
	{{Template rating\|Sometemplate\|rating=deprecated\|namespace=Template\|details=Other details go here.\|debug=1\|delete=1}}		{{Template rating\|Sometemplate\|rating=deprecated\|namespace=Template\|details=Other details go here.\|debug=1\|delete=1}}