Template:Userbox: Difference between revisions

From SkyCorp Global
Jump to navigation Jump to search
No edit summary
(Blanked the page)
Tag: Blanking
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{{info}}}


 Template documentation[view] [edit] [history] [purge]
This template uses Lua:
Module:Userbox (sandbox)
This template is used on approximately 320,000 pages, or roughly 1% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. 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 must 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/testcasesOnce 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/sandboxTO https://en.wikipedia.org/wiki/Template:Userbox/WhateverYourNewBoxNameIsIf 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 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
CodeResult
{{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
bodyclassmicroformat 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):
<nowiki> | title = …the books of <span class="fn">[[Iain Banks]]</span> </nowiki>
...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.
Template Data
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Userbox in articles based on its TemplateData.
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.
Template parameters[Edit template data]
This template prefers block formatting of parameters.
ParameterDescriptionTypeStatusBody classbodyclass
Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.
StringoptionalFloatfloat
left|right|none
Suggested valuesleft right noneStringoptionalBorder colorborder-c border-color
Color of the outer border
DefaultStringoptionalBorder widthborder-s border-width
border width in pixels
DefaultNumberoptionalLogoid 3 logo
id image or text
ContentsuggestedLogo content horizontal alignmentid-a
Horizontal alignment of logo content; left/center/right/justify
Suggested valuesleft center right justifyStringoptionalLogo background colorlogo-background
Background color of logo
DefaultStringoptionalid-cid-c 1
Two-in-one alias for border color and logo background color. Lower priority than border-c and logo-background
ExampleStringoptionalLogo font colorid-fc logo-color
Logo font color; if not specified, defaults to info font color
DefaultStringoptionalLogo heightid-h logo-height
Logo box height in pixels
DefaultNumberoptionalLogo font sizeid-s 5 logo-size
Logo text size in points
DefaultStringoptionalLogo line heightid-lh logo-line-height
Logo line height
DefaultStringoptionalLogo paddingid-p logo-padding
Logo cell padding
DefaultStringoptionalLogo widthid-w logo-width
id box width in pixels
DefaultNumberoptionalLogo CSS classesid-class
CSS class or classes for the logo; optional
DefaultStringoptionalExtra logo stylingid-op logo-other-param
Add additional arbitrary CSS styling to the logo
ExampleStringoptionalInfoinfo 4
info text or image
ContentrequiredInfo content horizontal alignmentinfo-a
Horizontal alignment of info content; left/center/right/justify
Suggested valuesleft center right justifyStringoptionalInfo background colorinfo-c 2 info-background
Info background color
DefaultStringoptionalInfo font colorinfo-fc info-color
info font color
DefaultStringoptionalInfo line heightinfo-lh info-line-height
Info line height
DefaultStringoptionalInfo paddinginfo-p info-padding
info padding
DefaultStringoptionalInfo font sizeinfo-s info-size
info text size in points
DefaultNumberoptionalInfo CSS classesinfo-class
Adds an HTML class attribute to the "info" HTML table-row, to allow for styling, emission of microformats, etc.
StringoptionalExtra info stylinginfo-op info-other-param
Add additional arbitrary CSS styling to the info
ExampleStringoptionalnocatnocat
block page category declarations (see WP:NOCAT)
DefaultStringoptionalusercategoryusercategory
user category (optional)
Stringoptionalusercategory2usercategory2
user category (optional)
Stringoptionalusercategory3usercategory3
user category (optional)
Stringoptionalusercategory4usercategory4
user category (optional)
Stringoptionalusercategory5usercategory5
user category (optional)
Stringoptional
See also
vte
Userbox metatemplatesLeft{{Userbox}}{{Userbox-w}} — wide variation{{Userbox-flag}} — for location-related userboxes{{Userbox-level}} — for skill-related userboxesRight{{Userbox-r}}{{Userbox-w-r}} — wide variation{{userbox-flag-r}} — for location-related userboxes{{Userbox-level-r}} — for skill-related userboxesLeft and Right{{Userbox-2}}None{{Userbox-m}}
See also: Module:Userbox, Wikipedia:Userboxes, Wikipedia:Userboxes/Userboxes
The above documentation is transcluded from Template:Userbox/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.

Latest revision as of 23:30, 6 February 2025