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

Introduction and index to Wiki plugins
PDF Print

Wiki Plugins

Tiki's wiki plugins are powerful extensions to the basic wiki syntax that allows you to embed features and interactive data and functions in any wiki text area in your Tiki site. This includes wiki pages, blogs, articles, forums, and so on... nearly every feature!

For example, you can use wiki plugins to:
  • Show images, and play videos or audio files
  • Arrange content in rows and columns and create specially formatted tables and boxes
  • Automatically build a table of contents, display backlinks, or redirect visitors to other pages
  • Display charts, gauges, drawings, and maps
  • Display user and tracking information, query databases, or show information from other pages
  • And much more.
Close
tipNote
Even though they are called plugins, nearly all are included with the default Tiki installation. There are no additional "add-ons" to be installed in order to use these plugins.

Most plugins are enabled by default. For the others, simply enable them from the Text Area Admin page. Starting in Tiki3, some plugins require admin-level approval before becoming "live" on a page.
Close
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


Close
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.

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.

There are two basic styles of syntax, upper case, which works for virtually all plugins, and lower case, which works for plugins that do not require a body.

Upper Case Syntax

This syntax works for virtually all plugins (an exception is {maketoc}) and here is an example:
{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, except between parameter names

  • Case sensitive: Tags must be in all caps

  • Ending tag: For plugins that do not require text in the body of the plugin (between the tags), a forward slash can be used instead of a closing tag as follows:
    {AGENTINFO(info="IP") /} instead of {AGENTINFO(info="IP")}{AGENTINFO}

  • Parameters:
    • Parentheses are always necessary even if no parameters are set. For example: {CODE()}
    • Parameters are separated by spaces, commas, or a comma and a space. Values within a parameter are are usually separated by vertical bars (|) or colons (:) - check the documentation for the specific plugin to be sure
    • Either = or => can be used to separate parameters from values
    • It is best to enclose parameter values in single or double quotes, although the plugin may work without quotes if there are no spaces or unusual characters in the parameter values. Example: {CODE(wrap="1")}
    • Parameters you don't specify may be set to a default - check the documentation for that plugin for more information.

Lower Case Syntax

For plugins that do not require a body (i.e., content between the beginning and ending plugin tags), the lower case syntax can be used (since Tiki6). Here's an example:
{pluginname parameter1="value1|value2" parameter2="value"}

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}

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.

Pending approval notification

Since Tiki7.0, there is a setting called "Plugin pending notification" in "Admin home > Editing and plugins > Plugins (tab)", which allows users in groups with the permission tiki_p_plugin_approve to receive an email notification each time a new plugin call is added in a wiki page as pending approval.

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 from version 2.0 on. 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.

Aliases





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