<<O>>  Difference Topic EmptyPlugin (r1.6 - 21 Mar 2004 - PeterThoeny)

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
 <<O>>  Difference Topic EmptyPlugin (r1.5 - 13 Jun 2002 - PeterThoeny)
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
 <<O>>  Difference Topic EmptyPlugin (r1.4 - 05 Jan 2002 - PeterThoeny)

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.:
 <<O>>  Difference Topic EmptyPlugin (r1.3 - 14 Jul 2001 - PeterThoeny)

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
 <<O>>  Difference Topic EmptyPlugin (r1.2 - 09 Jul 2001 - PeterThoeny)
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

 <<O>>  Difference Topic EmptyPlugin (r1.1 - 14 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

View topic | Diffs | r1.6 | > | r1.5 | > | r1.4 | More
Revision r1.1 - 14 Mar 2001 - 02:24 - PeterThoeny
Revision r1.6 - 21 Mar 2004 - 08:04 - PeterThoeny