Editing Template:Userboxtop/doc

{{Documentation subpage}}
{{High-use|50262}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

This template can be used to collect images or userboxes into a single column grouping easily.

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 {{tl|stack}}. This template will add pages in the [[WP:NS0|main namespace]] to [[:category:articles incorrectly using userbox templates]] if used there.

=== Usage ===

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

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

{{userboxbottom}}
</pre>
Note that <nowiki>{{userboxbottom}}</nowiki>  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 ===

Detailed explanations of the parameters are below. All of the parameters are optional.

{| class="wikitable"
|-
! Parameter
! Valid values
|-
| <code>toptext</code>
| (or the first positional parameter) Overrides the standard "'''[[Wikipedia:Userboxes|Userboxes]]'''" text and link. Can include wiki-markup.
|-
| <code>align</code>
| <code>left</code> or <code>right</code> (default) <!-- <code>center</code> does not work -->
|-
| <code>left</code>
| Any left margin value. Defaults to 1.
|-
| <code>backgroundcolor</code>
| Any [[Web colors|web color]] (name or <tt>#XXXXXX</tt> hex format). Defaults to <tt>#FFFFFF</tt>.
|-
| <code>bordercolor</code>
| Any [[Web colors|web color]] (name or <tt>#XXXXXX</tt> hex format). Defaults to <tt>#99B3FF</tt>.
|-
| <code>extra-css</code>
| Allows you to provide additional [[Cascading Style Sheets|CSS]] style information.
|-
| <code>textcolor</code>
| Any [[Web colors|web color]] (name or <tt>#XXXXXX</tt> hex format). Defaults to <tt>#000000</tt>.
|}

You may also insert breaks by using {{tl|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 [[WP:SKIN|skin]]'s CSS file, and add the following–

<code><nowiki>table.userboxes { display: none; }</nowiki></code>

== Redirects ==
* {{tl|BoxTop}}
* {{tl|Boxboxtop}}
* {{tl|Boxtop}}
* {{tl|User box top}}
* {{tl|Userbox top}}

== See also ==

* {{tl|Userboxbreak}}
* {{tl|Userboxbottom}}
* {{tl|Userboxside}}

<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:User namespace templates]]
[[Category:Userbox arrangement templates]]
}}</includeonly>