Template:Olpcboxtop: Difference between revisions

From OLPC
Jump to navigation Jump to search
m (Template:Userboxtop moved to Template:Olpcboxtop: it's not for users only)
(selectable class - see Activity_microformat for why)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
{|class="userboxes" style="margin-left: {{{left|1}}}em;; margin-bottom: 0.5em; width: 248px; border: {{{bordercolor|#99B3FF}}} solid 1px; background-color: {{{backgroundcolor|#FFFFFF}}}; color: {{{textcolor|#000000}}}; float: {{{2|{{{align|right}}}}}}; {{{extra-css|}}}"
{|class="{{{class|userboxes}}}" style="margin-left: {{{left|1}}}em;; margin-bottom: 0.5em; width: 248px; border: {{{bordercolor|#99B3FF}}} solid 1px; background-color: {{{backgroundcolor|#FFFFFF}}}; color: {{{textcolor|#000000}}}; float: {{{2|{{{align|right}}}}}}; {{{extra-css|}}}"
|<div style="text-align: center; font-size: 120%; font-weight: bold;">{{{1|{{{toptext|[[Wikipedia:Userboxes|Userboxes]]}}}}}}</div><noinclude>
|<div style="text-align: center; font-size: 120%; font-weight: bold;">{{{1|{{{toptext|[[Olpcboxes]]}}}}}}</div><noinclude>
|}
|}
==Purpose==
==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.
To collect images or olpc & user boxes 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.


{{Pending|This documentation needs to be fully integated to the wiki.}}
==Usage==
==Usage==
<pre><nowiki>{{userboxtop
<nowiki>{{olpcboxtop</nowiki>
| align = &lt;!-- { <u>'''left'''</u> | right } --&gt;
| align =
| left = &lt;!-- Any left margin value. Defaults to <u>'''1'''</u>. --&gt;
| left =
| backgroundcolor = &lt;!-- Any [http://en.wikipedia.org/wiki/Web_colors web color] (name or <tt>#XXXXXX</tt> hex format). Defaults to <u>'''<tt>#FFFFFF</tt>'''</u>. --&gt;
| backgroundcolor =
| bordercolor = &lt;!-- Any [http://en.wikipedia.org/wiki/Web_colors web color] (name or <tt>#XXXXXX</tt> hex format). Defaults to <u>'''<tt>#99B3FF</tt>'''</u>. --&gt;
| bordercolor =
| extra-css = &lt;!-- Allows you to provide additional [http://en.wikipedia.org/wiki/Cascading_Style_Sheets CSS] style information. --&gt;
| extra-css =
| textcolor = &lt;!-- Any [http://en.wikipedia.org/wiki/Web_colors web color] (name or <tt>#XXXXXX</tt> hex format). Defaults to <u>'''<tt>#000000</tt>'''</u>. --&gt;
| textcolor =
| toptext = &lt;!-- Overrides the standard <u>'''[[[[Olpcboxes]]]]'''</u> text and link. Can include wiki-markup. --&gt;
| toptext =
}}
}}
[olpcboxes]
{{tl|olpcboxbottom}}


All of the parameters are '''optional'''. You may also insert breaks by using {{tl|olpcboxbreak}}. See that template for details.
[userboxes]


==Hiding olpcboxes==
{{userboxbottom}}</nowiki></pre>
You can hide olpcboxes 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>table.userboxes { display: none; }</nowiki></code>
All of the parameters are '''optional'''.


<code><nowiki>table.olpcboxes { display: none; }</nowiki></code>
===Customizing===
Detailed explanations of the parameters are below.


{{Pending|the above has to be determined & established}}
{| 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 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>table.userboxes { display: none; }</nowiki></code>


==See also==
==See also==
* [[Olpcboxes]]
*[[Template:Userboxbreak]]
*[[Template:Userboxbottom]]
* [[Template:Olpcboxbreak]]
* [[Template:Olpcboxbottom]]
{{WikipediaTemplate}}
{{WikipediaTemplate|name=Userboxtop}}
</noinclude>
</noinclude>

Latest revision as of 23:24, 27 July 2008

Purpose

To collect images or olpc & user boxes 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. {{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.

This documentation needs to be fully integated to the wiki.

Usage

{{olpcboxtop
 | align =           <!-- { left | right } -->
 | 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 [[Olpcboxes]] text and link. Can include wiki-markup. -->
 }}

[olpcboxes]

{{olpcboxbottom}}

All of the parameters are optional. You may also insert breaks by using {{olpcboxbreak}}. See that template for details.

Hiding olpcboxes

You can hide olpcboxes 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–

table.userboxes { display: none; }

table.olpcboxes { display: none; }

the above has to be determined & established

See also


This template was extracted, copied, adapted or otherwise inspired by an existing one in the Wikipedia, which is licensed under the GNU Free Documentation License.