Difference: EmptyPlugin (5 vs. 6)

Revision 621 Mar 2004 - PeterThoeny

Line: 1 to 1
 

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.

Line: 11 to 11
 

Syntax Rules

Changed:
<
<
(describe the syntax)
>
>
(none)
 
Changed:
<
<

EmptyPlugin Global Settings

>
>

Plugin Settings

 
Changed:
<
<
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %EMPTYPLUGIN_SHORTDESCRIPTION%
>
>
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
 
Changed:
<
<
>
>
 
    • Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
Changed:
<
<
  • Your own settings, for example:
>
>
  • Your own setting, i.e.:
 
    • Set EXAMPLE = got it!

  • Debug plugin: (See output in data/debug.txt)
Line: 28 to 29
 

Plugin Installation Instructions

Changed:
<
<
(This plugin is preinstalled, you do not need to install it.)

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

  • 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)
>
>
  • This plugin is preinstalled, you do not need to install it.
 

Plugin Info

Changed:
<
<
Plugin Author: AndreaSterbini, PeterThoeny
Plugin Version: 14 Jul 2001 (V1.000)
Change History:
<-- specify latest version first -->
 
>
>
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
Plugin Version: 21 Mar 2003
Change History:
<-- versions below in reverse order -->
 
21 Mar 2004: Added afterSaveHandler
 
14 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
CPAN Dependencies: none
Other Dependencies: none
Changed:
<
<
Perl Version: 5.005
>
>
Perl Version: 5.0
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

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

Changed:
<
<
-- AndreaSterbini - 27 Feb 2001
-- PeterThoeny - 14 Jul 2001
>
>
-- TWiki:Main.AndreaSterbini - 27 Feb 2001
-- TWiki:Main.PeterThoeny - 21 Mar 2004
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 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.