Template:User settings page/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 2: | Line 2: | ||
This template is used for checking the functionality of a user settings subpage {{Code|[[Special:MyPage/Settings]]}}. | This template is used for checking the functionality of a user settings subpage {{Code|[[Special:MyPage/Settings]]}}. | ||
==Usage== | == Usage == | ||
{{Code|select=1|<nowiki>{{User settings page}}</nowiki>}} | {{Code|select=1|<nowiki>{{User settings page}}</nowiki>}} | ||
== | == Translations == | ||
The used strings are on [[/strings|strings subpage]]. Please follow the format to add translations for them. | |||
== User Parameters == | == Copy and Paste == | ||
{{CodeBlock|<nowiki>{{User settings page}} | |||
<onlyinclude>{{#switch:{{{1|}}} | |||
| username = | |||
| timeoffsetdir = | |||
| timeoffseth = | |||
| timeoffsetm = | |||
| squareavatar = | |||
| staticframe = | |||
| avatarformat = | |||
| avatarframeformat = | |||
}}</onlyinclude></nowiki>}} | |||
== Parameters and Examples == | |||
These are parameters that used by various templates such as {{tl|Message}}. | These are parameters that used by various templates such as {{tl|Message}}. | ||
{| class="standard-table" | {| class="standard-table" width="100%" | ||
! Parameter | ! Parameter | ||
! Description | ! Description | ||
! Example | ! Example | ||
|- | |- | ||
|align="center"|{{Code|style=1|{{Param|username}}}} | | align="center" | {{Code|style=1|{{Param|username}}}} | ||
|Your nickname that the template should show instead of your username. | | Your nickname that the template should show instead of your username. | ||
{{ModernTip|You can use {{tl|Autolang}} for supporting multi-language nickname.}} | {{ModernTip|You can use {{tl|Autolang}} for supporting multi-language nickname.}} | ||
|{{CodeBlock|<nowiki>|username = Gabe Newell</nowiki>}} | | {{CodeBlock|<nowiki>| username = Gabe Newell</nowiki>}} | ||
{{CodeBlock|<nowiki>|username = {{Autolang|Gabe Newell|zh=加布·纽维尔}}</nowiki>}} | {{CodeBlock|<nowiki>| username = {{Autolang|Gabe Newell|zh=加布·纽维尔}}</nowiki>}} | ||
|- | |- | ||
|align="center"|{{Code|style=1|{{Param|timeoffsetdir}}}} | | align="center" | {{Code|style=1|{{Param|timeoffsetdir}}}} | ||
|Time direction (plus or minus) relative to UTC. The default value is +, so this parameter should only be used if you want to specify a minus | | Time direction (plus or minus) relative to UTC. The default value is +, so this parameter should only be used if you want to specify a minus | ||
|{{CodeBlock|<nowiki>| timeoffsetdir = -</nowiki>}} | | {{CodeBlock|<nowiki>| timeoffsetdir = -</nowiki>}} | ||
|- | |- | ||
|align="center"|{{Code|style=1|{{Param|timeoffseth}}}} | | align="center" | {{Code|style=1|{{Param|timeoffseth}}}} | ||
|Time difference from UTC (hours) | | Time difference from UTC (hours) | ||
|{{CodeBlock|<nowiki>| timeoffseth = 8</nowiki>}} | | {{CodeBlock|<nowiki>| timeoffseth = 8</nowiki>}} | ||
|- | |- | ||
|align="center"|{{Code|style=1|{{Param|timeoffsetm}}}} | | align="center" | {{Code|style=1|{{Param|timeoffsetm}}}} | ||
|Time difference from UTC (minutes) | | Time difference from UTC (minutes) | ||
|{{CodeBlock|<nowiki>| timeoffsetm = 30</nowiki>}} | | {{CodeBlock|<nowiki>| timeoffsetm = 30</nowiki>}} | ||
|- | |- | ||
|align="center"|{{Code|style=1|{{Param|squareavatar}}}} | | align="center" | {{Code|style=1|{{Param|squareavatar}}}} | ||
|When specified as true, the avatar is square instead of round. | | When specified as true, the avatar is square instead of round. | ||
|{{CodeBlock|<nowiki>|</nowiki> squareavatar {{=}} true}} | | {{CodeBlock|<nowiki>|</nowiki> squareavatar {{=}} true}} | ||
|- | |- | ||
|align="center"|{{Code|style=1|{{Param|staticframe}}}} | | align="center" | {{Code|style=1|{{Param|staticframe}}}} | ||
| | | It is necessary to specify the recommended resolution of the avatar frame instead of the native one. The parameter was added due to differences between static and animated avatar frames on Steam. Static avatar frames have a resolution of 244 pixels, while animated frames use the recommended 224 pixels. | ||
Due to the way MediaWiki works, we cannot specify a fixed size for all avatar frames, because after that animated frames simply won't work. | |||
| {{CodeBlock|<nowiki>| staticframe = 224px</nowiki>}} | |||
|- | |- | ||
|align="center"|{{Code|style=1|{{Param|avatarformat}}}} | | align="center" | {{Code|style=1|{{Param|avatarformat}}}} | ||
|The file format of your avatar. Without this parameter, the image for avatar will not be used. | | The file format of your avatar. Without this parameter, the image for avatar will not be used. | ||
|{{CodeBlock|<nowiki>| avatarformat = png</nowiki>}} | | {{CodeBlock|<nowiki>| avatarformat = png</nowiki>}} | ||
|- | |- | ||
|align="center"|{{Code|style=1|{{Param|avatarframeformat}}}} | | align="center" | {{Code|style=1|{{Param|avatarframeformat}}}} | ||
|The file format of the frame of your avatar. Without this parameter, the frame image for avatar will not be used. | | The file format of the frame of your avatar. Without this parameter, the frame image for avatar will not be used. | ||
|{{CodeBlock|<nowiki>| | | {{CodeBlock|<nowiki>| avatarframeformat = gif</nowiki>}} | ||
|- | |- | ||
|} | |} |
Revision as of 21:58, 6 April 2023

This is a documentation subpage for Template:User settings page.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
This template is used for checking the functionality of a user settings subpage Special:MyPage/Settings.
Usage
{{User settings page}}
Translations
The used strings are on strings subpage. Please follow the format to add translations for them.
Copy and Paste
Parameters and Examples
These are parameters that used by various templates such as {{Message}}
.
Parameter | Description | Example |
---|---|---|
{{{username}}} | Your nickname that the template should show instead of your username. | |
{{{timeoffsetdir}}} | Time direction (plus or minus) relative to UTC. The default value is +, so this parameter should only be used if you want to specify a minus | |
{{{timeoffseth}}} | Time difference from UTC (hours) | |
{{{timeoffsetm}}} | Time difference from UTC (minutes) | |
{{{squareavatar}}} | When specified as true, the avatar is square instead of round. | |
{{{staticframe}}} | It is necessary to specify the recommended resolution of the avatar frame instead of the native one. The parameter was added due to differences between static and animated avatar frames on Steam. Static avatar frames have a resolution of 244 pixels, while animated frames use the recommended 224 pixels.
Due to the way MediaWiki works, we cannot specify a fixed size for all avatar frames, because after that animated frames simply won't work. |
|
{{{avatarformat}}} | The file format of your avatar. Without this parameter, the image for avatar will not be used. | |
{{{avatarframeformat}}} | The file format of the frame of your avatar. Without this parameter, the frame image for avatar will not be used. |