You are here: CTSPedia>System Web>Plugins (09 Jan 2009, ProjectContributor?)EditAttach
Tags:
create new tag
, view all tags, tagging instructions

Foswiki Plugins

Add functionality to Foswiki with plugins

Overview

You can add plugins to extend Foswiki functionality without altering the core code. A plug-in approach lets you:

  • add virtually unlimited features while keeping the main Foswiki code compact and efficient;
  • heavily customize an installation and still do clean updates to new versions of Foswiki;
  • rapidly develop new Foswiki functions in Perl using the plugin API.

Everything to do with Foswiki plugins - demos, new releases, downloads, development, general discussion - is available at Foswiki.org, in the Foswiki:Extensions web.

Foswiki plugins are developed and contributed by interested members of the community. Plugins are provided on an 'as is' basis; they are not a part of Foswiki, but are independently developed and maintained.

Most TWiki® plugins can also be used with Foswiki if the TWikiCompatibilityPlugin is installed (it is by default).

See other types of extensions: Contribs, Skins

Installed Plugins

  • TWikiCompatibilityPlugin (Foswiki-1.0, $Rev: 3132 (2009-03-16) $): add TWiki personality to Foswiki
  • SpreadSheetPlugin (06 Jan 2009, $Rev: 3048 (2009-03-12) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to Foswiki tables and other topic text
  • CommentPlugin (Foswiki-1.0.1, $Rev: 3048 (2009-03-12) $): Quickly post comments to a page without an edit/preview/save cycle
  • ActionTrackerPlugin (21 May 2007, $Rev: 2242 (30 Jan 2009) $): Adds support for action tags in topics, and automatic notification of action statuses
  • JQueryPlugin (3.51, $Rev: 20090710 (2009-07-10) $): jQuery JavaScript library for Foswiki
  • JumpAutocompletePlugin (Foswiki-1.0.0, $Rev: 1 (3 Apr 2009) $): Makes the jump box autocomplete topic names
  • AntiWikiSpamPlugin (1.5, 1.5): Lightweight wiki spam prevention
  • AttachmentListPlugin (1.3.3, $Rev: 4282 (2009-06-22) $):
  • BibliographyPlugin (2.2.2, $Rev: 11925 (2011-06-15) $): Cite bibliography in one topic and get a references list automatically created.
  • CalendarPlugin (2.000, $Rev: 8058 (2010-07-07) $): Show a monthly calendar with highlighted events
  • CheckToIncludePlugin ($Date: 2008-12-14 18:49:56 +0100 (Sun, 14 Dec 2008) $, $Rev: 3048 (2009-03-12) $): Conditionally Include Topics
  • DirectedGraphPlugin (Foswiki-1.0.0, $Rev: 1.2 (19 Mar 2009) $): Embed directed graphs in TWiki topics
  • DpSyntaxHighlighterPlugin (1.9, $Rev: 8361 (2010-07-30) $): Client side syntax highlighting using the dp.SyntaxHighlighter
  • EFetchPlugin (Foswiki-1.0.0, $Rev: 1 (16 Mar 2009) $): Grab abstract information from PubMed
  • EditTablePlugin (4.20, $Rev: 3160 (2009-03-18) $): Edit tables using edit fields, date pickers and drop down boxes
  • EmbedBibPlugin (Foswiki-1.0.0, $Rev: 1 (25 Mar 2009) $): Embeds BibTeX entries in a TWiki page
  • FoldingTOCPlugin (Pants, $Rev: 1 (2009-04-07) $): Provides a table of contents that folds
  • GoogleAnalyticsPlugin (2.1.1, 4729): Adds Google Analytics javascript code to specified pages
  • InterwikiPlugin (03 Aug 2008, $Rev: 3048 (2009-03-12) $): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
  • LatexModePlugin (3.71, $Rev: 16926 (12 Dec 2008) $): Enables LaTeX markup (mathematics and more) in TWiki topics
  • LightboxPlugin (Oct 2009, $Rev: 5249 (2009-10-09) $): Foswiki hooks to the Lightbox Javascript package for better thumbnail image click-through
  • PreferencesPlugin (Foswiki-1.0, $Rev: 3048 (2009-03-12) $): Allows editing of preferences using fields predefined in a form
  • RandomTopicPlugin (20100328, $Rev: 6961 (2010-03-28) $): Pick a selection of Random Topics
  • SlideShowPlugin (02 Aug 2008, $Rev: 3048 (2009-03-12) $): Create web based presentations based on topics with headings.
  • SmiliesPlugin (04 Jan 2009, $Rev: 3048 (2009-03-12) $): Render smilies as icons, like smile for  :-) or eek! for  :eek:
  • StylishPlugin (0.0.1, $Rev: 3048 (2009-03-12) $): Plugin for registering stylesheets and what not
  • TablePlugin (1.037, $Rev: 3048 (2009-03-12) $): Control attributes of tables and sorting of table columns
  • TagCloudPlugin (v2.21, $Rev: 5764 (2009-12-10) $): Renders a tag cloud given a list of terms
  • TagMePlugin (02 Mar 2010, $Rev: 6613 (2010-03-02) $): Tag wiki content collectively to find content by keywords
  • TinyMCEPlugin (21 Jan 2009, $Rev: 3048 (2009-03-12) $): Integration of TinyMCE? with WysiwygPlugin
  • TopicDataHelperPlugin (1.1.1, $Rev: 4253 (2009-06-20) $):
  • TopicVarsPlugin (Foswiki-1.0.0, 1.000): allows you to define variables
  • TopicVotePlugin (v1.3.1, $Rev: 3048 (2010-01-29) $): Enables voting on topics
  • TreePlugin (1.9.1, $Rev: 6156 (2010-01-27) $): Renders topics' parent-child relationships as hierarchical tree view. Useful for dynamic site maps and threads.
  • TwistyPlugin (1.5.4, $Rev: 6281 (2010-02-12) $): Twisty section Javascript library to open/close content dynamically
  • VotePlugin (1.33, $Rev: 5560 (2009-11-17) $): Simple way to count votes
  • WysiwygPlugin (03 Aug 2008, $Rev: 3048 (2009-03-12) $): Translator framework for Wysiwyg editors
  • ZonePlugin (2.1, $Rev: 6966 (2010-03-28) $): Gather content of a page in named zones while rendering it

Failed Plugins

PluginErrors
TWikiCompatibilityPlugin none
SpreadSheetPlugin none
CommentPlugin none
ActionTrackerPlugin none
JQueryPlugin none
JumpAutocompletePlugin none
AntiWikiSpamPlugin none
AttachmentListPlugin none
BibliographyPlugin none
CalendarPlugin none
CheckToIncludePlugin none
DirectedGraphPlugin none
DpSyntaxHighlighterPlugin none
EFetchPlugin none
EditTablePlugin none
EmbedBibPlugin none
FoldingTOCPlugin none
GoogleAnalyticsPlugin none
InterwikiPlugin none
LatexModePlugin none
LightboxPlugin none
PreferencesPlugin none
RandomTopicPlugin none
SlideShowPlugin none
SmiliesPlugin none
StylishPlugin none
TablePlugin none
TagCloudPlugin none
TagMePlugin none
TinyMCEPlugin none
TopicDataHelperPlugin none
TopicVarsPlugin none
TopicVotePlugin none
TreePlugin none
TwistyPlugin none
VotePlugin none
WysiwygPlugin none
ZonePlugin none
HandlerPlugins
afterCommonTagsHandlerLatexModePlugin
afterEditHandlerActionTrackerPlugin
WysiwygPlugin
afterSaveHandlerJumpAutocompletePlugin
TagMePlugin
TreePlugin
beforeAttachmentSaveHandlerAntiWikiSpamPlugin
beforeCommonTagsHandlerEditTablePlugin
PreferencesPlugin
WysiwygPlugin
beforeEditHandlerActionTrackerPlugin
TinyMCEPlugin
WysiwygPlugin
beforeMergeHandlerWysiwygPlugin
beforeSaveHandlerCommentPlugin
ActionTrackerPlugin
AntiWikiSpamPlugin
WysiwygPlugin
commonTagsHandlerSpreadSheetPlugin
CommentPlugin
ActionTrackerPlugin
CheckToIncludePlugin
DirectedGraphPlugin
DpSyntaxHighlighterPlugin
EditTablePlugin
EmbedBibPlugin
FoldingTOCPlugin
LatexModePlugin
LightboxPlugin
RandomTopicPlugin
SlideShowPlugin
SmiliesPlugin
TopicVarsPlugin
completePageHandlerZonePlugin
earlyInitPluginTWikiCompatibilityPlugin
endRenderingHandlerLatexModePlugin
WysiwygPlugin
This handler is deprecated - please check for updated versions of the plugins that use it!
initPluginTWikiCompatibilityPlugin
SpreadSheetPlugin
CommentPlugin
ActionTrackerPlugin
JQueryPlugin
JumpAutocompletePlugin
AntiWikiSpamPlugin
AttachmentListPlugin
BibliographyPlugin
CalendarPlugin
CheckToIncludePlugin
DirectedGraphPlugin
DpSyntaxHighlighterPlugin
EFetchPlugin
EditTablePlugin
EmbedBibPlugin
FoldingTOCPlugin
GoogleAnalyticsPlugin
InterwikiPlugin
LatexModePlugin
LightboxPlugin
PreferencesPlugin
RandomTopicPlugin
SlideShowPlugin
SmiliesPlugin
StylishPlugin
TablePlugin
TagCloudPlugin
TagMePlugin
TinyMCEPlugin
TopicDataHelperPlugin
TopicVarsPlugin
TopicVotePlugin
TreePlugin
TwistyPlugin
VotePlugin
WysiwygPlugin
ZonePlugin
modifyHeaderHandlerJQueryPlugin
WysiwygPlugin
postRenderingHandlerEFetchPlugin
EditTablePlugin
GoogleAnalyticsPlugin
PreferencesPlugin
WysiwygPlugin
preRenderingHandlerInterwikiPlugin
SmiliesPlugin
TablePlugin
registrationHandlerAntiWikiSpamPlugin
startRenderingHandlerWysiwygPlugin
This handler is deprecated - please check for updated versions of the plugins that use it!
38 plugins

Installing Plugins

Each Foswiki plugin comes with its own documentation: step-by-step installation instructions, a detailed description of any special requirements, version details, and a working example for testing. Many plugins have an install script that automates these steps for you.

Special Requirements: Some plugins need certain Perl modules to be preinstalled on the host system. Plugins may also use other resources, like graphics, other modules, applications, and templates. You should be able to find detailed instructions in the plugin's documentation.

Each plugin has a standard release topic, located in the Foswiki:Extensions web at Foswiki.org. There's usually a number of other related topics, such as a developers page, and an appraisal page.

On-Site Pretesting

The recommended approach to testing new plugins before making them public is to create a second local Foswiki installation, and test the plugin there. You can allow selected users access to the test area. Once you are satisfied that it won't compromise your main installation, you can install it there as well.

The plugins page shows which plugins are: 1) installed, 2) loading properly, and 3) what plugin handlers they invoke. Any failures are shown in the Errors section. The %FAILEDPLUGINS% macro can be used to debug failures. You may also want to check your webserver error log and the various Foswiki log files.

Some Notes on Plugin Performance

The performance of the system depends to some extent on the number of plugins installed and on the plugin implementation. Some plugins impose no measurable performance decrease, some do. For example, a Plugin might use many Perl libraries that need to be initialized with each page view (unless you run mod_perl). You can only really tell the performance impact by installing the plugin and by measuring the performance with and without the new plugin, on real data.

TIP If you need to install an "expensive" plugin, but you only need its functionality only in a subset of your data, you can disable it elsewhere by defining the %DISABLEDPLUGINS% setting.

Define DISABLEDPLUGINS to be a comma-separated list of names of plugins to disable. Define it in Main.SitePreferences to disable those plugins everywhere, in the WebPreferences topic to disable them in an individual web, or in a topic to disable them in that topic. For example,

   * Set DISABLEDPLUGINS = SpreadSheetPlugin, EditTablePlugin

Managing Installed Plugins

Some plugins require additional settings or offer extra options that you have to select. Also, you may want to make a plugin available only in certain webs, or temporarily disable it. And may want to list all available plugins in certain topics. You can handle all of these management tasks with simple procedures:

Listing Active Plugins

Plugin status macros let you list all active plugins wherever needed.

This site is running Foswiki version Foswiki-1.0.4, Thu, 19 Mar 2009, build 3201, plugin API version 2.0

  • %ACTIVATEDPLUGINS% - shows the activated plugins
  • %PLUGINVERSION% - shows the plugins API version
  • %FAILEDPLUGINS% - shows what plugins failed, and why

Enabling Plugins

Plugins can be enabled and disabled with the configure script. An installed plugin needs to be enabled before it can be used.

Plugin Evaluation Order

By default, plugins are executed in alphabetical order on plugin name. It is possible to change the order, for example to evaluate database macros before the spreadsheet CALCs. This can be done with {PluginsOrder} in the plugins section of configure.

Plugin-Specific Settings

Some plugins are configured with plugin preference settings, newer plugins with configure settings.

configure settings are accessible though the configure interface.

Plugin preference settings are defined in the plugin topic and can be overloaded. The SHORTDESCRIPTION setting is always present, it is needed for the automation in the extensions repository. Example preference settings defined in the TablePlugin topic:

  • Set SHORTDESCRIPTION = Control attributes of tables and sorting of table columns

Preference settings of active plugins can be retrieved anywhere in Foswiki with %<pluginname>_<var>%, such as %TABLEPLUGIN_SHORTDESCRIPTION%. They can also be redefined with the %<pluginname>_<var>% setting at a lower level in the Main.SitePreferences or at the web level. For an easier upgrade it is recommended to customize plugin preference settings in Main.SitePreferences only.

Installing Plugins

Each Foswiki plugin comes with its own documentation: step-by-step installation instructions, a detailed description of any special requirements, version details, and a working example for testing. Many plugins have an install script that automates these steps for you.

Special Requirements: Some plugins need certain Perl modules to be preinstalled on the host system. Plugins may also use other resources, like graphics, other modules, applications, and templates. You should be able to find detailed instructions in the plugin's documentation.

Each plugin has a standard release topic, located in the Foswiki:Extensions web at Foswiki.org. There's usually a number of other related topics, such as a developers page, and an appraisal page.

On-Site Pretesting

The recommended approach to testing new plugins before making them public is to create a second local Foswiki installation, and test the plugin there. You can allow selected users access to the test area. Once you are satisfied that it won't compromise your main installation, you can install it there as well.

The plugins page shows which plugins are: 1) installed, 2) loading properly, and 3) what plugin handlers they invoke. Any failures are shown in the Errors section. The %FAILEDPLUGINS% macro can be used to debug failures. You may also want to check your webserver error log and the various Foswiki log files.

Some Notes on Plugin Performance

The performance of the system depends to some extent on the number of plugins installed and on the plugin implementation. Some plugins impose no measurable performance decrease, some do. For example, a Plugin might use many Perl libraries that need to be initialized with each page view (unless you run mod_perl). You can only really tell the performance impact by installing the plugin and by measuring the performance with and without the new plugin, on real data.

TIP If you need to install an "expensive" plugin, but you only need its functionality only in a subset of your data, you can disable it elsewhere by defining the %DISABLEDPLUGINS% setting.

Define DISABLEDPLUGINS to be a comma-separated list of names of plugins to disable. Define it in Main.SitePreferences to disable those plugins everywhere, in the WebPreferences topic to disable them in an individual web, or in a topic to disable them in that topic. For example,

   * Set DISABLEDPLUGINS = SpreadSheetPlugin, EditTablePlugin

The Foswiki Perl Application Programming Interface

Developing plugins provides a simple introduction to hooking into Foswiki code from your own Perl modules. Foswiki:Development.GettingStarted is the starting point for more comprehensive documentation.


Related Topics: DeveloperDocumentationCategory, AdminDocumentationCategory
Topic revision: r1 - 09 Jan 2009 - 06:00:00 - ProjectContributor?
 
This site is powered by FoswikiCopyright & by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding CTSPedia? Send feedback