Template:Template rating/doc: Difference between revisions

(6 intermediate revisions by 2 users not shown)

Line 1:

'''{{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 ===

Line 9:

: 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 ~~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> (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.

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

Line 16:

Line 19:

; <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>)

: 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 ===

The following examples assumes use for a template.

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

'''Draft template'''

Line 37:

Line 49:

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

Line 44:

Line 56:

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

@@ 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.
+'''{{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 ===
@@ Line 9: / Line 9: @@
 : 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 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> (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.
 ; <code>details</code> (optional)
@@ Line 16: / Line 19: @@
 ; <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>)
-: 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 ===
-The following examples assumes use for a template.
+The following examples assumes use for a template. Usage within the module namespace is automatically detected.
 '''Draft template'''
@@ Line 37: / Line 49: @@
 '''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>
@@ Line 44: / Line 56: @@
 '''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>