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

Distributed Plugins Documented on This Site

• PluginAddToCart : Display a button for adding items to the shopping cart
• PluginAgentinfo : Show user's browser and server information
• PluginAlink : Create a link to an anchor in a wiki page.
• PluginAname : Create an anchor into a wiki page that can be linked to
• PluginAnnotation : Annotate an image
  • PluginAnnotation example
• PluginArchiveBuilder : Define an archive that can be downloaded
• PluginArticle : Display a component of an article in a wiki page
• PluginArticles : Display multiple articles in a wiki page
• PluginAttach : Display an attachment or a list of attachments
• PluginAuthor
• PluginAvatar : Displays a user's avatar
• PluginBack : Create a link that goes back one page in the browser history
• PluginBacklinks : Lists all pages that link to a particular page
• PluginBanner : Add a banner to a wiki page
• PluginBigBlueButton : Starts a video/audio/chat/presentation session using BigBlueButton
• PluginBloglist : Displays posts from the tiki blog on a wiki page.
• PluginBox : Creates a box with a title bar
• PluginCalendar : Display a calendar and its events in a wiki page
• PluginCategory : List categories and objects assigned to them
• PluginCatOrphans : Lists all objects that are not categorized
• PluginCatpath : Show the full category path for a wiki page
• PluginCenter : Center text
• PluginCode : Display code syntax with line numbers and color highlights
• PluginColorbox : Display a gallery of images in a popup slideshow
• PluginContent : Display content from dynamic content repository
• PluginCookie : Display a tagline or cookie
• PluginCopyright : Inserts a copyright notice
• PluginCountdown : Displays a countdown to a future date.
• PluginDataChannel : Display a form to access data channels
• PluginDBReport : Query an SQL database and display results
• PluginDiv : Defines and formats sections of a page or text.
• PluginDl : Creates a definition list
• PluginEquation : Renders an equation written in LaTeX syntax as an image.
• PluginEvents : Display upcoming events from calendars
• PluginFade : Creates a fade-in/fade-out effect on a text
• PluginFancylist : Creates a fancy looking list
• PluginFancyTable : Displays a table using TikiWiki odd/even style
• PluginFile : Link to a file that's attached or in a gallery or archive
• PluginFiles : List files in a gallery or category
• PluginFlash : Embed a video or audio file in a wiki page
• PluginFootnote : Create automatically numbered footnotes
• PluginFootnotearea : Create automatically numbered footnotes
• PluginFreetagged : List similarly tagged objects
• PluginFtp : Create a button for downloading a file from an FTP server
• PluginGauge : Displays a horizontal bar gauge
• PluginGoogleAnalytics : Implement Google Analytics for the site
• PluginGoogleDoc : Include a Google Docs document.
• PluginGoogleMap : Display a Google Map
• PluginGroup : Display content based on the user's groups or friends.
• PluginGroupList : List all groups or just groups including a certain group
• PluginGroupMailCore : Display GroupMail functions on a wiki page
• PluginGroupstat : Show the distribution of users among groups
• PluginHTML : Add HTML to a page
• PluginIframe : Include another web page in a wiki page within a frame
• PluginImage : (deprecated in Tiki5) Displays an image
• PluginImg : Display custom formatted images
• PluginInclude : Include content from another wiki page
• PluginInvite : Invite a user to join your groups
• PluginJabber : Chat using Jabber
• PluginJq : Insert JQuery Javascript
• PluginJS : Include Javascript code or files
• PluginKaltura : Display a video created through the Kaltura feature
• PluginLang : Vary text based on the page language
• PluginLastmod : Show the last modification date for a page
• PluginListpages : List pages based on various criteria
• PluginLsDir : List files in a directory
• PluginMail : Directly mail other users or groups
• PluginMaketoc : Create a table of contents from section headings.
• PluginMap : Display a map created using the Maps feature
• PluginMcalendar : Convert a Gregorian date to a Mayan calendar date
• PluginMediaPlayer : Add a media player to a page
• PluginMemberList : List and allow editing of group members
• PluginMemberPayment : Receive payment from a user to extend membership to a group
• PluginMiniQuiz : Create a quiz using a tracker
• PluginModule : Display a module in a wiki page
• PluginMono : Diplay text in a monospace font
• PluginMouseover : Display hidden content by mousing over a link
• PluginMWTable : Display a table using MediaWiki syntax
• PluginMySpace : Displays a MySpace Flash mp3 playlist
• PluginObjecthits : Displays number of hits for certain objects
• PluginPayment : Show details of a payment request or invoice
• PluginPerm : Display content based on permission settings
• PluginPluginManager : List wiki plugins info for the site
• PluginPoll : Display a poll
• PluginProfile : Add a button for installing a profile
• PluginProposal : Widget for voting on a proposal and viewing results
• PluginQuote : Format text as a quote
• PluginR : Execute R commands and show results
• PluginRcontent : Display pre-programmed changing content
• PluginRealnamelist : Show user real names for members of a group
• PluginRedirect : Redirect to another page
• PluginRegex : Perform a regular expression search and replace
  • PluginRegex Example : This page supports the PluginRegex page
• PluginRemarksbox : Display a comment, tip, note or warning box
• PluginRSS : Display items from an RSS feed
• PluginScreenCast : Display a screencast
• PluginScroll : Show animated text that scrolls up or down
• PluginSharethis : Adds a ShareThis button
• PluginSheet : Display data from a TikiSheet
• PluginShowpages : Find pages by searching within page names
• PluginSkype : Call or chat with a Skype user
• PluginSmarty : Insert a Smarty function
• PluginSnarf : Display contents of another web page
• PluginSort : Sort lines of text
• PluginSplit : Easily arrange content on a page into rows and columns
• PluginSQL : Query a MySQL database and display the results
• PluginStat : Show various statistics for an object
• PluginSub : Applies subscript font to text
• PluginSubscribeGroup : Allow users to subscribe to a group
• PluginSubscribeGroups : Allow users to subscribe to a list of groups
• PluginSubscribeNewsletter : Allow users to subscribe to a newsletter
• PluginSup : Applies superscript font to text
• PluginTabs : Arrange content in tabs
• PluginTag : Apply an HTML tag to content
• PluginThumb : (deprecated with 5.0) Display a thumbnail
• PluginTitleSearch : Search page titles
• PluginToc : Display a table of contents of pages or sub-pages
• PluginTr : Translate text to the user language
• PluginTracker : Create a form in a wiki page (to populate a tracker)
  • Plugin Tracker Advanced : Advanced use cases for PluginTracker
• PluginTrackerFilter : Create a form to filter tracker fields
• PluginTrackerItemField : Display or test the value of a tracker item field
• PluginTrackerList
• PluginTrackerPrefill : Create a button to prefill tacker fields
• PluginTrackerStat : Display some statistics about a tracker.
• PluginTrackerTimeline : Show a timeline view of a tracker
• PluginTranslated : Create multi-lingual links
• PluginUsercount : Display number of users for a site or group
• PluginUserlink : Display link to tiki user page
• PluginUserlist : Display a list of users
• PluginUserpref : Display contents based on user preference settings
• PluginVersions : Create tabs for showing alternate versions of content
• PluginVote : Create a tracker for voting
• PluginWantedPages : Show location of links to pages not yet created
• PluginWebservice : Pull data from any JSON enabled service
• PluginWMV : Play a movie with Windows Media Viewer
• PluginYouTube : Embed a YouTube video in a page

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 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 ( to toggle on and 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}

Related Pages

• Plugin Security - regarding enabling and approving plugins
• Plugin Help - illustration of plugin help for version 3.0
• Plugin Alias - powerful feature that allows you to configure plugins with your own defaults
• For developers: Create a plugin, Hello World#To_create_a_plugin

Aliases

• Plugin
• Plugins
• Wiki Plugins

---