テンプレート:Userbox/doc

Dependencies:

• Module:Userbox
• Module:Arguments
• Module:Yesno

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.

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

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

...and so forth.

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

Template Data

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.

テンプレートパラメーター

このテンプレートは、パラメーターを複数行に分けて記述することが推奨されています。

パラメーター		説明	型	状態
bodyclass	bodyclass	Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.	文字列	省略可能
border-c	border-c	border color 既定 #999	文字列	省略可能
border-s	border-s	border width in pixels 既定 1	文字列	省略可能
float	float	left|right|none 既定 left	文字列	省略可能
id	id	id image or text	文字列	省略可能
id-a	id-a	id horizontal alignment left/center/right/justify 既定 center	文字列	省略可能
id-c	id-c	id background color 既定 #d0d0d0	文字列	省略可能
id-fc	id-fc	id font color 既定 black	文字列	省略可能
id-h	id-h	id box height in pixels 既定 45	文字列	省略可能
id-lh	id-lh	id line height 既定 1.25em	文字列	省略可能
id-op	id-op	id other CSS parameters	文字列	省略可能
id-p	id-p	id cell padding 既定 0 1px 0 0	文字列	省略可能
id-s	id-s	id text size in points 既定 14	文字列	省略可能
id-w	id-w	id box width in pixels 既定 45	文字列	省略可能
info-class	info-class	Adds an HTML class attribute to the "info" HTML table-row, to allow for styling, emission of microformats, etc.	文字列	省略可能
info	info	info text or image	文字列	省略可能
info-a	info-a	info horizontal alignment left/center/right/justify 既定 left	文字列	省略可能
info-c	info-c	info background color 既定 #e0e0e0	文字列	省略可能
info-fc	info-fc	info font color 既定 black	文字列	省略可能
info-lh	info-lh	info line height 既定 1.25em	文字列	省略可能
info-op	info-op	info other CSS parameters	文字列	省略可能
info-p	info-p	info padding 既定 0 4px 0 4px	文字列	省略可能
info-s	info-s	info text size in points 既定 8	文字列	省略可能
nocat	nocat	block page category declarations (see WP:NOCAT) 既定 false	文字列	省略可能
usercategory	usercategory	user category (optional)	文字列	省略可能
usercategory2	usercategory2	user category (optional)	文字列	省略可能
usercategory3	usercategory3	user category (optional)	文字列	省略可能
usercategory4	usercategory4	user category (optional)	文字列	省略可能
usercategory5	usercategory5	user category (optional)	文字列	省略可能