dd06c94ac7af3800b31e2337dbe2f76548518aed
[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 (describe the syntax)
14
15 ## <a name="%TOPIC% Global Settings"></a> %TOPIC% Global 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 settings, for example:
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 **_Note:_** You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.
33
34 - Download the ZIP file from the Plugin web (see below)
35 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
36   <tr>
37     <th bgcolor="#99CCCC"><strong> File: </strong></th>
38     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
39   </tr>
40   <tr>
41     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
42     <td> Plugin topic </td>
43   </tr>
44   <tr>
45     <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
46     <td> Plugin topic repository </td>
47   </tr>
48   <tr>
49     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
50     <td> Plugin Perl module </td>
51   </tr>
52 </table>
53 - Test if the plugin is correctly installed:
54   - (describe tests here)
55
56 ## <a name="Plugin Info"></a> Plugin Info
57
58 <table border="1" cellpadding="0" cellspacing="0">
59   <tr>
60     <td align="right"> Plugin Author: </td>
61     <td>[[TWiki/AndreaSterbini]], [[TWiki/PeterThoeny]]</td>
62   </tr>
63   <tr>
64     <td align="right"> Plugin Version: </td>
65     <td> 14 Jul 2001 (V1.000) </td>
66   </tr>
67   <tr>
68     <td align="right"> Change History: </td>
69     <td>  </td>
70   </tr>
71   <tr>
72     <td align="right"> 14 Jul 2001: </td>
73     <td> Changed to plug&amp;play </td>
74   </tr>
75   <tr>
76     <td align="right"> 27 Feb 2001: </td>
77     <td> Initial version </td>
78   </tr>
79   <tr>
80     <td align="right"> CPAN Dependencies: </td>
81     <td> none </td>
82   </tr>
83   <tr>
84     <td align="right"> Other Dependencies: </td>
85     <td> none </td>
86   </tr>
87   <tr>
88     <td align="right"> Perl Version: </td>
89     <td> 5.005 </td>
90   </tr>
91   <tr>
92     <td align="right"> Plugin Home: </td>
93     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
94   </tr>
95   <tr>
96     <td align="right"> Feedback: </td>
97     <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>
98   </tr>
99 </table>
100
101 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], [[DefaultPlugin]]
102
103 -- [[AndreaSterbini]] - 27 Feb 2001 <br /> -- [[PeterThoeny]] - 14 Jul 2001