Template:User settings page/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Parameters and Examples: {{{staticavatar}}} replaced with {{{avatarradius}}})
m (autolang replace)
 
(6 intermediate revisions by 3 users not shown)
Line 7: Line 7:
== Create your settings page ==
== Create your settings page ==
To create your settings page, click <span class="plainlinks">[http://developer.valvesoftware.com/w/index.php?title&#61;Special:MyPage/Settings&action&#61;edit&preload&#61;Template:User_settings_page/preload here]</span>.
To create your settings page, click <span class="plainlinks">[http://developer.valvesoftware.com/w/index.php?title&#61;Special:MyPage/Settings&action&#61;edit&preload&#61;Template:User_settings_page/preload here]</span>.
== Copy and Paste ==
{{CodeBlock|<nowiki>{{User settings page}}
&lt;onlyinclude>{{#switch:{{{1|}}}
| username =
| timeoffsetdir =
| timeoffseth =
| timeoffsetm =
| avatar format =
| avatar radius =
| avatar frame format =
| avatar frame size =
}}&lt;/onlyinclude></nowiki>}}


== Translations ==
== Translations ==
Line 14: Line 27:
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" width="100%"
{| class="standard-table" width="100%"
! Parameter
! width="15%" | Parameter
! Description
! Description
! Example
! Example
Line 20: Line 33:
| 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.}}
{{tip|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 = {{#switch: {{language}}|#default = Gabe Newell|zh=加布·纽维尔}}</nowiki>}}
|-
! colspan="3" | Location
|-
|-
| align="center" | {{Code|style=1|{{Param|timeoffsetdir}}}}
| align="center" | {{Code|style=1|{{Param|timeoffsetdir}}}}
Line 36: Line 51:
| {{CodeBlock|<nowiki>| timeoffsetm = 30</nowiki>}}
| {{CodeBlock|<nowiki>| timeoffsetm = 30</nowiki>}}
|-
|-
| align="center" | {{Code|style=1|{{Param|staticframe}}}}
! colspan="3" | Avatar
| 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 x 244 pixels, while animated frames use the recommended 224 x 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|avatar format}}}}
| 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>| avatar format = png</nowiki>}}
|-
|-
| align="center" | {{Code|style=1|{{Param|avatarframeformat}}}}
| align="center" | {{Code|style=1|{{Param|avatar radius}}}}
| The file format of the frame of your avatar. Without this parameter, the frame image for avatar will not be used.
| Avatar Radius.
| {{CodeBlock|<nowiki>| avatarframeformat = gif</nowiki>}}
| {{CodeBlock|<nowiki>| avatar radius = 6px</nowiki>}}
|-
|-
| align="center" | {{Code|style=1|{{Param|avatarrendering}}}}
| align="center" | {{Code|style=1|{{Param|avatar rendering}}}}
| Specifies the value for {{Code|select=1|image-rendering}} (CSS property) in the avatar. The default value is {{Code|select=1|auto}}.
| Specifies the value for {{Code|select=1|image-rendering}} (CSS property) in the avatar. The default value is {{Code|select=1|auto}}.
| {{CodeBlock|<nowiki>| avatarrendering = pixelated</nowiki>}}
| {{CodeBlock|<nowiki>| avatar rendering = pixelated</nowiki>}}
|-
! colspan="3" | Avatar Frame
|-
| align="center" | {{Code|style=1|{{Param|avatar frame format}}}}
| The file format of the frame of your avatar. Without this parameter, the frame image for avatar will not be used.
| {{CodeBlock|<nowiki>| avatar frame format = gif</nowiki>}}
|-
|-
| align="center" | {{Code|style=1|{{Param|avatarradius}}}}
| align="center" | {{Code|style=1|{{Param|avatar frame size}}}}
| Avatar Radius.
| 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 x 244 pixels, while animated frames use the recommended 224 x 224 pixels.
| {{CodeBlock|<nowiki>| avatarradius = 6px</nowiki>}}
 
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>| avatar frame size = 224px</nowiki>}}
|}
|}

Latest revision as of 04:04, 6 August 2024

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}}

Create your settings page

To create your settings page, click here.

Copy and Paste

{{User settings page}} <onlyinclude>{{#switch:{{{1|}}} | username = | timeoffsetdir = | timeoffseth = | timeoffsetm = | avatar format = | avatar radius = | avatar frame format = | avatar frame size = }}</onlyinclude>

Translations

The used strings are on strings subpage. Please follow the format to add translations for them.

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.
Tip.pngTip:You can use {{Autolang}} for supporting multi-language nickname.
| username = Gabe Newell
| username = {{#switch: {{language}}|#default = Gabe Newell|zh=加布·纽维尔}}
Location
{{{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
Avatar
{{{avatar format}}} The file format of your avatar. Without this parameter, the image for avatar will not be used.
| avatar format = png
{{{avatar radius}}} Avatar Radius.
| avatar radius = 6px
{{{avatar rendering}}} Specifies the value for image-rendering (CSS property) in the avatar. The default value is auto.
| avatar rendering = pixelated
Avatar Frame
{{{avatar frame format}}} The file format of the frame of your avatar. Without this parameter, the frame image for avatar will not be used.
| avatar frame format = gif
{{{avatar frame size}}} 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 x 244 pixels, while animated frames use the recommended 224 x 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.

| avatar frame size = 224px
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:User_settings_page/doc&oldid=442956"