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. |
 | This template should always be substituted – use {{subst:Welcome}}. Any accidental transclusions will be automatically substituted by a bot. |
 | This template is substituted very frequently, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
 | This template is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
 | Any breaking changes to this template, including moving it or nominating it for deletion, must be communicated in advance to Twinkle's users and maintainers at Wikipedia talk:Twinkle. The standard installation of Twinkle relies on this template. Thank you. |
Usage
[edit source]Add {{subst:Welcome}} ~~~~ to the user's talk page. It is suggested that you watch the talk page in case the user replies there.
Parameters:
|heading=no– Suppress the automatic heading:{{subst:Welcome|heading=no}}|headtext=Heading text– Change the contents of the heading:{{subst:Welcome|headtext=Greetings!}}|border=Color– Adds a border in the specified color, along with a light shadow.|borderradius=can optionally be used to create rounded corners:{{subst:Welcome|border=DarkViolet|borderradius=15px}}|newuser=y– alternate text for users with zero contributions (such as accounts just made via ACC; you can also use{{subst:Welcome-newuser}}, which includes your signature). Equivalent to setting|art=newuser.|image=File:Filename.png– Adds an image to the message (no brackets needed).|imagecaption=can optionally be used to specify the caption:{{subst:Welcome|image=File:Chocolate chip cookies.jpg|imagecaption=Here, enjoy some cookies!}}. If you want to get really fancy, you can specify the image size or link here like this:{{subst:Welcome|imagecaption=400px{{!}}link{{=}}[[Article]]{{!}}Caption}}.|art=Article name– Article to which the user contributed positively (no brackets needed):{{subst:Welcome|art=Foobar}}.- This can be set to
newuserto produce the same text as setting|newuser=ywhen using Twinkle:{{subst:Welcome|art=newuser}}
- This can be set to
|customstart=– Adds a custom message at the end of the first paragraph, replacing "I hope you like it here and decide to stay."|customend=– Adds a custom ending to replace "Happy editing!"
Shortcut: {{subst:Wel}} ~~~~
For anonymous editors
[edit source]Use {{subst:Welcome-anon}} or {{subst:Thanks}} for anonymous (IP) editors.
Wrapper
[edit source]{{subst:Welcome-autosign}} (or {{subst:wela}}) invokes this template but includes your signature.
TemplateData
[edit source]<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! 
",
"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
[edit source]Find subst count and examples of this template on User talk pages using this advanced search.[2026; 2025; 2024] (Patience; this may take a while.)
See also
[edit source]