Template:Db notice doc

Template documentation[view] [edit] [history] [purge]

This is a boilerplate template used to create documentation pages for the speedy deletion notification templates.

Usage

This template should be substituted on to the documentation subpage of the speedy deletion notification template. Basic usage is as follows:

{{subst:db notice doc
|criterion       = <!-- G1, G3, A7, etc. -->
|criterion-desc  = <!-- patent nonsense, vandalism, etc. -->
|speedy-template = <!-- db-nonsense, db-vandalism, etc. -->
|twinkle         = yes
|namespace       = yes 
|nowelcome       = yes
|header          = yes
|header-text     = yes
|demo            = yes
|cat-name        = <!-- nonsense-notice, vandalism-notice, etc. -->
}}

This template uses subpages to make the speedy deletion notice documentation pages both flexible and easy to maintain. These subpages are usually transcluded on the documentation subpage, but they can also be substituted if desired - see the individual subpages for instructions on how to do this.

Subpages of {{db notice doc}}:

• {{db notice doc/lead}}
• {{db notice doc/usage}}
• {{db notice doc/basicusage}}
• {{db notice doc/parameters}}
• {{db notice doc/examples}}
• {{db notice doc/seealso}}

Parameters

Main 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.
• twinkle:- If this parameter exists, the {{twinkle standard installation}} template is included at the top of the page.
• namespace:- If this parameter exists, an explanation of the "namespace" parameter for the notification template will be included. Leave this parameter blank if you don't want to include the explanation.
• nowelcome:- If this parameter exists, an explanation of the "nowelcome" parameter for the notification template will be included. Leave this parameter blank if you don't want to include the explanation.
• header:- If this parameter exists, an explanation of the "header" parameter for the notification template will be included. Leave this parameter blank if you don't want to include the explanation.
• header-text:- If this parameter exists, an explanation of the "header-text" parameter for the notification template will be included. Leave this parameter blank if you don't want to include the explanation.
• demo:- If this parameter exists, an explanation of the "demo" parameter for the notification template will be included. Leave this parameter blank if you don't want to include the explanation.
• cat-name:- This is the name that the template should be categorised under. For example, nonsense-notice or vandalism-notice.

Optional parameters

• warning-template:- The name of the notification template. For example, db-nonsense-notice or db-vandalism-notice. This parameter is only necessary if the documentation is not being created in the template's documentation subpage.
• othercats:- Additional categories can be specified with this parameter. Each category should go on a new line. Example: [[Category:Copyright maintenance templates]]
• interwiki:- You can specify interwiki links with this parameter. Each link should go on a new line. Example: [[he:תבנית:הבל]]

See also

• {{db-notice}}
• {{db-deleted}}

The above documentation is transcluded from Template:Db notice doc/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.