User:Ukexpat/welcome5/doc

This is a documentation subpage for User:Ukexpat/welcome5.
It may contain usage information, categories and other content that is not part of the original user template page.

Usage

This user page employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
You can conduct experiments, and should test all major changes, in either , the general template sandbox, or your user space before changing anything here.

This template should 'always' be substituted.

Without substitution of this template (or its short versions), features of the template will not work correctly.

Use to welcome new editors and provide links to useful information spread out across Wikipedia.
To add the default version to a user's talk page, write {{subst:Welcome to Wikipedia}}. To see how it works, transclude it in various forms to your own talk page or sandbox.
Can be given to IP or registered users. If given to an IP user, the content changes to advise the user to create an account, pointing out a few of the benefits.
An extra message can be appended to the header message. If desired, include your message as the first parameter, using a pipe (|) separator following the template name.
- If your added message includes any equal signs (=), each one must be wrapped in doubled braces, as in {{=}}. E.g., a diff should be written as https://en.wiki.x.io/w/index.php?title{{=}}Template_talk:Welcome_to_Wikipedia&curid{{=}}32277318&diff{{=}}465230338&oldid{{=}}465229550.
- If your added message includes one or more pipes (|), replace each instance with {{!}}. This calls the template {{!}}, which adds a pipe in its place.
The template contains a section heading in the banner by default, so there is no need to add one manually.
- The section heading level is <h2 /> (==) by default, but can be changed by specifying the desired level as the second parameter. If the second parameter is a number from 2 to 6 (inclusive), the banner's heading will be set to the corresponding level.
- If the second parameter is a non-numeric text (i.e., more than just "3" or "24" or an IP address), it will be used as a level 2 (==) section heading placed outside (above) the template body (as normal).
There is no need to sign your addition as the template already contains code that does it for you. This will not work if you do not substitute the template.
A shorthand of {{subst:Wtw}} or {{subst:Greet}} may be used for this template.

Syntax simplified

{{subst:Welcome to Wikipedia
|Extra message appended to header message
|Section level if number between 2 and 6 (inclusive) or level 2 section heading if text string
}}

Examples

{{subst:Welcome to Wikipedia}} → The standard version for registered or IP users. Auto detects whether IP or not.

{{subst:Welcome to Wikipedia|Thanks for correcting the spelling at [[Example]].}} → Adds an extra message to the header.

{{subst:Welcome to Wikipedia||4}} → Sets the "Welcome to Wikipedia" section heading in the banner to level 4 (====)

{{subst:Welcome to Wikipedia||Message from a fellow editor}} → Sets the text as a normal level 2 (==) section heading above the template message's banner (The template is the message within the section titled "Message from a fellow editor").