(r4)EmptyPlugin < TWiki

r4 - 05 Jan 2002 - 09:30:43 - PeterThoeny^?You are here: TWiki >

TWiki Web > EmptyPlugin

---++ Empty TWiki Plugin

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

To create your own plugin:

   * Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==&lt;name&gt;Plugin.pm== and customize the plugin.
   * Create a  ==&lt;name&gt;Plugin== topic in the %TWIKIWEB% 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.
   * See details in %TWIKIWEB%.TWikiPlugins.

---+++ Syntax Rules

(none)

---+++ <nop>%TOPIC% Settings

Plugin settings are stored as preferences variables. To reference
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==

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

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

   * Debug 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: | %TWIKIWEB%.AndreaSterbini, %TWIKIWEB%.PeterThoeny |
|  Plugin Version: | 14 Jul 2001 |
|  Change History: | 14 Jul 2001: Changed to plug&play <br> 27 Feb 2001: Initial version |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.0 |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, DefaultPlugin

-- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br> 
-- %TWIKIWEB%.PeterThoeny - 14 Jul 2001 <br>

TWiki

Webs
Main
Sandbox
TWiki

Copyright © 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