Fullscreen
Loading...
 
[Show/Hide Right Column]

This page needs review

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.

Parameter Adv Accepted values Effect Since
title n 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 n anglophone color name or a hexadecimal color code, such as #FFFFFF (white) a background color
width n 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
align n left or right or center
float n left or right
class n class name 2
id n html id 2
style y CSS style definitions Any valid CSS style definition following proper semi-colon terminated syntax can go in this field. Definition in this field take precedence over the site theme or the clas field entry. 13


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.



Aliases for this page
Plugin Box

Contributors to this page: Vranicoff , pianoliv , lindon , sylvie , Xavi and system .
Page last modified on Sunday 17 November, 2013 03:12:35 CET by Vranicoff.

doc.tiki.org
[toggle]





Site Language

Keywords

These keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):



Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki