Difference between revisions of "Template:Userboxtop/doc"

From Wazeopedia
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.
+
{|name="userboxes" id="userboxes" style="margin-left: 1em; margin-bottom: 0.5em; width: 242px; border: {{{bordercolor|#99B3FF}}} solid 1px; background-color: {{{backgroundcolor|#FFFFFF}}}; {{{extra-css|}}}" align="{{{2|{{{align|right}}}}}}"
 +
!<big>{{{1|{{{toptext|[[w:Wikipedia:Userboxes|Userboxes]]}}}}}}</big>
 +
|- align="center"
 +
|<noinclude>
 +
{{userboxbottom}}
 +
==Purpose==
 +
To collect userboxes into a single column grouping easily.
  
=== Usage ===
+
==Usage==
 
+
<pre><nowiki>{{userboxtop
<pre>
+
| bordercolor =  
{{ userboxtop
 
| toptext        =
 
| align          =
 
| left            =  
 
 
| backgroundcolor =  
 
| backgroundcolor =  
| bordercolor    =  
+
| align =
| extra-css       =
+
| toptext =  
| textcolor      =  
+
| extra-css =
 
}}
 
}}
  
{{userboxname1}}
+
[userboxes]
{{userboxname2}}
 
{{userboxname3}}
 
{{userboxname4}}
 
{{...etc}}}
 
 
 
{{userboxbottom}}
 
</pre>
 
 
 
=== Parameters ===
 
 
 
Detailed explanations of the parameters are below. All of the parameters are optional.
 
  
{| class="wikitable"
+
{{userboxbottom}}</nowiki></pre>
|-
 
! 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.
+
All of the parameters are '''optional'''.
  
=== Hiding userboxes ===
+
You may insert breaks by using {{tl|userboxbreak}}. See that template for details.
  
<code><nowiki>table.userboxes { display: none; }</nowiki></code>
+
==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–
  
== Redirects ==
+
<code><nowiki>#userboxes { display: none; }</nowiki></code>
* {{tl|Userboxtop}}
 
* {{tl|Boxboxtop}}
 
* {{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>
 
  
 +
==See also==
 +
*[[Template:userboxbreak]]
 +
*[[Template:userboxbottom]]
  
 
<includeonly>
 
<includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
+
[[Category:Template]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
  
 
</includeonly>
 
</includeonly>

Revision as of 22:16, 6 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.
Userboxes

Purpose

To collect userboxes into a single column grouping easily.

Usage

{{userboxtop
| bordercolor = 
| backgroundcolor = 
| align = 
| toptext = 
| extra-css =
}}

[userboxes]

{{userboxbottom}}

All of the parameters are optional.

You may 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, monobook.css for the Monobook skin) and add the following–

#userboxes { display: none; }

See also