TWiki/EmptyPlugin.mdwn

   1 # <a name="Empty TWiki Plugin"></a> Empty TWiki Plugin
   2
   3 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.
   4
   5 To create your own Plugin:
   6
   7 - Copy file <code>**TWiki/Plugins/EmptyPlugin.pm**</code> to <code>**&lt;name&gt;Plugin.pm**</code> and customize the plugin.
   8 - Create a <code>**&lt;name&gt;Plugin**</code> 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.
   9 - See details in [[TWikiPlugins]].
  10
  11 ## <a name="Syntax Rules"></a> Syntax Rules
  12
  13 (none)
  14
  15 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
  16
  17 - This plugin is preinstalled, you do not need to install it.
  18
  19 ## <a name="Plugin Info"></a> Plugin Info
  20
  21 <table border="1" cellpadding="0" cellspacing="0">
  22   <tr>
  23     <td align="right"> Plugin Author: </td>
  24     <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie </td>
  25   </tr>
  26   <tr>
  27     <td align="right"> Copyright: </td>
  28     <td> © 2001-2006, [[TWiki/TWikiContributor]]</td>
  29   </tr>
  30   <tr>
  31     <td align="right"> License: </td>
  32     <td> GPL (<a href="http://www.gnu.org/copyleft/gpl.html" target="_top">GNU General Public License</a>) </td>
  33   </tr>
  34   <tr>
  35     <td align="right"> Plugin Version: </td>
  36     <td> 01 Feb 2006 </td>
  37   </tr>
  38   <tr>
  39     <td align="right"> Change History: </td>
  40     <td>  </td>
  41   </tr>
  42   <tr>
  43     <td align="right"> 01 Feb 2006: </td>
  44     <td> Dakar changes </td>
  45   </tr>
  46   <tr>
  47     <td align="right"> 21 Mar 2004: </td>
  48     <td> Added afterSaveHandler </td>
  49   </tr>
  50   <tr>
  51     <td align="right"> 14 Jul 2001: </td>
  52     <td> Changed to plug&amp;play </td>
  53   </tr>
  54   <tr>
  55     <td align="right"> 27 Feb 2001: </td>
  56     <td> Initial version </td>
  57   </tr>
  58   <tr>
  59     <td align="right"> TWiki Dependency: </td>
  60     <td> $TWiki::Plugins::VERSION 1.1 </td>
  61   </tr>
  62   <tr>
  63     <td align="right"> CPAN Dependencies: </td>
  64     <td> none </td>
  65   </tr>
  66   <tr>
  67     <td align="right"> Other Dependencies: </td>
  68     <td> none </td>
  69   </tr>
  70   <tr>
  71     <td align="right"> Perl Version: </td>
  72     <td> 5.005 </td>
  73   </tr>
  74   <tr>
  75     <td align="right"> TWiki:Plugins/Benchmark: </td>
  76     <td>[[TWiki/GoodStyle]] 99%, [[TWiki/FormattedSearch]] 99%, %TOPIC% 99% </td>
  77   </tr>
  78   <tr>
  79     <td align="right"> Plugin Home: </td>
  80     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
  81   </tr>
  82   <tr>
  83     <td align="right"> Feedback: </td>
  84     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
  85   </tr>
  86   <tr>
  87     <td align="right"> Appraisal: </td>
  88     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
  89   </tr>
  90 </table>
  91
  92 **_Related Topics:_** [[TWikiPlugins]], [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]], [[TWikiPreferences]]
  93
  94 -- [[TWikiContributor]] - 01 Feb 2006