Template:SideBox

From aroonn wiki
Jump to navigation Jump to search
You are viewing the documentation for Template:SideBox, which has been automatically transcluded from its documentation page. You may:
  • Edit the template; or:
  • Edit the documentation

This template provides a "side box", a box that contains material supplemental to the main text, and which appears off to the right hand side.

This template is derived from, and uses, the generic Template:Box. Related templates that you might find relevant are Template:FullBox and Template:TextBox. For more details, see the documentation for those templates.

What it does

This template provides a "side box", a box that contains material supplemental to the main text, and which appears off to the right hand side. The size and position of the box are decided for you, so all you have to supply are the colours and the text.

Usage

{{SideBox
 |bg=<background colour (HTML style)>
 |fg=<foreground colour (HTML style)>
 |br=<border colour (HTML style)>
 |text=<text>}}
 

All of the arguments are optional, including text.

bg and fg

These specify a background and foreground colour, respectively, in HTML style, eg #RGB or #RRGGBB. If either or both is missing, then the box will inherit the corresponding colour(s) from the page.

br

This specifies a border colour, in HTML style, eg #RGB or #RRGGBB. The border will be solid, 1 pixel wide. If this is missing, then the box will have a mid-dark grey border (#666666).

text

This specifies the content of the box, which may itself be plain text, wiki markup, HTML markup or other templates.

If this is missing, then the entire box is suppressed. This is useful for derived templates that rely on conditional code.

Related templates

This template uses the generic Template:Box. Related templates that you might find relevant are Template:FullBox and Template:TextBox. For more details, see the documentation for those templates.

To see a complete lystte of pages using this template, directly or indirectly, see "What links here" from the Tools menu.