Jump to content

Template:Userboxtop/doc

From Wikipedia, the free encyclopedia

This template can be used to organize userboxes (or other user-page content) into a single column grouping.

Please do not use this in articles: for historic reasons this template uses different rules for floating alongside other templates and this will lead to unpredictable results. If you need to stack objects in an article for some reason, use {{stack}}. This template will add pages in the main namespace to Category:Articles incorrectly using userbox templates.

Usage

[edit]
{{Userboxtop
| toptext         = 
| toptextstyle    = 
| align           = 
| left            = 
| backgroundcolor = 
| bordercolor     = 
| extra-css       = 
| textcolor       = 
}}

{{userboxname1}}
{{userboxname2}}
{{userboxname3}}
{{userboxname4}}
{{...etc}}}

{{Userboxbottom}}

Note that {{Userboxbottom}} must be separated from the last userbox by a newline. In the absence of a newline, other text on the page may appear inside the confines of the userbox area.

Parameters

[edit]

All parameters are optional.

Parameter Description
toptext (or the first positional parameter) Overrides the default header "Userboxes". Can include wiki-markup.
toptextstyle Additional CSS code for the toptext.
align (or the second positional parameter) left or center or right (default)
left Left margin in CSS's ems. Defaults to 1.
backgroundcolor Any web color (name or #XXXXXX hex format). Defaults to #FFFFFF.
bordercolor Any web color (name or #XXXXXX hex format). Defaults to #99B3FF.
extra-css Additional CSS code for the box itself.
textcolor Any web color (name or #XXXXXX hex format). Defaults to #000000.

You may also insert breaks by using {{userboxbreak}}. See that template for details.

Hiding userboxes

[edit]

You can hide userboxes which use this (as well as a few other) forms of template-based userbox organization. Simply go to Special:Mypage/skin.css, which redirects to your current skin's CSS file, and add the following:

table.userboxes { display: none; }

Redirects

[edit]

See also

[edit]


TemplateData

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

TemplateData for Userboxtop

This template can be used to organize userboxes (or other user-page content) into a single column grouping. Please do *not* use this in articles. Please see https://en.wikipedia.org/wiki/Template:Userboxtop/doc for full documentation.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Header (toptext)toptext 1

Overrides the default header "Userboxes". Can include wiki-markup

Suggested values
About me Information Userboxes
Default
Userboxes
Example
About me
Linesuggested
Alignmentalign 2

Whether you want your userbox to be left-aligned or right-aligned. Value must be 'left' or 'right'.

Suggested values
left right
Default
right
Example
right
Linesuggested
Header style (toptextstyle)toptextstyle

Additional CSS code for the header (toptext).

Stringoptional
Text colourtextcolor

Default colour for text within this userbox. Any web color (name or #XXXXXX hex format). Defaults to #000000.

Suggested values
black #000000 crimson darkblue green
Default
#000000
Example
#000000
Lineoptional
Left margin sizeleft

Left margin size (in CSS ems). Defaults to 1

Default
1
Example
1
Numberoptional
Border colourbordercolor

Colour for the userbox border. Any web color (name or #XXXXXX hex format). Defaults to #99B3FF.

Suggested values
#99B3FF black grey #4A412A
Default
#99B3FF
Example
#99B3FF
Lineoptional
Background colourbackgroundcolor

Background colour for this userbox. Any web color (name or #XXXXXX hex format). Defaults to #FFFFFF.

Suggested values
#FFFFFF white lightgrey
Default
#FFFFFF
Example
#FFFFFF
Lineoptional
Extra CSSextra-css

Additional CSS code for the box itself.

Stringoptional