Template:Userboxtop/doc

From The Redstone Compendium, the online reference for all of technical Minecraft
Jump to navigation Jump to search

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

{{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

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

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

See also


<templatedata> { "params": { "left": { "label": "Left margin size", "description": "Left margin size (in CSS ems). Defaults to 1", "example": "1", "type": "number", "default": "1" }, "bordercolor": { "label": "Border colour", "description": "Colour for the userbox border. Any web color (name or #XXXXXX hex format). Defaults to #99B3FF.", "example": "#99B3FF", "type": "line", "suggestedvalues": [ "#99B3FF", "black", "grey",

               "#4A412A"

], "default": "#99B3FF" }, "backgroundcolor": { "label": "Background colour", "description": "Background colour for this userbox. Any web color (name or #XXXXXX hex format). Defaults to #FFFFFF.", "example": "#FFFFFF", "type": "line", "suggestedvalues": [ "#FFFFFF", "white", "lightgrey" ], "default": "#FFFFFF" }, "textcolor": { "label": "Text colour", "description": "Default colour for text within this userbox. Any web color (name or #XXXXXX hex format). Defaults to #000000.", "example": "#000000", "type": "line", "suggestedvalues": [ "black", "#000000", "crimson", "darkblue", "green" ], "default": "#000000" }, "align": { "aliases": [ "2" ], "label": "Alignment", "description": "Whether you want your userbox to be left-aligned or right-aligned. Value must be 'left' or 'right'.", "example": "right", "type": "line", "suggestedvalues": [ "left", "right" ], "default": "right", "suggested": true }, "extra-css": { "label": "Extra CSS", "description": "Additional CSS code for the box itself.", "type": "string" }, "toptextstyle": { "label": "Header style (toptextstyle)", "description": "Additional CSS code for the header (toptext).", "type": "string" }, "toptext": { "aliases": [ "1" ], "label": "Header (toptext)", "description": "Overrides the default header \"Userboxes\". Can include wiki-markup", "example": "About me", "type": "line", "suggestedvalues": [ "About me", "Information", "Userboxes" ], "default": "Userboxes", "suggested": true } }, "description": "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.", "paramOrder": [ "toptext", "align", "toptextstyle", "textcolor", "left", "bordercolor", "backgroundcolor", "extra-css" ], "format": "block" } </templatedata>