Wikipedia:Userboxes/Design and construct

From Wikipedia, the free encyclopedia

Contents

[edit] Creating a new userbox

For help with these instructions, ask a question at Wikipedia:Requested templates.
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.

[edit] Which namespace?

Should your userbox be prefixed with Template:, User:, or Wikipedia:?

Userboxes may only be created or displayed in the Template, User, or Project Namespaces. 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. Create it as a subpage to the WikiProject.

[edit] 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. 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. See Wikipedia's fair use policy guidelines for more details.

[edit] Caution about user categories

Main article: Wikipedia:User categories

[edit] Content restrictions

  • All userboxes are governed by the civility policy.
    • Userboxes must not include incivility or personal attacks.
    • Userboxes must not be inflammatory or divisive.
    • 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.

[edit] Content examples

Typical userbox content:

Typical verbs (others are possible):

  • drives, eats, edits, enjoys, likes, loves, plays, reads, speaks, understands, uses, and watches.

Some alternate combinations (other combinations are possible):

  • 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>
Potentially divisive words

Avoid verbs which may be used to suggest negative comparison, and would thus be potentially divisive, such as:

  • believes, considers, favors, finds, knows, prefers, thinks and wishes.

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

[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 color of the userbox. CSS color value (#hex or color name)
border-s The border size of the userbox. Width in pixels
id-c The background color of the id box. CSS color value
id-s The font size of the id box. Size in PostScript points
id-fc The font color of the id box text. CSS color 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 color of info box. CSS color value
info-s The font size of info box. Size in PostScript points
info-fc The font color of info box. CSS color 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. 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.

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