Template:User link/doc

Usage
This template provides a way to link to a userpage and display just the username, like Example. This may not save much typing for a short username like "Example", but it may be more useful with long usernames such as Guywhositsbehindphilip12. This template is commonly used to ping a user to a discussion (when not using something like ). However, please read the notifications section below, if you need to notify the user.

Example


or the shortcut form

gives

The template's second parameter, which is optional, takes the link's label; for example, a link to the long username used above can be shortened while viewing the text like this:

which gives

Alternative
The desired result can also be achieved using the pipe trick feature of the MediaWiki software. For example, the wikitext

gives
 * Example

Notifications
As with other templates that create a link to a user page, the linked-to user may be notified under certain circumstances: it happens whenever the conditions described at Notifications are met. These conditions include the addition of one or more new lines of text, one (or more) of which contains the link, and one of which is signed in the same edit.

TemplateData
{	"params": { "1": {			"label": "User", "description": "User being linked", "example": "Jimbo Wales", "type": "wiki-user-name", "required": true },		"2": {			"label": "Label", "description": "Text label for the link", "example": "Jimmy", "type": "string", "suggested": true }	},	"description": "Links to an editor's userpage and displays just their username" }