Template:User settings page/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 7: Line 7:
== Translations ==
== Translations ==
The used strings are on [[/strings|strings subpage]]. Please follow the format to add translations for them.
The used strings are on [[/strings|strings subpage]]. Please follow the format to add translations for them.
== Copy and Paste ==
{{CodeBlock|<nowiki>{{User settings page}}
&lt;onlyinclude>{{#switch:{{{1|}}}
| username =
| timeoffsetdir =
| timeoffseth =
| timeoffsetm =
| squareavatar =
| staticframe =
| avatarformat =
| avatarframeformat =
}}&lt;/onlyinclude></nowiki>}}


== Parameters and Examples ==
== Parameters and Examples ==

Revision as of 21:59, 6 April 2023

Edit-copy.png
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.

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

{{User settings page}} <onlyinclude>{{#switch:{{{1|}}} | username = | timeoffsetdir = | timeoffseth = | timeoffsetm = | squareavatar = | staticframe = | avatarformat = | avatarframeformat = }}</onlyinclude>

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.

Template:ModernTip

| username = Gabe Newell
| username = {{Autolang|Gabe Newell|zh=加布·纽维尔}}
{{{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
| timeoffsetdir = -
{{{timeoffseth}}} Time difference from UTC (hours)
| timeoffseth = 8
{{{timeoffsetm}}} Time difference from UTC (minutes)
| timeoffsetm = 30
{{{squareavatar}}} When specified as true, the avatar is square instead of round.
| squareavatar = true
{{{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.

| staticframe = 224px
{{{avatarformat}}} The file format of your avatar. Without this parameter, the image for avatar will not be used.
| avatarformat = png
{{{avatarframeformat}}} The file format of the frame of your avatar. Without this parameter, the frame image for avatar will not be used.
| avatarframeformat = gif