Difference: EmptyPlugin (15 vs. 16)

Revision 162010-05-08 - TWikiContributor

Changed:
<
<

Empty TWiki Plugin

>
>

Empty TWiki Plugin

Added:
>
>
<--
   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.
-->
Empty Plugin used as a template for new plugins
 
Changed:
<
<		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.
>
>

Introduction

 
Changed:
<
<		To create your own Plugin:
>
>		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.
 
Changed:
<
<
  • Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.
>
>		To create your own plugin:
Deleted:
<
<
 
Added:
>
>
  • 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.
 

Syntax Rules

(none)

Plugin Settings

Changed:
<
<		Plugin settings are stored as preferences variables. To reference
>
>		Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
Deleted:
<
<		a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
 
Changed:
<
<
  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins
>
>
  • 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

Changed:
<
<
  • This plugin is preinstalled, you do not need to install it.
>
>
  • This plugin is pre-installed, you do not need to install it.
 

Plugin Info

Changed:
<
<
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2007, TWikiContributor
>
>
Plugin Author: TWiki:Main/AndreaSterbini, TWiki:Main/PeterThoeny, TWiki:Main/CrawfordCurrie
Copyright: © 2001-2010, TWiki:TWiki/TWikiContributor
 
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 15942 (02 Sep 2009)
>
>
Plugin Version: 18620 (2010-05-29)
 
Change History: 
<-- versions below in reverse order -->
 
Changed:
<
<
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
>
>
2010-05-08: TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB
2007-05-20: Added renderWikiWordHandler
2006-02-01: Dakar changes
2004-03-21: Added afterSaveHandler
2001-07-14: Changed to plug&play
Added:
>
>
2001-02-27: Initial version
 
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
Dependencies: %$DEPENDENCIES
Changed:
<
<
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
>
>
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
Changed:
<
<		Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences
>
>		Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences
Deleted:
<
<		 -- TWikiContributor - 01 Feb 2006
 
View topic | History: r19 < r18 < r17 < r16 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright © 1999-2025 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.