Permanently protected template

Template:Userbox

From Wikipedia, the free encyclopedia
Jump to: navigation, search
info
Documentation icon Template documentation[view] [edit] [history] [purge]

This template can be used to quickly create a userbox for display on a user's user page without having to know HTML or Wikitable syntax.
Nonfree images may not be displayed in userboxes, and are subject to summary removal by any editor without any notice being required.

Sandbox reminder:

Usage

{{userbox
| bodyclass     = <!--Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.-->
| border-c      = <!--border color (default=id-c)-->
| border-s      = <!--border width in pixels (default=1)-->
| float         = <!--left|right|none (default=left)-->
| id            = <!--id image or text (standard height=x45px)-->
| id-a          = <!--id horizontal alignment left/center/right/justify (default=center)-->
| id-c          = <!--id background color (default=#d0d0d0)-->
| id-fc         = <!--id font color (default=black)-->
| id-h          = <!--id box height in pixels (default=45)-->
| id-lh         = <!--id line height (default=1.25em)-->
| id-op         = <!--id other CSS parameters-->
| id-p          = <!--id cell padding (default=0 1px 0 0)-->
| id-s          = <!--id text size in points (default=14)-->
| id-w          = <!--id box width in pixels (default=45)-->
| info-class    = <!--Adds an HTML class attribute to the "info" HTML table-row, to allow for styling, emission of microformats, etc.-->
| info          = <!--info text or image-->
| info-a        = <!--info horizontal alignment left/center/right/justify (default=left)-->
| info-c        = <!--info background color (default=#e0e0e0)-->
| info-fc       = <!--info font color (default=black)-->
| info-lh       = <!--info line height (default=1.25em)-->
| info-op       = <!--info other CSS parameters-->
| info-p        = <!--info padding (default=0 4px 0 4px)-->
| info-s        = <!--info text size in points (default=8)-->
| nocat         = <!--block page category declarations (default=false)-->
| usercategory  = <!--user category (optional)-->
| usercategory2 = <!--user category (optional)-->
| usercategory3 = <!--user category (optional)-->
}}
  • All parameters are optional
  • Images should normally be scaled to x45px or less.

Most HTML-based tables use only a handful of these attributes. The following subset can be used to quickly convert an HTML userbox into the format used here:

{{userbox
| border-c      = 
| id            = 
| id-c          = 
| id-fc         = 
| id-s          = 
| info          = 
| info-c        = 
| info-fc       = 
| info-lh       = 
| info-s        = 
| nocat         = {{{nocat|}}}
| usercategory  = 
}}

Examples

Code Result
{{userbox}}
info
{{userbox
| border-c      = #aaffaa
| border-s      = 2
| id            = foo
| id-c          = #ffffee
| id-s          = 20
| info          = ''foo bar''
| info-c        = #ffeeff
| info-s        = 12
}}
foo foo bar
Below example shows the default appearance of a userbox, which is (much) higher than the 45px. Compare the height of the one below with the above userbox.
{{userbox
| border-c      = #aaffaa
| border-s      = 2
| id            = foo logo
| id-c          = #ffffee
| info          = ''We are trying to see 
default distance in between text 
lines, see the distance in 
between cell content and its border, 
and also see total height.''
| info-c        = #ffeeff
}}
foo logo We are trying to see default distance in between text lines, see the distance in between cell content and its border, and also see total height.
Below example shows how we can change that userbox and further specify parameters to bring down the overall height of the userbox to the recommended height of 45px, even with four text lines. Cell padding parameter "info-p" can also be set at "1pt 1pt 1pt 2pt", or "1pt 2pt" for better appearance, when there are 4 text lines.
{{userbox
| border-c      = #aaffaa
| border-s      = 1
| id            = foo logo
| id-c          = #ffffee
| id-lh         = 1.1em
| id-s          = 14
| info          = ''We have specified values 
to lessen the distance in between 
text lines & padding space in between 
cell content and its border.''
| info-c        = #ffeeff
| info-lh       = 1.05em
| info-p        = 1pt
| info-s        = 8
}}
foo logo We have specified values to lessen the distance in between text lines & padding space in between cell content and its border.
Below example is for advanced users, showing how we can specify other CSS properties, for example, "font-family", to change the font or "font-weight" to change the boldface from the default. Below, on the right side are two userboxes: the top one is displayed without the "font-family" or "font-weight" parameters; and the bottom userbox is displayed by using the below code, with the help of the "info-op" field.
{{userbox
| border-c      = #afa
| border-s      = 2
| id            = foo logo
| id-c          = #ffe
| id-lh         = 1.1em
| id-s          = 14
| info          = foo bar
| info-c        = #fef
| info-op       = font-family: 'Courier New'; font-weight: 700;
| info-s        = 14
}}
foo logo foo bar

 
foo logo foo bar

Microformats

bodyclass 
This parameter is inserted into the "class" attribute for the userbox as a whole.
info-class 
This parameter is inserted into the "class" attribute for the info component.

This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. To flag a userbox as containing hCard information about a person, for example, add the following parameter:

| bodyclass     = vcard

or

| info-class    = vcard

then (for example):

| title         = …the books of <span class="fn">[[Iain Banks]]</span>

...and so forth.

Examples include:

See Wikipedia:WikiProject Microformats for more information on adding microformat information to Wikipedia.

Template Data

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Userbox

This template can be used to quickly create a userbox for display on a user's user page without having to know HTML or Wikitable syntax.

Template parameters
Parameter Description Type Status
bodyclass bodyclass

Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.

Default
id-c
Example
empty
Auto value
empty
string optional
border-c border-c

border color

Default
Example
empty
Auto value
empty
string optional
border-s border-s

border width in pixels

Default
1
Example
empty
Auto value
empty
string optional
float float

left|right|none

Default
left
Example
empty
Auto value
empty
string optional
id id

id image or text

Default
x45px
Example
empty
Auto value
empty
string optional
id-a id-a

id horizontal alignment left/center/right/justify

Default
center
Example
empty
Auto value
empty
string optional
id-c id-c

id background color

Default
#d0d0d0
Example
empty
Auto value
empty
string optional
id-fc id-fc

id font color

Default
black
Example
empty
Auto value
empty
string optional
id-h id-h

id box height in pixels

Default
45
Example
empty
Auto value
empty
string optional
id-lh id-lh

id line height

Default
1.25em
Example
empty
Auto value
empty
string optional
id-op id-op

id other CSS parameters

Default
Example
empty
Auto value
empty
string optional
id-p id-p

id cell padding

Default
0 1px 0 0
Example
empty
Auto value
empty
string optional
id-s id-s

id text size in points

Default
14
Example
empty
Auto value
empty
string optional
id-w id-w

id box width in pixels

Default
45
Example
empty
Auto value
empty
string optional
info-class info-class

Adds an HTML class attribute to the “info” HTML table-row, to allow for styling, emission of microformats, etc.

Default
Example
empty
Auto value
empty
string optional
info info

info text or image

Default
Example
empty
Auto value
empty
string optional
info-a info-a

info horizontal alignment left/center/right/justify

Default
left
Example
empty
Auto value
empty
string optional
info-c info-c

info background color

Default
#e0e0e0
Example
empty
Auto value
empty
string optional
info-fc info-fc

info font color

Default
black
Example
empty
Auto value
empty
string optional
info-lh info-lh

info line height

Default
1.25em
Example
empty
Auto value
empty
string optional
info-op info-op

info other CSS parameters

Default
Example
empty
Auto value
empty
string optional
info-p info-p

info padding

Default
0 4px 0 4px
Example
empty
Auto value
empty
string optional
info-s info-s

info text size in points

Default
8
Example
empty
Auto value
empty
string optional
nocat nocat

block page category declarations

Default
false
Example
empty
Auto value
empty
string optional
usercategory usercategory

user category (optional)

Default
Example
empty
Auto value
empty
string optional
usercategory2 usercategory2

user category (optional)

Default
Example
empty
Auto value
empty
string optional
usercategory3 usercategory3

user category (optional)

Default
Example
empty
Auto value
empty
string optional

See also