Template:Db-notice/doc
This is a documentation subpage for Template:Db-notice (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
This template is a meta-template used to create speedy deletion notifications. It is typically transcluded into another template.
Usage[edit]
Basic usage:
{{<includeonly>safesubst:</includeonly>db-notice |namespace = {{{namespace|}}} |target = {{{1}}} |nowelcome = {{{nowelcome|}}} |header = {{{header|}}} |header-text = {{{header-text|}}} |text = }}<!-- Template:Db-XX-notice --> <noinclude> {{documentation}} </noinclude>
All fields:
{{<includeonly>safesubst:</includeonly>db-notice |namespace = {{{namespace|}}} |target = {{{1}}} |nowelcome = {{{nowelcome|}}} |header = {{{header|}}} |header-text = {{{header-text|}}} |nothanks = |icon = |text = |if you think that = |button = |additionally = }}<!-- Template:Db-XX-notice --> <noinclude> {{documentation}} </noinclude>
The template should usually be used with safesubst, so that the template can be both transcluded and substituted. In most cases templates made with this meta-template will be substituted on user talk pages, but sometimes transclusion is necessary, for example when creating template documentation.
Parameters[edit]
Parameter name | Example values | Description |
---|---|---|
namespace |
{{{namespace|}}} |
The namespace of the page tagged for deletion. This should be passed through from the daughter template. |
target |
{{{1}}} |
This is the name of the page which was tagged for deletion. It should always be set as the first positional parameter. |
nowelcome |
{{{nowelcome|}}} , yes |
This template automatically welcomes users with {{first article}} if their user talk page was previously a red link (i.e. the deletion template is the first edit to the page). If this parameter is set to "yes", then this welcome is omitted. This should usually be passed through from the daughter template, unless a welcome is never desired. |
header |
{{{header|}}} |
If this is set to "no", no section heading is generated before the deletion notification. This should be passed through from the daughter template to give end users control over whether they want to include a heading or not. |
header-text |
{{{header-text|}}} |
This allows users to specify custom text for the section heading before the deletion notice. This should usually be passed through from the daughter template. |
nothanks |
yes |
If the page the notification template is used on was previously a red link, and this parameter contains any text, then the text "thank you for your contributions" is omitted from the welcome message. This is used when the contributions are assumed not to be useful, such as in templates for vandalism or attack pages. |
icon |
File:Information icon4.svg |
The filename of the image used in the top-left-hand corner of the notice. |
text |
The main text of the notice. This does not include the last paragraph, which is included automatically in every notice. Some aspects of the last paragraph can be changed with other parameters, however. | |
if you think that |
If this parameter exists, it will replace the text "the page was nominated in error" with the text it contains. | |
button |
no |
Setting this to "no" removes the text about clicking on the button labelled "Click here to contest this speedy deletion" in the speedy deletion tag. Useful if the related speedy deletion template doesn't have such a button. |
additionally |
This text will be appended to the very end of the notice. |