wiki-archive/twiki/data/TWiki/EmptyPlugin.txt,v

head	1.9;
access;
symbols;
locks; strict;
comment	@# @;


1.9
date	2007.01.16.04.12.04;	author TWikiContributor;	state Exp;
branches;
next	1.8;

1.8
date	2006.04.01.05.55.29;	author TWikiContributor;	state Exp;
branches;
next	1.7;

1.7
date	2006.02.01.12.01.22;	author TWikiContributor;	state Exp;
branches;
next	1.6;

1.6
date	2004.03.21.08.04.00;	author PeterThoeny;	state Exp;
branches;
next	1.5;

1.5
date	2002.06.13.05.54.00;	author PeterThoeny;	state Exp;
branches;
next	1.4;

1.4
date	2002.01.05.08.30.43;	author PeterThoeny;	state Exp;
branches;
next	1.3;

1.3
date	2001.07.14.09.20.08;	author PeterThoeny;	state Exp;
branches;
next	1.2;

1.2
date	2001.07.09.08.56.30;	author PeterThoeny;	state Exp;
branches;
next	1.1;

1.1
date	2001.03.14.02.24.02;	author PeterThoeny;	state Exp;
branches;
next	;


desc
@none
@


1.9
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="9"}%
---+ Empty TWiki Plugin

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.

To create your own Plugin:

   * Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==<name>Plugin.pm== and customize the plugin.
   * Create a  ==<name>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.
   * See details in %TWIKIWEB%.TWikiPlugins.

---++ Syntax Rules

(none)

---++ Plugin Installation Instructions

   * This plugin is preinstalled, you do not need to install it.

---++ Plugin Info

|  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie |
|  Copyright: | © 2001-2006, %TWIKIWEB%.TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 01 Feb 2006 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  01 Feb 2006: | Dakar changes |
|  21 Mar 2004: | Added afterSaveHandler |
|  14 Jul 2001: | Changed to plug&amp;play |
|  27 Feb 2001: | Initial version |
|  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 |
|  TWiki:Plugins/Benchmark: | %TWIKIWEB%.GoodStyle 99%, %TWIKIWEB%.FormattedSearch 99%, %TOPIC% 99% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences

-- %TWIKIWEB%.TWikiContributor - 01 Feb 2006
@


1.8
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="8"}%
a15 14
---++ Plugin Settings

Plugin settings are stored as preferences variables. To reference
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==

   * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins

   * Your own setting, for example:
      * Set EXAMPLE = got it!

   * Debug plugin: (See output in =data/debug.txt=)
      * Set DEBUG = 0

@


1.7
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="7"}%
d4 1
a4 1
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.
d6 1
a6 1
To create your own plugin:
d8 3
a10 3
	* Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==&lt;name&gt;Plugin.pm== and customize the plugin.
	* 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.
	* See details in %TWIKIWEB%.TWikiPlugins.
d21 2
a22 2
	* 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.
d24 2
a25 2
	* Your own setting, for example:
		* Set EXAMPLE = got it!
d27 2
a28 2
	* Debug plugin: (See output in =data/debug.txt=)
		* Set DEBUG = 0
d32 1
a32 1
	* This plugin is preinstalled, you do not need to install it.
d36 4
a39 2
|  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
|  Plugin Version: | 21 Mar 2004 |
d41 1
d45 1
d48 1
a48 1
|  Perl Version: | 5.0 |
d54 1
a54 2
__Related Topics:__ DeveloperDocumentationCategory, AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins

d56 1
@


1.6
log
@none
@
text
@d1 52
a52 52
%META:TOPICINFO{author="PeterThoeny" date="1079856240" format="1.0" version="1.6"}%
---+ Empty TWiki Plugin

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.

To create your own plugin:

	* Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==&lt;name&gt;Plugin.pm== and customize the plugin.
	* 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.
	* See details in %TWIKIWEB%.TWikiPlugins.

---++ Syntax Rules

(none)

---++ Plugin Settings

Plugin settings are stored as preferences variables. To reference
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==

	* 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 setting, i.e.:
		* Set EXAMPLE = got it!

	* Debug plugin: (See output in =data/debug.txt=)
		* Set DEBUG = 0

---++ Plugin Installation Instructions

	* This plugin is preinstalled, you do not need to install it.

---++ Plugin Info

|  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
|  Plugin Version: | 21 Mar 2003 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  21 Mar 2004: | Added afterSaveHandler |
|  14 Jul 2001: | Changed to plug&amp;play |
|  27 Feb 2001: | Initial version |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.0 |
|  TWiki:Plugins/Benchmark: | %TWIKIWEB%.GoodStyle 99%, %TWIKIWEB%.FormattedSearch 99%, %TOPIC% 99% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, DefaultPlugin

-- TWiki:Main.AndreaSterbini - 27 Feb 2001 %BR% 
-- TWiki:Main.PeterThoeny - 21 Mar 2004
@


1.5
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1023947640" format="1.0" version="1.5"}%
d14 1
a14 1
(describe the syntax)
d16 1
a16 1
---++ <nop>%TOPIC% Global Settings
d18 2
a19 1
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%==
d21 1
a21 1
	* One line description, shown in the %TWIKIWEB%.TextFormattingRules topic:
d24 1
a24 1
	* Your own settings, for example:
d32 1
a32 12
(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 ==%TOPIC%.zip== in your twiki installation directory. Content:
	  | *File:* | *Description:* |
	  | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
	  | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository |
	  | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
	* Test if the plugin is correctly installed:
		* (describe tests here)
d36 4
a39 3
|  Plugin Author: | %TWIKIWEB%.AndreaSterbini, %TWIKIWEB%.PeterThoeny |
|  Plugin Version: | 14 Jul 2001 (V1.000) |
|  Change History: | <!-- specify latest version first -->&nbsp; |
d44 2
a45 1
|  Perl Version: | 5.005 |
d51 2
a52 2
-- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br /> 
-- %TWIKIWEB%.PeterThoeny - 14 Jul 2001
@


1.4
log
@none
@
text
@d1 2
a2 2
%META:TOPICINFO{author="PeterThoeny" date="1010219443" format="1.0" version="1.4"}%
---++ Empty TWiki Plugin
d12 1
a12 1
---+++ Syntax Rules
d14 1
a14 1
(none)
d16 1
a16 1
---+++ <nop>%TOPIC% Settings
d18 1
a18 2
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%==
d23 1
a23 1
	* Your own setting, i.e.:
d29 1
a29 1
---+++ Plugin Installation Instructions
d31 1
a31 1
	* This plugin is preinstalled, you do not need to install it.
d33 12
a44 1
---+++ Plugin Info
d47 4
a50 2
|  Plugin Version: | 14 Jul 2001 |
|  Change History: | 14 Jul 2001: Changed to plug&play <br> 27 Feb 2001: Initial version |
d53 1
a53 1
|  Perl Version: | 5.0 |
d59 2
a60 2
-- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br> 
-- %TWIKIWEB%.PeterThoeny - 14 Jul 2001 <br>
@


1.3
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="995149114" format="1.0beta2" version="1.3"}%
d19 1
a19 1
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
d21 1
a21 1
	* One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
@


1.2
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{version="1.2" date="994668989" author="PeterThoeny" format="1.0beta2"}%
d9 1
a9 1
	* Copy this topic to ==&lt;name&gt;Plugin== and customize it.
d16 1
a16 1
---+++ <nop>%TOPIC% Preferences
d18 2
a19 2
Plugin preferences are stored as preferences variables. To reference
a plugin preference write ==%<nop>&lt;plugin&nbsp;name&gt;_&lt;preference&nbsp;name&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%==
d21 1
a21 1
	* One line description, is included in the %TWIKIWEB%.TextFormattingRules topic:
d24 5
a28 2
	* Your own preferences, i.e.:
		* Set COLOR = red
d37 2
a38 2
|  Plugin Version: | 08 Jul 2001 |
|  Change History: | 08 Jul 2001: Changed to plug&play <br> 27 Feb 2001: Initial version |
d48 1
a48 1
-- %TWIKIWEB%.PeterThoeny - 08 Jul 2001 <br>
@


1.1
log
@none
@
text
@d1 2
a2 1
*Empty TWiki Plugin*
d4 1
a4 1
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.
d6 1
a6 1
Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==&lt;name&gt;Plugin.pm== and customize the plugin.
d8 3
a10 1
__Related Topics:__ TWikiPreferences, TWikiPlugins, DefaultPlugin
d12 34
a45 1
-- Main.PeterThoeny - 13 Mar 2001 <br>
@