Template:Template rating/doc: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
documentation |
||
| Line 1: | Line 1: | ||
{{dochead}} | {{dochead}} | ||
'''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''' | '''Draft template''' | ||
{{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}} | ||
| Line 22: | Line 30: | ||
'''Deprecated template, delete''' | '''Deprecated template, delete''' | ||
{{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''' | ||
{{Template rating|Sometemplate|rating=aaa|namespace=User}} | {{Template rating|Sometemplate|rating=aaa|namespace=User}} | ||
{{Todo|inline=1|Add documentation}} | |||
Revision as of 04:58, 23 October 2025
- 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
|
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
|
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
|
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
|
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
|
|
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
|
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
|
|
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 |