Template:User page/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Frame Background colors: I could've went on the page to edit...)
 
(64 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<includeonly>{{ModernTodo|Someday complete work on this template, thereby standardizing non-stylized user pages.}}</includeonly>
{{Doc/subpage}}
<includeonly>{{ModernTodo|This template should become the second {{tl|MultiPage}}, but for user pages.}}</includeonly>
This template is intended for use on user pages as a means of standardizing them and making them look better. It will automatically search and attempt to load these images {{Code|UserAvatar-YOURNAME}} {{Code|UserAvatarFrame-YOURNAME}} or {{Code|UserCover-YOURNAME}}. If any of the applicable images are available, then they will replace their correspondent placeholder counterparts.
{{ModernNote|Work on the template is temporarily suspended. The template author doesn't have any good ideas yet 🙁}}


== Preview ==
Another thing to note. If your user page has a subpage called "Achievements", and it has the {{tl|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 {{tl|Wikichievements/Data}} then they will load in the aforementioned box.
<br>{{User page}}
 
== Translations ==
The used strings are on [[/strings|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 ==
{{CodeBlock|margin=5px|<nowiki>{{User page
| website =
| facebook =
| gamebanana =
| github =
| gitlab =
| patreon =
| reddit =
| lambdageneration =
| soundcloud =
| gamemaps =
| moddb =
| twhl =
| gamerlab =
| steam =
| twitter =
| bluesky =
| youtube =
| twitch =
| discord id =
}}</nowiki>}}
 
=== Frame style ===
{{CodeBlock|margin=5px|<nowiki>| align =
| frame bg =
| frame =
| radius frame cover =
| radius frame username =
| radius frame buttons =
| padding frame cover =
| padding frame username =
| padding frame avatar =
| padding frame buttons =
</nowiki>}}


== Parameters and Examples ==
== Parameters and Examples ==
{| class="standard-table" style="width:100%"
{{note|All these parameters are optional. For the template to work properly, it is enough to use it without any parameters.}}
!style="width:10%"|Parameter
 
!Description
{| class="standard-table plainlinks" style="width:100%"
!Example
! style="width:12%" | Parameter
! Description
! Example
|-
| align="center" | {{Code|style=2|{{Param|doc}}}}
| Prevents the {{Code|<nowiki>{{DISPLAYTITLE}}</nowiki>}} from being removed; ergo forcing it to be shown instead.
| {{CodeBlock|margin=5px|<nowiki>| doc = 1</nowiki>}}
|-
|-
|align="center"|No Parameters
| align="center" | {{Code|style=2|{{Param|nolinks}}}}
|This template will automatically search and attempt to load these images {{code|UserAvatar-YOURNAME}} {{code|UserAvatarFrame-YOURNAME}} or {{code|UserCover-YOURNAME}}. If any of the applicable images are available, then they will replace their correspondent placeholder counterparts seen above.<br>
| Prevents all of the link column from being loaded. Useful for removing empty space if you have no links. This also removes the achievement box.
Another thing to note. If your user page has a subpage called "Achievements", and it has the {{code|<nowiki>{{Wikichievements}}</nowiki>}} 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 {{code|<nowiki>{{Wikichievements/Data}}</nowiki>}} then they will load in the aforementioned box.
| {{CodeBlock|margin=5px|<nowiki>| nolinks = true</nowiki>}}
|{{CodeBlock|{{((}}{{ROOTPAGENAME}}{{))}}}}
|-
|-
|align="center"|{{param|doc}}
| align="center" | {{Code|style=2|{{Param|noach}}}}
|''Optional:'' Prevents the username defined in {{code|/settings}} from being loaded. Designed especially for use within this documentation.
| Prevents the achievements box from being loaded. Useful for if you have an achievements subpage but no achievements.
|{{CodeBlock|<nowiki>{{Userpage|doc=1}}</nowiki>}}
| {{CodeBlock|margin=5px|<nowiki>| noach = true</nowiki>}}
|-
|-
|align="center"|{{param|links}}
| align="center" | {{Code|style=2|{{Param|nocat}}}}
|''Optional:'' For specifying links that will appear in a box to the right titled "Links".<br>
| Prevents category inclusion
{{ModernNote|You can specify whatever content you want to appear in {{param|links}}}}
| {{CodeBlock|margin=5px|<nowiki>| nocat = 1</nowiki>}}
|{{CodeBlock|<nowiki>{{Userpage|links=[[Category:Templates]]}}</nowiki>}}
|-
|-
| align="center" | {{Code|style=2|{{Param|theme}}}}
| Changes the preset styling for various components.
| {{CodeBlock|margin=5px|<nowiki>| theme = dark</nowiki>}}
|-
! colspan="3" | Links
|-
| align="center" | {{Code|style=2|{{Param|links-before}}}}
| Your own content, included before the below parameters.
| {{CodeBlock|margin=5px|<nowiki>| links-before = [www.half-life.com Half-Life]</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|website}}}}
| Link to your website.
| {{CodeBlock|margin=5px|<nowiki>| website = valvesoftware.com</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|facebook}}}}
| Your [http://www.facebook.com Facebook] username.
| {{CodeBlock|margin=5px|<nowiki>| facebook = Steam</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|gamebanana}}}}
| Your [http://gamebanana.com GameBanana] user ID.
| {{CodeBlock|margin=5px|<nowiki>| gamebanana = 2385315</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|github}}}}
| Your [http://github.com GitHub] username.
| {{CodeBlock|margin=5px|<nowiki>| github = Gaben</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|gitlab}}}}
| Your [http://gitlab.com GitLab] username.
| {{CodeBlock|margin=5px|<nowiki>| gitlab = EliVance</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|patreon}}}}
| Your [http://patreon.com Patreon] username.
| {{CodeBlock|margin=5px|<nowiki>| patreon = Patreon</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|lambdageneration}}}}
| Your [http://lambdageneration.com LambdaGeneration] username.
| {{CodeBlock|margin=5px|<nowiki>| lambdageneration = lambdageneration</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|soundcloud}}}}
| Your [http://soundcloud.com SoundCloud] username.
| {{CodeBlock|margin=5px|<nowiki>| soundcloud = valvestudioorchestra</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|gamemaps}}}}
| Your [http://gamemaps.com GameMaps] user ID.
| {{CodeBlock|margin=5px|<nowiki>| gamemaps = 1</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|moddb}}}}
| Your [http://moddb.com ModDB] username.
| {{CodeBlock|margin=5px|<nowiki>| moddb = intense</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|twhl}}}}
| Your [http://twhl.info TWHL] user ID.
| {{CodeBlock|margin=5px|<nowiki>| twhl = 1983</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|gamerlab}}}}
| Your [http://gamer-lab.com Gamer-Lab] username.
| {{CodeBlock|margin=5px|<nowiki>| gamerlab = username</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|reddit}}}}
| Your [http://reddit.com Reddit] username.
| {{CodeBlock|margin=5px|<nowiki>| reddit = Left4Dead</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|steam}}}}
| Your Vanity [[Steam]] URL.<br>Choose between this or {{Code|style=2|{{Param|steam id}}}}.
| {{CodeBlock|margin=5px|<nowiki>| steam = gabelogannewell</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|steam id}}}}
| Your [[Steam]] ID.<br>Choose between this or {{Code|style=2|{{Param|steam}}}}.
| {{CodeBlock|margin=5px|<nowiki>| steam id = 76561197960287330</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|twitter}}}}
| Your [http://x.com X (Twitter)] username.
| {{CodeBlock|margin=5px|<nowiki>| twitter = TeamFortress</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|bluesky}}}}
| Your [http://bsky.app Bluesky] username.
| {{CodeBlock|margin=5px|<nowiki>| bluesky = directorscut.bsky.social</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|youtube}}}}
| Your [http://youtube.com YouTube] handle.
| {{CodeBlock|margin=5px|<nowiki>| youtube = @alyxvance</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|youtube}}}}
| Your [http://twitch.tv Twitch] username.
| {{CodeBlock|margin=5px|<nowiki>| twitch = valve</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|discord id}}}}
| Your [http://discord.com Discord] user ID.
| {{CodeBlock|margin=5px|<nowiki>| discord id = 728082336536854559</nowiki>}}
|-
| align="center" | {{Code|style=2|{{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" | {{Code|style=2|{{Param|discord}}}}
| Your [http://discord.com Discord] username. {{deprecated|This parameter should be avoided in favor of {{Code|style=2|{{Param|discord id}}}}.}}
| {{CodeBlock|margin=5px|<nowiki>| discord = Gabe_Newell</nowiki>}}
|-
! colspan="3" | Frame Style
|-
| align="center" | {{Code|style=2|{{Param|frame}}}}
| Adds a frame around the Cover, Avatar, Username, and Buttons. (see Preview)
| {{CodeBlock|margin=5px|<nowiki>| frame = true </nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|frame bg}}}}
| Background value. If the theme is set to dark, this parameter will overwrite the frame color (Does not overwrite <code>userboxes</code> theme).
| {{CodeBlock|margin=5px|<nowiki>| frame bg = #4A6821 </nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|radius frame *}}}}
| Radius value. replace the <nowiki>*</nowiki> with username, cover, buttons. Avatar frame is controlled by user settings page.
| {{CodeBlock|margin=5px|<nowiki>| radius frame cover = 10px </nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|padding frame *}}}}
| Padding value. replace the <nowiki>*</nowiki> with avatar , username, cover, buttons.
| {{CodeBlock|margin=5px|<nowiki>| padding frame cover = 10px </nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|align}}}}
| Aligns the Avatar and the Username if there is a frame
| {{CodeBlock|margin=5px|<nowiki>| align = -65px</nowiki>}}
|-
! colspan="3" | Other
|-
| align="center" | {{Code|style=2|{{Param|userboxes}}}}
| A box designed for containing userboxes added via use of the {{tl|link=Userbox}} template.
| {{CodeBlock|margin=5px|<nowiki>| userboxes = {{Userbox}}</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|infobox}}}}
| A box designed for containing info stuff or other.
| {{CodeBlock|margin=5px|<nowiki>| infobox = Hello World!</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|infoboxtitle}}}}
| Changes the title.
| {{CodeBlock|margin=5px|<nowiki>| infoboxtitle = informational </nowiki>}}
|}
|}
== Used Categories ==
[[:Category:Users|Users]]
== Preview ==
{{Capsule|style=2|{{User page|doc=1|nocat=1|nolinks=1}}}}
{{Capsule|style=2|{{User page|theme=dark|doc=1|nocat=1|nolinks=1}}}}
=== Frames ===
{{Capsule|style=2|{{User page|frame=true|align=-85px|doc=1|nocat=1|nolinks=1}}}}
{{Capsule|style=2|{{User page|frame=true|align=-85px|theme=dark|doc=1|nocat=1|nolinks=1}}}}
=== Frame Background colors ===
{{Capsule|style=2|{{User page|frame = true|align = -85px|frame bg = #4A6821|doc=1|nocat=1|nolinks=1}}}}
{{Capsule|style=2|{{User page|frame = true|align = -85px|frame bg = #214268|theme=dark|doc=1|nocat=1|nolinks=1}}}}
{{Doc/Sandbox other|[[Category:Templates]]}}

Latest revision as of 06:16, 28 January 2025

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.

This template is intended for use on user pages as a means of standardizing them and making them look better. It 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 = | facebook = | gamebanana = | github = | gitlab = | patreon = | reddit = | lambdageneration = | soundcloud = | gamemaps = | moddb = | twhl = | gamerlab = | steam = | twitter = | bluesky = | youtube = | twitch = | discord id = }}

Frame style

| align = | frame bg = | frame = | radius frame cover = | radius frame username = | radius frame buttons = | padding frame cover = | padding frame username = | padding frame avatar = | padding frame buttons =

Parameters and Examples

Note.pngNote:All these parameters are optional. For the template to work properly, it is enough to use it without any parameters.

Used Categories

Users

Preview

Add a cover (PNG or JPG)


Add an avatar (PNG or JPG)


User page/doc


User SandboxUser Settings
Add a cover (PNG or JPG)


Add an avatar (PNG or JPG)


User page/doc


User SandboxUser Settings

Frames

Add a cover (PNG or JPG)
Add an avatar (PNG or JPG)
User page/doc
User SandboxUser Settings
Add a cover (PNG or JPG)
Add an avatar (PNG or JPG)
User page/doc
User SandboxUser Settings

Frame Background colors

Add a cover (PNG or JPG)
Add an avatar (PNG or JPG)
User page/doc
User SandboxUser Settings
Add a cover (PNG or JPG)
Add an avatar (PNG or JPG)
User page/doc
User SandboxUser Settings