data/TWiki/EmptyPlugin.txt,v
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 head	1.10;
     2 access;
     3 symbols;
     4 locks; strict;
     5 comment	@# @;
     6 
     7 
     8 1.10
     9 date	2008.01.22.03.21.30;	author TWikiContributor;	state Exp;
    10 branches;
    11 next	1.9;
    12 
    13 1.9
    14 date	2007.01.16.04.12.04;	author TWikiContributor;	state Exp;
    15 branches;
    16 next	1.8;
    17 
    18 1.8
    19 date	2006.04.01.05.55.29;	author TWikiContributor;	state Exp;
    20 branches;
    21 next	1.7;
    22 
    23 1.7
    24 date	2006.02.01.12.01.22;	author TWikiContributor;	state Exp;
    25 branches;
    26 next	1.6;
    27 
    28 1.6
    29 date	2004.03.21.08.04.00;	author PeterThoeny;	state Exp;
    30 branches;
    31 next	1.5;
    32 
    33 1.5
    34 date	2002.06.13.05.54.00;	author PeterThoeny;	state Exp;
    35 branches;
    36 next	1.4;
    37 
    38 1.4
    39 date	2002.01.05.08.30.43;	author PeterThoeny;	state Exp;
    40 branches;
    41 next	1.3;
    42 
    43 1.3
    44 date	2001.07.14.09.20.08;	author PeterThoeny;	state Exp;
    45 branches;
    46 next	1.2;
    47 
    48 1.2
    49 date	2001.07.09.08.56.30;	author PeterThoeny;	state Exp;
    50 branches;
    51 next	1.1;
    52 
    53 1.1
    54 date	2001.03.14.02.24.02;	author PeterThoeny;	state Exp;
    55 branches;
    56 next	;
    57 
    58 
    59 desc
    60 @none
    61 @
    62 
    63 
    64 1.10
    65 log
    66 @buildrelease
    67 @
    68 text
    69 @%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="10"}%
    70 ---+ Empty TWiki Plugin
    71 
    72 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.
    73 
    74 To create your own Plugin:
    75 
    76    * Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==&lt;name&gt;Plugin.pm== and customize the plugin.
    77    * 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.
    78    * See details in %TWIKIWEB%.TWikiPlugins.
    79 
    80 ---++ Syntax Rules
    81 
    82 (none)
    83 
    84 ---++ Plugin Settings
    85 
    86 Plugin settings are stored as preferences variables. To reference
    87 a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
    88 
    89    * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
    90       * Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins
    91 
    92    * Your own setting, for example:
    93       * Set EXAMPLE = got it!
    94 
    95    * Debug plugin: ( TWiki sets =$debug= in your plugin. See output in =data/debug.txt=.)
    96       * Set DEBUG = 0
    97 
    98 ---++ Plugin Installation Instructions
    99 
   100    * This plugin is preinstalled, you do not need to install it.
   101 
   102 ---++ Plugin Info
   103 
   104 |  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie |
   105 |  Copyright: | &copy; 2001-2007, %TWIKIWEB%.TWikiContributor |
   106 |  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
   107 |  Plugin Version: | 15942 (22 Jan 2008) |
   108 |  Change History: | <!-- versions below in reverse order -->&nbsp; |
   109 |  20 May 2007 | Added renderWikiWordHandler |
   110 |  01 Feb 2006: | Dakar changes |
   111 |  21 Mar 2004: | Added afterSaveHandler |
   112 |  14 Jul 2001: | Changed to plug&amp;play |
   113 |  27 Feb 2001: | Initial version |
   114 |  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 |
   115 |  Dependencies: | %$DEPENDENCIES |
   116 |  TWiki:Plugins/Benchmark: | %TWIKIWEB%.GoodStyle 99%, %TWIKIWEB%.FormattedSearch 99%, %TOPIC% 99% |
   117 |  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
   118 |  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
   119 |  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
   120 
   121 __Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences
   122 
   123 -- %TWIKIWEB%.TWikiContributor - 01 Feb 2006
   124 @
   125 
   126 
   127 1.9
   128 log
   129 @buildrelease
   130 @
   131 text
   132 @d1 1
   133 a1 1
   134 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="9"}%
   135 d16 14
   136 d37 1
   137 a37 1
   138 |  Copyright: | &copy; 2001-2006, %TWIKIWEB%.TWikiContributor |
   139 d39 1
   140 a39 1
   141 |  Plugin Version: | 01 Feb 2006 |
   142 d41 1
   143 d47 1
   144 a47 3
   145 |  CPAN Dependencies: | none |
   146 |  Other Dependencies: | none |
   147 |  Perl Version: | 5.005 |
   148 @
   149 
   150 
   151 1.8
   152 log
   153 @buildrelease
   154 @
   155 text
   156 @d1 1
   157 a1 1
   158 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="8"}%
   159 a15 14
   160 ---++ Plugin Settings
   161 
   162 Plugin settings are stored as preferences variables. To reference
   163 a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
   164 
   165    * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
   166       * Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins
   167 
   168    * Your own setting, for example:
   169       * Set EXAMPLE = got it!
   170 
   171    * Debug plugin: (See output in =data/debug.txt=)
   172       * Set DEBUG = 0
   173 
   174 @
   175 
   176 
   177 1.7
   178 log
   179 @buildrelease
   180 @
   181 text
   182 @d1 1
   183 a1 1
   184 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="7"}%
   185 d4 1
   186 a4 1
   187 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.
   188 d6 1
   189 a6 1
   190 To create your own plugin:
   191 d8 3
   192 a10 3
   193 	* Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==&lt;name&gt;Plugin.pm== and customize the plugin.
   194 	* Create a  ==&lt;name&gt;Plugin== 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.
   195 	* See details in %TWIKIWEB%.TWikiPlugins.
   196 d21 2
   197 a22 2
   198 	* One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
   199 		* Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
   200 d24 2
   201 a25 2
   202 	* Your own setting, for example:
   203 		* Set EXAMPLE = got it!
   204 d27 2
   205 a28 2
   206 	* Debug plugin: (See output in =data/debug.txt=)
   207 		* Set DEBUG = 0
   208 d32 1
   209 a32 1
   210 	* This plugin is preinstalled, you do not need to install it.
   211 d36 4
   212 a39 2
   213 |  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
   214 |  Plugin Version: | 21 Mar 2004 |
   215 d41 1
   216 d45 1
   217 d48 1
   218 a48 1
   219 |  Perl Version: | 5.0 |
   220 d54 1
   221 a54 2
   222 __Related Topics:__ DeveloperDocumentationCategory, AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins
   223 
   224 d56 1
   225 @
   226 
   227 
   228 1.6
   229 log
   230 @none
   231 @
   232 text
   233 @d1 52
   234 a52 52
   235 %META:TOPICINFO{author="PeterThoeny" date="1079856240" format="1.0" version="1.6"}%
   236 ---+ Empty TWiki Plugin
   237 
   238 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.
   239 
   240 To create your own plugin:
   241 
   242 	* Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==&lt;name&gt;Plugin.pm== and customize the plugin.
   243 	* Create a  ==&lt;name&gt;Plugin== 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.
   244 	* See details in %TWIKIWEB%.TWikiPlugins.
   245 
   246 ---++ Syntax Rules
   247 
   248 (none)
   249 
   250 ---++ Plugin Settings
   251 
   252 Plugin settings are stored as preferences variables. To reference
   253 a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
   254 
   255 	* One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
   256 		* Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
   257 
   258 	* Your own setting, i.e.:
   259 		* Set EXAMPLE = got it!
   260 
   261 	* Debug plugin: (See output in =data/debug.txt=)
   262 		* Set DEBUG = 0
   263 
   264 ---++ Plugin Installation Instructions
   265 
   266 	* This plugin is preinstalled, you do not need to install it.
   267 
   268 ---++ Plugin Info
   269 
   270 |  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
   271 |  Plugin Version: | 21 Mar 2003 |
   272 |  Change History: | <!-- versions below in reverse order -->&nbsp; |
   273 |  21 Mar 2004: | Added afterSaveHandler |
   274 |  14 Jul 2001: | Changed to plug&amp;play |
   275 |  27 Feb 2001: | Initial version |
   276 |  CPAN Dependencies: | none |
   277 |  Other Dependencies: | none |
   278 |  Perl Version: | 5.0 |
   279 |  TWiki:Plugins/Benchmark: | %TWIKIWEB%.GoodStyle 99%, %TWIKIWEB%.FormattedSearch 99%, %TOPIC% 99% |
   280 |  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
   281 |  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
   282 
   283 __Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, DefaultPlugin
   284 
   285 -- TWiki:Main.AndreaSterbini - 27 Feb 2001 %BR% 
   286 -- TWiki:Main.PeterThoeny - 21 Mar 2004
   287 @
   288 
   289 
   290 1.5
   291 log
   292 @none
   293 @
   294 text
   295 @d1 1
   296 a1 1
   297 %META:TOPICINFO{author="PeterThoeny" date="1023947640" format="1.0" version="1.5"}%
   298 d14 1
   299 a14 1
   300 (describe the syntax)
   301 d16 1
   302 a16 1
   303 ---++ <nop>%TOPIC% Global Settings
   304 d18 2
   305 a19 1
   306 Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
   307 d21 1
   308 a21 1
   309 	* One line description, shown in the %TWIKIWEB%.TextFormattingRules topic:
   310 d24 1
   311 a24 1
   312 	* Your own settings, for example:
   313 d32 1
   314 a32 12
   315 (This plugin is preinstalled, you do not need to install it.)
   316 
   317 __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.
   318 
   319 	* Download the ZIP file from the Plugin web (see below)
   320 	* Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
   321 	  | *File:* | *Description:* |
   322 	  | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
   323 	  | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository |
   324 	  | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
   325 	* Test if the plugin is correctly installed:
   326 		* (describe tests here)
   327 d36 4
   328 a39 3
   329 |  Plugin Author: | %TWIKIWEB%.AndreaSterbini, %TWIKIWEB%.PeterThoeny |
   330 |  Plugin Version: | 14 Jul 2001 (V1.000) |
   331 |  Change History: | <!-- specify latest version first -->&nbsp; |
   332 d44 2
   333 a45 1
   334 |  Perl Version: | 5.005 |
   335 d51 2
   336 a52 2
   337 -- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br /> 
   338 -- %TWIKIWEB%.PeterThoeny - 14 Jul 2001
   339 @
   340 
   341 
   342 1.4
   343 log
   344 @none
   345 @
   346 text
   347 @d1 2
   348 a2 2
   349 %META:TOPICINFO{author="PeterThoeny" date="1010219443" format="1.0" version="1.4"}%
   350 ---++ Empty TWiki Plugin
   351 d12 1
   352 a12 1
   353 ---+++ Syntax Rules
   354 d14 1
   355 a14 1
   356 (none)
   357 d16 1
   358 a16 1
   359 ---+++ <nop>%TOPIC% Settings
   360 d18 1
   361 a18 2
   362 Plugin settings are stored as preferences variables. To reference
   363 a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
   364 d23 1
   365 a23 1
   366 	* Your own setting, i.e.:
   367 d29 1
   368 a29 1
   369 ---+++ Plugin Installation Instructions
   370 d31 1
   371 a31 1
   372 	* This plugin is preinstalled, you do not need to install it.
   373 d33 12
   374 a44 1
   375 ---+++ Plugin Info
   376 d47 4
   377 a50 2
   378 |  Plugin Version: | 14 Jul 2001 |
   379 |  Change History: | 14 Jul 2001: Changed to plug&play <br> 27 Feb 2001: Initial version |
   380 d53 1
   381 a53 1
   382 |  Perl Version: | 5.0 |
   383 d59 2
   384 a60 2
   385 -- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br> 
   386 -- %TWIKIWEB%.PeterThoeny - 14 Jul 2001 <br>
   387 @
   388 
   389 
   390 1.3
   391 log
   392 @none
   393 @
   394 text
   395 @d1 1
   396 a1 1
   397 %META:TOPICINFO{author="PeterThoeny" date="995149114" format="1.0beta2" version="1.3"}%
   398 d19 1
   399 a19 1
   400 a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
   401 d21 1
   402 a21 1
   403 	* One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
   404 @
   405 
   406 
   407 1.2
   408 log
   409 @none
   410 @
   411 text
   412 @d1 1
   413 a1 1
   414 %META:TOPICINFO{version="1.2" date="994668989" author="PeterThoeny" format="1.0beta2"}%
   415 d9 1
   416 a9 1
   417 	* Copy this topic to ==&lt;name&gt;Plugin== and customize it.
   418 d16 1
   419 a16 1
   420 ---+++ <nop>%TOPIC% Preferences
   421 d18 2
   422 a19 2
   423 Plugin preferences are stored as preferences variables. To reference
   424 a plugin preference write ==%<nop>&lt;plugin&nbsp;name&gt;_&lt;preference&nbsp;name&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
   425 d21 1
   426 a21 1
   427 	* One line description, is included in the %TWIKIWEB%.TextFormattingRules topic:
   428 d24 5
   429 a28 2
   430 	* Your own preferences, i.e.:
   431 		* Set COLOR = red
   432 d37 2
   433 a38 2
   434 |  Plugin Version: | 08 Jul 2001 |
   435 |  Change History: | 08 Jul 2001: Changed to plug&play <br> 27 Feb 2001: Initial version |
   436 d48 1
   437 a48 1
   438 -- %TWIKIWEB%.PeterThoeny - 08 Jul 2001 <br>
   439 @
   440 
   441 
   442 1.1
   443 log
   444 @none
   445 @
   446 text
   447 @d1 2
   448 a2 1
   449 *Empty TWiki Plugin*
   450 d4 1
   451 a4 1
   452 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.
   453 d6 1
   454 a6 1
   455 Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==&lt;name&gt;Plugin.pm== and customize the plugin.
   456 d8 3
   457 a10 1
   458 __Related Topics:__ TWikiPreferences, TWikiPlugins, DefaultPlugin
   459 d12 34
   460 a45 1
   461 -- Main.PeterThoeny - 13 Mar 2001 <br>
   462 @