buildrelease
[openafs-wiki.git] / TWiki / EmptyPlugin.mdwn
index f65e243..080cd22 100644 (file)
@@ -1,48 +1,76 @@
-## <a name="Empty TWiki Plugin"></a> Empty TWiki Plugin
+# <a name="Empty TWiki Plugin"></a> Empty TWiki Plugin
 
-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.
+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.
 
-To create your own plugin:
+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 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.
+- Create a <code>**&lt;name&gt;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.
 - See details in [[TWikiPlugins]].
 
-### <a name="Syntax Rules"></a> Syntax Rules
+## <a name="Syntax Rules"></a> Syntax Rules
 
 (none)
 
-### <a name="%TOPIC% Settings"></a> %TOPIC% Settings
+## <a name="Plugin Settings"></a> Plugin Settings
 
-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>
+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, shown in the [[TextFormattingRules]] topic:
-  - Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
+- One line description, is shown in the [[TextFormattingRules]] topic:
+  - Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins
 
-- Your own setting, i.e.:
+- Your own setting, for example:
   - Set EXAMPLE = got it!
 
 - Debug plugin: (See output in `data/debug.txt`)
   - Set DEBUG = 0
 
-### <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
+## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 
 - This plugin is preinstalled, you do not need to install it.
 
-### <a name="Plugin Info"></a> Plugin Info
+## <a name="Plugin Info"></a> Plugin Info
 
 <table border="1" cellpadding="0" cellspacing="0">
   <tr>
     <td align="right"> Plugin Author: </td>
-    <td>[[TWiki/AndreaSterbini]], [[TWiki/PeterThoeny]]</td>
+    <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie </td>
+  </tr>
+  <tr>
+    <td align="right"> Copyright: </td>
+    <td> © 2001-2006, [[TWiki/TWikiContributor]]</td>
+  </tr>
+  <tr>
+    <td align="right"> License: </td>
+    <td> GPL (<a href="http://www.gnu.org/copyleft/gpl.html" target="_top">GNU General Public License</a>) </td>
   </tr>
   <tr>
     <td align="right"> Plugin Version: </td>
-    <td> 14 Jul 2001 </td>
+    <td> 01 Feb 2006 </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
-    <td> 14 Jul 2001: Changed to plug&amp;play <br /> 27 Feb 2001: Initial version </td>
+    <td>  </td>
+  </tr>
+  <tr>
+    <td align="right"> 01 Feb 2006: </td>
+    <td> Dakar changes </td>
+  </tr>
+  <tr>
+    <td align="right"> 21 Mar 2004: </td>
+    <td> Added afterSaveHandler </td>
+  </tr>
+  <tr>
+    <td align="right"> 14 Jul 2001: </td>
+    <td> Changed to plug&amp;play </td>
+  </tr>
+  <tr>
+    <td align="right"> 27 Feb 2001: </td>
+    <td> Initial version </td>
+  </tr>
+  <tr>
+    <td align="right"> TWiki Dependency: </td>
+    <td> $TWiki::Plugins::VERSION 1.1 </td>
   </tr>
   <tr>
     <td align="right"> CPAN Dependencies: </td>
@@ -54,7 +82,11 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
   </tr>
   <tr>
     <td align="right"> Perl Version: </td>
-    <td> 5.0 </td>
+    <td> 5.005 </td>
+  </tr>
+  <tr>
+    <td align="right"> TWiki:Plugins/Benchmark: </td>
+    <td>[[TWiki/GoodStyle]] 99%, [[TWiki/FormattedSearch]] 99%, %TOPIC% 99% </td>
   </tr>
   <tr>
     <td align="right"> Plugin Home: </td>
@@ -64,8 +96,12 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
     <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>
+  <tr>
+    <td align="right"> Appraisal: </td>
+    <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>
+  </tr>
 </table>
 
-**_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], [[DefaultPlugin]]
+**_Related Topics:_** [[TWikiPlugins]], [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]], [[TWikiPreferences]]
 
--- [[AndreaSterbini]] - 27 Feb 2001 <br /> -- [[PeterThoeny]] - 14 Jul 2001 <br />
+-- [[TWikiContributor]] - 01 Feb 2006