data/TWiki/EmptyPlugin.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="10"}%
     2 ---+ Empty TWiki Plugin
     3 
     4 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.
     5 
     6 To create your own Plugin:
     7 
     8    * Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==&lt;name&gt;Plugin.pm== and customize the plugin.
     9    * Create a  ==&lt;name&gt;Plugin== topic in the %TWIKIWEB% 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.
    10    * See details in %TWIKIWEB%.TWikiPlugins.
    11 
    12 ---++ Syntax Rules
    13 
    14 (none)
    15 
    16 ---++ Plugin Settings
    17 
    18 Plugin settings are stored as preferences variables. To reference
    19 a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
    20 
    21    * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
    22       * Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins
    23 
    24    * Your own setting, for example:
    25       * Set EXAMPLE = got it!
    26 
    27    * Debug plugin: ( TWiki sets =$debug= in your plugin. See output in =data/debug.txt=.)
    28       * Set DEBUG = 0
    29 
    30 ---++ Plugin Installation Instructions
    31 
    32    * This plugin is preinstalled, you do not need to install it.
    33 
    34 ---++ Plugin Info
    35 
    36 |  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie |
    37 |  Copyright: | &copy; 2001-2007, %TWIKIWEB%.TWikiContributor |
    38 |  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
    39 |  Plugin Version: | 15942 (22 Jan 2008) |
    40 |  Change History: | <!-- versions below in reverse order -->&nbsp; |
    41 |  20 May 2007 | Added renderWikiWordHandler |
    42 |  01 Feb 2006: | Dakar changes |
    43 |  21 Mar 2004: | Added afterSaveHandler |
    44 |  14 Jul 2001: | Changed to plug&amp;play |
    45 |  27 Feb 2001: | Initial version |
    46 |  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 |
    47 |  Dependencies: | %$DEPENDENCIES |
    48 |  TWiki:Plugins/Benchmark: | %TWIKIWEB%.GoodStyle 99%, %TWIKIWEB%.FormattedSearch 99%, %TOPIC% 99% |
    49 |  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
    50 |  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
    51 |  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
    52 
    53 __Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences
    54 
    55 -- %TWIKIWEB%.TWikiContributor - 01 Feb 2006