University Wiki:Userboxes
From University Wiki
| Most of our userboxes are raw imports from Wikipedia and may not be working perfectly. You can find more information on our userbox issues page. |
A userbox (commonly abbreviated as UBX) is a small colored box (see examples to the right) designed to appear only on a user page as a communicative notice about the user, in order to directly (or even indirectly) help users collaborate more effectively on articles.
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 non-mainspace talk/discussion pages by anyone.
[edit] Syntax
The standard syntax for adding a userbox to your user page (also known as transclusion) is: {{user name_of_box}}.
[edit] 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.
[edit] Creating a new userbox
[edit] Which namespace?
Should your userbox be prefixed with Template:, User:, or University Wiki:?
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 maintaining a neutral point of view. 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 University Wiki: 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.
University Wiki:- Userboxes in the project namespace are generally for task force membership.
[edit] Caution about image use
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.
[edit] Caution about user categories
- Names and descriptions of user categories are subject to the same rules and restrictions as userbox content.
- Userboxes should not automatically include categories by default.
[edit] Content restrictions
-
- Userboxes must not include incivility or personal attacks.
- Userboxes must not be inflammatory or divisive.
- University Wiki 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
- The following section is not to be considered all-inclusive. As such, other word combinations (both appropriate and inappropriate) are obviously possible.
Typical userbox content:
- This user <verb phrase> <noun phrase>
- This user <verb phrase> <noun phrase> <prepositional phrase>
Typical verbs:
- verbs of action: contributes (to), drives, eats, edits, plays, uses, and watches
- verbs of comprehension: reads, speaks, understands
- verbs of preference: enjoys, likes, loves
Additional examples, using the linking verb is:
- This user is <noun phrase>
- This user is a fan of <noun phrase>
- This user is a member of <noun phrase>
- This user is interested in <noun phrase>
- Potentially divisive words
Avoid verbs (often followed by the word "that") which may be used to suggest negative comparison and would thus be potentially divisive, such as:
- believes, considers, 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 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.
[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 University Wiki 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}} |
|
|||
| 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}} |
|
|||
| 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}} |
|
|||
| 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}} |
|
|||
[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 '''[[University Wiki:Userboxes|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 '''[[University Wiki:Userboxes|Userbox]]'''. | float = left }} |
|
There are not yet any similar templates available for userboxes created by the templates Userbox-r, Userbox-2 and Userbox-m.
[edit] Grouping userboxes
[edit] Using the Userboxtop template
|
Example 1
|
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}}
{{User Homestead HS}}
{{User Tufts}}
{{user fr-2}}
{{Userboxbottom}}
[edit] Using the boxboxtop template
If you wish an expandable list of userboxes you may try:
{{boxboxtop|Example2}} <BR> <div class="NavFrame" style="padding:0;border-style:none;"><br /> <div class="NavFrame" style="border-style:none;padding:0;"><br /> <div class="NavHead" style="background:#EDF1F1;text-align:left;text-style:normal"><br /> Caption</div><div class="NavContent" style="display:none;"><br /> </tt><i>Place your userboxes here...</i><tt><br /> </div></div></div><br /> {{boxboxbottom}}
(Of course you can put more than one such section inside a userbox, see Example 2 at right.)
|
Example2
My yellow userboxes
My purple userboxes
|
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}}.
[edit] Using the Babel grouping system
Similar results can be achieved with either of the following:
{{Babel-X |header=Example 1 |footer= |align=left |Homestead HS |Tufts |fr-2}}
{{UBX-X |header=Example 1 |Homestead HS |Tufts |fr-2}}
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.
[edit] Using tables
A fourth alternative would be to table your userboxes. For example:
- {| style="margin: 1em auto 1em auto"
- | {{User:Feureau/UserBox/SimpsonsExcellent}} {{User_USAFo5}}
- |-
- | {{User:ZabMilenko/Userboxes/php coder-3}} {{User:UBX/Zodiac Gemini}}
- |}
would produce the following:
|
||||
|
[edit] Combining tables and the boxboxtop template
A fifth method of grouping boxes is done by combining Examples 2 and 4 together. Example 2 breaks DHTML interoperability. 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 align="right" can be changed to place the userboxes left, right, or center of the page.
|
{|align="right" 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>
|}
[edit] External links
- The Super-Simple Userbox Maker - External tool that outputs userboxes in wiki markup. With built-in color schemes.
|
||||||||||||||||||||||
This page was adapted from Wikipedia and is available for reuse under the terms of the GNU Free Documentation License.


