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

From blackwiki
Jump to navigation Jump to search
imported>Mr. Stradivarius
(Create documentation)
 
imported>Mr. Stradivarius
(Add "twinkle" parameter documentation)
Line 11: Line 11:
 
|criterion-desc  = <!-- patent nonsense, vandalism, etc. -->
 
|criterion-desc  = <!-- patent nonsense, vandalism, etc. -->
 
|speedy-template = <!-- db-nonsense, db-vandalism, etc. -->
 
|speedy-template = <!-- db-nonsense, db-vandalism, etc. -->
 +
|twinkle        = yes
 
|namespace      = yes  
 
|namespace      = yes  
 
|nowelcome      = yes
 
|nowelcome      = yes
Line 21: Line 22:
 
=== Parameters ===
 
=== Parameters ===
  
;Compulsory parameters
+
;Main 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>.
 
*'''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>.
 
*'''criterion-desc''':- A short description of the speedy deletion criterion. For example, <code>patent nonsense</code> or <code>vandalism</code>.
 
*'''criterion-desc''':- A short description of the speedy deletion criterion. For example, <code>patent nonsense</code> or <code>vandalism</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>.
 
*'''speedy-template''':- The speedy deletion template used in conjunction with the warning template. For example, <code>db-nonsense</code> or <code>db-vandalism</code>.
 +
*'''twinkle''':- If this parameter exists, the {{tl|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.
 
*'''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.
 
*'''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.

Revision as of 12:26, 10 August 2012

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. -->
}}

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 new category should go on a new line.

See also