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 Settings"></a> Plugin Settings
  16
  17 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, i.e. <code>**%EMPTYPLUGIN\_SHORTDESCRIPTION%**</code>
  18
  19 - One line description, is shown in the [[TextFormattingRules]] topic:
  20   - Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins
  21
  22 - Your own setting, for example:
  23   - Set EXAMPLE = got it!
  24
  25 - Debug plugin: ( TWiki sets `$debug` in your plugin. See output in `data/debug.txt`.)
  26   - Set DEBUG = 0
  27
  28 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
  29
  30 - This plugin is preinstalled, you do not need to install it.
  31
  32 ## <a name="Plugin Info"></a> Plugin Info
  33
  34 <table border="1" cellpadding="0" cellspacing="0">
  35   <tr>
  36     <td align="right"> Plugin Author: </td>
  37     <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie </td>
  38   </tr>
  39   <tr>
  40     <td align="right"> Copyright: </td>
  41     <td> © 2001-2007, [[TWiki/TWikiContributor]]</td>
  42   </tr>
  43   <tr>
  44     <td align="right"> License: </td>
  45     <td> GPL (<a href="http://www.gnu.org/copyleft/gpl.html" target="_top">GNU General Public License</a>) </td>
  46   </tr>
  47   <tr>
  48     <td align="right"> Plugin Version: </td>
  49     <td> 15942 (30 Mar 2009) </td>
  50   </tr>
  51   <tr>
  52     <td align="right"> Change History: </td>
  53     <td>  </td>
  54   </tr>
  55   <tr>
  56     <td align="right"> 20 May 2007 </td>
  57     <td> Added renderWikiWordHandler </td>
  58   </tr>
  59   <tr>
  60     <td align="right"> 01 Feb 2006: </td>
  61     <td> Dakar changes </td>
  62   </tr>
  63   <tr>
  64     <td align="right"> 21 Mar 2004: </td>
  65     <td> Added afterSaveHandler </td>
  66   </tr>
  67   <tr>
  68     <td align="right"> 14 Jul 2001: </td>
  69     <td> Changed to plug&amp;play </td>
  70   </tr>
  71   <tr>
  72     <td align="right"> 27 Feb 2001: </td>
  73     <td> Initial version </td>
  74   </tr>
  75   <tr>
  76     <td align="right"> TWiki Dependency: </td>
  77     <td> $TWiki::Plugins::VERSION 1.1 </td>
  78   </tr>
  79   <tr>
  80     <td align="right"> Dependencies: </td>
  81     <td> %$DEPENDENCIES </td>
  82   </tr>
  83   <tr>
  84     <td align="right"> TWiki:Plugins/Benchmark: </td>
  85     <td>[[TWiki/GoodStyle]] 99%, [[TWiki/FormattedSearch]] 99%, %TOPIC% 99% </td>
  86   </tr>
  87   <tr>
  88     <td align="right"> Plugin Home: </td>
  89     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
  90   </tr>
  91   <tr>
  92     <td align="right"> Feedback: </td>
  93     <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>
  94   </tr>
  95   <tr>
  96     <td align="right"> Appraisal: </td>
  97     <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>
  98   </tr>
  99 </table>
 100
 101 **_Related Topics:_** [[TWikiPlugins]], [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]], [[TWikiPreferences]]
 102
 103 -- [[TWikiContributor]] - 01 Feb 2006