Template:User page/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(A small update of the documentation)
Line 1: Line 1:
{{Doc/subpage}}
{{Doc/subpage}}
<includeonly>{{ModernTodo|Someday complete work on this template, thereby standardizing non-stylized user pages.}}</includeonly>
<includeonly>{{ModernTodo|This template should become the second {{tl|MultiPage}}, but for user pages.}}</includeonly>
{{ModernNote|The template is being worked on from time to time. The template author doesn't have any good ideas yet 🙁}}
{{ModernNote|The template is being worked on from time to time. The template author doesn't have any good ideas yet 🙁}}


Line 19: Line 17:


'''Recommended avatar frame resolution:''' 224x224 pixels.
'''Recommended avatar frame resolution:''' 224x224 pixels.
== Copy and Paste ==
{{CodeBlock|margin=5px|<nowiki>{{User page
| website =
| steam =
| github =
| gitlab =
| youtube =
| twitter =
| facebook =
| gamebanana =
| discord =
}}</nowiki>}}


== Parameters and Examples ==
== Parameters and Examples ==
{| class="standard-table" style="width:100%"
{{ModernNote|All these parameters are optional. For the template to work properly, it is enough to use it without any parameters.}}
 
{| class="standard-table plainlinks" style="width:100%"
! style="width:10%" | Parameter
! style="width:10%" | Parameter
! Description
! Description
! Example
! Example
|-
| align="center" | No Parameters
| Places the template.
| {{CodeBlock|{{((}}{{ROOTPAGENAME}}{{))}}}}
|-
|-
| align="center" | {{Param|doc}}
| align="center" | {{Param|doc}}
| ''Optional:'' Prevents the {{Code|<nowiki>{{DISPLAYTITLE}}</nowiki>}} from being removed; ergo forcing it to be shown instead.  
| Prevents the {{Code|<nowiki>{{DISPLAYTITLE}}</nowiki>}} from being removed; ergo forcing it to be shown instead.  
| {{CodeBlock|<nowiki>{{User page|doc=1}}</nowiki>}}
| {{CodeBlock|margin=5px|<nowiki>| doc = 1</nowiki>}}
|-
|-
| align="center" | {{Param|noach}}
| align="center" | {{Param|noach}}
| ''Optional:'' Prevents the achievements box from being loaded. Useful for if you have an achievements subpage but no achievements.
| Prevents the achievements box from being loaded. Useful for if you have an achievements subpage but no achievements.
| {{CodeBlock|<nowiki>{{User page|noach=true}}</nowiki>}}
| {{CodeBlock|margin=5px|<nowiki>| noach = true</nowiki>}}
|-
! colspan="3" | Links
|-
| align="center" | {{Param|links-before}}
| Your own content that is included before the parameters below.
| {{CodeBlock|margin=5px|<nowiki>| links-before = [www.half-life.com Half-Life]</nowiki>}}
|-
| align="center" | {{Param|website}}
| Full link to your website
| {{CodeBlock|margin=5px|<nowiki>| website = valvesoftware.com</nowiki>}}
|-
| align="center" | {{Param|steam}}
| Your [[Steam]] ID (for example, {{Code|steamcommunity.com/id/gabelogannewell}}).
| {{CodeBlock|margin=5px|<nowiki>| steam = gabelogannewell</nowiki>}}
|-
| align="center" | {{Param|github}}
| Your [http://github.com GitHub] ID (for example, {{Code|github.com/Misha}}).
| {{CodeBlock|margin=5px|<nowiki>| github = Misha</nowiki>}}
|-
| align="center" | {{Param|gitlab}}
| Your [http://gitlab.com GitLab]  ID (for example, {{Code|gitlab.com/EliVance}}).
| {{CodeBlock|margin=5px|<nowiki>| gitlab = EliVance</nowiki>}}
|-
| align="center" | {{Param|youtube}}
| Your [http://youtube.com YouTube]  ID (for example, {{Code|youtube.com/@alyxvance}}).
| {{CodeBlock|margin=5px|<nowiki>| youtube = @alyxvance</nowiki>}}
|-
| align="center" | {{Param|twitter}}
| Your [http://twitter.com Twitter] ID (for example, {{Code|twitter.com/TeamFortress}}).
| {{CodeBlock|margin=5px|<nowiki>| twitter = TeamFortress</nowiki>}}
|-
| align="center" | {{Param|facebook}}
| Your [http://www.facebook.com Facebook] ID (for example, {{Code|www.facebook.com/Steam}}).
| {{CodeBlock|margin=5px|<nowiki>| facebook = Steam</nowiki>}}
|-
| align="center" | {{Param|gamebanana}}
| Your [http://gamebanana.com GameBanana] ID (for example, {{Code|gamebanana.com/2325315}}).
| {{CodeBlock|margin=5px|<nowiki>| gamebanana = 2325315</nowiki>}}
|-
| align="center" | {{Param|links-after}}
| Your own content, included after the above parameters.
| {{CodeBlock|margin=5px|<nowiki>| links-after = [wiki.teamfortress.com Team Fortress Wiki]</nowiki>}}
|-
| align="center" | {{Param|discord}}
| String parameter for your Discord user ID
| {{CodeBlock|margin=5px|<nowiki>| discord = THE OWL#5320</nowiki>}}
|-
|-
| align="center" | {{Param|links}}
! colspan="3" | Other
| ''Optional:'' For specifying links that will appear in a box to the right titled "Links".<br>
{{ModernNote|You can specify whatever content you want to appear in {{Param|links}}}}
| {{CodeBlock|<nowiki>{{User page|links=[[Category:Templates]]}}</nowiki>}}
|-
|-
| align="center" | {{Param|userboxes}}
| align="center" | {{Param|userboxes}}
| {{Todo|Describe}}
| {{Todo|Describe}}
| {{CodeBlock|<nowiki>{{User page|userboxes={{Userbox}}}}</nowiki>}}
| {{CodeBlock|margin=5px|<nowiki>| userboxes = {{Userbox}}</nowiki>}}
|-
|}
|}



Revision as of 13:18, 19 April 2023

Edit-copy.png
This is a documentation subpage for Template:User page.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Template:ModernNote

This template will automatically search and attempt to load these images UserAvatar-YOURNAME UserAvatarFrame-YOURNAME or UserCover-YOURNAME. If any of the applicable images are available, then they will replace their correspondent placeholder counterparts.

Another thing to note. If your user page has a subpage called "Achievements", and it has the {{Wikichievements}} template transcluded into it, then this template will detect that and load a box to the right of your userpage titled "Achievements". If you have any achievements defined in {{Wikichievements/Data}} then they will load in the aforementioned box.

Translations

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

Images

Supported formats: JPG, PNG (PNG only for avatar and avatar frame).

Recommended avatar resolution: 128x128 pixels.

Recommended cover resolution: 2560x256 pixels.

Recommended avatar frame resolution: 224x224 pixels.

Copy and Paste

{{User page | website = | steam = | github = | gitlab = | youtube = | twitter = | facebook = | gamebanana = | discord = }}

Parameters and Examples

Template:ModernNote

Preview

Add a cover (PNG or JPG)


Add an avatar (PNG or JPG)


User page/doc


User SandboxUser Settings