imported>DB1729: Reverted 2 edits by 109.93.137.28 (talk): Unexplained blanking (TW)

2020-08-30T09:08:14Z

Reverted 2 edits by 109.93.137.28 (talk): Unexplained blanking (TW)

imported>Andrybak: tweak category sort key

2020-06-29T18:36:32Z

tweak category sort key

New page

{{Documentation subpage}}
{{Lua|Module:Userbox}}
{{High-use}}


This template can be used to quickly create a [[Wikipedia:Userboxes|userbox]] for display on a user's [[Wikipedia:User pages|user page]] without having to know HTML or Wikitable syntax.

'''''[[WP:NFCC|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-r/sandbox]] or [[Template:Userbox-r/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''' [{{Fullurl:Template:Userbox-r/sandbox}} http://en.wikipedia.org/wiki/Template:Userbox-r/sandbox]
** '''TO''' [{{Fullurl:Template:Userbox-r/sandbox}} https://en.wikipedia.org/wiki/Template:Userbo-r/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 ==

<pre style="overflow: auto">
{{userbox-r
| bodyclass = 
| border-c = 
| border-s = 
| float = 
| id = 
| id-a = 
| id-c = 
| id-fc = 
| id-h = 
| id-lh = 
| id-op = 
| id-p = 
| id-s = 
| id-w = 
| info-class = 
| info = 
| info-a = 
| info-c = 
| info-fc = 
| info-lh = 
| info-op = 
| info-p = 
| info-s = 
| nocat = 
| usercategory = 
| usercategory2 = 
| usercategory3 = 
| usercategory4 = 
| usercategory5 = 
}}
</pre>
* 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:

<pre>
{{userbox-r
| border-c =
| id =
| id-c =
| id-fc =
| id-s =
| info =
| info-c =
| info-fc =
| info-lh =
| info-s =
}}</pre>

== Examples ==
{|
! style="width: 300px;" | Code
! Result
|-
| <pre>{{userbox-r
| border-c = #aaffaa
| border-s = 2
| id = foo
| id-c = #ffffee
| id-s = 20
| info = ''foo bar''
| info-c = #ffeeff
| info-s = 12
}}</pre> || {{userbox-r|id=foo|id-s=20|id-c=#ffffee|info=''foo bar''|info-c=#ffeeff|info-s=12|border-c=#aaffaa|border-s=2}}
|-
| colspan="2"| 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.
|-
| <pre>{{userbox-r
| 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
}}</pre> || {{userbox-r|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|border-c=#aaffaa|border-s=2}}
|-
| colspan="2"| 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.
|-
| <pre>{{userbox-r
| 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
}}</pre> || {{userbox-r|id=foo logo|id-s=14|id-lh=1.1em|id-c=#ffffee|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-s=8|info-p=1pt|info-lh=1.05em|border-c=#aaffaa|border-s=1}}
|-
| colspan="2"| Below example is for advanced users, showing how we can specify other [[Cascading Style Sheets|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.
|-
| <pre>{{userbox-r
| 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
}}</pre> || colspan="2"| {{Userbox-r|id=foo logo|id-s=14|id-lh=1.1em|id-c=#ffe|info=foo bar|info-c=#fef|info-s=14|border-c=#afa|border-s=2}}   {{Userbox-r|id=foo logo|id-s=14|id-lh=1.1em|id-c=#ffe|info=foo bar|info-c=#fef|info-s=14|info-op=font-family: 'Courier New', monospace; text-decoration: wavy overline green;|border-c=#afa|border-s=2}}
|}

==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:

<pre>
| bodyclass = vcard
</pre>

''or''

<pre>
| info-class = vcard
</pre>

''then'' (for example):

<pre><nowiki>
| title = …the books of [[Iain Banks]]
</nowiki></pre>

...and so forth.

Examples include:

* <code>{{tlu|User:UBX/Iain Banks}}</code> - person
* {{tlx|User Microformats}} - group (WikiProject Microformats)
* {{tlx|User Brum}} - place (Birmingham)

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

== Template Data ==
{{TemplateData header}}

<TemplateData>{
"description": "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.",
"params": {
"bodyclass": {
"label": "bodyclass",
"description": "Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.",
"type": "string",
"default": "",
"required": false
},"border-c": {
"label": "border-c",
"description": "border color",
"type": "string",
"default": "#999",
"required": false
},"border-s": {
"label": "border-s",
"description": "border width in pixels",
"type": "string",
"default": "1",
"required": false
},"float": {
"label": "float",
"description": "left|right|none",
"type": "string",
"default": "left",
"required": false
},"id": {
"label": "id",
"description": "id image or text",
"type": "string",
"default": "",
"required": false
},"id-a": {
"label": "id-a",
"description": "id horizontal alignment left/center/right/justify",
"type": "string",
"default": "center",
"required": false
},"id-c": {
"label": "id-c",
"description": "id background color",
"type": "string",
"default": "#d0d0d0",
"required": false
},"id-fc": {
"label": "id-fc",
"description": "id font color",
"type": "string",
"default": "black",
"required": false
},"id-h": {
"label": "id-h",
"description": "id box height in pixels",
"type": "string",
"default": "45",
"required": false
},"id-lh": {
"label": "id-lh",
"description": "id line height",
"type": "string",
"default": "1.25em",
"required": false
},"id-op": {
"label": "id-op",
"description": "id other CSS parameters",
"type": "string",
"default": "",
"required": false
},"id-p": {
"label": "id-p",
"description": "id cell padding",
"type": "string",
"default": "0 0 0 1px",
"required": false
},"id-s": {
"label": "id-s",
"description": "id text size in points",
"type": "string",
"default": "14",
"required": false
},"id-w": {
"label": "id-w",
"description": "id box width in pixels",
"type": "string",
"default": "45",
"required": false
},"info-class": {
"label": "info-class",
"description": "Adds an HTML class attribute to the \"info\" HTML table-row, to allow for styling, emission of microformats, etc.",
"type": "string",
"default": "",
"required": false
},"info": {
"label": "info",
"description": "info text or image",
"type": "string",
"default": "",
"required": false
},"info-a": {
"label": "info-a",
"description": "info horizontal alignment left/center/right/justify",
"type": "string",
"default": "left",
"required": false
},"info-c": {
"label": "info-c",
"description": "info background color",
"type": "string",
"default": "#e0e0e0",
"required": false
},"info-fc": {
"label": "info-fc",
"description": "info font color",
"type": "string",
"default": "black",
"required": false
},"info-lh": {
"label": "info-lh",
"description": "info line height",
"type": "string",
"default": "1.25em",
"required": false
},"info-op": {
"label": "info-op",
"description": "info other CSS parameters",
"type": "string",
"default": "",
"required": false
},"info-p": {
"label": "info-p",
"description": "info padding",
"type": "string",
"default": "0 4px 0 4px",
"required": false
},"info-s": {
"label": "info-s",
"description": "info text size in points",
"type": "string",
"default": "8",
"required": false
},"nocat": {
"label": "nocat",
"description": "block page category declarations (see WP:NOCAT)",
"type": "string",
"default": "false",
"required": false
},"usercategory": {
"label": "usercategory",
"description": "user category (optional)",
"type": "string",
"default": "",
"required": false
},"usercategory2": {
"label": "usercategory2",
"description": "user category (optional)",
"type": "string",
"default": "",
"required": false
},"usercategory3": {
"label": "usercategory3",
"description": "user category (optional)",
"type": "string",
"default": "",
"required": false
},"usercategory4": {
"label": "usercategory4",
"description": "user category (optional)",
"type": "string",
"default": "",
"required": false
},"usercategory5": {
"label": "usercategory5",
"description": "user category (optional)",
"type": "string",
"default": "",
"required": false
}
}}</TemplateData>

==See also==
{{UBT}}
<includeonly>{{Sandbox other||

[[Category:Userboxes|*]]
[[Category:User namespace templates]]
[[Category:Wikipedia metatemplates]]
}}</includeonly>

← Older revision	Revision as of 09:08, 30 August 2020
(No difference)

Template:Userbox-r/doc - Revision history

imported>DB1729: Reverted 2 edits by 109.93.137.28 (talk): Unexplained blanking (TW)

imported>Andrybak: tweak category sort key