This page documents an English Wikipedia guideline. It is a generally accepted standard that editors should follow, though it should be treated with common sense and the occasional exception. When editing this page, please ensure that your revision reflects consensus. When in doubt, discuss your idea on the talk page.
The following guidelines apply equally to all user templates (including any userbox or userbox-like markup), regardless of where the code resides; and regardless of whether they have been transcluded, substituted, or written from scratch. Such templates which fail to meet these guidelines may be subject to deletion.
A userbox is a small rectangular box that looks like this. Below are more examples.
Userboxes can come in many different styles and colors.
Userboxes can have one or two sideboxes.
A userbox (commonly abbreviated as UBX) is a small colored box (see examples to the right) designed to appear only on a Wikipedian's user page as a communicative notice about the user, in order to directly (or even indirectly) help Wikipedians collaborate more effectively on articles.
The first userboxes were introduced to support the Babel inter-language effort, to indicate users' skills in other languages.
Userboxes are for the use of users on their own user pages. It may be considered uncivil to place any userboxes on any other user's page(s) without their permission. However, userboxes may be placed on non-mainspace talk/discussion pages by anyone. (See also Wikipedia:Talk page.)
Syntax
The standard syntax for adding a userbox to your user page (also known as transclusion) is: {{user name_of_box}}.
Optional substitution
You may decide to substitute the template code onto your user page using the syntax {{subst:user name_of_box}}. The use of "subst:" will ensure that the template is always displayed in its form when you add it to your user page, i.e. it will not reflect subsequent edits to the template. This method will lead to large amounts of code on your user page.
If you wish to offer an idea for a userbox, do so on the ideas page.
If you have designed a userbox that you would like to make available to others, you may wish to first display it on the New Userboxes talk page for community comment.
Which namespace?
Should your userbox be prefixed with Template:, User:, or Wikipedia:?
Userboxes may only be created or displayed in the Template, User, or ProjectNamespaces. Userboxes in the Template and Project namespaces are expected to adhere more tightly with policies and guidelines, such as neutral point of view and what Wikipedia is. Traditionally, content in User: space is given more leeway than in other namespaces, so userboxes in User: space might not be as encyclopedic in nature as those in Template: or Wikipedia: namespaces.
Template:
In the template namespace, userbox names must begin with "User " (e.g. Template:User Brazil)
User:
In the user namespace, you may create a subpage of your own user page or User:UBX.
Wikipedia:
Userboxes in the project namespace are generally for WikiProject or task force membership. Simply create it as a subpage of the WikiProject.
Caution about image use
The Wikimedia Commons has a large range of icons for use within boxes. However, if you select an image from somewhere else, make certain the image license is free. Templates (which includes userboxes) or user pages may not contain any copyrighted content not under free license; so, for example, "fair use" images are explicitly forbidden. This is interpreted strictly and without exception. See Wikipedia's fair use policy guidelines for more details.
Wikipedia is not an appropriate place for propaganda, advocacy, or recruitment of any kind, commercial, political, religious, or otherwise, opinion pieces on current affairs or politics, self-promotion, or advertising.
Simply: If content is not appropriate on a user page, it is not appropriate within userboxes.
Content examples
The following section is not to be considered all-inclusive. As such, other word combinations (both appropriate and inappropriate) are obviously possible.
Avoid negative verb phrases which can be potentially divisive, such as:
dislikes, despises, hates, loathes
Also avoid compound sentences which are positive and negative, such as:
This user likes <noun phrase>, but does not like <another noun phrase>.
Essentially: Express what you do like, rather than what you don't like. Express who you are, rather than who you aren't. Express what you do, rather than what you don't.
Constructing a userbox
How to construct the box
There are a number of box types to select from when deciding to make a userbox. The most commonly used design is the "Standard box". It has one square shaped area on the left ("id") and a rectangular area on the right ("info").
For ease of use, userboxes are made using maker-templates that have a number of parameters. Once the maker-template is saved, it is automatically transformed to HTML.
The distance between border and content of info box.
CSS padding width value. px, pt
info-lh
The distance between text lines of info box.
CSS relative line height/length value. em
id
This is the content of the id box.
Free-form
info
This is the content of info box.
Free-form
The id and info boxes can include text, links, and images using the usual Wikipedia syntax. Generally, the id box will contain a few letters or a 43px image, while the info box will contain a sentence with a link or two.
To make it easier to quote the generation code for a userbox in a uniform format, a template {{Userbox sample compact}} has been made available, which produces a picture of the userbox along with the code necessary to create it. To use it, just give it exactly the same parameters you would give the {{Userbox}} template. You must use subst:, or the template will not work properly. An example is shown below:
{{subst:Userbox sample compact|id=UBX|id-c=red|info=This is a '''[[WP:UBX|Userbox]]'''.}}
Produces:
{{Userbox | border-c = #999 | border-s = 1 | id-c = red | id-s = 14 | id-fc = black | info-c = #EEE | info-s = 8 | info-fc = black | id = UBX | info = This is a '''[[WP:UBX|Userbox]]'''. | float = left }}
As with the Babel box, there is a box to group userboxes together. Just make a list of userboxes with {{Userboxtop|box-name}} at the top, followed by your list of userboxes, and {{Userboxbottom}} at the bottom. For example, the box to the right is created using the following list:
(Of course you can put more than one such section inside a userbox, see Example 2 at right.)
Example2
My yellow userboxes
Sample userbox #1.
Sample userbox #2.
Sample userbox #3.
My purple userboxes
Sample userbox #4.
Sample userbox #5.
Sample userbox #6.
You may also change the alignment by using 'right' or 'left' as the second parameter, or explicitly using parameter align. Thus, it is possible to create the same box on the right, but positioned on the left side of the page, by changing the first line from {{Userboxtop |Example 1}} to {{Userboxtop |Example 1|left}}.
Using the Babel grouping system
Similar results can be achieved with either of the following:
The older Babel grouping system can also be used, e.g. {{Babel-3|sv|no-4|rome}}. However, it only works for user boxes with the "User" prefix, which must then be dropped for the arguments. Also, boxes that need arguments of their own (such as {{User:UBX/Monty Python}}) cannot be used with Babel.
Using tables
A fourth alternative would be to table your userboxes. For example:
This user tries to do the right thing. If they make a mistake, please let him or her know.
Combining tables and the boxboxtop template
A fifth method of grouping boxes is done by combining Examples 2 and 4 together. Example 2 breaks DHTMLinteroperability. It works as intended on Internet Explorer; however, it does not work well with Firefox and Opera when additional hide/show sections are added. This solution provides proper rendering on all three web browsers and scales much better when it comes to the number of groups you want to have. The table property can be adjusted by adding width="100%" (adjusting its percentage or by using a pixel width multiple of the userbox) to add more than one column. Another property style="text-align: " can be changed to place the userboxes left, right, or center of the page.
My yellow userboxes
Sample userbox #1.
Sample userbox #2.
Sample userbox #3.
My purple userboxes
Sample userbox #4.
Sample userbox #5.
Sample userbox #6.
My green userboxes
Sample userbox #7.
Sample userbox #8.
Sample userbox #9.
{|style="text-align: " width="160px" style="background-color: transparent;"
|-
|<div>
{{boxboxtop| }}
<div class="NavFrame" style="padding: 0; border-style: none;">
<div class="NavFrame" style="border-style: none; padding: 0;">
<div class="NavHead" style="background: #edf1f1; text-align: left; text-style: normal;">
Caption</div><div class="NavContent" style="display: none;"> Place your userboxes here...
</div></div></div>
{{boxboxbottom}} Place additional userbox groups here...
</div>
|}