Difference between revisions of "Template:Userboxtop/doc"

From Wazeopedia
Line 2: Line 2:
 
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
 
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
 
==Purpose==
 
==Purpose==
To collect userboxes into a single column grouping easily.
+
This collects 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 a page.
  
==Usage==
+
===Usage===
<pre><nowiki>{{userboxtop
+
<pre>{{userboxtop
 +
| align =
 +
| left =
 +
| backgroundcolor =
 
| bordercolor =  
 
| bordercolor =  
| backgroundcolor =  
+
| extra-css =
| align =  
+
| textcolor =  
 
| toptext =  
 
| toptext =  
| extra-css =
 
 
}}
 
}}
  
 
[userboxes]
 
[userboxes]
  
{{userboxbottom}}</nowiki></pre>
+
{{userboxbottom}}</pre>
  
 
All of the parameters are '''optional'''.
 
All of the parameters are '''optional'''.
  
You may insert breaks by using {{tl|userboxbreak}}. See that template for details.
+
===Customizing===
 +
Detailed explanations of the parameters are below.
 +
 
 +
{| 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 [http://en.wikipedia.org/wiki/Web_colors web color] (name or <tt>#XXXXXX</tt> hex format). Defaults to <tt>#FFFFFF</tt>.
 +
|-
 +
| <code>bordercolor</code>
 +
| Any [http://en.wikipedia.org/wiki/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 [http://en.wikipedia.org/wiki/Cascading_Style_Sheets CSS] style information.
 +
|-
 +
| <code>textcolor</code>
 +
| Any [http://en.wikipedia.org/wiki/Web_colors web color] (name or <tt>#XXXXXX</tt> hex format). Defaults to <tt>#000000</tt>.
 +
|-
 +
| <code>toptext</code>
 +
| Overrides the standard [[Wikibooks: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==
+
===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–
+
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/vector.css|vector.css]] for the Vector skin) and add the following:
  
<code><nowiki>#userboxes { display: none; }</nowiki></code>
+
<code><nowiki>table.userboxes { display: none; }</nowiki></code>
  
==See also==
+
===See also===
*[[Template:userboxbreak]]
+
*[[Template:Userboxbreak]]
*[[Template:userboxbottom]]
+
*[[Template:Userboxbottom]]
  
 
<includeonly>
 
<includeonly>

Revision as of 23:11, 7 February 2016

This is a documentation subpage for Template:Userboxtop.
It contains usage information, categories and other content that is not part of the original template page.

Purpose

This collects 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 a page.

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, vector.css for the Vector skin) and add the following:

table.userboxes { display: none; }

See also