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/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]].
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 = Empty Plugin used as a template for new Plugins
22 - Your own setting, for example:
23 - Set EXAMPLE = got it!
25 - Debug plugin: ( TWiki sets `$debug` in your 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, TWiki:Main.CrawfordCurrie </td>
40 <td align="right"> Copyright: </td>
41 <td> © 2001-2007, [[TWiki/TWikiContributor]]</td>
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>
48 <td align="right"> Plugin Version: </td>
49 <td> 15942 (04 Aug 2008) </td>
52 <td align="right"> Change History: </td>
56 <td align="right"> 20 May 2007 </td>
57 <td> Added renderWikiWordHandler </td>
60 <td align="right"> 01 Feb 2006: </td>
61 <td> Dakar changes </td>
64 <td align="right"> 21 Mar 2004: </td>
65 <td> Added afterSaveHandler </td>
68 <td align="right"> 14 Jul 2001: </td>
69 <td> Changed to plug&play </td>
72 <td align="right"> 27 Feb 2001: </td>
73 <td> Initial version </td>
76 <td align="right"> TWiki Dependency: </td>
77 <td> $TWiki::Plugins::VERSION 1.1 </td>
80 <td align="right"> Dependencies: </td>
81 <td> %$DEPENDENCIES </td>
84 <td align="right"> TWiki:Plugins/Benchmark: </td>
85 <td>[[TWiki/GoodStyle]] 99%, [[TWiki/FormattedSearch]] 99%, %TOPIC% 99% </td>
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>
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>
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>
101 **_Related Topics:_** [[TWikiPlugins]], [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]], [[TWikiPreferences]]
103 -- [[TWikiContributor]] - 01 Feb 2006