| 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. |
> > | This is an empty plugin. Use it as a template to build your own TWikiPlugins. This plugin does nothing, but is ready to be extended and 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 on twiki.org yet). Customize your plugin topic to your needs.
|
|
> > |
- Please consider contributing your plugin back to the TWiki community by publishing it in the Plugins web on twiki.org.
|
|
Syntax Rules |
|
< < | (none) |
> > | %EXAMPLEVAR{"..."}% |
| |
|
> > |
Examples
-
%EXAMPLEVAR{}% expands to: %EXAMPLEVAR{}%
|
| Plugin Installation Instructions |
|
< < |
- This plugin is pre-installed, 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 TWiki server. |
| |
|
> > |
- For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
- Or, follow these manual installation steps:
- Download the ZIP file from the Plugins home (see below).
- Unzip
EmptyPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/EmptyPlugin.txt | Plugin topic | data/TWiki/VarEXAMPLEVAR.txt | Variable documentation topic | lib/TWiki/Plugins/EmptyPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/EmptyPlugin/Config.spec | Plugin Config spec |
- Set the ownership of the extracted directories and files to the webserver user.
- Install the dependencies (if any).
- Plugin configuration and testing:
- Run the configure script and enable the plugin in the Plugins section
- Configure additional plugin settings in the Extensions section if needed.
- Test if the installation was successful: See example above.
|
| Plugin Info
- One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Empty Plugin used as a template for new plugins
|
|
< < |
Plugin Version: |
20632 (2011-05-03) |
|
> > |
Plugin Version: |
21319 (2011-08-20) |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
> > |
|
|
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 |
2001-07-14: |
Changed to plug&play |
2001-02-27: |
Initial version |
|
|
< < |
TWiki Dependency: |
$TWiki::Plugins::VERSION 1.1 |
|
> > |
TWiki Dependency: |
$TWiki::Plugins::VERSION 1.4 |
|
|
|
|
< < | Related Topics: VarEXAMPLEVAR, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences |
> > | Related Topics: VarEXAMPLEVAR, TWikiPlugins, TWikiFuncDotPm, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences |
| |