History: PluginBox
Preview of version: 18
Table of contents
To place a simple box around text , you can use the ^ tag, as explained in WikiCharacterFormattingDoc. The BOX plugin, one of several plugins that may be available on your Tiki site, 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.
- Title bar is formatted using the module heading style defined in the current theme
- Optionally sets :
- a background color
- a width in pixels or percentage
Quick Reference
Here's the BOX plugin's syntax :
{BOX([title=>title],[bg=>color],[width=>num[%]])} Text inside box {BOX}
Note the following:
- title is text that appears in a one-line title box. Keep it short!
- color is an anglophone color name or a hexadecimal color code, such as #FFFFFF (white).
- num is the width of the box in pixels or, if followed by a percent sign, the width as a percentage of the available window area.
TIP: Even though the title is optional, be sure to define a title. The default title is "Message Box", which isn't very helpful to your readers.
The square brackets [ ] indicate that the parameter is optional. The commas aren't needed unless you type two or more of the options.
Examples
No options (note that Tiki supplies a default title automatically, but you probably don't want this title):
A whole lot a shakin goin on
Title only:
A whole lot a shakin goin on
Title and background color:
A whole lot a shakin goin on
Title, background color, and width:
A whole lot a shakin goin on
Step by step instructions for beginners
To use the BOX plugin, do the following:
- Place the insertion point on a blank line.
- Define the box and the options you want (title, background color, and/or width ) by following these examples:
- Title: {BOX(title=>Title)}
- Background color: {BOX(bg=>#CCCCCC)}
- Width in pixels: {BOX(width=>256)}
- Width in percentage: {BOX(width=75%)
- All options: {BOX(title=>Title, bg=>#CCCCCC, width=>75%)}
- Type the text you would like to place within the box, and press Enter.
- 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.