SockyPaws: Migrate template documentation to subpage and increase its informational value

2024-11-21T18:55:40Z

Migrate template documentation to subpage and increase its informational value

New page

{{Documentation subpage}}
The {{Template link general|plaincode=on|Delete}} template is intended for use by editors to alert wiki administrators of pages they feel should be deleted. Any articles transcluding this template are added into the corresponding [[:Category:Candidates for deletion|Candidates for deletion]] tracking category.

=== Usage ===
The template accepts two parameters, one unnamed/positional and the other named {{Para|nocat}}. The first is intended to record the rationale behind the editor's decision to place it on the page, and should always be used (as seen below). If the rationale includes an equality symbol anywhere within it, this parameter must be assigned as {{Para|1}} rather than being unnamed.

: {{Template link general|italic=on|plaincode=on|Delete|Reason for deletion}} or
: {{Template link general|italic=on|plaincode=on|Delete|2=1=Because this article = pure dumbness.}}

…whose parsed output is…

{{Delete|Reason for deletion|nocat=y}}
{{Delete|1=Because this article = pure dumbness.|nocat=y}}

=== Categorization ===
The {{Para|nocat}} parameter suspends the template's categorization behavior when assigned any non-null value, preventing the transcluding page from being added to the tracking category mentioned above. This is primary meant for use when demonstrating the template's use. In fact, it can be seen in use on this very page in the two examples above, the first of which having the wikitext:

: {{Template link general|code=on|Delete|Reason for deletion|3=nocat=y}}

== TemplateData ==
<div class="templatedata-header">This is the [[mediawikiwiki:Special:MyLanguage/Help:TemplateData|TemplateData]] for this template, used by [[mediawikiwiki:Special:MyLanguage/Help:Extension:TemplateWizard|TemplateWizard]], [[mediawikiwiki:Special:MyLanguage/Help:VisualEditor/User guide|VisualEditor]] and other tools.

'''TemplateData for {{BASEPAGENAME}}'''
</div><templatedata>{
"description": "Displays a notice informing visitors that the page has been proposed for deletion and adds it to the Candidates for deletion category",
"format": "inline",
"paramOrder": [
"1",
"nocat"
],
"params": {
"1": {
"label": "Rationale",
"type": "line",
"description": "The reason why you think the page should be deleted",
"example": "Unused redirect",
"default": "None given.",
"suggested": true
},
"nocat": {
"label": "Disable categorization",
"type": "line",
"description": "Suspends the addition of the transcluding page into the associated tracking category when assigned any non-null value; primarily intended for instances of demonstrating template usage.",
"example": "yes",
"suggestedvalues": [
"true",
"on",
"yes",
"y",
"1"
]
}
}
}</templatedata><includeonly>

[[Category:Maintenance templates]]
[[Category:Templates using TemplateData]]
</includeonly>

Template:Delete/doc - Revision history

SockyPaws: Migrate template documentation to subpage and increase its informational value