|
<
< | 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. |
| |
- 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.
|
|
<
< | Syntax Rules |
>
> | Syntax Rules |
| | |
|
<
< | (none) |
>
> | (describe the syntax) |
| | |
|
<
< | EmptyPlugin Settings |
>
> | EmptyPlugin Global Settings |
| | |
|
<
< | 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.
|
|
<
< | |
>
> |
- Your own settings, for example:
|
| |
- Debug plugin: (See output in
data/debug.txt)
|
|
<
< | Plugin Installation Instructions |
>
> | Plugin Installation Instructions |
| | |
|
<
< |
- This plugin is preinstalled, you do not need to install it.
|
>
> | (This plugin is preinstalled, you do not need to install it.) |
| | |
|
<
< | 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:
Plugin Info |
| |
|
|
<
< |
| 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 |
|
|
<
< |
|
>
> |
|
| |
Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin? |
|
<
< | -- AndreaSterbini? - 27 Feb 2001
-- PeterThoeny - 14 Jul 2001
|
>
> | -- AndreaSterbini? - 27 Feb 2001
-- PeterThoeny - 14 Jul 2001 |