User:Rei/userbox/templates/userboxtop: Difference between revisions

From Perplex City Wiki
Jump to navigationJump to search
No edit summary
 
No edit summary
Line 2: Line 2:
!<big>{{{1|{{{toptext|[[Wikipedia:Userboxes|Userboxes]]}}}}}}</big>
!<big>{{{1|{{{toptext|[[Wikipedia:Userboxes|Userboxes]]}}}}}}</big>
|- align="center"
|- align="center"
|
|<noinclude>
{{boxboxbottom}}
==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.  {{tl|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==
<pre><nowiki>{{userboxtop
| align =
| backgroundcolor =
| bordercolor =
| extra-css =
| textcolor =
| toptext =
}}
 
[userboxes]
 
{{userboxbottom}}</nowiki></pre>
 
All of the parameters are '''optional'''.
 
===Customizing===
Detailed explanations of the parameters are below.
 
{| class="wikitable"
|-
! Parameter
! Valid values
|-
| <code>align</code>
| <code>left</code>, <code>center</code>, or <code>right</code> (default)
|-
| <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 utilize this (as well as a few other) forms of template-based userbox organization. Simply edit your userspace CSS override (for example, [[Special:Mypage/monobook.css|monobook.css]] for the Monobook skin) and add the following–
 
<code><nowiki>#userboxes { display: none; }</nowiki></code>

Revision as of 10:47, 3 July 2006

Userboxes

Template:Boxboxbottom

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. Template:Tl, 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 = 
| 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, center, or right (default)
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 Template:Tl. 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–

#userboxes { display: none; }