Editing Template:Db-notice/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
{{substituted}}{{speedy deletion notices}}

This template is a meta-template used to create speedy deletion notifications. It is typically [[WP:TRANSCLUDE|transcluded]] into another template.

All of the speedy deletion notification templates that [[WP:TW|Twinkle]] uses are based on this template.  Twinkle will automatically add this message to a user's talk page whenever a page that user has created is nominated for Speedy Deletion. As such, users are unlikely to ever have cause to manually add this template to any page.

==Usage==

Basic usage:

<syntaxhighlight lang="wikitext">{{SAFESUBST:<noinclude />db-notice
|namespace     = {{{namespace|}}}
|target        = {{{1}}}
|nowelcome     = {{{nowelcome|}}}
|header        = {{{header|}}}
|header-text   = {{{header-text|}}}
|text          = 
}}<!-- Template:Db-XX-notice --> <noinclude>
{{documentation}}
</noinclude></syntaxhighlight>

All fields:

<syntaxhighlight lang="wikitext">{{SAFESUBST:<noinclude />db-notice
|namespace         = {{{namespace|}}}
|target            = {{{1}}}
|nowelcome         = {{{nowelcome|}}}
|header            = {{{header|}}}
|header-text       = {{{header-text|}}}
|nothanks          = 
|icon              = 
|wizard            = 
|text              = 
|if you think that = 
|button            = 
|willprovide       = 
|additionally      = 
}}<!-- Template:Db-XX-notice --> <noinclude>
{{documentation}}
</noinclude></syntaxhighlight>

The template should usually be used with [[WP:SAFESUBST|safesubst]], so that the template can be both [[WP:TRANSCLUDE|transcluded]] and [[WP:SUBST|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.

<templatedata>
{
	"description": "This template is a meta-template used to create speedy deletion notifications. It is typically transcluded into another template.\n All of the speedy deletion notification templates that use the Wikipedia tool known as Twinkle are based on this template. Twinkle will automatically add this message to a user's talk page whenever a page that user has created is nominated for Speedy Deletion. As such, users are unlikely to ever have cause to manually add this template to any page. The information below is intended for users who are creating their own deletion templates and as reference for those interested in modifying existing templates.",
	"params": {
		"namespace": {
			"label": "Namespace",
			"description": "The namespace of the article proposed/ nominated for deletion. This should be passed through from the daughter template.",
			"required": false,
			"example":"File:",
			"type": "string"
		},
		"target": {
			"label": "Target",
			"description": "This is the name of the page targeted for deletion, given without brackets of any kind",
			"required": true,
			"example": "Ham sandwich with mustard and mayo",
			"type": "wiki-page-name"
		},
		"nowelcome": {
			"label": "No welcome",
			"description": "This parameter automatically welcomes users with {{first article}} template 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 (for example for G10 'attack pages').",
			"example": "yes",
			"type": "string"
		},
		"header": {
			"label": "Header",
			"description": "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 deletion template creators control over whether they want to include a section heading or not.  If left blank, a new section heading is generated.",
			"example": "no",
			"type": "string"
		},
		"header-text": {
			"label": "Header text",
			"description": "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.",
			"type": "string"
		},
		"nothanks": {
			"label": "No thanks",
			"description": "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.",
			"example": "yes",
			"type": "string"
		},
		"icon": {
			"label": "Icon",
			"description": "The filename of the image used in the top-left-hand corner of the notice.  Most deletion notices are information notices (as opposed to warning notices), so the information icon4 is usually chosen.",
			"example": "Information icon4.svg",
			"type": "wiki-page-name"
		},
		"wizard": {
			"label": "Wizard",
			"description": "Optionally shows a message box with advice about creating new articles.",
			"example": "yes",
			"type": "string"
		},
		"text": {
			"label": "Text",
			"description": "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.",
			"type": "string"
		},
		"if you think that": {
			"label": "If you think that",
			"description": "If this parameter exists, it will replace the text 'the page was nominated in error' with the text it contains.",
			"default": "this page should not be deleted for this reason",
			"type": "string"
		},
		"button": {
			"label": "Button",
			"description": "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.",
			"example": "no",
			"type": "string"
		},
		"willprovide": {
			"label": "Will provide",
			"description": "By default, the template will include the sentence, 'If the page is deleted, and you wish to retrieve the deleted material for future reference or improvement, you can place a request here.' If willprovide is equal to 'no' then this sentence will be omitted. Template:Db-copyvio-notice, for instance, is set up to not include this sentence.",
			"example": "no",
			"type": "string"
		},
		"additionally": {
			"label": "Additionally",
			"description": "This optional text will be appended to the very end of the notice.",
			"type": "string"
		},
		"rfudlink": {
			"label": "RFUD link",
			"description": "If this parameter exists, the text prompting the user to go to WP:RFUD won't display. Useful as an alternative to the willprovide parameter if one can contact the deleting administrator to retrieve the article but for some reason can't place a request on that page (such as when the user in question has been blocked from editing Wikipedia). Template:Db-notability-notice, for example, is set up to omit this part of the sentence.",
			"example": "yes",
			"type": "string"
		}
	}
}
</templatedata>

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

<includeonly>{{Sandbox other||
<!--
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. -->
[[Category:Speedy deletion warning templates]]
}}</includeonly>