Editing Template:Db notice doc/doc

{{Documentation subpage}}
{{subst only}}
<!-- Categories and interwikis go at the bottom of this page. -->

This is a boilerplate template used to create documentation pages for the [[WP:CSD|speedy deletion]] notification templates.

== Usage ==
This template should be [[WP:SUBST|substituted]] on to the documentation subpage of the speedy deletion notification template. Basic usage is as follows:

<syntaxhighlight lang="wikitext">{{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. -->
}}</syntaxhighlight>

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

{{db notice doc/subpages}}

=== 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-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>.
*'''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.
*'''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, <code>nonsense-notice</code> or <code>vandalism-notice</code>.

;Optional parameters
*'''warning-template''':- The name of the notification template. For example, <code>db-nonsense-notice</code> or <code>db-vandalism-notice</code>. 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: <code><nowiki>[[Category:Copyright maintenance templates]]</nowiki></code>
*'''interwiki''':- You can specify interwiki links with this parameter. Each link should go on a new line. Example: <code><nowiki>[[he:תבנית:הבל]]</nowiki></code>

== See also ==
* {{tl|db-notice}}
* {{tl|db-deleted}}


{{speedy deletion navbox}}

<includeonly>{{Sandbox other||
<!-- Categories and interwikis go here: -->
[[Category:Speedy deletion warning templates|Db notice doc]]
[[Category:Documentation shared content templates]]
}}</includeonly>