37fd24ea591fbb3700d01a74047fec5d60b4dddd
[openafs-wiki.git] / 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 - Copy this topic to <code>**&lt;name&gt;Plugin**</code> and customize it.
9 - See details in [[TWikiPlugins]].
10
11 ### <a name="Syntax Rules"></a> Syntax Rules
12
13 (none)
14
15 ### <a name="%TOPIC% Preferences"></a> %TOPIC% Preferences
16
17 Plugin preferences are stored as preferences variables. To reference a plugin preference write <code>**%&lt;plugin┬áname&gt;\_&lt;preference┬áname&gt;%**</code>, i.e. <code>**%EMPTYPLUGIN\_SHORTDESCRIPTION%**</code>
18
19 - One line description, is included in the [[TextFormattingRules]] topic:
20   - Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
21
22 - Your own preferences, i.e.:
23   - Set COLOR = red
24
25 ### <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
26
27 - This plugin is preinstalled, you do not need to install it.
28
29 ### <a name="Plugin Info"></a> Plugin Info
30
31 <table border="1" cellpadding="0" cellspacing="0">
32   <tr>
33     <td align="right"> Plugin Author: </td>
34     <td>[[TWiki/AndreaSterbini]], [[TWiki/PeterThoeny]]</td>
35   </tr>
36   <tr>
37     <td align="right"> Plugin Version: </td>
38     <td> 08 Jul 2001 </td>
39   </tr>
40   <tr>
41     <td align="right"> Change History: </td>
42     <td> 08 Jul 2001: Changed to plug&amp;play <br /> 27 Feb 2001: Initial version </td>
43   </tr>
44   <tr>
45     <td align="right"> CPAN Dependencies: </td>
46     <td> none </td>
47   </tr>
48   <tr>
49     <td align="right"> Other Dependencies: </td>
50     <td> none </td>
51   </tr>
52   <tr>
53     <td align="right"> Perl Version: </td>
54     <td> 5.0 </td>
55   </tr>
56   <tr>
57     <td align="right"> Plugin Home: </td>
58     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
59   </tr>
60   <tr>
61     <td align="right"> Feedback: </td>
62     <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>
63   </tr>
64 </table>
65
66 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], [[DefaultPlugin]]
67
68 -- [[AndreaSterbini]] - 27 Feb 2001 <br /> -- [[PeterThoeny]] - 08 Jul 2001 <br />