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

Plugin Author:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright:	© 2001-2011, TWiki:TWiki.TWikiContributor

Empty TWiki Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/EmptyPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/EmptyPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Introduction

This is an empty plugin. Use it 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 lib/TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin. Add your own code; remove all handlers you do not plan to use.
• Create a <name>Plugin documentation topic in the TWiki web. Do so by visiting http://twiki.org/cgi-bin/view/Plugins/PluginPackageHowTo 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.

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

• This plugin is pre-installed, you do not need to install it.

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

• 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.

• • Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins

• Your own setting, for example:

Appraisal:

http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginAppraisal

Related Topics: DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences, TWikiPlugins

Plugin Settings

• One line description, is shown in the TextFormattingRules topic:

• Your own setting, i.e.:

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

Empty TWiki Plugin

Syntax Rules

EmptyPlugin Global Settings

• Your own settings, for example:

Plugin Installation Instructions

• Download the ZIP file from the Plugin web (see below)
• Unzip EmptyPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/EmptyPlugin.txt	Plugin topic
  data/TWiki/EmptyPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/EmptyPlugin.pm	Plugin Perl module

• Test if the plugin is correctly installed:
  • (describe tests here)

Plugin Info

• One line description, shown in the TextFormattingRules topic:

• Create a <name>Plugin topic in the TWiki web. Do so by visiting http://TWiki.org/cgi-bin/view/Plugins/ and starting a new topic to get the default plugin topic text (don't save the topic). Customize your plugin topic to your needs.

EmptyPlugin Settings

• One line description, is shown in the TextFormattingRules topic:

• Your own setting, i.e.:
  • Set EXAMPLE = got it!

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

Empty TWiki Plugin

• Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.
• Copy this topic to <name>Plugin and customize it.
• See details in TWikiPlugins.

Syntax Rules

(none)

EmptyPlugin Preferences

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

• One line description, is included in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.

• Your own preferences, i.e.:
  • Set COLOR = red

Plugin Installation Instructions

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

Plugin Info

Plugin Author:	AndreaSterbini, PeterThoeny
Plugin Version:	08 Jul 2001
Change History:	08 Jul 2001: Changed to plug&play 27 Feb 2001: Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.0
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

-- AndreaSterbini - 27 Feb 2001
-- PeterThoeny - 08 Jul 2001

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.

Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

-- PeterThoeny - 13 Mar 2001