Template:Template rating/doc: Difference between revisions

Line 1:

{{Template rating~~|details=It works now! This~~ template ~~may~~ be ~~tested on actual templates/modules before being declared~~ ready. ~~A fifth category may~~ be ~~added: replaced~~, ~~denoting~~ deprecated ~~templates with replacements~~, ~~whereas ordinary deprecated denotes~~ no replacement.}}

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

~~<hr>~~

* 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'''

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

Line 22:

Line 30:

'''Deprecated template, delete'''

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

'''Incorrect options'''

@@ Line 1: / Line 1: @@
 {{dochead}}
-{{Template rating|details=It works now! This template may be tested on actual templates/modules before being declared ready. A fifth category may be added: replaced, denoting deprecated templates with replacements, whereas ordinary deprecated denotes no replacement.}}
+'''Template:Template rating''' is used to denote one of several states for a template or module:
-<hr>
+* 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'''
 {{Template rating|Sometemplate|rating=draft|namespace=Template|details=Other details go here.|debug=1}}
@@ Line 22: / Line 30: @@
 '''Deprecated template, delete'''
 {{Template rating|Sometemplate|rating=deprecated|namespace=Template|details=Other details go here.|debug=1|delete=1}}
 '''Incorrect options'''
 {{Template rating|Sometemplate|rating=aaa|namespace=User}}
+{{Todo|inline=1|Add documentation}}