الگو:Userbox/doc

This is a documentation subpage for الگو:Userbox.
It contains usage information, categories, inter-language links and other content that is not part of the original الگو page.

خطای اسکریپتی: پودمان «Lua banner» وجود ندارد.

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/WhateverYourNewBoxNameIs
- TO http://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.

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)-->
| border-s      = <!--border width in pixels (default=1)-->
| float         = <!--left|right|none (default=left)-->
| id            = <!--id image and/or text (standard height=x45px)-->
| id-a          = <!--id horizontal alignment left/center/right/justify (default=center)-->
| id-c          = <!--id background color (default=#d0d0d0)-->
| id-fc         = <!--id font color (default=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 and/or image-->
| info-a        = <!--info horizontal alignment left/center/right/justify (default=left)-->
| info-c        = <!--info background color (default=#e0e0e0)-->
| 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 (default=false)-->
| usercategory  = <!--user category (optional)-->
| usercategory2 = <!--user category (optional)-->
| usercategory3 = <!--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        = 
| nocat         = {{{nocat|}}}
| usercategory  = 
}}

Examples

Code

Result

{{userbox}}

info

{{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 in between 
text lines & padding space in 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 in between text lines & padding space in 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-align" to change the alignment from the default parameters. At below, on the right side are two userboxes: top one is displayed without the "font-family" or "text-align" parameters; and the bottom userbox is displayed by using the below codes, 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'; text-align:center;
| 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.

Examples include:

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

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

Template Data

This is the TemplateData documentation for this template used by VisualEditor and other tools.

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.

پارامترهای الگو
پارامتر		توضیحات	نوع	وضعیت
bodyclass	`bodyclass`	Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc. پیش‌فرض id-c	رشته	اختیاری
border-c	`border-c`	border color پیش‌فرض	رشته	اختیاری
border-s	`border-s`	border width in pixels پیش‌فرض 1	رشته	اختیاری
float	`float`	left\|right\|none پیش‌فرض left	رشته	اختیاری
id	`id`	id image and/or text پیش‌فرض x45px	رشته	اختیاری
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 and/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 پیش‌فرض false	رشته	اختیاری
usercategory	`usercategory`	user category (optional) پیش‌فرض	رشته	اختیاری
usercategory2	`usercategory2`	user category (optional) پیش‌فرض	رشته	اختیاری
usercategory3	`usercategory3`	user category (optional) پیش‌فرض	رشته	اختیاری