Difference between revisions of "Template:Userboxtop/doc"

From Geohashing
imported>Hijackal
(copy from en.wiki)
 
imported>JesseW
(no need for this to be copied here -- just refer to the copy at WP)
 
Line 1: Line 1:
{{Documentation subpage}}
+
See https://en.wikipedia.org/wiki/Template:Userboxtop/doc for documentation.
<!--
 
    PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
 
    YOU CAN EDIT THE TEMPLATE DOCUMENTATION BELOW THIS COMMENT
 
-->
 
 
 
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
 
| align          =
 
| left            =
 
| backgroundcolor =
 
| bordercolor    =
 
| extra-css      =
 
| textcolor      =
 
| toptext        =
 
}}
 
 
 
{{userboxname1}}
 
{{userboxname2}}
 
{{userboxname3}}
 
{{userboxname4}}
 
{{...etc}}}
 
 
 
{{userboxbottom}}
 
</pre>
 
 
 
=== Parameters ===
 
 
 
Detailed explanations of the parameters are below. All of the parameters are optional.
 
 
 
{| class="wikitable"
 
|-
 
! Parameter
 
! Valid values
 
|-
 
| <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>.
 
|-
 
| <code>toptext</code>
 
| Overrides the standard [[Wikipedia:Userboxes|Userbox]] text and link. Can include wiki-markup.
 
|}
 
 
 
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>
 
 
 
=== See also ===
 
 
 
* {{tl|Userboxbreak}}
 
* {{tl|Userboxbottom}}
 
* {{tl|Userboxside}}
 
 
 
<includeonly>
 
 
 
<!-- PLEASE ADD CATEGORIES BELOW THIS LINE, THANKS. -->
 
[[Category:User namespace templates]]
 
</includeonly>
 

Latest revision as of 05:33, 22 May 2012