Template:Template rating/doc

This template should not be substituted.

English Wikipedia has an article on:

Template:Template rating

Template:Template rating 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 <noinclude></noinclude> block.

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

Parameters

rating (required; default draft)

The rating of template or module.

namespace (required; default is based on {{ARTICLESPACE}})

The namespace of the page. For normal use, this is automatically detected and does not need to be entered manually.

pagename (required; default is based on {{PAGENAME}})

The name of the page. For normal use, this is automatically detected and does not need to be entered manually.

details (optional)

Any details about the template or module in question.

replacement (required if rating=replaced)

The name of the replacement template or module, if the current template or module is being replaced by a new one.

delete (required if rating=replaced or rating=deprecated; default false)

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.

debug (optional; default false)

Whether to disable categories for Template:Category handler. For normal use, this should be left unchanged.

Quick copy (essential params only)

{{Template rating
| rating      =
| details     =
| replacement =
| delete      =
}}

Usage

The following examples assumes use for a template. Usage within the module namespace is automatically detected.

Draft template

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

{{Template rating|Sometemplate|rating=draft|details=Other details go here.}}

This documentation is for a draft template. It is incomplete and may not be in active development. If possible, editors are encouraged to help with its development. In the meantime, editors should avoid using this template across the Xenharmonic Wiki, except for testing. Details: Other details go here.

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

{{Template rating|Sometemplate|rating=ready|details=Other details go here.}}

This documentation is for a ready template. This message indicates that a template is ready for use, or has recently been repaired. This message may be removed once this template has been used on several pages or once it is verified to work as intended. Details: Other details go here.

Broken template

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.

{{Template rating|Sometemplate|rating=broken|details=Other details go here.}}

This documentation is for a broken template. If possible, editors are encouraged to improve it or nominate it for deletion or deprecation if it cannot be fixed. In the meantime, editors should avoid using this template across the Xenharmonic Wiki, except for testing. Details: Other details go here.

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.

{{Template rating|Sometemplate|rating=replaced|replacement=Somenewtemplate|details=Other details go here.}}

This documentation is for a deprecated template, which has been replaced by Template:Somenewtemplate. Further use of this template is not advised. This template is kept for historical purposes and should not be deleted. Details: Other details go here.

If a template has not been extensively used, it may be nominated for deletion by adding delete=1.

{{Template rating|Sometemplate|rating=replaced|replacement=Somenewtemplate|details=Other details go here.|delete=1}}

This documentation is for a deprecated template, which has been replaced by Template:Somenewtemplate. Further use of this template is not advised. This template is a candidate for deletion. Details: Other details go here.

Deprecated template

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

{{Template rating|Sometemplate|rating=deprecated|details=Other details go here.}}

This documentation is for a deprecated template, which has no replacement. Further use of this template is not advised. This template is kept for historical purposes and should not be deleted. Details: Other details go here.

As with replaced templates, deprecated templates are not nominated for deletion by default. To nominate it for deletion, add delete=1.

{{Template rating|Sometemplate|rating=deprecated|details=Other details go here.|delete=1}}

This documentation is for a deprecated template, which has no replacement. Further use of this template is not advised. This template is a candidate for deletion. Details: Other details go here.

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.

{{Template rating|Sometemplate|rating=aaa}}

This template has an unrecognized rating or is in the incorrect namespace. Details: Valid ratings are draft, ready, broken, replaced, and deprecated. Valid namespaces are Module and Template. This template's rating is aaa and is currently in the User namespace.

See also

• Template:Deprecated template, a template added to a deprecated template's code, to be used in conjunction with this template