NOTE: This is a DistributionDocument. Please help maintain high quality documentation: This is a wiki, please fix the documentation if you find errors or incomplete content. Put questions and suggestions concerning the documentation of this topic in the comments section below. Use the Support web for problems you are having using TWiki.

TWiki Add-Ons

Add functionality to TWiki with extensions not based on the TWiki scripts.

Overview

An add-on runs separately from the TWiki scripts, e.g. for data import, export to static HTML, etc. Add-Ons normally do not call any TWiki code directly, though may invoke TWiki scripts. There are different types of add-ons, they may be stand alone scripts, browser plugins, office tool extensions, or even a set of TWiki topics that form a TWiki application.

Relevant links on TWiki.org:

• TWiki:Plugins.AddOnPackage - list of all contributed add-on scripts
• TWiki:Plugins.AddOnDevelopment - discussion and feedback on contributed add-on scripts
• TWiki:Plugins.AddOnBrainstorming - open forum for new add-on script ideas
• TWiki:Plugins.AddOnPackageHowTo - instructions and template to create a new add-on topic

See other types of extensions: TWikiContribs, TWikiPlugins, TWikiSkins

Add-Ons Installed on this TWiki

Installing Add-Ons

• Download an add-on from TWiki:Plugins.AddOnPackage.
• Follow the installation instructions in the add-on topic.

Creating new Add-Ons

• Visit TWiki:Plugins.AddOnPackageHowTo and follow the instructions.

Related Topics: DeveloperDocumentationCategory, AdminDocumentationCategory, TWiki:TWiki.TWikiPluginsSupplement

-- Contributors: TWiki:Main.PeterThoeny

Comments & Questions about this Distribution Document Topic

I have a new Add-On ready for release. However, I can't find a step by step explanation how to create a new Add-On topic in this web. The links lead me in a circle without giving precise info. I don't want to "try and error" in this web ...

-- DetlefMarxsen - 08 Jun 2005

See revised and expanded instructions above. Thanks for sharing your add-on with the Twiki community!

-- LynnwoodBrown - 09 Jun 2005

The description of AddOns as "Enhanced tools to be used by a site administrator on a TWiki server" is inaccurate, as there are a number of AddOns which don't fit this description. These deviant AddOns are actually end-user tools, which run on some platform other than a TWiki instance (e.g. a browser, a database) to perform some TWiki-related service (e.g. assist in editing a TWiki page, classify TWiki pages).

For example, EditTWikiExternalEditorAddOn, ExcelExportTwikiTableAddOn.

Either some new category is needed for such TWiki assistants, or the description of AddOns should be changed.

-- NigelGreen - 20 Apr 2006