Template:Template rating/doc: Difference between revisions
m →Usage |
clarify when some params are used; module namespace detection is automatic, so there's no need to enter the namespace manually; added a quick copy to see how it looks |
||
| Line 19: | Line 19: | ||
; <code>replacement</code> (required if <code>rating=replaced</code>) | ; <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> ( | ; <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>) | ; <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 === | === 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''' | '''Draft template''' | ||