Template:Userbox/doc

This is a documentation subpage for Template:Terminate sentence
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:Userbox

This template is used on approximately 313,000 pages, or roughly 37351% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

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 must not be displayed in userboxes, and are subject to summary removal by any editor without any notice being required.

Sandbox reminder

Always practice or experiment in the Template:Userbox/sandbox or Template:Userbox/testcases
Once you are satisfied: Copy your code!
In your Browser's address bar, change "sandbox" or "testcases" to the name of your new Userbox.
- Example:
- CHANGE http://en.wikipedia.org/wiki/Template:Userbox/sandbox
- TO https://en.wikipedia.org/wiki/Template:Userbox/WhateverYourNewBoxNameIs
- If the name of your new Userbox is taken, create a different name.
You will be prompted to Start or Create your new Template Userbox!
Paste your code into the space provided.

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 #999999)-->
| 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=#DDDDDD)-->
| 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=#EEEEEE)-->
| 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
}}

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 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 logo

We 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 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):

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

...and so forth.

Examples include:

{{User:UBX/Iain Banks}} - person
{{User Microformats}} - group (WikiProject Microformats)
{{User Brum}} - place (Birmingham)

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

Template Data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Userbox in articles based on its TemplateData.

TemplateData for 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
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Body class	`bodyclass`	Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.	String	optional
Float	`float`	left\|right\|none Suggested values `left` `right` `none` Default left	String	optional
Border color	`border-c` `border-color`	Color of the outer border Default #999	String	optional
Border width	`border-s` `border-width`	border width in pixels Default 1	Number	optional
Logo	`id` `3` `logo`	id image or text	Content	suggested
Logo content horizontal alignment	`id-a`	Horizontal alignment of logo content; left/center/right/justify Suggested values `left` `center` `right` `justify` Default center	String	optional
Logo background color	`logo-background`	Background color of logo Default #ddd	String	optional
id-c	`id-c` `1`	Two-in-one alias for border color and logo background color. Lower priority than border-c and logo-background Example #d0d0d0	String	optional
Logo font color	`id-fc` `logo-color`	Logo font color; if not specified, defaults to info font color Default black	String	optional
Logo height	`id-h` `logo-height`	Logo box height in pixels Default 45	Number	optional
Logo font size	`id-s` `5` `logo-size`	Logo text size in points Default 14	String	optional
Logo line height	`id-lh` `logo-line-height`	Logo line height Default 1.25em	String	optional
Logo padding	`id-p` `logo-padding`	Logo cell padding Default 0 1px 0 0	String	optional
Logo width	`id-w` `logo-width`	id box width in pixels Default 45	Number	optional
Logo CSS classes	`id-class`	CSS class or classes for the logo; optional Default (none)	String	optional
Extra logo styling	`id-op` `logo-other-param`	Add additional arbitrary CSS styling to the logo Example opacity: 0.25	String	optional
Info	`info` `4`	info text or image	Content	required
Info content horizontal alignment	`info-a`	Horizontal alignment of info content; left/center/right/justify Suggested values `left` `center` `right` `justify` Default left	String	optional
Info background color	`info-c` `2` `info-background`	Info background color Default #e0e0e0	String	optional
Info font color	`info-fc` `info-color`	info font color Default black	String	optional
Info line height	`info-lh` `info-line-height`	Info line height Default 1.25em	String	optional
Info padding	`info-p` `info-padding`	info padding Default 0 4px 0 4px	String	optional
Info font size	`info-s` `info-size`	info text size in points Default 8	Number	optional
Info CSS classes	`info-class`	Adds an HTML class attribute to the "info" HTML table-row, to allow for styling, emission of microformats, etc.	String	optional
Extra info styling	`info-op` `info-other-param`	Add additional arbitrary CSS styling to the info Example opacity: 0.25	String	optional
nocat	`nocat`	block page category declarations (see WP:NOCAT) Default false	String	optional
usercategory	`usercategory`	user category (optional)	String	optional
usercategory2	`usercategory2`	user category (optional)	String	optional
usercategory3	`usercategory3`	user category (optional)	String	optional
usercategory4	`usercategory4`	user category (optional)	String	optional
usercategory5	`usercategory5`	user category (optional)	String	optional

v t e	Userbox metatemplates
Left	`{{Userbox}}` `{{Userbox-w}}` — wide variation `{{Userbox-flag}}` — for location-related userboxes `{{Userbox-level}}` — for skill-related userboxes
Right	`{{Userbox-r}}` `{{Userbox-w-r}}` — wide variation `{{userbox-flag-r}}` — for location-related userboxes `{{Userbox-level-r}}` — for skill-related userboxes
Left and Right	`{{Userbox-2}}`
None	`{{Userbox-m}}`
See also: Module:Userbox, Wikipedia:Userboxes, Wikipedia:Userboxes/Userboxes

Template:Userbox/doc

Sandbox reminder

Usage

Examples

Microformats

Template Data

See also