f65e243ad8760d20d09da070104deee377c1fb4f
[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 - Create a <code>**&lt;name&gt;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]].
10
11 ### <a name="Syntax Rules"></a> Syntax Rules
12
13 (none)
14
15 ### <a name="%TOPIC% Settings"></a> %TOPIC% Settings
16
17 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, for example, <code>**%EMPTYPLUGIN\_SHORTDESCRIPTION%**</code>
18
19 - One line description, shown 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 setting, i.e.:
23   - Set EXAMPLE = got it!
24
25 - Debug 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/AndreaSterbini]], [[TWiki/PeterThoeny]]</td>
38   </tr>
39   <tr>
40     <td align="right"> Plugin Version: </td>
41     <td> 14 Jul 2001 </td>
42   </tr>
43   <tr>
44     <td align="right"> Change History: </td>
45     <td> 14 Jul 2001: Changed to plug&amp;play <br /> 27 Feb 2001: Initial version </td>
46   </tr>
47   <tr>
48     <td align="right"> CPAN Dependencies: </td>
49     <td> none </td>
50   </tr>
51   <tr>
52     <td align="right"> Other Dependencies: </td>
53     <td> none </td>
54   </tr>
55   <tr>
56     <td align="right"> Perl Version: </td>
57     <td> 5.0 </td>
58   </tr>
59   <tr>
60     <td align="right"> Plugin Home: </td>
61     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
62   </tr>
63   <tr>
64     <td align="right"> Feedback: </td>
65     <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>
66   </tr>
67 </table>
68
69 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], [[DefaultPlugin]]
70
71 -- [[AndreaSterbini]] - 27 Feb 2001 <br /> -- [[PeterThoeny]] - 14 Jul 2001 <br />