Empty TWiki Plugin

This is an empty Plugin you can use as a template to build your own TWikiPlugins. This Plugin does nothing, but is ready to be used.

To create your own Plugin:

  • Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.
  • Create a <name>Plugin topic in the TWiki web. Do so by visiting http://TWiki.org/cgi-bin/view/Plugins/PluginPackage#NewPlugin and starting a new topic to get the default plugin topic text (don't save the topic). Customize your plugin topic to your needs.
  • See details in TWikiPlugins.

Syntax Rules

(none)

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins

  • Your own setting, for example:
    • Set EXAMPLE = got it!

  • Debug plugin: ( TWiki sets $debug in your plugin. See output in data/debug.txt.)
    • Set DEBUG = 0

Plugin Installation Instructions

  • This plugin is preinstalled, you do not need to install it.

Plugin Info

Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2007, TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 15942 (11 Aug 2008)
Change History:  
20 May 2007 Added renderWikiWordHandler
01 Feb 2006: Dakar changes
21 Mar 2004: Added afterSaveHandler
14 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
Dependencies: %$DEPENDENCIES
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWikiContributor - 01 Feb 2006

This topic: TWiki > EmptyPlugin
Topic revision: r12 - 27 Mar 2005 - 10:14:15 - TWikiContributor
 
This site is powered by the TWiki collaboration platformCopyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.EmptyPlugin