Template:Db-meta/doc

< Template:Db-meta
Revision as of 02:11, 17 May 2019 by Ghant (talk | contribs) (Created page with "{{Documentation subpage}} {{template sandbox notice}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> ===Usage=== This template is a meta-template us...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


Usage

This template is a meta-template used to create the other speedy deletion templates used for nominating pages for speedy deletion. Do not attempt to use this template directly on articles. For a generic speedy deletion template, see {{db}}.

Syntax

Basic syntax:

{{db-meta
 |bot={{{bot|}}}
 |raw={{{raw|}}}
 |criterion=
 |1=
 |2=
 |temp=
 |summary=
}}

Extended syntax:

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

Parameters

Required parameters
  • criterion is the Criterion number from Wikipedia:Speedy deletion criteria. Do not create a CSD template which does not already have a CSD criterion, or it will itself be deleted under CSD T2!
  • 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 (&#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.

  • 2 is the text which appears in italics after 1. This should be a complete sentence, minus trailing punctuation (a full stop is included in db-meta).
  • temp is the user warning template which corresponds to the CSD criterion. For instance, {{db-a1}} uses Template:empty-warn, so passes the parameter |temp=empty-warn. All such warning templates should be categorised at Category:CSD warning templates
  • 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.
  • 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 |bot={{{bot|}}}. It should not be called directly from db-meta.
  • raw is used for generating a simple deletion message with no message box. It should be passed through to the specific deletion template, using |raw={{{raw|}}}. This parameter is used by {{db-multiple}} to generate the notices about individual speedy deletion criteria.
Optional parameters
  • rationale adds a custom deletion rationale in red after the speedy deletion criterion number.
  • self: if this parameter exists, there is no message about not removing speedy deletion templates from things you have created/uploaded yourself.
  • 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.
  • anote adds an extra custom note to the message only visible to admins.
  • temp2 allows the addition of extra parameters to the end of the user warning template specified in |temp=.
  • sig: if this exists, the four tildes normally appended to the user warning template text are removed.
  • image adds an image to the right-hand side of the template. Include only the image name; do not add "File:" or "Image:".
  • wiki is the interwikimedia link for the image named in |image=, if it is not on the English Wikipedia.
  • blanked: if this exists, a message box is shown beneath the main deletion template that says "This page has been blanked as a courtesy."
  • blanked-text is the custom text for the "blanked" message box. |blanked= must exist for this to work.
  • pleaseblank: if this exists, a message box is shown beneath the main deletion template that says "Please blank this page so that it only contains the deletion template."
  • divblank: if this parameter exists, the code <div id="AttackPage" style="display:none"> is added to the end of the deletion template, which prevents all subsequent content on the page from being displayed.

Other notes

  • All CSD templates based directly on db-meta should ideally use {{db doc}} for centralised documentation.
  • For templates which have variants, like {{db-g6}} and {{db-a7}}, it is recommended to base the variants on those templates, rather than directly on db-meta. For instance, {{db-band}} calls {{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 java script:
    • <div id="delete-criterion"></div> contains only the CSD criterion ("A1", "P2", "R3", etc)
    • <div id="delete-reason"></div> contains a complete, legible deletion log summary which is suitable for preloading into the deletion confirmation screen.