Template:User settings page/doc: Difference between revisions

Revision as of 08:38, 12 March 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.

This template is used for checking the functionality of a user settings subpage Special:MyPage/Settings.

Go to the strings subpage and translate the string into the desired language inside the Autoland template.

These are parameters that used by various templates such as {{Message}}.

User Parameters
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}}}`	Template:ModernTodo
`{{{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.	\| avatarformat = gif

@@ Line 23: / Line 23: @@
 |-
 |align="center"|{{Code|style=1|{{Param|timeoffsetdir}}}}
-|colspan=2|{{ModernTodo|Document it.}}
+|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>}}
 |-
 |align="center"|{{Code|style=1|{{Param|timeoffseth}}}}
 |Time difference from UTC (hours)
 |{{CodeBlock|<nowiki>| timeoffseth = 8</nowiki>}}
-{{CodeBlock|<nowiki>| timeoffseth = -8</nowiki>}}
 |-
 |align="center"|{{Code|style=1|{{Param|timeoffsetm}}}}
 |Time difference from UTC (minutes)
-|{{CodeBlock|<nowiki>| timeoffseth = 30</nowiki>}}
+|{{CodeBlock|<nowiki>| timeoffsetm = 30</nowiki>}}
-{{CodeBlock|<nowiki>| timeoffseth = -30</nowiki>}}
 |-
 |align="center"|{{Code|style=1|{{Param|squareavatar}}}}
@@ Line 43: / Line 42: @@
 |-
 |align="center"|{{Code|style=1|{{Param|avatarformat}}}}
-|The file format of your avatar.
+|The file format of your avatar. Without this parameter, the image for avatar will not be used.
 |{{CodeBlock|<nowiki>| avatarformat = png</nowiki>}}
 |-
 |align="center"|{{Code|style=1|{{Param|avatarframeformat}}}}
-|The file format of the frame of your avatar.
+|The file format of the frame of your avatar. Without this parameter, the frame image for avatar will not be used.
 |{{CodeBlock|<nowiki>| avatarformat = gif</nowiki>}}
 |-
 |}