Empty TWiki Plugin

This is an empty Plugin you can use as a template to build your own TWiki Plugins. 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 TWiki Plugins.

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 Text Formatting Rules 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

Related Topics: TWiki Plugins, Developer Documentation Category, Admin Documentation Category, TWiki Preferences

-- TWiki Contributor - 01 Feb 2006