Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r5  >  r4  ...
EmptyPlugin 5 - 13 Jun 2002 - Main.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 5r5 - 13 Jun 2002 - 05:54:00 - PeterThoeny?
Revision 4r4 - 05 Jan 2002 - 08:30:43 - PeterThoeny?
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM