Teamplaid:Userbox/documentation

This is a documentation subpage for Teamplaid:Userbox.
It contains usage information, categories and other content that is not part of the original teamplaid page.

Uses Lua:

Module:Userbox

This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template can be used to quickly create a userbox for display on a user's user page without having to know HTML or Wikitable syntax.

Nonfree images may not be displayed in userboxes, and are subject to summary removal by any editor without any notice being required.

Sandbox reminder

Always practice or experiment in the Template:Userbox/sandbox or Template:Userbox/testcases
Once you are satisfied: Copy your code!
In your Browser's address bar, change "sandbox" or "testcases" to the name of your new Userbox.
- Example:
- CHANGE http://en.wikipedia.org/wiki/Template:Userbox/sandbox
- TO https://en.wikipedia.org/wiki/Template:Userbox/WhateverYourNewBoxNameIs
- If the name of your new Userbox is taken, create a different name.
You will be prompted to Start or Create your new Template Userbox!
Paste your code into the space provided.

Ùsaid - Usage

{{Userbox
| bodyclass     = <!--Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.-->
| border-c      = <!--border color (default=id-c or #999)-->
| border-s      = <!--border width in pixels (default=1)-->
| float         = <!--left|right|none (default=left)-->
| id            = <!--id image or text (image size should normally not exceed 90x45px)-->
| id-a          = <!--id horizontal alignment left/center/right/justify (default=center)-->
| id-c          = <!--id background color (default=#ddd)-->
| id-fc         = <!--id font color (default=info-fc or black)-->
| id-h          = <!--id box height in pixels (default=45)-->
| id-lh         = <!--id line height (default=1.25em)-->
| id-op         = <!--id other CSS parameters-->
| id-p          = <!--id cell padding (default=0 1px 0 0)-->
| id-s          = <!--id text size in points (default=14)-->
| id-w          = <!--id box width in pixels (default=45)-->
| info-class    = <!--Adds an HTML class attribute to the "info" HTML table-row, to allow for styling, emission of microformats, etc.-->
| info          = <!--info text or image-->
| info-a        = <!--info horizontal alignment left/center/right/justify (default=left)-->
| info-c        = <!--info background color (default=#eee)-->
| info-fc       = <!--info font color (default=black)-->
| info-lh       = <!--info line height (default=1.25em)-->
| info-op       = <!--info other CSS parameters-->
| info-p        = <!--info padding (default=0 4px 0 4px)-->
| info-s        = <!--info text size in points (default=8)-->
| nocat         = <!--block page category declarations; see [[:w:en:WP:NOCAT|WP:NOCAT]] (default=false)-->
| usercategory  = <!--user category (optional, unlinked and without the "Category:" part)-->
| usercategory2 = <!--user category (optional)-->
| usercategory3 = <!--user category (optional)-->
| usercategory4 = <!--user category (optional)-->
| usercategory5 = <!--user category (optional)-->
}}

All parameters are optional.
Images should normally be scaled to x45px or less.

Most HTML-based tables use only a handful of these attributes. The following subset can be used to quickly convert an HTML Userbox into the format used here:

{{Userbox
| border-c = 
| id       = 
| id-c     = 
| id-fc    = 
| id-s     = 
| info     = 
| info-c   = 
| info-fc  = 
| info-lh  = 
| info-s   = 
}}

Eisimpleirean - Examples

Code

Result

{{Userbox
| border-c      = #aaffaa
| border-s      = 2
| id            = foo
| id-c          = #ffffee
| id-s          = 20
| info          = ''foo bar''
| info-c        = #ffeeff
| info-s        = 12
}}

foo

foo bar

Below example shows the default appearance of a Userbox, which is (much) higher than the 45px.
Compare the height of the one below with the above Userbox.

{{Userbox
| border-c      = #aaffaa
| border-s      = 2
| id            = foo logo
| id-c          = #ffffee
| info          = ''We are trying to see 
default distance in between text 
lines, see the distance in 
between cell content and its border, 
and also see total height.''
| info-c        = #ffeeff
}}

foo logo

We are trying to see default distance in between text lines, see the distance in between cell content and its border, and also see total height.

Below example shows how we can change that Userbox and further specify parameters to bring down
the overall height of the Userbox to the recommended height of 45px, even with four text lines.
Cell padding parameter "info-p" can also be set at "1pt 1pt 1pt 2pt", or "1pt 2pt" for better appearance,
when there are 4 text lines.

{{Userbox
| border-c      = #aaffaa
| border-s      = 1
| id            = foo logo
| id-c          = #ffffee
| id-lh         = 1.1em
| id-s          = 14
| info          = ''We have specified values 
to lessen the distance between 
text lines and padding space between 
cell content and its border.''
| info-c        = #ffeeff
| info-lh       = 1.05em
| info-p        = 1pt
| info-s        = 8
}}

foo logo

We have specified values to lessen the distance between text lines and padding space between cell content and its border.

Below example is for advanced users, showing how we can specify other CSS properties,for example, "font-family",
to change the font or "text-decoration" to add lines around the text. Below, on the right side are two userboxes:
the top one is displayed without either parameters; and the bottom Userbox is displayed by using the below code,
with the help of the "info-op" field.

{{Userbox
| border-c      = #afa
| border-s      = 2
| id            = foo logo
| id-c          = #ffe
| id-lh         = 1.1em
| id-s          = 14
| info          = foo bar
| info-c        = #fef
| info-op       = font-family: 'Courier New', monospace; text-decoration: wavy overline green;
| info-s        = 14
}}

foo logo

foo bar

foo logo

foo bar

Microformats

bodyclass: This parameter is inserted into the "class" attribute for the Userbox as a whole.
info-class: This parameter is inserted into the "class" attribute for the info component.

This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. To flag a Userbox as containing hCard information about a person, for example, add the following parameter:

| bodyclass     = vcard

or

| info-class    = vcard

then (for example):

| title         = …the books of <span class="fn">[[:w:en:Iain Banks|Iain Banks]]</span>

...and so forth.

Examples include:

{{User:UBX/Iain Banks}} - person
{{User Microformats}} - group (WikiProject Microformats)
{{User Brum}} - place (Birmingham)

See Wikipedia:WikiProject Microformats for more information on adding microformat information to Wikipedia.

Teamplaid-dàta - TemplateData

This is the WP:TemplateData documentation for this template used by WP:VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Userbox

This template can be used to quickly create a Userbox for display on a user's user page without having to know HTML or Wikitable syntax.

Paramadairean na teamplaide[Stiùirich an TemplateData]
Paramadair		Tuairisgeul	Seòrsa	Staid
bodyclass	`bodyclass`	Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc. Bun-roghainn	Sreang	roghainneil
border-c	`border-c`	border color Bun-roghainn #999	Sreang	roghainneil
border-s	`border-s`	border width in pixels Bun-roghainn 1	Sreang	roghainneil
float	`float`	left\|right\|none Bun-roghainn left	Sreang	roghainneil
id	`id`	id image or text Bun-roghainn	Sreang	roghainneil
id-a	`id-a`	id horizontal alignment left/center/right/justify Bun-roghainn center	Sreang	roghainneil
id-c	`id-c`	id background color Bun-roghainn #d0d0d0	Sreang	roghainneil
id-fc	`id-fc`	id font color Bun-roghainn black	Sreang	roghainneil
id-h	`id-h`	id box height in pixels Bun-roghainn 45	Sreang	roghainneil
id-lh	`id-lh`	id line height Bun-roghainn 1.25em	Sreang	roghainneil
id-op	`id-op`	id other CSS parameters Bun-roghainn	Sreang	roghainneil
id-p	`id-p`	id cell padding Bun-roghainn 0 1px 0 0	Sreang	roghainneil
id-s	`id-s`	id text size in points Bun-roghainn 14	Sreang	roghainneil
id-w	`id-w`	id box width in pixels Bun-roghainn 45	Sreang	roghainneil
info-class	`info-class`	Adds an HTML class attribute to the "info" HTML table-row, to allow for styling, emission of microformats, etc. Bun-roghainn	Sreang	roghainneil
info	`info`	info text or image Bun-roghainn	Sreang	roghainneil
info-a	`info-a`	info horizontal alignment left/center/right/justify Bun-roghainn left	Sreang	roghainneil
info-c	`info-c`	info background color Bun-roghainn #e0e0e0	Sreang	roghainneil
info-fc	`info-fc`	info font color Bun-roghainn black	Sreang	roghainneil
info-lh	`info-lh`	info line height Bun-roghainn 1.25em	Sreang	roghainneil
info-op	`info-op`	info other CSS parameters Bun-roghainn	Sreang	roghainneil
info-p	`info-p`	info padding Bun-roghainn 0 4px 0 4px	Sreang	roghainneil
info-s	`info-s`	info text size in points Bun-roghainn 8	Sreang	roghainneil
nocat	`nocat`	block page category declarations (see WP:NOCAT) Bun-roghainn false	Sreang	roghainneil
usercategory	`usercategory`	user category (optional) Bun-roghainn	Sreang	roghainneil
usercategory2	`usercategory2`	user category (optional) Bun-roghainn	Sreang	roghainneil
usercategory3	`usercategory3`	user category (optional) Bun-roghainn	Sreang	roghainneil
usercategory4	`usercategory4`	user category (optional) Bun-roghainn	Sreang	roghainneil
usercategory5	`usercategory5`	user category (optional) Bun-roghainn	Sreang	roghainneil

Faic cuideachd - Also see

Teamplaid:UBT