Editing Template:Db-meta/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

===Usage===
This template is a meta-template used to create the other [[CAT:SDT|speedy deletion templates]] used for nominating pages for [[WP:CSD|speedy deletion]]. '''Do not''' attempt to use this template directly on articles. For a generic speedy deletion template, see {{tl|db}}.

===Syntax===
Basic syntax:

<pre>
{{db-meta
 |bot={{{bot|}}}
 |raw={{{raw|}}}
 |criterion=
 |1=
 |2=
 |temp=
 |summary=
}}</pre>

Extended syntax:

<pre>
{{db-meta
 |bot={{{bot|}}}
 |raw={{{raw|}}}
 |criterion=
 |1=
 |2=
 |rationale=
 |summary=
 |self=
 |notes=
 |anote=
 |temp=
 |temp2=
 |sig=
 |image=
 |wiki=
 |blanked=
 |blanked-text=
 |pleaseblank=
 |divblank=
 |help=
}}</pre>

=== Parameters ===
'''Required parameters'''

*{{para|criterion}} is the Criterion number from [[Wikipedia:Speedy deletion criteria]]. '''Do not''' create a CSD template which does not already have a CSD criterion.
*{{para|1}} is the text which will go in bold immediately after "may qualify for speedy deletion". Note that there is no space between the word "deletion" and the parameter – if you want to continue the sentence without punctuation, use an HTML space (&amp;#32;) to prevent the template 'eating' the leading space. A trailing full stop is ''already'' included in db-meta, so don't add it to this parameter

;Recommended parameters
:These parameters are generally used in all speedy deletion templates based on db-meta, and some may break other templates/scripts if they are omitted.

*{{para|2}} is the text which appears in italics after {{para|1}}. This should be a complete sentence, minus trailing punctuation (a full stop is included in db-meta).
*{{para|temp}} is the [[Wikipedia:user warning template|user warning template]] which corresponds to the CSD criterion. For instance, {{tlx|db-a1}} uses [[Template:empty-warn]], so passes the parameter {{para|temp|empty-warn}}. All such warning templates should be categorised at [[:Category:Speedy deletion warning templates]]
*{{para|summary}} is the brief summary which will be preloaded into the deletion confirmation screen. There is no need to include the CSD criterion as this is added automatically.
*{{para|bot}} is the name of the bot account that tagged the page for deletion, if applicable. This should be passed through to the specific deletion template, using <code><nowiki>|bot={{{bot|}}}</nowiki></code>. It should not be called directly from db-meta.
*{{para|raw}} is used for generating a simple deletion message with no message box. It should be passed through to the specific deletion template, using <code><nowiki>|raw={{{raw|}}}</nowiki></code>. This parameter is used by {{tl|db-multiple}} to generate the notices about individual speedy deletion criteria.

'''Optional parameters'''

*{{para|rationale}} adds a custom deletion rationale in red after the speedy deletion criterion number.
*{{para|self}}: if this parameter exists, there is no message about not removing speedy deletion templates from things you have created/uploaded yourself.
*{{para|notes}} is a space for notes. It appears after the notice about using the talk page for contesting speedy deletions, and before the message only visible to admins.
*{{para|anote}} adds an extra custom note to the message only visible to admins.
*{{para|temp2}} allows the addition of extra parameters to the end of the user warning template specified in {{para|temp}}.
*{{para|sig}}: if this exists, the four tildes normally appended to the user warning template text are removed.
*{{para|image}} adds an image to the right-hand side of the template. Include only the image name; do not add "File:" or "Image:".
*{{para|wiki}} is the [[Help:Interwikimedia links|interwikimedia link]] for the image named in {{para|image}}, if it is not on the English Wikipedia.
*{{para|blanked}}: if this exists, a message box is shown beneath the main deletion template that says "This page has been [[Wikipedia:Deletion policy#Courtesy blanking|blanked as a courtesy]]."
*{{para|blanked-text}} is the custom text for the "blanked" message box. {{para|blanked}} must exist for this to work.
*{{para|pleaseblank}}: if this exists, a message box is shown beneath the main deletion template that says "Please [[Wikipedia:Courtesy blanking|blank this page]] so that it only contains the deletion template."
*{{para|divblank}}: if this parameter exists, the code <code><nowiki><div id="AttackPage" style="display:none"></nowiki></code> is added to the end of the deletion template, which prevents all subsequent content on the page from being displayed.
*{{para|help}}: pass {{para|help|off}} to hide the message to the nominator about notifying the author.

=== Other notes ===
*For templates which have variants, like {{tlx|db-g6}} and {{tlx|db-a7}}, it is recommended to base the variants ''on those templates'', rather than directly on db-meta. For instance, {{tlx|db-band}} calls {{tlx|db-a7}} which in turn calls db-meta, rather than db-band calling db-meta directly.
*All CSD templates using db-meta produce two invisible spans which may be useful for client-side JavaScript:
**<code><nowiki><div id="delete-criterion"></div></nowiki></code> contains only the CSD criterion ("A1", "P2", "R3", etc.)
**<code><nowiki><div id="delete-reason"></div></nowiki></code> contains a complete, legible deletion log summary which is suitable for preloading into the deletion confirmation screen.

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {},
		"2": {},
		"raw": {
			"description": "Set to any value to remove the red box around the deletion message (used for {{db-multiple}}). Don't use this directly."
		},
		"criterion": {},
		"rationale": {
			"description": "Rationale",
			"example": "Why the page should be deleted."
		},
		"bot": {
			"description": "Bot?"
		},
		"summary": {},
		"self": {},
		"help": {},
		"temp": {},
		"temp2": {},
		"sig": {},
		"notes": {},
		"anote": {},
		"blanked": {},
		"blanked-text": {},
		"pleaseblank": {},
		"divblank": {}
	},
	"description": "A meta template, used for various speedy deletion templates. Don't transclude this template directly. "
}
</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Speedy deletion templates|Meta]]
[[Category:Wikipedia metatemplates]]
[[Category:Wikipedia templates which apply NOINDEX]]

}}</includeonly>