Difference between revisions of "Template:Db notice doc/lead/doc"

From blackwiki
Jump to navigation Jump to search
imported>Mr. Stradivarius
(Create documentation)
 
imported>Andrybak
(→‎Parameters: format with dt & dd)
 
Line 16: Line 16:
  
 
=== Parameters ===
 
=== Parameters ===
*'''criterion''':- This is the abbreviation of the [[WP:CSD|speedy deletion criterion]] used by the notice. For example, <code>G1</code>, <code>G3</code>, or <code>A7</code>.
+
;{{para|criterion}}
*'''criterion-desc''':- A short description of the speedy deletion criterion. For example, <code>patent nonsense</code> or <code>vandalism</code>.
+
:This is the abbreviation of the [[WP:CSD|speedy deletion criterion]] used by the notice. For example, <code>G1</code>, <code>G3</code>, or <code>A7</code>.
*'''speedy-template''':- The speedy deletion template used in conjunction with the warning template. For example, <code>db-nonsense</code> or <code>db-vandalism</code>.
+
;{{para|criterion-desc}}
 +
:A short description of the speedy deletion criterion. For example, <code>patent nonsense</code> or <code>vandalism</code>.
 +
;{{para|speedy-template}}
 +
:The speedy deletion template used in conjunction with the warning template. For example, <code>db-nonsense</code> or <code>db-vandalism</code>.
  
 
=== Substituting ===
 
=== Substituting ===

Latest revision as of 12:14, 23 August 2019

This template is used to create the lead section for the documentation pages of the different speedy deletion notification templates. This template affects all of the notification templates - if you only want to edit the documentation for one particular notification template, please go back to the documentation page for that template and add your new text directly after the {{db notice doc/lead}} text.

Usage

This template should usually be transcluded. However, it is also possible to substitute it if a customized version is needed for an individual documentation page.

Basic usage

{{db notice doc/lead
|criterion       = <!-- G1, G3, A7, etc. -->
|criterion-desc  = <!-- patent nonsense, vandalism, etc. -->
|speedy-template = <!-- db-nonsense, db-vandalism, etc. -->
}}

Parameters

|criterion=
This is the abbreviation of the speedy deletion criterion used by the notice. For example, G1, G3, or A7.
|criterion-desc=
A short description of the speedy deletion criterion. For example, patent nonsense or vandalism.
|speedy-template=
The speedy deletion template used in conjunction with the warning template. For example, db-nonsense or db-vandalism.

Substituting

If the text of this template is too restrictive and you want to make a custom version for an individual template documentation page, you can substitute the template. To do this, simply add subst: after the two opening curly braces to the template that already exists on the documentation page:

{{subst:db notice doc/lead
|criterion       = <!-- G1, G3, A7, etc. -->
|criterion-desc  = <!-- patent nonsense, vandalism, etc. -->
|speedy-template = <!-- db-nonsense, db-vandalism, etc. -->
}}

After you have substituted the template, you can customize the text however you want.

See also

Subpages of {{db notice doc}}: