TWiki/EmptyPlugin.mdwn


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

## <a name="Empty_TWiki_Plugin"> Empty TWiki Plugin </a>

This is an empty plugin you can use as a template to build your own %TWIKIWEB%.TWikiPlugins. This plugin does nothing, but is ready to be used.

To create your own plugin:

* Copy file <code>**TWiki/Plugins/EmptyPlugin.pm**</code> to <code>**&lt;name&gt;Plugin.pm**</code> and customize the plugin.
* Create a <code>**&lt;name&gt;Plugin**</code> topic in the %TWIKIWEB% 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.
* See details in %TWIKIWEB%.TWikiPlugins.

### <a name="Syntax_Rules"> Syntax Rules </a>

(none)

### <a name="_TOPIC_Settings"> %TOPIC% Settings </a>

Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, i.e. <code>**%EMPTYPLUGIN\_SHORTDESCRIPTION%**</code>

* One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
  * Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.

* Your own setting, i.e.:
  * Set EXAMPLE = got it!

* Debug plugin: (See output in `data/debug.txt`)
  * Set DEBUG = 0

### <a name="Plugin_Installation_Instructions"> Plugin Installation Instructions </a>

* This plugin is preinstalled, you do not need to install it.

### <a name="Plugin_Info"> Plugin Info </a>

<table border="1" cellpadding="1" cellspacing="0">
  <tr>
    <td align="right"> Plugin Author: </td>
    <td> %TWIKIWEB%.AndreaSterbini, %TWIKIWEB%.PeterThoeny </td>
  </tr>
  <tr>
    <td align="right"> Plugin Version: </td>
    <td> 14 Jul 2001 </td>
  </tr>
  <tr>
    <td align="right"> Change History: </td>
    <td> 14 Jul 2001: Changed to plug&amp;amp;play <br /> 27 Feb 2001: Initial version </td>
  </tr>
  <tr>
    <td align="right"> CPAN Dependencies: </td>
    <td> none </td>
  </tr>
  <tr>
    <td align="right"> Other Dependencies: </td>
    <td> none </td>
  </tr>
  <tr>
    <td align="right"> Perl Version: </td>
    <td> 5.0 </td>
  </tr>
  <tr>
    <td align="right"> Plugin Home: </td>
    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
  </tr>
  <tr>
    <td align="right"> Feedback: </td>
    <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>
  </tr>
</table>

**_Related Topics:_** %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, [[DefaultPlugin]]

-- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br /> -- %TWIKIWEB%.PeterThoeny - 14 Jul 2001 <br />