m (fix {{tl}} to {{tlx}}) |
(added info on rank template data, and updated documentation) |
||
| Line 1: | Line 1: | ||
{{doc subpage}} | {{doc subpage}} | ||
<!-- ADD DOCUMENTATION BELOW THIS LINE --> | <!-- ADD DOCUMENTATION BELOW THIS LINE --> | ||
This template accepts a username and returns different results depending upon the optional second parameter. | This template accepts a username, rank, and returns different results depending upon the optional second parameter. | ||
== Usage == | == Usage == | ||
Place {{tlx|Username|NAME_OF_USER}} on a page where one of the desired outputs is desired. The default output is a hyperlink to a | Place {{tlx|Username|NAME_OF_USER|rank{{=}}3}} on a page where one of the desired outputs is desired. The default output is the username as a hyperlink to the [[Glossary#User Page profile|users' page]] in the Wazeopedia, followed by a [[Glossary#Private Message|private message]] link, and a [[Glossary#Rank|rank]] avatar linked to their [[Glossary#Map-Editor Profile|Editor User Profile]]. | ||
:{{Username|WazeUserName}} | :{{Username|WazeUserName}} | ||
== Parameters == | == Parameters == | ||
The | {{Para||USERNAME}} - The first unnamed parameter must be the Waze username exactly as it appears in the forum, and WME. | ||
To change the name displayed put the desired display name after the username, separated by a pipe character (|). | The following optional parameters can be passed after the username to modify the output: | ||
:{{Para||desired display name}} - To change the name displayed put the desired display name as the second unnamed parameter after the username, separated by a pipe character (|). ''NOTE: this is not necessary if you want your proper username to be displayed. | |||
:{{para|rank|3}} - To display the correct avatar for your rank, add the rank parameter with your proper rank. ''NOTE: If no rank is provided the default avatar displayed will be for rank 2. | |||
=== Examples === | |||
{{tlx|Username|WAZE_USER_NAME|DISPLAY_NAME}} | {{tlx|Username|WAZE_USER_NAME|DISPLAY_NAME}} | ||
| Line 19: | Line 26: | ||
{{Username|WAZE_USER_NAME|DISPLAY_NAME}} | {{Username|WAZE_USER_NAME|DISPLAY_NAME}} | ||
This is | This is useful if you want to display your real name, but still want to be able to receive Personal Messages which require your Waze Username. For example if Bob Smith has a username bsitty29 he might use this to display his real name on a page but still link to | ||
his user page and PM. | |||
{{tlx|Username|bsmitty29|Bob Smith}} | {{tlx|Username|bsmitty29|Bob Smith|rank{{=}}4}} | ||
Produces: | Produces: | ||
{{Username|bsmitty29|Bob Smith}} | {{Username|bsmitty29|Bob Smith|rank=4}} | ||
| Line 34: | Line 42: | ||
</includeonly> | </includeonly> | ||
<templatedata> | |||
{ | |||
"params": { | |||
"1": { | |||
"label": "Username", | |||
"description": "This must be the Waze username exactly as it appears in the forum, and WME.", | |||
"type": "wiki-user-name", | |||
"required": true | |||
}, | |||
"2": { | |||
"label": "Display Name (if different from username)", | |||
"description": " To change the name displayed put the desired display name here.", | |||
"type": "string" | |||
}, | |||
"rank": { | |||
"label": "Editor Rank", | |||
"description": "To display the correct avatar for your rank, add the rank parameter with your proper rank.", | |||
"type": "number", | |||
"default": "2", | |||
"suggested": true | |||
} | |||
}, | |||
"description": "This template accepts a username, rank, and returns different results depending upon the optional second parameter.\nThe default output is the username as a hyperlink to the users' page in the Wazeopedia, followed by a private message link, and a rank avatar linked to their Editor User Profile." | |||
} | |||
</templatedata> | |||
Revision as of 15:01, 28 August 2016
 |
This is a documentation subpage for . It contains usage information, categories and other content that is not part of the original template page. |
This template accepts a username, rank, and returns different results depending upon the optional second parameter.
Usage
Place {{Username|NAME_OF_USER|rank=3}} on a page where one of the desired outputs is desired. The default output is the username as a hyperlink to the users' page in the Wazeopedia, followed by a private message link, and a rank avatar linked to their Editor User Profile.
Parameters
|USERNAME - The first unnamed parameter must be the Waze username exactly as it appears in the forum, and WME.
The following optional parameters can be passed after the username to modify the output:
|desired display name- To change the name displayed put the desired display name as the second unnamed parameter after the username, separated by a pipe character (|). NOTE: this is not necessary if you want your proper username to be displayed.
|rank=3- To display the correct avatar for your rank, add the rank parameter with your proper rank. NOTE: If no rank is provided the default avatar displayed will be for rank 2.
Examples
{{Username|WAZE_USER_NAME|DISPLAY_NAME}}
Will produce:
This is useful if you want to display your real name, but still want to be able to receive Personal Messages which require your Waze Username. For example if Bob Smith has a username bsitty29 he might use this to display his real name on a page but still link to his user page and PM.
{{Username|bsmitty29|Bob Smith|rank=4}}
Produces:
This template accepts a username, rank, and returns different results depending upon the optional second parameter. The default output is the username as a hyperlink to the users' page in the Wazeopedia, followed by a private message link, and a rank avatar linked to their Editor User Profile.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Username | 1 | This must be the Waze username exactly as it appears in the forum, and WME. | User | required |
| Display Name (if different from username) | 2 | To change the name displayed put the desired display name here. | String | optional |
| Editor Rank | rank | To display the correct avatar for your rank, add the rank parameter with your proper rank.
| Number | suggested |