Template:Db notice doc/examples
This template is used to create the "examples" 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/examples}} 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">- No welcome message
{{subst:db notice doc|PageName|nowelcome=yes}}
- No header
{{subst:db notice doc|PageName|header=no}}
- Using a custom header
{{subst:db notice doc|PageName|header-text=Custom header text}}
- No welcome message and a custom header
{{subst:db notice doc|PageName|nowelcome=yes|header-text=Custom header text}}
- No welcome message and no header
{{subst:db notice doc|PageName|nowelcome=yes|header=no}}</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.
|warning-template=- The name of the notification template. For example,
db-nonsense-noticeordb-vandalism-notice. This parameter is only necessary if the documentation is not being created in the template's documentation subpage.
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/examples |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}}: