[Show/Hide Right Column]

Creates a box with a title bar
Print

Plugin Box

This Wiki Plugin creates a box with a title bar. Optionally, you can add title text, a background color, and/or a width (specified in pixels or a percentage of the available window space). The title bar is formatted using the CSS style used for module headings, so the box will look consistent no matter which theme is chosen.

To place a simple box around text , you can use the ^ tag, as explained in Wiki-Syntax Text.

Usage

Below is an example of the syntax:

{BOX([title=>title],[bg=>color],[width=>num[%]])}
 Text inside box
{BOX}
The square brackets [ ] indicate that the parameter is optional. The commas aren't needed unless you type two or more of the options.

ParameterAccepted valuesEffectSince
title text Text that appears in a one-line title box. Keep it short!. Title bar is formatted using the non-module box heading style defined in the current theme
bg anglophone color name or a hexadecimal color code, such as #FFFFFF (white) a background color
width number or % width of the box in pixels or, if followed by a percent sign, the width as a percentage of the available window area
alignleft or right or center
floatleft or right
classclass name 1.10
idhtml id 1.10

Examples

No options

This code,

{BOX()}
A whole lot a shakin goin on
{BOX}

Would produce:

A whole lot a shakin goin on

Title only

This code,

{BOX(title=>Tiki Rocks)}
A whole lot a shakin goin on
{BOX}

Would produce:

Tiki Rocks
A whole lot a shakin goin on

Title and background color

This code,

{BOX(title=>Tiki Rocks, bg=>#CCCCCC)}
A whole lot a shakin goin on
{BOX}

Would produce:

Tiki Rocks
A whole lot a shakin goin on

Title, background color, and width

This code,

{BOX(title=>Tiki Rocks, bg=>#CCCCCC,width=>90%)}
A whole lot a shakin goin on
{BOX}

Would produce:

Tiki Rocks
A whole lot a shakin goin on

Step by step instructions for beginners

To use the BOX plugin, do the following:

  1. Place the insertion point on a blank line.
  2. Define the box and the options you want (title, background color, and/or width ) by following these examples:
    1. Title: {BOX(title=>Title)}
    2. Background color: {BOX(bg=>#CCCCCC)}
    3. Width in pixels: {BOX(width=>256)}
    4. Width in percentage: {BOX(width=75%)
    5. All options: {BOX(title=>Title, bg=>#CCCCCC, width=>75%)}
  3. Type the text you would like to place within the box, and press Enter.
  4. Type {BOX} .

Help!

Did something go wrong?

  • Double-check your typing to make sure you have included all the necessary curly braces, commas, and parentheses.
  • If you're sure you typed the plugin syntax correctly, ask your administrator whether the BOX plugin is enabled.
Related pages

Contributors to this page: miarrobino23 points  , Xavi36278 points  , system , sylvie4333 points  and lindon2331 points  .
Page last modified on Thursday 25 February, 2010 00:30:15 UTC by miarrobino23 points .

Find by Page Name

Exact match

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki documentation and should correspond to development keywords (bug reports and feature requests):