Template:Delete/doc: Difference between revisions
Created page with "{{doc/start}} This template place a notice box using Template:Notice and is used for maintenance purposes to signal that a page is no longer needed and is suggested to be deleted. == Usage == To use, put {{tlx|Delete|1}} at the start of the page. Pages will automatically be added to Category:Pages marked for deletion. === Parameters === {| class="wikitable" ! Parameter !! Data Type !! Default Value !! Description |- | 1 ("reason") || String || No reason has b..." |
m added a bit more context to the note |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{doc/start}} | {{doc/start}} | ||
This template | This template is used for maintenance purposes to signal that a page is no longer needed and is suggested to be deleted. Marked pages will automatically be added to [[:Category:Pages marked for deletion]]. | ||
This template uses {{tl|Notice}} to create the box and it's not visible on mobile devices (added class <code>nomobile</code>). | |||
== Usage == | == Usage == | ||
To use, put {{tlx|Delete| | To use, put {{tlx|Delete|reason}} at the start of the page. | ||
=== Parameters === | === Parameters === | ||
{| class="wikitable" | {| class="wikitable" | ||
! Parameter !! Data Type !! Default Value !! | ! colspan=2 | Parameter<ref group="note">Placeholders refer to the names used in the syntax above. For documentation purposes positioned parameters often have a pseudo name instead of their number to improve readabilty, e.g. <code>reason</code> instead of <code>1</code>.<br> Placeholder <code>-</code> indicates parameters that are not used by default and need to be added by hand, e.g. <code>{{!}}noCategories = 1</code>.</ref> | ||
! rowspan=2 | Data Type | |||
! rowspan=2 | Status | |||
! rowspan=2 | Default Value | |||
! rowspan=2 | Description | |||
|- | |||
! Position or name | |||
! Placeholder | |||
|- | |- | ||
| 1 | | <code>1</code> | ||
| <code>reason</code> | |||
| String | |||
| Optional | |||
| No reason has been provided | |||
| Reason why the page is suggested to be deleted. | |||
|- | |- | ||
| noCategories || Boolean|| - || | | <code>noCategories</code> | ||
| style="text-align: center"| - | |||
| Boolean | |||
| Optional | |||
| style="text-align: center"| - | |||
| If given any value, the page will not be auto-categorized. | |||
|} | |} | ||
==== Notes ==== | |||
<references group="note"/> | |||
== Example == | == Example == | ||
| Line 19: | Line 40: | ||
{{Delete|Page is no longer needed|noCategories=1}} | {{Delete|Page is no longer needed|noCategories=1}} | ||
== See also == | |||
{{#dpl: | |||
|namespace = Template | |||
|category = Notice templates | |||
|uses = Template:Notice | |||
|nottitlematch = %{{ROOTPAGENAME}}% | |||
|ordermethod = title | |||
|order = ascending | |||
}} | |||
{{doc/end}} | {{doc/end}} | ||