User:Theki/sandbox/userboxes

Angry Emoji - FREE (50213827537)This user sure do be riled up BOY!!!!!!!!
Mother and child by Ruby LindsayThis user's first name is Joe, and their last name is Mama.


Userbox Documentation edit

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 edit

Usage edit

{{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 #999999)-->
| 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=#DDDDDD)-->
| 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=#EEEEEE)-->
| 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 [[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   = 
}}

Examples edit

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
}}
foofoo 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 logoWe 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 logoWe 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 logofoo bar

 
foo logofoo bar

Microformats edit

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">[[Iain Banks]]</span>

...and so forth.

Examples include:

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

Template Data edit

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Theki/sandbox in articles based on its TemplateData.

TemplateData for Theki/sandbox

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.

Template parameters

ParameterDescriptionTypeStatus
bodyclassbodyclass

Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.

Default
Stringoptional
border-cborder-c

border color

Default
#999
Stringoptional
border-sborder-s

border width in pixels

Default
1
Stringoptional
floatfloat

left|right|none

Default
left
Stringoptional
idid

id image or text

Default
Stringoptional
id-aid-a

id horizontal alignment left/center/right/justify

Default
center
Stringoptional
id-cid-c

id background color

Default
#d0d0d0
Stringoptional
id-fcid-fc

id font color

Default
black
Stringoptional
id-hid-h

id box height in pixels

Default
45
Stringoptional
id-lhid-lh

id line height

Default
1.25em
Stringoptional
id-opid-op

id other CSS parameters

Default
Stringoptional
id-pid-p

id cell padding

Default
0 1px 0 0
Stringoptional
id-sid-s

id text size in points

Default
14
Stringoptional
id-wid-w

id box width in pixels

Default
45
Stringoptional
info-classinfo-class

Adds an HTML class attribute to the "info" HTML table-row, to allow for styling, emission of microformats, etc.

Default
Stringoptional
infoinfo

info text or image

Default
Stringoptional
info-ainfo-a

info horizontal alignment left/center/right/justify

Default
left
Stringoptional
info-cinfo-c

info background color

Default
#e0e0e0
Stringoptional
info-fcinfo-fc

info font color

Default
black
Stringoptional
info-lhinfo-lh

info line height

Default
1.25em
Stringoptional
info-opinfo-op

info other CSS parameters

Default
Stringoptional
info-pinfo-p

info padding

Default
0 4px 0 4px
Stringoptional
info-sinfo-s

info text size in points

Default
8
Stringoptional
nocatnocat

block page category declarations (see WP:NOCAT)

Default
false
Stringoptional
usercategoryusercategory

user category (optional)

Default
Stringoptional
usercategory2usercategory2

user category (optional)

Default
Stringoptional
usercategory3usercategory3

user category (optional)

Default
Stringoptional
usercategory4usercategory4

user category (optional)

Default
Stringoptional
usercategory5usercategory5

user category (optional)

Default
Stringoptional

See also edit

Userbox metatemplates
Left
Right
Left and Right
None

See also: Module:Userbox, Wikipedia:Userboxes, Wikipedia:Userboxes/Userboxes


Userbox Gallery Documentation edit

This Yy series of templates can create a userbox table that displays a list of userboxes along with their Wikitext and the pages that invoke each userbox template. Templates also display boxes for WikiProjects, portals, and notice boards.

The yy template series comprises the following nine templates:

{{yytop}} {{yy}} {{yycat}} {{yytxt}} {{yytab}} {{yywp}} {{yyp}} {{yynb}} {{yybottom}}

Template:Yytop edit

Template:Yytop always comes first to create the three column headings and to size the columns. Template:Yytop may also be used to create a centered table title.

{{yytop|title|headers=}}

where:

  • title is the optional table title.
  • headers= is the optional column headings switch.
    • headers=yes creates three column headings (default)
    • headers=no creates no column headings.

Example
{{yytop|Userbox Templates}} creates:

Userbox Templates
Wikitext userbox where used


Template:Yytop is very similar to Template:Usbktop except:

  1. Template:Yytop default sizes the three columns to 390, 250, and 80 pixels respectively.
    Template:Usbktop does no default column sizing.
  2. Template:Yytop places the linked labels Wiki markup, userbox, and where used centered at the top of each column.
    Template:Usbktop places the labels Code and Result left justified at the top of the first two columns only.
  3. Template:Yytop may be used to create a centered table title.

Template:Yy edit

Template:Yy creates a single table row with the template Wiki markup, the template box, and a link to the list of pages that link to the called template.

{{yy|template|par1|...|par12}}

where:

  • template is the required template name.
  • par1|...|par12 are up to 12 optional template parameters.

A zero-width space &#82​03; may be used to represent a missing parameter.

Examples
{{yy|User in New Zealand|5|comment=parameter: number from 1&nbsp;to&nbsp;64}} creates:

{{User in New Zealand|5}}
 This user is a student in New Zealand.
linked pages
parameter: number from 1 to 64

{{yy|User coord|51|28|40.12|N|0|0|5.31|W}} creates:

{{User coord|51|28|40.12|N|0|0|5.31|W}}
This user is currently near geocoordinates
51°28′40.12″N 0°0′5.31″W / 51.4778111°N 0.0014750°W / 51.4778111; -0.0014750
linked pages


Template:Yy is similar to Template:Usbk except:

  1. Template:Yy will pass up to 12 parameters to the called template.
    Template:Usbk will pass no more than three parameters to the called template.
  2. Template:Yy forces all cells to align to the left.
    Template:Usbk uses the default object alignment.
  3. Template:Yy uses the same category suppression as Template:Usbk.

Template:Yycat edit

Template:Yycat creates a reference to a category.

{{yycat|category|link=}}

where:

  • category is the required category name.
  • link= is the optional link to the category. (default=no)

Example
{{yycat|Wikipedians in South Africa|link=yes}} creates:

[[Category:Wikipedians in South Africa]] none linked pages

Template:Yytxt edit

Template:Yytxt creates a row of text in the table.

{{yytop|txt1|txt2|txt3|opt=}}

where:

  • txt1 is the optional text for the table or first column.
  • txt2 is the optional text for the second column
  • txt3 is the optional text for the third column
  • opt= is the optional format parameter:
    • opt=1 creates a line of left-justified text (default)
    • opt=2 creates a line of table-centered text
    • opt=3 creates a line of right-justified text
    • opt=4 creates a line of left-justified text for each column
    • opt=5 creates a line of column-centered text for each column
    • opt=6 creates a line of right-justified text for each column
    • opt=7 recreates the column headings of Template:Yytop

If all three optional text parameters are blank or missing, a blank row will be inserted.

Example
{{yytxt|Residence:}} creates:

Residence:


Template:Usbkbreak centers text on only the first two columns and has no other options.

Template:Yytab edit

See also Template:yytabcities—a shortcut for {{yytab}} for location related userboxes.

Template:Yytab creates a pointer to another table. Template:Yytab may be used to break an overly large table into subtables.

{{yytab|name|address|desc=|image=|size=|alone=}}

where:

  • name (first positional argument) is the required name of a region, portal, noticeboard, WikiProject. (See Module:Portal/images)
  • address (second positional argument)is the optional address of the subtable. (default=Wikipedia:Userboxes/Location/name)
  • desc= is the optional description of the subtable. (default=name userbox templates)
  • image= is the optional image file. (default image file from Module:Portal/images)
  • size= is the optional image size. (default=x45px)
  • info-s= is the optional font size. (default=9)
  • alone= is the optional stand alone switch.
    • alone=no pointer is part of a table. (default)
    • alone=yes pointer in its own table.

Example
{{yytab|Canada|alone=yes}} creates:

See Wikipedia:Userboxes/Location/Canada for Canada userbox templates.

{{yytab|United Arab Emirates|info-s=8|alone=yes}} creates:

See Wikipedia:Userboxes/Location/United Arab Emirates for United Arab Emirates userbox templates.


Template:Yytab is somewhat similar to Template:usee.

Template:Yywp edit

Template:Yywp creates a WikiProject box.

{{yywp|wikiproject|group|type|label|folder=|size=}}

where:

  • wikiproject is the required WikiProject base name.
  • group an optional project group base name if any.
  • type an optional project group type if any.
  • label an optional WikiProject box label. (default=WikiProject wikiproject or group type)
  • folder= is an optional WikiProject folder name.
  • size= is the optional image size. (default=x45px)

Examples
{{yywp|New South Wales}} creates:

[[Wikipedia:WikiProject New South Wales]] linked pages

and {{yywp|California|Los Angeles|task force}} creates:

[[Wikipedia:WikiProject California/Los Angeles task force]] linked pages


Template:WikiProject box creates a smaller standalone WikiProject box.

Template:Yyp edit

Template:Yyp creates a portal box.

{{yyp|portal|size=}}

where:

  • portal is the required portal name.
  • size= is the optional image size. (default=x45px)

Example
{{yyp|South Africa}} creates:

{{Portal:South Africa}} linked pages


Template:Portal creates a smaller standalone portal box.

Template:Yynb edit

Template:Yynb creates a noticeboard box.

{{yynb|noticeboard|size=}}

where:

  • notice is the required noticeboard base name.
  • size= is the optional image size. (default=x45px)

Example
{{yynb|Pakistan}} creates:

{{Wikipedia talk:Notice board for Pakistan-related topics}} linked pages


Template:Noticeboard box creates a smaller standalone notice board box.

Template:Yybottom edit

Template:Yybottom always comes last and completes the table.

{{yybottom|comment}}

where:

  • comment is an optional comment to appear at the bottom right of the table.


Template:Usbkbottom is similar to Template:Yybottom but does not permit a comment line.

Table example edit

The following Wiki markup:

{{yytop|[[Samoan Archipelago]]}}
{{yytxt|American Samoa:}}
{{yywp|Polynesia|American Samoa|work group}}
{{yy|User in American Samoa}}
{{yy|User wishes to visit|American Samoa}}
{{yy|User American Samoa WG}}
{{yytab|American Samoa|Wikipedia:Userboxes/Location/Oceania#American Samoa}}
{{yytxt|Samoa:}}
{{yy|User citizen Samoa}}
{{yy|User interest Samoa}}
{{yy|User WP Samoa}}
{{yytab|Samoa|Wikipedia:Userboxes/Location/Oceania#Samoa}}
{{yybottom|updated 2 October 2017}}

creates the following table:

Samoan Archipelago
Wikitext userbox where used
American Samoa:
[[Wikipedia:WikiProject Polynesia/American Samoa work group]] linked pages
{{User in American Samoa}}
 This user lives in American Samoa.
linked pages
{{User wishes to visit|American Samoa}}
 This user wishes to visit American Samoa.
linked pages
{{User American Samoa WG}} linked pages
See Wikipedia:Userboxes/Location/Oceania#American Samoa for American Samoa userbox templates.
Samoa:
{{User citizen Samoa}}
 This user is a citizen of Samoa.
linked pages
{{User interest Samoa}}
 This user is interested in Samoa.
linked pages
{{User WP Samoa}} linked pages
See Wikipedia:Userboxes/Location/Oceania#Samoa for Samoa userbox templates.
updated 14 October 2017

See also edit