none
[openafs-wiki.git] / TWiki / EmptyPlugin.mdwn
index 37fd24e..dd06c94 100644 (file)
@@ -1,32 +1,59 @@
-## <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.
 
 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.
-- Copy this topic to <code>**&lt;name&gt;Plugin**</code> and customize it.
+- 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.
 - See details in [[TWikiPlugins]].
 
-### <a name="Syntax Rules"></a> Syntax Rules
+## <a name="Syntax Rules"></a> Syntax Rules
 
-(none)
+(describe the syntax)
 
-### <a name="%TOPIC% Preferences"></a> %TOPIC% Preferences
+## <a name="%TOPIC% Global Settings"></a> %TOPIC% Global Settings
 
-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>
+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>
 
-- One line description, is included in the [[TextFormattingRules]] topic:
+- 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.
 
-- Your own preferences, i.e.:
-  - Set COLOR = red
+- Your own settings, for example:
+  - Set EXAMPLE = got it!
 
-### <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
+- Debug plugin: (See output in `data/debug.txt`)
+  - Set DEBUG = 0
 
-- This plugin is preinstalled, you do not need to install it.
+## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 
-### <a name="Plugin Info"></a> Plugin Info
+(This plugin is preinstalled, you do not need to install it.)
+
+**_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.
+
+- Download the ZIP file from the Plugin web (see below)
+- Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
+  <tr>
+    <th bgcolor="#99CCCC"><strong> File: </strong></th>
+    <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+  </tr>
+  <tr>
+    <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
+    <td> Plugin topic </td>
+  </tr>
+  <tr>
+    <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
+    <td> Plugin topic repository </td>
+  </tr>
+  <tr>
+    <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
+    <td> Plugin Perl module </td>
+  </tr>
+</table>
+- Test if the plugin is correctly installed:
+  - (describe tests here)
+
+## <a name="Plugin Info"></a> Plugin Info
 
 <table border="1" cellpadding="0" cellspacing="0">
   <tr>
@@ -35,11 +62,19 @@ Plugin preferences are stored as preferences variables. To reference a plugin pr
   </tr>
   <tr>
     <td align="right"> Plugin Version: </td>
-    <td> 08 Jul 2001 </td>
+    <td> 14 Jul 2001 (V1.000) </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
-    <td> 08 Jul 2001: Changed to plug&amp;play <br /> 27 Feb 2001: Initial version </td>
+    <td>  </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"> CPAN Dependencies: </td>
@@ -51,7 +86,7 @@ Plugin preferences are stored as preferences variables. To reference a plugin pr
   </tr>
   <tr>
     <td align="right"> Perl Version: </td>
-    <td> 5.0 </td>
+    <td> 5.005 </td>
   </tr>
   <tr>
     <td align="right"> Plugin Home: </td>
@@ -65,4 +100,4 @@ Plugin preferences are stored as preferences variables. To reference a plugin pr
 
 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], [[DefaultPlugin]]
 
--- [[AndreaSterbini]] - 27 Feb 2001 <br /> -- [[PeterThoeny]] - 08 Jul 2001 <br />
+-- [[AndreaSterbini]] - 27 Feb 2001 <br /> -- [[PeterThoeny]] - 14 Jul 2001