Template:Template rating/doc

This template has a corresponding Lua module Module:Template rating, but does not invoke its functions.

Template:Template rating is used to denote one of several states for a template or module:

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

Draft template - for testing new templates and, sometimes, rewriting existing templates.

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 - for templates that are ready; the absence of this template implies a template is ready, so this isn't strictly required.

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 - for templates with broken functionality that requires rewriting

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

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.

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.

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, archived - for templates that have been deprecated without a replacement, and shouldn't be deleted.

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.

Deprecated template, delete - for templates that have been deprecated without a replacement, and should be deleted.

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

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.

Todo: add documentation