Difference: EmptyPlugin (1 vs. 25)

Revision 2506 Jul 2018 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Revision 2418 Sep 2015 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Changed:
<
<
>
>
 
Changed:
<
<
>
>
 Empty Plugin used as a template for new plugins

Introduction

Line: 70 to 72
 
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Changed:
<
<
Copyright: © 2001-2013, TWiki:TWiki.TWikiContributor
>
>
Copyright: © 2001-2015 TWiki:Main.PeterThoeny, TWiki.org;
© 2001-2015 TWiki:TWiki.TWikiContributor
 
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 2013-09-27
>
>
Plugin Version: 2015-09-18
 
<--/twistyPlugin twikiMakeVisibleInline-->
Added:
>
>
2015-09-18: TWikibug:Item7689: Introducing topicTitleHandler() in plugins
2015-07-02: TWikibug:Item7604: Fix source code comment about parameters of TWiki variables
2015-01-10: TWikibug:Item7604: Switch from GPL v2 to v3
 
2013-09-27: TWikibug:Item7354: Align TWiki::Plugins::VERSION with TWiki release version, e.g. 6.00 for TWiki-6.0.0
2013-02-16: TWikibug:Item7123: Use TWISTY in installation instructions and change history
2013-02-11: TWikibug:Item7142: iewRedirectHandler() in plug-ins -- TWiki:Main.HideyoImazu

Revision 2327 Sep 2013 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Revision 2216 Feb 2013 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Revision 2113 Dec 2012 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Revision 2023 May 2011 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Revision 1923 May 2011 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Revision 1823 May 2011 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Revision 1707 Mar 2011 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Added:
>
>
 Empty Plugin used as a template for new plugins
Deleted:
<
<
 

Introduction

Line: 25 to 25
  (none)
Deleted:
<
<

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Empty Plugin used as a template for new plugins

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

  • Debug plugin: ( TWiki sets $debug in your plugin. See output in data/debug.txt.)
    • Set DEBUG = 0
 

Plugin Installation Instructions

  • This plugin is pre-installed, you do not need to install it.

Plugin Info

Changed:
<
<
Plugin Author: TWiki:Main/AndreaSterbini, TWiki:Main/PeterThoeny, TWiki:Main/CrawfordCurrie
Copyright: © 2001-2010, TWiki:TWiki/TWikiContributor
>
>
  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Empty Plugin used as a template for new plugins

Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2011, TWiki:TWiki.TWikiContributor
 
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 18620 (2010-05-29)
>
>
Plugin Version: 20632 (2011-05-03)
 
Change History:
<-- versions below in reverse order -->
 
Changed:
<
<
2010-05-08: TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB
>
>
2011-03-06: TWikibug:Item6656: Add meta data to attachment save handlers
2011-02-08: TWikibug:Item6593: Doc improvements; adding VarEXAMPLEVAR variable documentation
2010-05-08: TWikibug:Item6433: Doc improvements; replacing TWIKIWEB with SYSTEMWEB
 
2007-05-20: Added renderWikiWordHandler
2006-02-01: Dakar changes
2004-03-21: Added afterSaveHandler
Line: 62 to 54
 
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginAppraisal
Changed:
<
<
Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences
>
>
Related Topics: VarEXAMPLEVAR, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Revision 1608 May 2010 - TWikiContributor

Line: 1 to 1
Changed:
<
<

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 TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.
  • Create a <name>Plugin topic in the TWiki 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 TWikiPlugins.
>
>

Empty TWiki Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/EmptyPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/EmptyPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
Empty Plugin used as a template for new plugins

Introduction

This is an empty plugin. Use it 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 lib/TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin. Add your own code; remove all handlers you do not plan to use.
  • Create a <name>Plugin documentation topic in the TWiki web. Do so by visiting http://twiki.org/cgi-bin/view/Plugins/PluginPackageHowTo 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.
 

Syntax Rules

Line: 15 to 27
 

Plugin Settings

Changed:
<
<
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
>
>
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
 
Changed:
<
<
  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins
>
>
  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Empty Plugin used as a template for new plugins
 
  • Your own setting, for example:
    • Set EXAMPLE = got it!
Line: 29 to 40
 

Plugin Installation Instructions

Changed:
<
<
  • This plugin is preinstalled, you do not need to install it.
>
>
  • This plugin is pre-installed, you do not need to install it.
 

Plugin Info

Changed:
<
<
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2007, TWikiContributor
>
>
Plugin Author: TWiki:Main/AndreaSterbini, TWiki:Main/PeterThoeny, TWiki:Main/CrawfordCurrie
Copyright: © 2001-2010, TWiki:TWiki/TWikiContributor
 
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 15942 (02 Sep 2009)
>
>
Plugin Version: 18620 (2010-05-29)
 
Change History:
<-- versions below in reverse order -->
 
Changed:
<
<
20 May 2007 Added renderWikiWordHandler
01 Feb 2006: Dakar changes
21 Mar 2004: Added afterSaveHandler
14 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
>
>
2010-05-08: TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB
2007-05-20: Added renderWikiWordHandler
2006-02-01: Dakar changes
2004-03-21: Added afterSaveHandler
2001-07-14: Changed to plug&play
2001-02-27: Initial version
 
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
Dependencies: %$DEPENDENCIES
Changed:
<
<
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
>
>
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
 
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginAppraisal
Changed:
<
<
Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWikiContributor - 01 Feb 2006

>
>
Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Revision 1527 Mar 2005 - TWikiContributor

Line: 1 to 1
 

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.

Line: 36 to 36
 
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2007, TWikiContributor
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 15942 (29 Apr 2009)
>
>
Plugin Version: 15942 (02 Sep 2009)
 
Change History:
<-- versions below in reverse order -->
 
20 May 2007 Added renderWikiWordHandler
01 Feb 2006: Dakar changes

Revision 1427 Mar 2005 - TWikiContributor

Line: 1 to 1
 

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.

Line: 36 to 36
 
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2007, TWikiContributor
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 15942 (30 Mar 2009)
>
>
Plugin Version: 15942 (29 Apr 2009)
 
Change History:
<-- versions below in reverse order -->
 
20 May 2007 Added renderWikiWordHandler
01 Feb 2006: Dakar changes

Revision 1327 Mar 2005 - TWikiContributor

Line: 1 to 1
 

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.

Line: 36 to 36
 
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2007, TWikiContributor
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 15942 (06 Dec 2008)
>
>
Plugin Version: 15942 (30 Mar 2009)
 
Change History:
<-- versions below in reverse order -->
 
20 May 2007 Added renderWikiWordHandler
01 Feb 2006: Dakar changes

Revision 1227 Mar 2005 - TWikiContributor

Line: 1 to 1
 

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.

Line: 36 to 36
 
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2007, TWikiContributor
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 15942 (04 Aug 2008)
>
>
Plugin Version: 15942 (06 Dec 2008)
 
Change History:
<-- versions below in reverse order -->
 
20 May 2007 Added renderWikiWordHandler
01 Feb 2006: Dakar changes

Revision 1127 Mar 2005 - TWikiContributor

Line: 1 to 1
 

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.

Line: 36 to 36
 
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2007, TWikiContributor
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 15942 (22 Jan 2008)
>
>
Plugin Version: 15942 (04 Aug 2008)
 
Change History:
<-- versions below in reverse order -->
 
20 May 2007 Added renderWikiWordHandler
01 Feb 2006: Dakar changes

Revision 1027 Mar 2005 - TWikiContributor

Line: 1 to 1
 

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.

Line: 13 to 13
  (none)
Added:
>
>

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%

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

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

  • Debug plugin: ( TWiki sets $debug in your plugin. See output in data/debug.txt.)
    • Set DEBUG = 0
 

Plugin Installation Instructions

  • This plugin is preinstalled, you do not need to install it.
Line: 20 to 34
 

Plugin Info

Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Changed:
<
<
Copyright: © 2001-2006, TWikiContributor
>
>
Copyright: © 2001-2007, TWikiContributor
 
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 01 Feb 2006
>
>
Plugin Version: 15942 (22 Jan 2008)
 
Change History:
<-- versions below in reverse order -->
 
Added:
>
>
20 May 2007 Added renderWikiWordHandler
 
01 Feb 2006: Dakar changes
21 Mar 2004: Added afterSaveHandler
14 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
Changed:
<
<
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
>
>
Dependencies: %$DEPENDENCIES
 
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev

Revision 927 Mar 2005 - TWikiContributor

Line: 1 to 1
 

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.

Line: 13 to 13
  (none)
Deleted:
<
<

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the 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
 

Plugin Installation Instructions

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

Revision 827 Mar 2005 - TWikiContributor

Line: 1 to 1
 

Empty TWiki Plugin

Changed:
<
<
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.
>
>
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.
 
Changed:
<
<
To create your own plugin:
>
>
To create your own Plugin:
 
  • Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.
Changed:
<
<
  • Create a <name>Plugin 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.
>
>
 

Syntax Rules

Line: 19 to 19
 a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%

Changed:
<
<
    • Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
>
>
    • Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins
 
  • Your own setting, for example:
    • Set EXAMPLE = got it!
Line: 33 to 33
 

Plugin Info

Changed:
<
<
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
Plugin Version: 21 Mar 2004
>
>
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: © 2001-2006, TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 01 Feb 2006
 
Change History:
<-- versions below in reverse order -->
 
Added:
>
>
01 Feb 2006: Dakar changes
 
21 Mar 2004: Added afterSaveHandler
14 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
Added:
>
>
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
 
CPAN Dependencies: none
Other Dependencies: none
Changed:
<
<
Perl Version: 5.0
>
>
Perl Version: 5.005
 
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginAppraisal
Changed:
<
<
Related Topics: DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences, TWikiPlugins
>
>
Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences
 
Added:
>
>
-- TWikiContributor - 01 Feb 2006

Revision 727 Mar 2005 - TWikiContributor

Line: 1 to 1
 

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.

Line: 21 to 21
 
  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
Changed:
<
<
  • Your own setting, i.e.:
>
>
  • Your own setting, for example:
 
    • Set EXAMPLE = got it!

  • Debug plugin: (See output in data/debug.txt)
Line: 34 to 34
 

Plugin Info

Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
Changed:
<
<
Plugin Version: 21 Mar 2003
>
>
Plugin Version: 21 Mar 2004
 
Change History:
<-- versions below in reverse order -->
 
21 Mar 2004: Added afterSaveHandler
14 Jul 2001: Changed to plug&play
Line: 45 to 45
 
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev
Added:
>
>
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginAppraisal

Related Topics: DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences, TWikiPlugins

 
Deleted:
<
<
Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin
 
Deleted:
<
<
-- TWiki:Main.AndreaSterbini - 27 Feb 2001
-- TWiki:Main.PeterThoeny - 21 Mar 2004

Revision 621 Mar 2004 - PeterThoeny

Line: 1 to 1
 

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.

Line: 11 to 11
 

Syntax Rules

Changed:
<
<
(describe the syntax)
>
>
(none)
 
Changed:
<
<

EmptyPlugin Global Settings

>
>

Plugin Settings

 
Changed:
<
<
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %EMPTYPLUGIN_SHORTDESCRIPTION%
>
>
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
 
Changed:
<
<
>
>
 
    • Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
Changed:
<
<
  • Your own settings, for example:
>
>
  • Your own setting, i.e.:
 
    • Set EXAMPLE = got it!

  • Debug plugin: (See output in data/debug.txt)
Line: 28 to 29
 

Plugin Installation Instructions

Changed:
<
<
(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 EmptyPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/EmptyPlugin.txt Plugin topic
    data/TWiki/EmptyPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/EmptyPlugin.pm Plugin Perl module
  • Test if the plugin is correctly installed:
    • (describe tests here)
>
>
  • This plugin is preinstalled, you do not need to install it.
 

Plugin Info

Changed:
<
<
Plugin Author: AndreaSterbini, PeterThoeny
Plugin Version: 14 Jul 2001 (V1.000)
Change History:
<-- specify latest version first -->
 
>
>
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
Plugin Version: 21 Mar 2003
Change History:
<-- versions below in reverse order -->
 
21 Mar 2004: Added afterSaveHandler
 
14 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
CPAN Dependencies: none
Other Dependencies: none
Changed:
<
<
Perl Version: 5.005
>
>
Perl Version: 5.0
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
 
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

Changed:
<
<
-- AndreaSterbini - 27 Feb 2001
-- PeterThoeny - 14 Jul 2001
>
>
-- TWiki:Main.AndreaSterbini - 27 Feb 2001
-- TWiki:Main.PeterThoeny - 21 Mar 2004

Revision 513 Jun 2002 - PeterThoeny

Line: 1 to 1
Changed:
<
<

Empty TWiki Plugin

>
>

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.
Line: 9 to 9
 
  • Create a <name>Plugin 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.
Changed:
<
<

Syntax Rules

>
>

Syntax Rules

 
Changed:
<
<
(none)
>
>
(describe the syntax)
 
Changed:
<
<

EmptyPlugin Settings

>
>

EmptyPlugin Global Settings

 
Changed:
<
<
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %EMPTYPLUGIN_SHORTDESCRIPTION%
>
>
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %EMPTYPLUGIN_SHORTDESCRIPTION%
 
  • 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.
Changed:
<
<
  • Your own setting, i.e.:
>
>
  • Your own settings, for example:
 
    • Set EXAMPLE = got it!

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

Plugin Installation Instructions

>
>

Plugin Installation Instructions

 
Changed:
<
<
  • This plugin is preinstalled, you do not need to install it.
>
>
(This plugin is preinstalled, you do not need to install it.)
 
Changed:
<
<

Plugin Info

>
>
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 EmptyPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/EmptyPlugin.txt Plugin topic
    data/TWiki/EmptyPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/EmptyPlugin.pm Plugin Perl module
  • Test if the plugin is correctly installed:
    • (describe tests here)

Plugin Info

 
Plugin Author: AndreaSterbini, PeterThoeny
Changed:
<
<
Plugin Version: 14 Jul 2001
Change History: 14 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
>
>
Plugin Version: 14 Jul 2001 (V1.000)
Change History:
<-- specify latest version first -->
 
14 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
 
CPAN Dependencies: none
Other Dependencies: none
Changed:
<
<
Perl Version: 5.0
>
>
Perl Version: 5.005
 
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

Changed:
<
<
-- AndreaSterbini - 27 Feb 2001
-- PeterThoeny - 14 Jul 2001
>
>
-- AndreaSterbini - 27 Feb 2001
-- PeterThoeny - 14 Jul 2001

Revision 405 Jan 2002 - PeterThoeny

Line: 1 to 1
 

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.

Line: 16 to 16
 

EmptyPlugin Settings

Plugin settings are stored as preferences variables. To reference

Changed:
<
<
a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
>
>
a plugin setting write %<plugin>_<setting>%, for example, %EMPTYPLUGIN_SHORTDESCRIPTION%
 
Changed:
<
<
>
>
 
    • Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.

  • Your own setting, i.e.:

Revision 314 Jul 2001 - PeterThoeny

Line: 1 to 1
 

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.

Line: 6 to 6
 To create your own plugin:

  • Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.
Changed:
<
<
  • Copy this topic to <name>Plugin and customize it.
>
>
  • Create a <name>Plugin 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.
 

Syntax Rules

(none)

Changed:
<
<

EmptyPlugin Preferences

>
>

EmptyPlugin Settings

 
Changed:
<
<
Plugin preferences are stored as preferences variables. To reference a plugin preference write %<plugin name>_<preference name>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
>
>
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
 
Changed:
<
<
>
>
 
    • Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
Changed:
<
<
  • 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
 

Plugin Installation Instructions

Line: 31 to 34
 

Plugin Info

Plugin Author: AndreaSterbini, PeterThoeny
Changed:
<
<
Plugin Version: 08 Jul 2001
Change History: 08 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
>
>
Plugin Version: 14 Jul 2001
Change History: 14 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
 
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.0
Line: 42 to 45
 Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

-- AndreaSterbini - 27 Feb 2001

Changed:
<
<
-- PeterThoeny - 08 Jul 2001
>
>
-- PeterThoeny - 14 Jul 2001

Revision 209 Jul 2001 - PeterThoeny

Line: 1 to 1
Changed:
<
<
Empty TWiki Plugin
>
>

Empty TWiki Plugin

 
Changed:
<
<
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.
>
>
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.
 
Changed:
<
<
Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.
>
>
To create your own plugin:
 
Changed:
<
<
Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin
>
>
  • Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.
  • Copy this topic to <name>Plugin and customize it.
  • See details in TWikiPlugins.
 
Changed:
<
<
-- PeterThoeny - 13 Mar 2001
>
>

Syntax Rules

(none)

EmptyPlugin Preferences

Plugin preferences are stored as preferences variables. To reference a plugin preference write %<plugin name>_<preference name>%, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%

  • One line description, is included 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

Plugin Installation Instructions

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

Plugin Info

Plugin Author: AndreaSterbini, PeterThoeny
Plugin Version: 08 Jul 2001
Change History: 08 Jul 2001: Changed to plug&play
27 Feb 2001: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.0
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

-- AndreaSterbini - 27 Feb 2001
-- PeterThoeny - 08 Jul 2001

Revision 114 Mar 2001 - PeterThoeny

Line: 1 to 1
Added:
>
>
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.

Copy file TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin.

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

-- PeterThoeny - 13 Mar 2001

 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.EmptyPlugin.