diff options
Diffstat (limited to 'TWiki')
| -rw-r--r-- | TWiki/EmptyPlugin.mdwn | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/TWiki/EmptyPlugin.mdwn b/TWiki/EmptyPlugin.mdwn index b71fb5f7..af0e8796 100644 --- a/TWiki/EmptyPlugin.mdwn +++ b/TWiki/EmptyPlugin.mdwn @@ -5,22 +5,25 @@ This is an empty plugin you can use as a template to build your own %TWIKIWEB%.T To create your own plugin: * Copy file <code>**TWiki/Plugins/EmptyPlugin.pm**</code> to <code>**<name>Plugin.pm**</code> and customize the plugin. -* Copy this topic to <code>**<name>Plugin**</code> and customize it. +* Create a <code>**<name>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_Preferences"> %TOPIC% Preferences </a> +### <a name="_TOPIC_Settings"> %TOPIC% Settings </a> -Plugin preferences are stored as preferences variables. To reference a plugin preference write <code>**%<plugin name>\_<preference name>%**</code>, i.e. <code>**%EMPTYPLUGIN\_SHORTDESCRIPTION%**</code> +Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, i.e. <code>**%EMPTYPLUGIN\_SHORTDESCRIPTION%**</code> -* One line description, is included in the %TWIKIWEB%.TextFormattingRules topic: +* 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 preferences, i.e.: - * Set COLOR = red +* 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> @@ -35,11 +38,11 @@ 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 </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> 14 Jul 2001: Changed to plug&amp;play <br /> 27 Feb 2001: Initial version </td> </tr> <tr> <td align="right"> CPAN Dependencies: </td> @@ -65,4 +68,4 @@ Plugin preferences are stored as preferences variables. To reference a plugin pr **_Related Topics:_** %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, [[DefaultPlugin]] --- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br /> -- %TWIKIWEB%.PeterThoeny - 08 Jul 2001 <br /> +-- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br /> -- %TWIKIWEB%.PeterThoeny - 14 Jul 2001 <br /> |