Template:Welcome/doc

This is a documentation subpage for Template:Welcome.
It may contain usage information, categories and other content that is not part of the original template page.

If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as this template is used in the standard installation of Twinkle. Thank you!

This template should always be substituted (i.e., use {{subst:Welcome}}).

Usage

Add {{subst:Welcome}} ~~~~ to the user's talk page.

Parameters:

First parameter = your name: {{subst:Welcome|Myname}}
Parameter 'art' = Article the user positively contributed to: {{subst:Welcome|art=Radar detector}}

Be sure to remember to add your signature ( ~~~~ ) after the template, as the text refers to 'my talk page'.

TemplateData

The standard template to welcome new editors.

Template parameters
Parameter		Description	Type	Status
heading	`heading`	Suppresses the automatic heading	Unknown	optional
Heading text	`headtext`	Changes the contents of the heading Default Welcome!	String	optional
border	`border`	Adds a border around the message in a specified color or hex triplet Example DarkViolet, #9400D3	String	optional
Border radius	`borderradius`	Specifies the rounding of the border Default 2px Example 15px	Unknown	optional
image	`image`	Adds an image to go with the welcome (no need for brackets) Example File:Chocolate chip cookies.jpg	File	optional
Image caption	`imagecaption`	Specifies a caption to go with the image Example Here, enjoy some cookies! [[File:Face-smile.svg\|20px\|link=\|alt=Smiley emoji]]	String	optional
New user	`newuser`	Uses alternate text not linking to the editor's contributions Example y	Boolean	optional
Article	`art` `article`	Mentions and links to an article the editor has contributed to	Page name	suggested
Custom start	`customstart`	Adds a custom message at the end of the first paragraph Default I hope you like it here and decide to stay.	String	suggested
Custom end	`customend`	Adds a custom ending to the message Default Happy editing!	String	suggested

Related pages

Use {{subst:welcome-anon}} for anonymous (IP) editors.
See Category:Welcome templates for others.