Difference between revisions of "Template:Userboxtop/doc"

From Wazeopedia
m (updated category)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{doc subpage}}
 
{{doc subpage}}
 
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
 
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
This template can be used to collect images or userboxes into a single column grouping easily.
+
==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 ===
+
===Usage===
 
+
<pre>{{userboxtop
<pre>
+
| align =  
{{ userboxtop
+
| left =
| toptext        =
 
| align           =  
 
| left           =  
 
 
| backgroundcolor =  
 
| backgroundcolor =  
| bordercolor     =  
+
| bordercolor =  
| extra-css       =
+
| extra-css =
| textcolor       =  
+
| textcolor =
 +
| toptext =  
 
}}
 
}}
  
{{userboxname1}}
+
[userboxes]
{{userboxname2}}
 
{{userboxname3}}
 
{{userboxname4}}
 
{{...etc}}}
 
  
{{userboxbottom}}
+
{{userboxbottom}}</pre>
</pre>
 
  
=== Parameters ===
+
All of the parameters are '''optional'''.
  
Detailed explanations of the parameters are below. All of the parameters are optional.
+
===Customizing===
 +
Detailed explanations of the parameters are below.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 33: Line 28:
 
! Parameter
 
! Parameter
 
! Valid values
 
! 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>align</code>
Line 44: Line 36:
 
|-
 
|-
 
| <code>backgroundcolor</code>
 
| <code>backgroundcolor</code>
| Any [[Web colors|web color]] (name or <tt>#XXXXXX</tt> hex format). Defaults to <tt>#FFFFFF</tt>.
+
| 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>
 
| <code>bordercolor</code>
| Any [[Web colors|web color]] (name or <tt>#XXXXXX</tt> hex format). Defaults to <tt>#99B3FF</tt>.
+
| 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>
 
| <code>extra-css</code>
| Allows you to provide additional [[Cascading Style Sheets|CSS]] style information.
+
| Allows you to provide additional [http://en.wikipedia.org/wiki/Cascading_Style_Sheets CSS] style information.
 
|-
 
|-
 
| <code>textcolor</code>
 
| <code>textcolor</code>
| Any [[Web colors|web color]] (name or <tt>#XXXXXX</tt> hex format). Defaults to <tt>#000000</tt>.
+
| 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.
 
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/vector.css|vector.css]] for the Vector skin) and add the following:
  
 
<code><nowiki>table.userboxes { display: none; }</nowiki></code>
 
<code><nowiki>table.userboxes { display: none; }</nowiki></code>
  
== Redirects ==
+
===See also===
* {{tl|Userboxtop}}
+
*[[Template:Userboxbreak]]
* {{tl|Boxboxtop}}
+
*[[Template:Userboxbottom]]
* {{tl|Boxtop}}
 
* {{tl|User box top}}
 
* {{tl|Userbox top}}
 
 
 
== See also ==
 
 
 
* {{tl|Userboxbreak}}
 
* {{tl|Userboxbottom}}
 
* {{tl|Userboxside}}
 
 
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<!-- Categories go here and interwikis go in Wikidata. -->
 
[[Category:Templates]]
 
}}</includeonly>
 
 
 
  
 
<includeonly>
 
<includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
+
[[Category:User namespace templates]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
  
 
</includeonly>
 
</includeonly>

Latest revision as of 23:40, 6 May 2017

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