[Show/Hide Right Column]

noteNote
This page is to document what Tiki does. For feature requests and bug reports, please see corresponding page on dev site

Introduction and index to Wiki plugins
Print
Tags: timeline wiki plugin edit syntax google calendar guestbook
TOC Previous page Parent page Next page

Wiki Plugins

Wiki plugins are a powerful type of wiki syntax that allows you to embed features and interactive data and functions within all the types of pages in your tiki site (wiki pages, blogs, articles, forums, etc.). Here are some examples of what wiki plugins do:

  • Show images and videos and play audio files
  • Arrange content in rows and columns, create formatted tables and boxes
  • Show automated table of contents, backlinks, redirect to other pages
  • Display charts, gauges, drawings, maps
  • Display user and tracking information, query databases, show information from other pages
  • Etc., etc., etc

tipTip
Plugins are also easy to develop - see Create a Plugin for some tips on how to get started.

Distributed Plugins Documented on This Site

noteNote
When in the edit window of a page, click on the Image icon and then click on 'Plugins help' for a list of plugins and their descriptions with buttons for inserting the syntax and linking to the documentation.

Site Settings for Plugins

Enabling Plugins

If not enabled by default, the site administrator must enable a plugin before it can be used by (since 3.0) going to Admin Home > Editing and Plugins > Plugins (tab) and checking the "Enable" box of that plugin and clicking "Change Preferences."

Enable Edit Plugin Icons

On the same tab (Admin Home > Editing and Plugins > Plugins (tab)), a feature called "Enable edit plugin icons" can be enabled, which will place an Image icon wherever there's a plugin. This edit icon will display a popup input form when clicked so that the plugin can be edited without editing and saving the whole page.

Toggle Plugin Edit Icons

Also, "Toggle display of section and plugin edit icons" can be enabled (at Admin Home > Wiki > General Preferences (tab) > Edit (section)). This will place an icon at the top of every page for turning section and plugin edit icons on or off with a single click ( Image to toggle on and Image to toggle off).

Plugin Security

Plugins that are a potential security risk require approval by an administrator before they can be used - a notice will appear when that's the case.

Distributed Plugins versus Mods

Most plugins are bundled with the rest of the tiki software. The list of bundled plugins varies with each Tiki version - please see All Plugins for which are available in 2.0 through 4.0. The table of contents above is to the documentation for distributed plugins.

Some plugins are not installed by default with your tiki installation. They can be installed separately as a Mod. See Mods Type Wikiplugins for a list of these and links to their documentation, and see Mods User for information on how to install them.

Plugin Syntax

The way plugin syntax works in general is described below. The individual documentation page for a plugin also gives examples of the specific syntax for that plugin.

Regular Syntax

Most plugins have "begin" and "end" tags and use the following syntax: 

{PLUGINNAME(parameter1=value1|value2, parameter2=value)} 
content affected by plugin and called body or data
{PLUGINNAME}

  • Avoid spaces: No spaces in or around the tag names or parameter values

  • Case sensitive: Tags must be in all caps for regular syntax plugins

  • Ending tag: For some plugins, a forward slash can be used instead of a closing tag as follows:
    {AGENTINFO(info=>IP) /} instead of {AGENTINFO(info=>IP)}{AGENTINFO}
    This shortcut won't work for plugins that require text in the body of the plugin (between the tags).

  • Parameters:
    • For regular syntax plugins, parentheses are always necessary even if no parameters are set. For example: {CODE ()}
    • Parameters are separated by commas, values within a parameter are usually separated by vertical bars (|) (but check the documentation for that plugin to be sure)
    • Either = or => can be used to separate parameters from values
    • Parameter values may be enclosed in single or double quotes, but don't have to be. Example: {CODE(wrap= "1")}
    • Parameters you don't specify may be set to a default - check the documentation for that plugin for more information.

Special Syntax

The following plugins use a slightly different syntax: PluginBanner, PluginContent, PluginCookie, PluginDraw, PluginImg, PluginMaketoc, PluginRSS, PluginTOC.

Here's what's different about the syntax for these:

  • Only one tag, and it's in lower case
  • No parentheses for the parameters are needed
  • For example:
    {toc} instead of {TOC()}{TOC}
    {toc type=fancy} instead of {TOC(type=fancy)}{TOC}

Aliases

Contributors to this page: Gergely334 points  , Xavi36278 points  , wrihelp20 points  , sylvie4333 points  , rpg14 points  , rodrigo_sampaio , robferguson10 points  , Rick7121 points  , omstefanov448 points  , mlpvolt1895 points  , Marc Laporte5511 points  , lindon2331 points  , Jürgen Heckes471 points  , Greg Martin49 points  , fivos88 points  , Gary Cunningham-Lee996 points  and atilabelloquim5 points  .
Page last modified on Thursday 20 May, 2010 08:25:59 UTC by Gergely334 points .

SourceHistorySlides

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):