Template:Userbox: Difference between revisions

Latest revision as of 02:00, 20 October 2021

Usage

This template is used to place a box on a page which includes a header bar with the name of the page, the {{scummer}} template, and also automatically adds a Table of Contents within the box.

Syntax

{{userbox| | | | }}

{{userbox
| user#= 
| color= 
| style= 
| title= 
| avatar= 
}}

Parameters

{{{user#}}}

user number

for more information on finding a 'user number' click here

{{{color}}}

the color of the text for the header bar

{{{style}}}

the style of font of the text for the header bar

{{{title}}}

the title of the userbox

this parameter is optional, and if left blank will automatically insert the name of the page the userbox is on

{{{avatar}}}

the name of the image of the user's avatar

this parameter is optional, and if used will create a 75x75 px version of the image filename listed as well as replacing the default MS logo of {{scummer}}

Examples

@@ Line 1: / Line 1: @@
-<includeonly>{| cellspacing="0" cellpadding="0" style="clear:right; float: right; margin: 0px 0px 10px 10px; padding: 5px 5px 5px 5px; width: 250px; border: #99B3FF solid 1px"
+<noinclude>
-|- align="center"; valign="center"
+<!--  -->
-! {{color|{{{2|black}}}|{{ #switch:{{{3}}}
+<!--  -->
-| b='''{{PAGENAME}}'''
+<!-- note: when editing the role template, be sure to edit any major changes into the examples -->
-| i=''{{PAGENAME}}''
+<!--  -->
-| u=<u>{{PAGENAME}}</u>
+<!--  -->
-| bi='''''{{PAGENAME}}'''''
+</noinclude><includeonly>{| cellpadding="0" cellspacing="0" style="clear:right; float:right; margin:0px 5px 5px 5px; padding:5px 5px 0px 0px; width:250px; border:#AAA solid 1px;"
-| ib='''''{{PAGENAME}}'''''
+|
-| bu='''<u>{{PAGENAME}}</u>'''
+{| style="background:#EEE; margin:0px 5px 5px 5px; border:solid #AAA 1px;{{ #ifeq: {{{style| }}} | c | font-family: Monotype Corsiva, cursive; font-size: 14pt;" | " }} width="100%"
-| ub='''<u>{{PAGENAME}}</u>'''
+| align="center" style="width:{{ #ifeq: {{{avatar| }}} | | 245 | 175 }}px;" | {{color|{{{color|black}}}| {{ #if: {{{title| }}} | {{{title}}} | {{ #switch:{{{style}}}
-| iu=''<u>{{PAGENAME}}</u>''
+| b='''{{BASEPAGENAME}}'''
-| ui=''<u>{{PAGENAME}}</u>''
+| c={{BASEPAGENAME}}
-| biu='''''<u>{{PAGENAME}}</u>'''''
+| i=''{{BASEPAGENAME}}''
-| bui='''''<u>{{PAGENAME}}</u>'''''
+| u=<u>{{BASEPAGENAME}}</u>
-| ibu='''''<u>{{PAGENAME}}</u>'''''
+| bi=
-| iub='''''<u>{{PAGENAME}}</u>'''''
+| ib='''''{{BASEPAGENAME}}'''''
-| ubi='''''<u>{{PAGENAME}}</u>'''''
+| bu=
-| uib='''''<u>{{PAGENAME}}</u>'''''
+| ub='''<u>{{BASEPAGENAME}}</u>'''
-| {{PAGENAME}} }} }}
+| iu=
+| ui=''<u>{{BASEPAGENAME}}</u>''
+| biu
+| bui
+| ibu
+| iub
+| ubi
+| uib='''''<u>{{BASEPAGENAME}}</u>'''''
+| {{BASEPAGENAME}} }} }} }}
+| style="width:{{ #ifeq: {{{avatar| }}} | | 0 | 75 }}px"; | {{ #ifeq: {{{avatar| }}} | | | [[File:{{{avatar}}}|75px]] }}
+|}
+|-[
+| align="left" | {{scummer|{{{user#|0}}}|userpic={{#ifexist:File:{{{avatar}}}| {{{avatar}}}|logo_mafiascum_medium.jpg}}}}
 |-
-| {{scummer|{{{1|0}}}}}
+| <small>{{TOCubx}}</small>
-|-
+|}</includeonly><noinclude>
-| __TOC__
+{{TOCright}}
-|}</includeonly>
+== Usage ==
+This template is used to place a box on a page which includes a header bar with the name of the page, the {{tl|scummer}} template, and also automatically adds a [[Template:TOCubx|Table of Contents]] within the box.
+== Syntax ==
+<pre>
+{{userbox| | | | }}
+</pre>
+<pre>
+{{userbox
+| user#=
+| color=
+| style=
+| title=
+| avatar=
+}}
+</pre>
+== Parameters ==
+=== {{{user#}}} ===
+:user number
+''for more information on finding a 'user number' [[Template:Profile/user_number|click here]]''
+=== {{{color}}} ===
+:the color of the text for the header bar
+=== {{{style}}} ===
+:the style of font of the text for the header bar
+=== {{{title}}} ===
+:the title of the userbox
+''this parameter is optional, and if left blank will automatically insert the name of the page the userbox is on''
+=== {{{avatar}}} ===
+:the name of the image of the user's [[avatar]]
+''this parameter is optional, and if used will create a 75x75 px version of the image filename listed as well as replacing the default MS logo of {{tl|scummer}}''
+== Examples ==
+[[category: Templates|{{BASEPAGENAME}}]]</noinclude>