Wikipedia:Userboxes

From Wikipedia, the free encyclopedia

This page gives information about the design, construction, and usage of userboxes, which are only intended to be used on userpages. Wikipedia is first and foremost an online encyclopedia, and its online community is a means to that end. Userboxes are tools which are intended for communication purposes, such as helping Wikipedians collaborate more effectively on articles.
Shortcut:
WP:BOX
WP:UBX
WP:BOX redirects here. You may be looking for Wikipedia:Sandbox. For Navigation or "Click boxes", see Wikipedia:Navigational templates.
A userbox is a small box that looks like this.
Userboxes can come in many different styles and colours.
Userboxes can have one or two sideboxes.

Userboxes (commonly abbreviated as UBX) are small colored boxes designed to appear on Wikipedians' user pages. They generally include one or two small graphics and a few short lines of text. Often they also include wiki markup that places the user in a category. Userboxes are generally created as templates and transcluded onto userpages, although their markup may be substituted directly onto userpages instead. Userboxes should not be used in articles.

The first Userboxes were designed to support the Babel inter-language effort, which were designed to show skills in other languages.


Contents

[edit] Using existing userboxes

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 talk/discussion pages by anyone. (See Wikipedia:Talk page.)

[edit] Syntax

The standard syntax for adding a userbox to your user page (also known as transclusion) is: {{user nameofbox}}.

If you wish, you can use the following substitution syntax instead: {{subst: user nameofbox}}. The use of "subst:" will ensure the template is always displayed in its form at the time of addition to a page and will not reflect subsequent edits to the template. It should be noted that this method will lead to large amounts of Wikicode being present on your page, and the version of the userbox on your userpage will not reflect any new changes.

[edit] Creating a new userbox

Userbox names must begin with "User " (for example, Template:User Someuserboxname).

If you wish to offer an idea for a userbox, please 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.

As an alternative, you may wish to consider having it as a sub-page of your userpage and making it available through Category:Original Wikipedian userboxes, using the following syntax:

<noinclude>
[[category:Original Wikipedian userboxes]]
</noinclude>

Namespaces: Userboxes are only to be created or displayed in Template: namespace, Wikipedia: project namespace or User: namespace. Those in Template: or Wikipedia: namespaces may be expected to adhere more tightly with policies and guidelines such as those about neutral point of view or 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.

[edit] Designing a userbox

The following userbox design and creation guidelines apply equally to all user templates (including any userbox or userbox-like markup), regardless of whether they have been transcluded, substituted, or written from scratch. Userboxes that fail to meet these guidelines may be subject to deletion.

[edit] Content

Typical userbox content examples:

  • This user <verb phrase> <noun phrase>
    • This user is <noun phrase>
    • This user is a member of <noun phrase>
    • This user is a fan of <noun phrase>
    • This user supports <noun phrase>
    • This user contributes to <noun phrase>
    • This user is interested in <noun phrase>
    • This user is fascinated by <noun phrase>

Other combinations are obviously possible.

Other typical verbs (again, others are possible): drives, eats, edits, enjoys, favors, likes, loves, plays, prefers, reads, speaks, understands, uses, and watches.

Avoid the following verbs: considers, finds, knows, and thinks.

Also avoid compound sentences which are positive and negative, such as:

  • This user likes <noun phrase>, but does not like <another noun phrase>.

[edit] Content restrictions

Simply: If content is not appropriate on a user page, it is not appropriate within userboxes.

[edit] Caution about image use

  • The Wikimedia Commons has a large range of icons for use within boxes. However, if you wish to select a different image to put in a userbox, make certain the image license is free. Wikipedia policy does not allow templates (which includes userboxes) or user pages to contain any copyrighted content not under free license; so, for example, "fair use" images are explicitly forbidden. This clause is to be interpreted strictly and without exception, for legal reasons. See Wikipedia's fair use policy guidelines for more details.

[edit] Category inclusion

  • Userboxes that include Category markup which adds the bearing userpage to a category must only categorize within subcategories of Category:Wikipedians.
  • Names and descriptions of subcategories are subject to the same rules and restrictions as userbox content.
  • Userboxes should not automatically include categories by default. Consider how useful the category would be to other editors before adding it to your userbox.
  • Do not create categories which could potentially include all Wikipedians. For example, userboxes such as: "This user is a Wikipedian."; "This user is human."; "This user uses the internet"; etc., should not include category markup based on such criteria.
  • Avoid categorizing "not"-based userboxes. For example: "This user does not like <noun phrase>."

[edit] Constructing a userbox

[edit] 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.

Template Parameters Meaning Value type
border-c The border colour of the userbox. CSS colour value (#hex or colour name)
border-s The border size of the userbox. Width in pixels
id-c The background colour of the id box. CSS colour value
id-s The font size of the id box. Size in PostScript points
id-fc The font colour of the id box text. CSS colour value
id-p The distance between border and content of id box. CSS padding width value. px, pt
id-lh The distance between text lines of id box. CSS relative line height/length value. em
info-c The background colour of info box. CSS colour value
info-s The font size of info box. Size in PostScript points
info-fc The font colour of info box. CSS colour value
info-p 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. Text
info This is the content of info box. Text

[edit] Userbox types

Code Appearance
Standard box
{{Userbox |border-c=#000 |border-s=1 |id-c=#fff |id-s=12 |id-fc=#000 |info-c=#039 |info-s=8 |info-fc=#fff |id=ID |info=Content}}

or {{Userbox |side-box colour |main box colour |side-box content |main box content}}

ID Content
Reverse box
{{Userbox-r |border-c=#000 |border-s=1 |id-c=#fff |id-s=12 |id-fc=#000 |info-c=#039 |info-s=8 |info-fc=#fff |id=ID |info=Content}}

or {{Userbox-r |side-box colour |main box colour |side-box content |main box content}}

Content ID
Double box
{{Userbox-2 |border-c=#000 |border-s=1 |id1-c=#fff |id1-s=12 |id1-fc=#000 |id2-c=#000 |id2-s=12 |id2-fc=#fff |info-c=#039 |info-s=8 |info-fc=#fff |id1=ID 1 |id2=ID 2 |info=Content}}

or {{Userbox-2 |side-box 1 colour |main box colour |side-box 1 content |message |side-box 2 content |border colour |side-box 2 colour |main box font-colour |box border thickness}}
Note: If omitted, border colour and side-box 2 colour default to the same colour as side-box 1, and font colour is black. Default border thickness is 1.

ID 1 Content ID 2
Mini box
{{Userbox-m |border-c=#000 |border-s=1 |id-c=#fff |id-s=12 |id-fc=#000 |id=ID}}

or {{Userbox-m |box colour |box content}}

ID

[edit] Userbox sampling templates

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 }}
UBX This is a Userbox.

There are not yet any similar templates available for userboxes created by the templates Userbox-r, Userbox-2 and Userbox-m.

[edit] Grouping userboxes

Example 1
This user is a member of WikiProject Userboxes.
This user is interested in ancient Rome.
This user wants to be your friend.

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:

{{Userboxtop |Example 1}} {{Wikipedia:WikiProject Userboxes/Userbox}} {{User Rome}} {{User:Nihiltres/Userboxes/Friendly}} {{Userboxbottom}}

If you wish an expandable list of userboxes you may try:

{{boxboxtop|Example2}}
<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}}

(Of course you can put more than one such section inside an userbox, see Example 2 at right.)

Example2

You may also change the alignment by using 'right' or 'left' as the 2nd 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}}.

Similar results can be achieved with either of the following:

{{Babel-X |header=Example 1 |footer= |align=left |Wikipedia:WikiProject Userboxes/Userbox |Rome |:Nihiltres/Userboxes/Friendly}}

{{UBX-X |header=Example 1 |Wikipedia:WikiProject Userboxes/Userbox |Rome |:Nihiltres/Userboxes/Friendly}}

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.

A fourth alternative would be to table your userboxes. For example:

{| style="margin: 1em auto 1em auto"
| {{User wikipedia/No personal attacks}} {{user NPOV}}
|-
| {{User wikipedia/Signpost}} {{User wikipedia/Department of Fun}}
|}


would produce the following:

This user maintains a strict policy advising against all personal attacks.
This user strives to maintain a policy of neutrality on controversial issues.
This user writes for The Wikipedia Signpost. Do you?
This user is a member of the Wikipedia Department of Fun.

[edit] Gallery

[edit] Languages

[edit] Interests and Tastes

[edit] Life, Status, and Situation

[edit] Wikipedia-related

[edit] See also