Template:User link/doc
This is a documentation subpage for Template:User link. It contains usage information, categories and other content or metadata that is not part of the original template. |
Usage
This template provides a way to link to a userpage and display just the username, like [[User:Example|Example]]
. This may not save much typing for a short username like "Example", but it may be more useful with long usernames such as [[User:Guywh0sitsbehindphilip12|Guywhositsbehindphilip12]]
. This template is commonly used to ping a user to a discussion (when not using something like {{reply to}}
). However, please read the notifications section below, if you need to notify the user.
Example
{{user link|Example}}
or the shortcut form
{{u|Example}}
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:
{{u|Guywhositsbehindphilip12|Guy}}
which gives
Alternative
The desired result can also be achieved using the pipe trick feature of the MediaWiki software. For example, the wikitext
[[User:Example|]]
gives
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
TemplateData for User link
{
"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"
}
See also
- Manual:Echo – the manual page for the underlying Echo feature that provides the notifications
- Help:Fixing failed pings
- Help:Magic words
- Help:Notifications
- {{reply to}} – links to a user's page (with the @ sign and colon) and pings a user.
- {{hidden ping}} – notifies one or more users without displaying any text
- {{no ping}} – links a user's name without triggering the Echo notification system
- {{to}} – uses "To " (with a space) at the beginning instead of the @ sign
- {{talkback}} – allows a user to direct the attention of another user to a discussion via a notification