Template:Db notice doc/parameters/doc
 | This is a documentation subpage for Template:Db notice doc/parameters. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used to create the "parameters" 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/parameters}} 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
<syntaxhighlight lang="wikitext">
|nowelcome=- If this parameter exists, then the {{first article}} welcome message is not included, even if the page the notice is being placed on did not previously exist.
|header=- by default, the template adds a level two section header of "Speedy deletion nomination of PageName". To suppress the header, use
|header=no. |header-text=- a custom value for the header text.
|demo=- if you are demonstrating the template's functionality, transclude the template rather than substitute it, and use
|demo=yes. This will prevent the template from being automatically substituted by a bot. |namespace=- this is the namespace of the page tagged for speedy deletion. For example, if the page is in the "Wikipedia" namespace then the value would be
Wikipedia. It is not necessary to specify this parameter if the namespace is already included in the page name. If the page is in the main article namespace then this parameter should be omitted.</syntaxhighlight>
Parameters
|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.
|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.
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 page:
<syntaxhighlight lang="wikitext">{{subst:db notice doc/parameters |nowelcome = yes |header = yes |header-text = yes |demo = yes |namespace = yes }}</syntaxhighlight>
After you have substituted the template, you can customize the text however you want.
See also
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}}