Editing BattleTechWiki:Userboxes

{{WIP}}

{{about||the WikiProject collaboration on userboxes|BattleTechWiki:Project Userboxes|userbox-like recognitions given by users to other users|BattleTechWiki:Awards}}
 
{| style="float:right; background:none;"
|-
| {{userbox|#c8a2c8|yellow|[[File:Crystal kthememgr.svg|40px]]|A userbox is a small rectangular box that looks like this. More examples below.}}
|-
| {{userbox-r|green|lightgreen|[[File:Crystal package-plain.svg|40px]]|Userboxes can come in many different styles and colors.}}
|-
| {{userbox-2|#66f|#ADD8E6|[[File:Userbox love.svg|40px]]|Userboxes can have one or two sideboxes.|[[File:Ark-icon.svg|40px]]}}
|}

A '''userbox''' (commonly abbreviated as '''UBX''') is a small colored box (see examples to the right) display on a user's "user" page. As a communicative notice about the user, in order to directly or indirectly help other editors collaborate more effectively on articles.

Be mindful that like anything else you add to BTW, userboxes you add will likely be public forever, even if you later have your user page deleted. (Like other MediaWiki pages, your user page will be regularly archived in the database dumps and may be archived by third parties such as the [[w:Internet Archive|Internet Archive]].)
__TOC__

==Using existing userboxes==
Userboxes belong on their users' pages, however they may be placed on non-mainspace talk pages by anyone. In some cases, it may be considered uncivil to place userboxes on other users' pages without their permission (''especially'' in a mean-spirited way that would go against our [[Help:Contents#Policies|policies]] 

The {{tlx|clear}} template can be placed after the plain userbox if text is added on a new line immediately after it.

A gallery of existing userboxes can be found at [[BattleTechWiki:Userboxes/Galleries]].

===Syntax===
The standard syntax for adding a userbox to your user page (also known as [[w:Wikipedia:Transclusion|transclusion]]) is: <code><nowiki>{{user </nowiki>''name_of_box''<nowiki>}}</nowiki></code>.

If you do not have any userboxes on your user page yet, you want to begin using them, and you want to add them down the right side of your user page starting at the top, then edit your user page and, at or near the top of the source for your user page, add <code><nowiki>{{Userboxtop |}}</nowiki></code>, add the transclusion(s) for the userbox(es) you wish to include, and add <code><nowiki>{{userboxbottom}}</nowiki></code> just after the last userbox transclusion.

===Optional substitution===
You may decide to [[w:Wikipedia:Template substitution|substitute]] the template code onto your user page using the syntax <code><nowiki>{{subst:</nowiki>user ''name_of_box''<nowiki>}}</nowiki></code>. 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.

==Creating a new userbox==
{{shortcut|WP:CREATEUBX|WP:CREATEUSERBOX|WP:UBXCREATE|WP:USERBOXCREATE}}
:''If you wish to offer an idea for a userbox, do so on the [[BattleTechWiki:Project Userboxes/Ideas|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 [[Wikipedia talk:WikiProject Userboxes/New Userboxes|New Userboxes talk page]] for community comment.

=== {{anchor|namespace}} Namespace ===
{{shortcut|WP:UBXNS}}<!-- make sure shortcut still links here if renaming the section -->
{{See also|Wikipedia:Userbox migration}}
The [[WP:NAMESPACE|namespace]] you place your userbox in matters. Userboxes may ''only'' be created or displayed in the [[Wikipedia:User page|User]], [[Wikipedia:Project namespace|Project]] (Wikipedia), or [[Wikipedia:Template namespace|Template]] namespaces.

So which prefix is best for your userbox: <code>User:</code>, <code>Wikipedia:</code>, or <code>Template:</code>?

Since content in <code>User:</code>space represents individual editors more than the community, they are traditionally given more leeway than in other namespaces. Thus, userboxes in <code>User:</code>space may not be as directly collaborative in nature as those in <code>Template:</code>or <code>Wikipedia:</code>namespaces, which are expected to adhere more tightly with certain [[Wikipedia:Policies and guidelines|policies and guidelines]], especially [[Wikipedia:Neutral point of view|Neutral point of view]] and [[Wikipedia:What Wikipedia is not|What Wikipedia is not]]. This should also be considered before [[WP:MOVE|moving]] a userbox from userspace to any other namespace.

;<code>User:</code>: To host a userbox in the user namespace, simply create a [[Wikipedia:Subpages|subpage]] of your own user page or [[User:UBX]].
;<code>Wikipedia:</code>: Userboxes in the project namespace are generally for [[Wikipedia:WikiProject|WikiProject]] or [[Wikipedia:Task force|task force]] usage. Simply create it as a [[Wikipedia:Subpages|subpage]] of the WikiProject (e.g. <code>[[Wikipedia:WikiProject Board and table games/Userbox]]</code>).
;<code>Template:</code>: In the template namespace, userbox names must begin with "<code>User </code>" (e.g. <code>[[Template:User Brazil]]</code> or <code>[[Template:User en]]</code>)

If you are uncertain if your userbox is in the correct namespace, consider presenting the userbox at the [[Wikipedia talk:Userboxes/New Userboxes|New Userboxes talk page]] for community comment.

=== <span id="Caution about category use"></span><span id="Category"></span><span id="Categories"></span><span id="User category"></span><span id="User categories"></span> Userboxes and category use ===
{{shortcut|WP:USERBOXCAT}}
{{main|Wikipedia:User categories}}
{{see also|Wikipedia:Overcategorization/User categories|Wikipedia:User categories#Syntax for including a user category in a userbox}}

A userbox can be coded to autocategorise any user pages which [[Wikipedia:Transclusion|transclude]] the userbox into one or more [[Wikipedia:User categories|user categories]]. However, '''do not''' use autocategorisation without good reason.
* Most userboxes refer to a single isolated characteristic of the user; unless the characteristic directly relates to the user's [[Wikipedia:User categories#Appropriate types of user categories|ability or willingness to collaborate on certain areas of or topics within Wikipedia]], a user category should not exist for it and the userbox should not be used for categorisation.
* Users of the userbox can be located using the [[Special:WhatLinksHere]] tool from the userbox template. Networking between editors with similar interests or views is best done using a [[Wikipedia:Essays#Wikipedia essays|projectspace essay]] with a signup section for editors interested in networking.
* If there is a good reason for the user category, first create the category pages and include a description that explains its purpose and scope.
* User categories must be [[WP:SUBCAT|sub-categories]] of [[:Category:Wikipedians]].
* Names and descriptions of user categories are subject to the same rules and restrictions as [[Wikipedia:Userboxes#Content restrictions|userbox content]].

{{anchor|Color|Colour|color|colour|colors|colours|Colors|Colours}}

== Userbox content ==

=== Content restrictions ===
{{shortcut|BTW:UBCR}}
*All userboxes are subject to the same rules and restrictions as {{cl|Policies|our polices}}.
**Userboxes '''must not''' include incivility or personal attacks.
**Userboxes '''must not''' be inflammatory or substantially divisive. 
*The BTW is not an appropriate place for:
** Propaganda, advocacy, or recruitment of any kind (commercial, political, religious, or otherwise)
** Opinion pieces, particularly on current affairs or politics
** Self-promotion or advertising

'''Simply:''' If content is not appropriate on other parts of BTW, it is not appropriate within userboxes.

=== Caution about image use ===
* Wikimedia Commons has a [[:commons:Category:Icons|large range of icons]] for use within boxes. However, if you select an image from somewhere else, make certain the image has a free license. 
* Currently BTW uses both [https://icon-sets.iconify.design/ooui/ OOUI] and [https://icon-sets.iconify.design/mdi/ Material Design Icons] (Where OOUI will be replaced by MDI in time)
* Templates on BTW may not contain any copyrighted content not under free license. This is interpreted strictly and without exception.

=== Caution about colours ===
Please be mindful of the color contrast guidelines at [[Help:Color]] – low-contrast colours present accessibility barriers to people with colour-blindness or other visual disabilities.
{{clear}}

=== 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 &lt;[[wikt:verb phrase|verb phrase]]&gt; &lt;[[wikt:noun phrase|noun phrase]]&gt;.
* This user &lt;[[wikt:verb phrase|verb phrase]]&gt; &lt;[[wikt:noun phrase|noun phrase]]&gt; &lt;[[wikt:prepositional phrase|prepositional phrase]]&gt;.

Typical [[wikt:verb|verb]]s:
* verbs of action: contributes (to), drives, eats, edits, plays, uses, watches
* verbs of comprehension: reads, speaks, understands
* verbs of preference: enjoys, likes, loves

Additional examples, using the linking verb [[wikt:is#English|is]]:
* This user is &lt;noun phrase&gt;.
* This user is a fan of &lt;noun phrase&gt;.
* This user is a member of &lt;noun phrase&gt;.
* This user is interested in &lt;noun phrase&gt;.

Another option is to allow changing the verb phrase using a template parameter. This is especially useful in location userboxes:
* This user {{(((}}1{{!}}lives in{{)))}} &lt;location&gt;.

To avoid the awkward third-person phrasing ("This user"), you can use "<code><nowiki>{{</nowiki>#titleparts: <nowiki>{{</nowiki>PAGENAME}} | 1 | 1 }}</code>" (without the quotes) to insert the name of the user that includes it on their page (e.g. "<code><nowiki>{{</nowiki>#titleparts: <nowiki>{{</nowiki>PAGENAME}} | 1 | 1 }} uses second-person phrasing</code>" produces "{{#titleparts: {{PAGENAME}} | 1 | 1 }} uses second-person phrasing").

==== Potentially divisive words ====
Avoid verbs (often followed by the word "[[wikt:that#English|that]]") which may be used to suggest negative comparison and would thus be potentially divisive, such as: 
* believes, considers, finds, knows, prefers, thinks, 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 &lt;noun phrase>, but does not like &lt;another noun phrase>.

'''Essentially:''' Express what you do like, rather than what you don't like. Express what you comprehend, rather than what you don't comprehend. Express what you do, rather than what you don't. Express who you are, rather than who you aren't.

=== Design: 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 typically made using maker-templates that have a number of parameters.
{| class="wikitable"
!Template Parameters
!Meaning
!Value type
|-
|border-c
|<span style="border:1px solid #333;">The '''border color''' of the userbox.</span>
|[[w:Web colors|CSS color value]] ([[w:hexadecimal|#hex]] or color name)
|-
|border-s
|<span style="border:4px solid #3f3;">The '''border size''' of the userbox.</span>
|Width in pixels
|-
|id-c
|<span style="background:#efe">The '''background color''' of the id box.</span>
|CSS color value
|-
|id-s
|The font <span style="font-size:150%">'''size'''</span> of the id box.
|Size in [[w:Point (typography)|PostScript points]]
|-
|id-fc
|The font <span style="color:#090">'''color'''</span> of the id box text.
|CSS color value
|-
|id-p
|The distance between border and content of id box.
|CSS padding width value. [[w:Pixel|px]], [[w:Point (typography)|pt]]
|-
|id-lh
|The distance between text lines of id box.
|CSS relative line height/length value. [[w:Em (typography)|em]]
|-
|info-c
|<span style="background:#efe">The background color of info box.</span>
|CSS color value
|-
|info-s
|The font <span style="font-size:150%">'''size'''</span> of info box.
|Size in [[w:Point (typography)|PostScript points]]
|-
|info-fc
|The font <span style="color:#090">'''color'''</span> of info box.
|CSS color value
|-
|info-a
|style="text-align:right"|The horizontal alignment of text in info box.
|left/right/center/justify
|-
|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 MediaWiki syntax. Generally, the '''info''' box will contain a sentence with a link or two, while the '''id''' box will contain a few letters or a 43px image.

===== Userbox types =====
{| class="collapsible collapsed" style="background: #99f; color: #000; width: 100%; border-spacing: 1px; padding: 2px;"
! colspan="2" style="background: #FFF;"|Types of Userboxes
|-
! style="background: #FFF;"|Code
! style="background: #FFF;"|Appearance
|-
! colspan="2" style="background: #FFF; text-align: left; padding: 0em 1em;"|Standard box
|-
| style="background: #FFF;"|<kbd><nowiki>{{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}}</nowiki></kbd>
''or'' <kbd><nowiki>{{Userbox |side-box colour |main box colour |side-box content |main box content}}</nowiki></kbd>
| style="width:243px; background: #FFF;"|{{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}}
|-
! colspan="2" style="background: #FFF; text-align: left; padding: 0em 1em;"|Reverse box
|-
| style="background: #FFF;"|<kbd><nowiki>{{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}}</nowiki></kbd>
''or'' <kbd><nowiki>{{Userbox-r |side-box colour |main box colour |side-box content |main box content}}</nowiki></kbd>
| style="width:243px; background: #FFF;"|{{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}}
|-
! colspan="2" style="background: #FFF; text-align: left; padding: 0em 1em;"|Double box
|-
| style="background: #FFF;"|<kbd><nowiki>{{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}}</nowiki></kbd>
''or'' <kbd><nowiki>{{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}}</nowiki></kbd>
<br/>'''''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.''
| style="width:243px; background: #FFF;"|{{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}}
|-
! colspan="2" style="background: #FFF; text-align: left; padding: 0em 1em;"|Mini box
|-
| style="background: #FFF;"|<kbd><nowiki>{{Userbox-m |border-c=#000 |border-s=1 |id-c=#FFF |id-s=12 |id-fc=#000 |id=ID}}</nowiki></kbd>
''or'' <kbd><nowiki>{{Userbox-m |box colour |box content}}</nowiki></kbd>
| style="width:243px; background: #FFF;"|{{Userbox-m |border-c=#000 |border-s=1 |id-c=#FFF |id-s=12 |id-fc=#000 |id=ID}}
|}

== See also ==
* [[BattleTechWiki:Userboxes/Maker]]
* [[BattleTechWiki:Userboxes/Galleries]]
* [[BattleTechWiki:Project Userboxes]]

<noinclude>
[[Category:Userboxes|Userboxes]]
</noinclude>