Template:User link/doc: Difference between revisions
←Blanked the page Tags: Blanking Reverted Mobile edit Mobile web edit |
m Reverted 1 edit by 2402:800:6340:D36C:6140:2425:B8F2:4F78 (talk) to last revision by W.andrea Tags: Twinkle Undo Disambiguation links added |
||
Line 1: | Line 1: | ||
{{For|the template that gives a link to a user's user page, talk page, and contributions page|Template:User}} |
|||
{{Redirect|Template:UL|unordered lists (and ordered lists)|Template:HTML lists}} |
|||
{{Documentation subpage}} |
|||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
|||
{{High-use}} |
|||
{{Template shortcut|U|ul}} |
|||
==Usage== |
|||
This template provides a way to link to a userpage and display just the username, like {{code|[[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 {{code|[[User:Guywh0sitsbehindphilip12|Guywhositsbehindphilip12]]}}. This template is commonly used to [[Help:Notifications|ping]] a user to a discussion (when not using something like {{tlx|reply to}}). However, please read the notifications section below, if you need to notify the user. |
|||
===Example=== |
|||
{{tlx|User link|Example|_show_result=y}} |
|||
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: |
|||
{{tlx|User link|Guywhositsbehindphilip12|Guy|_show_result=y}} |
|||
===Alternative=== |
|||
The desired result can also be achieved using the [[Help:pipe trick|pipe trick]] feature of the MediaWiki software. For example, the wikitext |
|||
:<code><nowiki>[[User:Example|]]</nowiki></code> |
|||
gives |
|||
:[[User:Example|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 [[Help:Notifications#Triggering events|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 header}} |
|||
<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" |
|||
} |
|||
</templatedata> |
|||
==See also== |
|||
* [[:mw:Manual:Echo|Manual:Echo]] – the manual page for the underlying ''Echo'' feature that provides the notifications |
|||
* [[Help:Fixing failed pings]] |
|||
* [[Help:Magic words]] |
|||
* [[Help:Notifications]] |
|||
* {{tl|reply to}} – links to a user's page (with the @ sign and colon) and pings a user. |
|||
* {{tl|hidden ping}} – notifies one or more users without displaying any text |
|||
* {{tl|no ping}} – links a user's name without triggering the Echo notification system |
|||
* {{tl|to}} – uses "To " (with a space) at the beginning instead of the @ sign |
|||
* {{tl|talkback}} – allows a user to direct the attention of another user to a discussion via a notification |
|||
{{Userspace linking templates}} |
|||
<includeonly>{{Sandbox other|| |
|||
<!-- Categories below this line, please; interwikis at Wikidata --> |
|||
[[Category:Username internal link templates]] |
|||
}}</includeonly> |
Latest revision as of 13:26, 8 August 2024
This is a documentation subpage for Template:User link. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 255,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
Usage
[edit]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
[edit]{{User link|Example}}
→ Example
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:
{{User link|Guywhositsbehindphilip12|Guy}}
→ Guy
Alternative
[edit]The desired result can also be achieved using the pipe trick feature of the MediaWiki software. For example, the wikitext
[[User:Example|]]
gives
Notifications
[edit]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
[edit]TemplateData for User link
Links to an editor's userpage and displays just their username
Parameter | Description | Type | Status | |
---|---|---|---|---|
User | 1 | User being linked
| User | required |
Label | 2 | Text label for the link
| String | suggested |
See also
[edit]- 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
Userspace link templates
User information templates provide informational links for a user; they are similar to signatures, but often provide additional information, and may be used by other users. List:
- Demo user used is User:Example