Template:Userboxtop/doc

From WiiBrew
Jump to navigation Jump to search

Purpose

To collect images or userboxes into a single column grouping easily. This template is not just for userboxes; it is also an efficient way of creating a column of images to run along the side of an article. {{Gallery}}, by contrast, creates rows of images and is used when the images should not run alongside the text but rather should serve as a break in the text.

Usage

{{userboxtop
| align = 
| left =
| backgroundcolor = 
| bordercolor = 
| extra-css =
| textcolor = 
| toptext = 
}}

[userboxes]

{{userboxbottom}}

All of the parameters are optional.

Customizing

Detailed explanations of the parameters are below.

Parameter Valid values
align left or right (default)
left Any left margin value. 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 Allows you to provide additional CSS style information.
textcolor Any web color (name or #XXXXXX hex format). Defaults to #000000.
toptext Overrides the standard Userbox text and link. Can include wiki-markup.

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

Hiding userboxes

You can hide userboxes which utilize this (as well as a few other) forms of template-based userbox organization. Simply edit your userspace CSS override (for example, monobook.css for the Monobook skin) and add the following–

table.userboxes { display: none; }

See also