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.
See also: Plugin Remarksbox
Tip
To place a simple box around text , you can use the
^ tag, as explained in Wiki-Syntax Text.
Parameters
Create a formatted box with a title barIntroduced in Tiki 1.
Go to the source code
Preferences required: wikiplugin_box
| Parameters | Accepted Values | Description | Default | Since |
|---|---|---|---|---|
| (body of plugin) | text | |||
width |
text | In pixels or percentage. Default value is 100%. |
1 | |
bg |
As defined by CSS, name, or color hex code. | 1 | ||
title |
text | Displayed above the content | 1 | |
style |
text | Enter CSS styling tags for the div type used e.g. padding: 5px | 13.0 | |
id |
text | ID | 1 | |
class |
Apply custom CSS class to the box. | 1 | ||
clear |
(blank) 1 0 |
Text, etc. is not allowed to wrap around the box if this parameter is set to 1 (Yes) |
1 | |
float |
(blank) left right |
Set the alignment for the entire box. For elements with a width of less than 100%, other elements
will wrap around it unless the clear parameter is appropriately set.) |
1 | |
align |
left right center |
Aligns the text within the box (left-aligned by default) | left | 1 |
Examples
No options
This code:
Copy to clipboard
{BOX()} A whole lot a shakin goin on {BOX}
Would produce:
A whole lot a shakin goin on
Title only
This code:
Copy to clipboard
{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:
Copy to clipboard
{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:
Copy to clipboard
{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:
- 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%")}
- Title:
- 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.