Difference: EmptyPlugin (16 vs. 17)

Revision 172011-03-07 - 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.
-->
Added:
>
>
 Empty Plugin used as a template for new plugins
Deleted:
<
<
 

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.

Syntax Rules

(none)

Deleted:
<
<

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
 

Plugin Installation Instructions

  • 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-2010, TWiki:TWiki/TWikiContributor
>
>
  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Empty Plugin used as a template for new plugins
Added:
>
>
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2011, TWiki:TWiki.TWikiContributor
 
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 18620 (2010-05-29)
>
>
Plugin Version: 20632 (2011-05-03)
 
Change History: 
<-- versions below in reverse order -->
 
Changed:
<
<
2010-05-08: TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB
>
>
2011-03-06: TWikibug:Item6656: Add meta data to attachment save handlers
Added:
>
>
2011-02-08: TWikibug:Item6593: Doc improvements; adding VarEXAMPLEVAR variable documentation
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
2001-02-27: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
Dependencies: %$DEPENDENCIES
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: VarEXAMPLEVAR, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences
 
View topic | History: r25 < r24 < r23 < r22 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 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.