UserGuide: Plugins

LionWiki contains only basic functionality, more advanced features are provided by plugins.

Plugins distributed with LionWiki(Edit)

  • Admin provides means to block IPs, disable plugins etc.
  • AjaxEditing provides "in place" editing
  • BetterEditor contains some editor enhancements
  • Captcha is spam filtering plugin
  • Comments provides support for page comments
  • Footnotes
  • ImageExt provides advanced operations with images
  • Index inserts list of all pages into a page
  • InlineDiff provides high quality revision diffs
  • LatexImg provides ability to insert snippets of LaTeX into a page that are rendered as either .gif or .png images.
  • ListPlugins is simple example plugin which prints installed plugins together with description and their functions. See it here.
  • Menu can create one level menus
  • Meta inserts into HTML head meta tags description and keywords
  • PageVersions creates list (either bulleted or comma separated) of (language) variants of a page
  • RSS generates RSS channel with page changes
  • SelectLanguage and SelectTemplate which creates simple select box to choose from language/template
  • Tables is plugin providing syntax for creating tables
  • Tags creates non-hierarchical categorization
  • WhatLinksHere generates list of pages which contain link to specified page, especially useful when moving pages

Standalone plugins(Edit)

These plugins are not part of standard LionWiki distribution and must be downloaded and "installed" separately.

Plugin installation and configuration(Edit)

Installation/Activation/deactivation(Edit)

Plugin installation and activation is done by simply copying the plugin file(s) to the "plugins" directory.

If you want to deactivate some plugin, you have at least three options:

  • Delete plugin file.
  • Rename them. LionWiki accepts plugins with specific filename - it must start with "wkp_" and end with ".php".
  • Deactivate them in Admin plugin, like here.

Plugin configuration(Edit)

Plugins are basically PHP classes with some member variables — some of these member variables are configuration options. So if you want to change e.g. password in Admin plugin, open plugins/wkp_Admin.php in text editor and change $PASSWORD member variable.

Configuration in config.php(Edit)

Plugins configuration explained above has one serious flaw - when you upgrade your installation to newer version of LionWiki, all settings is lost. Since LionWiki 3.1 it is possible to configure plugins in config.php file:

$Admin["PASSWORD"] = sha1("my_password");

So, you take a look at the member variable name in the plugin class and use it as a member of an array named after plugin.

Writing plugins(Edit)

We have special page for this, see How to write a plugin.