Editing Template:Welcome/doc

{{documentation subpage}}
{{Subst only|auto=yes}}
{{frequent substitution}}
{{Template rating|protected}}
{{Twinkle standard installation}}

== Usage ==

Add <code>{{Tls|Welcome}} <nowiki>~~~~</nowiki></code> to the user's talk page. It is suggested that you watch the talk page in case the user replies there.

Parameters:
* {{Para|heading|no}}&nbsp;– Suppress the automatic heading: {{Tlsx|Welcome|2=heading=no}}
* {{Para|headtext|Heading text}}&nbsp;– Change the contents of the heading: {{Tlsx|Welcome|2=headtext=Greetings!}}
* {{Para|border|Color}}&nbsp;– Adds a border in the specified color, along with a light shadow. {{Para|borderradius}} can optionally be used to create rounded corners: {{Tlsx|Welcome|2=border=DarkViolet|3=borderradius=15px}}
* {{Para|newuser|y}}&nbsp;– alternate text for users with zero contributions (such as accounts just made via [[WP:ACC|ACC]]; you can also use {{tlxs|Welcome-newuser}}, which includes your signature). Equivalent to setting {{Para|art|newuser}}.
* {{Para|image|File:Filename.png}}&nbsp;– Adds an image to the message (no brackets needed). {{Para|imagecaption}} can optionally be used to specify the caption: {{Tlsx|Welcome|2=image=File:Chocolate chip cookies.jpg|3=imagecaption=Here, enjoy some cookies!}}. If you want to get really fancy, you can specify the image size or link here like this: {{Tlsx|Welcome|2=imagecaption=<nowiki>400px{{!}}link{{=}}[[Article]]{{!}}Caption</nowiki>}}.
* {{Para|art|Article name}}&nbsp;– Article to which the user contributed positively (no brackets needed): {{Tlsx|Welcome|2=art=Foobar}}.
** This can be set to <code>newuser</code> to produce the same text as setting {{Para|newuser|y}} when using [[WP:Twinkle|Twinkle]]: {{Tlsx|Welcome|2=art=newuser}}
* {{Para|customstart}}&nbsp;– Adds a custom message at the end of the first paragraph, replacing "I hope you like it here and decide to stay."
* {{Para|customend}}&nbsp;– Adds a custom ending to replace "Happy editing!"

Shortcut: '''<code>{{Tls|Wel}} <nowiki>~~~~</nowiki></code>'''

== For anonymous editors ==
Use {{Tlsx|Welcome-anon}} or {{tlsx|Thanks}} for anonymous (IP) editors.

== Wrapper ==
{{tlxs|Welcome-autosign}} (or {{tlxs|wela}}) invokes this template but includes your signature.

==TemplateData==
<templatedata>
{
	"params": {
		"heading": {
			"description": "Suppresses the automatic heading",
			"type": "unknown"
		},
		"headtext": {
			"description": "Changes the contents of the heading",
			"type": "string",
			"label": "Heading text",
			"default": "Welcome!"
		},
		"newuser": {
			"description": "Uses alternate text not linking to the editor's contributions",
			"label": "New user",
			"example": "y",
			"type": "boolean"
		},
		"art": {
			"description": "Mentions and links to an article the editor has contributed to",
			"type": "wiki-page-name",
			"label": "Article",
			"suggested": true,
			"aliases": [
				"article"
			]
		},
		"customend": {
			"label": "Custom end",
			"description": "Adds a custom ending to the message",
			"type": "string",
			"default": "Happy editing!",
			"suggested": true
		},
		"border": {
			"description": "Adds a border around the message in a specified color or hex triplet",
			"example": "DarkViolet, #9400D3",
			"type": "string"
		},
		"borderradius": {
			"label": "Border radius",
			"description": "Specifies the rounding of the border",
			"example": "15px",
			"default": "2px"
		},
		"image": {
			"description": "Adds an image to go with the welcome (no need for brackets)",
			"example": "File:Chocolate chip cookies.jpg",
			"type": "wiki-file-name"
		},
		"imagecaption": {
			"label": "Image caption",
			"description": "Specifies a caption to go with the image",
			"example": "Here, enjoy some cookies! [[File:Face-smile.svg|20px|link=|alt=Smiley emoji]]",
			"type": "string"
		},
		"customstart": {
			"label": "Custom start",
			"description": "Adds a custom message at the end of the first paragraph",
			"type": "string",
			"default": "I hope you like it here and decide to stay.",
			"suggested": true
		}
	},
	"description": "The standard template to welcome new editors.",
	"paramOrder": [
		"heading",
		"headtext",
		"border",
		"borderradius",
		"image",
		"imagecaption",
		"newuser",
		"art",
		"customstart",
		"customend"
	]
}
</templatedata>

== Notes ==
{{Find substed templates notice}}

== See also ==
* [[Wikipedia:Welcoming committee/Welcome templates|Wikipedia:Welcome templates]]
* {{tl|Welcome-unregistered}}
* {{tl|Register}}

<includeonly>{{Sandbox other||{{#ifeq:{{FULLPAGENAME}}|Template:Welcome|
<!-- Add template's categories here -->
[[Category:Welcome templates|*]]
[[Category:Teahouse message templates]]
}}}}</includeonly>