Template:Welcome/doc
More actions
| 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 (i.e., 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. |
| Logo of Twinkle; Police Man | 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
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
Use {{subst:Welcome-anon}} or {{subst:Thanks}} for anonymous (IP) editors.
Wrapper
{{subst:Welcome-autosign}} (or {{subst:wela}}) invokes this template but includes your signature.
TemplateData
The standard template to welcome new editors.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| heading | heading | Suppresses the automatic heading | Unknown | optional |
| Heading text | headtext | Changes the contents of the heading
| String | optional |
| border | border | Adds a border around the message in a specified color or hex triplet
| String | optional |
| Border radius | borderradius | Specifies the rounding of the border
| Unknown | optional |
| image | image | Adds an image to go with the welcome (no need for brackets)
| File | optional |
| Image caption | imagecaption | Specifies a caption to go with the image
| String | optional |
| New user | newuser | Uses alternate text not linking to the editor's contributions
| 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
| String | suggested |
| Custom end | customend | Adds a custom ending to the message
| String | suggested |
See also