1 # <a name="Empty TWiki Plugin"></a> Empty TWiki Plugin
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.
5 To create your own plugin:
7 - Copy file <code>**TWiki/Plugins/EmptyPlugin.pm**</code> to <code>**<name>Plugin.pm**</code> and customize the plugin.
8 - Create a <code>**<name>Plugin**</code> topic in the TWiki web. Do so by visiting <http://TWiki.org/cgi-bin/view/Plugins/> 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]].
11 ## <a name="Syntax Rules"></a> Syntax Rules
15 ## <a name="Plugin Settings"></a> Plugin Settings
17 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, i.e. <code>**%EMPTYPLUGIN\_SHORTDESCRIPTION%**</code>
19 - One line description, is shown in the [[TextFormattingRules]] topic:
20 - Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
22 - Your own setting, i.e.:
23 - Set EXAMPLE = got it!
25 - Debug plugin: (See output in `data/debug.txt`)
28 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
30 - This plugin is preinstalled, you do not need to install it.
32 ## <a name="Plugin Info"></a> Plugin Info
34 <table border="1" cellpadding="0" cellspacing="0">
36 <td align="right"> Plugin Author: </td>
37 <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny </td>
40 <td align="right"> Plugin Version: </td>
41 <td> 21 Mar 2003 </td>
44 <td align="right"> Change History: </td>
48 <td align="right"> 21 Mar 2004: </td>
49 <td> Added afterSaveHandler </td>
52 <td align="right"> 14 Jul 2001: </td>
53 <td> Changed to plug&play </td>
56 <td align="right"> 27 Feb 2001: </td>
57 <td> Initial version </td>
60 <td align="right"> CPAN Dependencies: </td>
64 <td align="right"> Other Dependencies: </td>
68 <td align="right"> Perl Version: </td>
72 <td align="right"> TWiki:Plugins/Benchmark: </td>
73 <td>[[TWiki/GoodStyle]] 99%, [[TWiki/FormattedSearch]] 99%, %TOPIC% 99% </td>
76 <td align="right"> Plugin Home: </td>
77 <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
80 <td align="right"> Feedback: </td>
81 <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 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], [[DefaultPlugin]]
87 -- TWiki:Main.AndreaSterbini - 27 Feb 2001 %BR% -- TWiki:Main.PeterThoeny - 21 Mar 2004