Wiki Plugins
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....
Many plugins are enabled by default. The others can be enabled easily from the Text Area Admin page. As a security measure, some plugins require admin-level approval before becoming "live" on a page.
Distributed Plugins
- : Create a social network activity stream
- : Provide an input field for adding a freetag to an object
- : Add a bibliography reference
- : Provide a button to toggle a pre-specified relation
- : Display a button for adding items to the shopping cart
- : Add a calendar item to a Google calendar
- : Adjust the inventory level of a product
- : Show user's browser and server information
- : Load data into a DIV using AJAX or in an IFRAME
- : Create a link to an anchor
- : Create an anchor that can be linked to
- : Annotate an image
- : Experiment with PluginAnnotate
- : Create a frame in which to assemble custom applications
- : Define an archive that can be downloaded
- : Display a field of an article
- : Display multiple articles
- : Display an attachment or a list of them
- : Assign generic attributes to the current object
- : Add pop-ups and color coding that identifies authors
- : Automatically propagate arguments when clicking on links
- : Create a table of contents for a page automatically
- : Display a user's profile picture
- : Display a link that goes back one page in the browser history
- : List all pages that link to a particular page
- : Add a banner
- : Hold a video/audio/chat/presentation session using BigBlueButton
- : Embed a Blip.tv video
- : Display posts from a site blog
- : Create a formatted box with a title bar
- : Add a link formatted as a button
- : Display a calendar and its events
- : Display images in a self-advancing carousel
- : Use CasperJS on a Tiki page
- : List categories and objects assigned to them
- : Display controls to trigger category transitions for any object
- : List objects that are not categorized
- : Show the full category path for a wiki page
- : Access and use your cclite social credit and alternative currency account
- : Center text
- : Display a chart from TikiSheet
- : Display content based on the address that originated the request for the current page
- : Display a chart
- : Display code with syntax highlighting and line numbering
- : Display a gallery of images in a popup slideshow
- : Display a comment area for a specified object
- : Display content from dynamic content repository
- : List users' contributions to a page
- : Agree a date from a list of alternatives
- : Display a tagline or cookie
- : Display content based on whether cookie consent has been granted by the user
- : Insert copyright notices
- : Display the time until or after a date and time
- : Create a custom search form for searching or listing items on the site
- :
- :
- : Use the webmail client Cypht in a Tiki page
- : Display a form to access data channels
- : Query an ADOdb database and display results
- : Create a custom pop-up dialog box
- : Define and format sections of a page or text
- : Create a definition list
- : Embed a drawing in a page
- : Render an equation written in LaTeX syntax as an image
- : Display events from calendars
- : Create an exercise for a user to complete and grade
- : Extend the time items are held in a shopping cart
- : Create a link that shows/hides initially hidden content
- : Create a formatted numbered list
- : Create a formatted table that can be filtered and sorted
- : Display a button for a user to click to make an object a favorite
- : Link to a file that's attached or in a gallery or archive
- : List files by ID, gallery or category, or show a slideshow of image files
- : Create test suites for applications built using Tiki
- : Embed a video or audio file
- : Create a Bootstrap responsive grid
- : Format the font type and size of text
- : Create automatically numbered footnotes (together with PluginFootnoteArea)
- : Create automatically numbered footnotes (together with PluginFootnote)
- : List similarly tagged objects
- : Create a button for downloading a file from an FTP server
- : Display a slideshow of images on a page
- : Display a horizontal bar gauge
- : Create a simple graph from supplied data
- : Display a link on a secure page using an access token
- : Add the tracking code for Google Analytics
- : Chart Google Analytics data in a page
- : Display a Google document
- : Display content based on the user's groups or friends
- : Show the expiration date of a group the user belongs to
- : Create a complete or filtered list of groups
- : Display GroupMail functions on a page
- : (Deprecated) Display a Google Map
- : Show the distribution of users among groups
- : Create, share and reuse interactive html5 content in your browser
- : Add HTML to a page
- : Add an item to HTML Feed
- : Receive and display content from another site sent using PluginHTMLFeed
- : Display an icon
- : Include the body of another web page in a scrollable frame within a page
- : (deprecated in Tiki5) Displays an image
- : Display one or more custom formatted images
- : Include a portion of another wiki page
- : Include a Smarty or wiki template file in a page
- : Indent a block of wiki content
- : Create a tracker item automatically upon saving a page
- : Invite a user to join your groups
- : Chat using Jabber
- : Add JQuery Javascript code
- : Include Javascript code or files
- : Display a video created through the Kaltura feature
- : Vary content based on the page language
- : Show the last modification date for a page
- : Search for, list, and filter all types of items and display custom formatted results
- :
- :
- :
- :
- :
- :
- :
- :
- :
- :
- :
- :
- :
- :
- : Set custom actions that can be executed on a filtered list of objects
- : List pages based on various criteria
- : Show link to local or shared files and directories
- : List files in a directory
- : Mail other users or groups
- : Generate a table of contents for a page automatically based on page headings
- : Display a map
- :
- : Create content using Markdown syntax
- : Convert a Gregorian date to a Mayan calendar date
- : Add a media player to a page
- : List and allow editing of group members
- : Receive payment from a user to extend membership to a group
- : Create a quiz using a tracker
- : Display a module in a wiki page
- : Display the modules assigned to a zone
- : Diplay text in a monospace font
- : Display hidden content by mousing over text
- : Display a table using MediaWiki syntax
- : Display a MySpace Flash mp3 playlist
- : Display content based on the user's IP address
- : Show current date and time
- : Display the number of hits for certain objects
- : Display a link to an object
- : Display content of other wiki pages in tabs
- : Display content based on URL parameters
- : Link content to another site
- : Show details of a payment request or invoice
- : Embed a PayPal button
- : Change default PDF output settings for a page
- : Change PDF output settings for a portion of a page
- : Create a page break for PDF output
- : Display content based on permission settings
- : Display content based on a user's perspective
- : Summarize data from objects
- : Play a SCORM learning object in an iframe using Moodle
- : List wiki plugin or module information for the site
- : Embed a poll
- : Display content based on global preference settings
- : Allows to edit a preference by anyone that has permissions to see the current page
- : Add a button for applying a profile
- : Allow users to vote on a proposal and see the results
- : Display a QR code
- : Format text as a quote
- : Execute R commands and show results
- : Include a random page's content
- : Display pre-programmed changing content
- : Show user real names for members of a group
- : Redirect to another page
- : Perform a regular expression search and replace
- : This page supports the PluginRegex page
- : Register and make a member payment in the same step
- : Display the relation of an object to the rest of the site
- : Display a comment, tip, note or warning box
- : Display data from the Tiki database in spreadsheet or chart format
- : Display items from one or more RSS feeds
- : Show animated text that scrolls up or down
- : Create a link to SourceForge tracker items
- : Add a ShareThis button
- : Display data from a TikiSheet
- : Collect shopper information for the shopping cart
- : Find pages by searching within page names
- : Display the value of public global preferences
- : Add bibliography listing in the footer of a wiki page
- : Sign and date your contribution to a page
- : Allows to draw signatures
- : Add a link for calling or chatting with a Skype user
- : Create a slideshow from the content of a wiki page
- : Insert a Smarty function or variable
- : Display contents of another web page
- : Sort lines of text
- : Arrange content on a page into rows and columns
- : Query a MySQL database and display the results
- : Show various statistics for an object
- : Apply subscript font to text
- : Allow users to subscribe to a group
- : Allow users to subscribe to a list of groups
- : Allow users to subscribe to a newsletter
- : Apply superscript font to text
- : Embed a survey
- : Embed swiper in content, support file galleries, files id and custom content
- : Arrange content in tabs
- : Apply an HTML tag to content
- : (deprecated with 5.0) Display a thumbnail
- : Display a timeline
- : Embed a timesheet into a page
- : Search page titles
- : Display a table of contents of pages in a structure
- : Collaborate in real time
- : List top-scoring users
- : Allows to generate Time-based One-time Password
- : Provide a step-by-step interactive tour
- : Translate text into the user language
- : Create a form in a wiki page to populate a Tracker
- : More information on using PluginTracker
- : Create and display a calendar using tracker data
- : Display the number of comments for a tracker
- : Create a form to filter tracker fields
- : Display content based on results of a tracker field test
- : Copy a tracker item
- : Display or test the value of a tracker item field
- : List, filter and sort the items in a tracker
- : Create a button to prefill tacker fields
- : Generate a form from tracker data
- : Display statistics about a tracker
- : Show a timeline view of a tracker
- : Show or hide tracker content
- : Send payments between members using cclite
- : Include the content of another page with certain changes
- : Create multi-lingual links
- : Translate a link from one language to another
- : Display the activity for a twitter account
- : Display number of users for a site or one or more groups
- : Display text based on whether a user is in a group
- : Show the last login information for a given or current user
- : Display link to a user's information page
- : Display a list of users
- : Display contents based on user preference settings
- : Create tabs for showing alternate versions of content
- : Embed a Vimeo video
- : Create a tracker for voting
- : Save voting information in Smarty variables for display
- : Show location of links to pages not yet created
- : View a document in a page
- : Display remote information exposed in JSON or YAML or SOAP XML
- : Use a WYSIWYG editor to edit a section of content
- : Update an XML file stored in a File Gallery
- : Embed a YouTube video in a page
- : Include a Zotero reference in a page
- : Display the complete reference list from a Zotero server
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.
Uppercase 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 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.
Lowercase 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 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.
Pending Approval Notification
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.
Related Pages
- All Plugins
- 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