Template:Userbox/doc

From Uncyclopedia, the content-free encyclopedia
Jump to navigation Jump to search
This is a documentation subpage for Template:Userbox.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Userbox.

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

Userboxes must not include Nonfree images. Any editor may remove them without notice to the author.

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 or #999)-->
| border-s      = <!--border width in pixels (default=1)-->
| float         = <!--left|right|none (default=left)-->
| id            = <!--id image or text (image size should normally not exceed 90x45px)-->
| id-a          = <!--id horizontal alignment left/center/right/justify (default=center)-->
| id-c          = <!--id background color (default=#ddd)-->
| id-fc         = <!--id font color (default=info-fc or 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=#eee)-->
| 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; see [[WP:NOCAT]] (default=false)-->
| usercategory  = <!--user category (optional, unlinked and without the "Category:" part)-->
| usercategory2 = <!--user category (optional)-->
| usercategory3 = <!--user category (optional)-->
| usercategory4 = <!--user category (optional)-->
| usercategory5 = <!--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   = 
}}

Examples

Code Result
{{userbox
| border-c      = #aaffaa
| border-s      = 2
| id            = foo
| id-c          = #ffffee
| id-s          = 20
| info          = ''foo bar''
| info-c        = #ffeeff
| info-s        = 12
}}
foofoo 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 logoWe 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 between 
text lines and padding space between 
cell content and its border.''
| info-c        = #ffeeff
| info-lh       = 1.05em
| info-p        = 1pt
| info-s        = 8
}}
foo logoWe have specified values to lessen the distance between text lines and padding space 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 "text-decoration" to add lines around the text. Below, on the right side are two userboxes:
the top one is displayed without either 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', monospace; text-decoration: wavy overline green;
| info-s        = 14
}}
foo logofoo bar

 
foo logofoo 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:Wikipedia:WikiProject Microformats for more information on adding microformat information to Wikipedia.

See also

TemplateData

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

TemplateData for Userbox

Extended content

Makes a userbox

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Border-widthborder-width border-s

Border width (in px)

Numberoptional
Border-colorborder-color border-c 1

Color of border

Default
#999
Example
blue
Stringsuggested
Info-backgroundinfo-background info-c 2

Background color of info

Default
#eee
Example
red
Stringsuggested
Infoinfo 4

Free-form userbox content

Contentrequired
Info-ainfo-a

Text alignment of info

Default
left
Stringsuggested
Info-sizeinfo-size info-s

Text size (in pt)

Default
8
Numbersuggested
Id-hid-h logo-height

Logo height (in px)

Default
45
Numberoptional
Info-paddinginfo-padding info-p

Padding of info

Default
0 4px 0 4px
Example
1px
Stringoptional
Info-line-heightinfo-line-height info-lh

Line height of info

Default
1.25em
Stringoptional
Info-colorinfo-color info-fc

Font color of info

Default
black
Example
gray
Stringsuggested
Info-other-paraminfo-other-param info-op

no description

Unknownoptional
Info-classinfo-class

CSS class for info

Example
plainlinks
Stringsuggested
Idid 3 logo

Image or text

Example
[[File:Example.jpg|45px|alt=]]
Contentrequired
Id-wid-w logo-width

Logo width (in px)

Default
45
Numberoptional
Id-cid-c 1 logo-background

Background color of logo

Default
#ddd
Stringsuggested
Id-aid-a

Text alignment of logo, if applicable

Default
center
Stringoptional
Id-sid-s 5 logo-size

Logo size (in pt)

Default
14
Numberoptional
Id-fcid-fc logo-color

Font color of logo, if applicable

Example
gray
Stringoptional
Id-pid-p logo-padding

Logo padding

Default
0 1px 0 0
Example
1px
Stringoptional
Id-lhid-lh logo-line-height

Line height of logo

Default
1.25em
Stringoptional
Id-opid-op logo-other-param

no description

Unknownoptional
Id-classid-class

CSS class for logo

Example
plainlinks
Stringoptional
Floatfloat

Direction to float the userbox

Default
left
Example
right
Stringsuggested
Bodyclassbodyclass

CSS class for body

Stringoptional