Template:Box/doc: Difference between revisions
(ldstech has been retired) |
(→Usage: add new 'header' parameter) |
||
| (4 intermediate revisions by one other user not shown) | |||
| Line 10: | Line 10: | ||
| header || optional || Valid options: <tt>yes</tt> or <tt>no</tt>.<br />Default: yes. | | header || optional || Valid options: <tt>yes</tt> or <tt>no</tt>.<br />Default: yes. | ||
|- | |- | ||
| | | color || optional || Valid options: <tt>ldstech</tt>, <tt>pink</tt>, <tt>orange</tt>, <tt>yellow</tt>, <tt>green</tt>, <tt>blue</tt> and <tt>purple</tt>.<br />Default: Gray box title, white background for body, shades of gray for borders. | ||
|- | |- | ||
| float || optional || Valid options: <tt>left</tt> or <tt>right</tt>.<br />Default: left. | | float || optional || Valid options: <tt>left</tt> or <tt>right</tt>.<br />Default: left. | ||
| Line 20: | Line 18: | ||
| width || optional || Values can be expressed in either % or px.<br />Default: adjusts to width of content. | | width || optional || Values can be expressed in either % or px.<br />Default: adjusts to width of content. | ||
|- | |- | ||
| title || mandatory || The title of the box | | title || mandatory || The title of the box. | ||
|- | |- | ||
| content || mandatory || The content to be displayed in the box | | content || mandatory || The content to be displayed in the box. | ||
|- | |- | ||
|} | |} | ||
| Line 88: | Line 86: | ||
}} | }} | ||
</pre> | </pre> | ||
|- | |||
|{{Box | |||
| color=ldstech | |||
| float=right | |||
| width=240px | |||
| title=LDSTech Colors | |||
| content=This box uses the default colors | |||
for the LDSTech skin of the wiki. | |||
}} | |||
|<pre> | |||
{{Box | |||
| color=ldstech | |||
| float=right | |||
| width=240px | |||
| title=LDSTech Colors | |||
| content=This box uses the default colors | |||
for the LDSTech skin of the wiki. | |||
}} | |||
</pre> | </pre> | ||
|- | |- | ||
| Line 101: | Line 116: | ||
| color=orange | | color=orange | ||
| content=This box is displayed with no header | | content=This box is displayed with no header | ||
}} | }} | ||
</pre> | </pre> | ||
Revision as of 16:05, 20 December 2011
 |
This is a documentation subpage for Template:Box (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Purpose[edit source]
To easily produce boxes with matching colored titles and borders.
Usage[edit source]
| Field Name | Usage | Description |
|---|---|---|
| header | optional | Valid options: yes or no. Default: yes. |
| color | optional | Valid options: ldstech, pink, orange, yellow, green, blue and purple. Default: Gray box title, white background for body, shades of gray for borders. |
| float | optional | Valid options: left or right. Default: left. |
| top | optional | If present, positions the box relatively using the specified offset. For example, "top=-60px" moves the box up 60 pixels. |
| width | optional | Values can be expressed in either % or px. Default: adjusts to width of content. |
| title | mandatory | The title of the box. |
| content | mandatory | The content to be displayed in the box. |
Examples[edit source]
|
{{Box
| title=Default Box
| content=This box has all default settings.
}}
| |||
|
{{Box
| color=blue
| float=right
| width=75%
| title=Blue Box
| content=This is some text.
}}
| |||
|
{{Box
| color=purple
| title=Purple Box
| content=Link to [[England]]<br>
<small>follow the link</small>
}}
| |||
|
{{Box
| color=green
| width=240px
| title=Green Box
| content=Lorem ipsum dolor sit amet,
consectetuer adipiscing elit, sed diam
nonummy nibh euismod tincidunt ut laoreet
dolore magna aliquam erat volutpat.
}}
| |||
|
{{Box
| color=ldstech
| float=right
| width=240px
| title=LDSTech Colors
| content=This box uses the default colors
for the LDSTech skin of the wiki.
}}
| |||
|
{{Box
| header=no
| color=orange
| content=This box is displayed with no header
}}
|