Difference: EmptyPlugin (r25 vs. r24)

Empty TWiki Plugin

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 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.
  • See details in TWikiPlugins.

Syntax Rules

%EXAMPLEVAR{"..."}%

ParameterExplanationDefault
"..." Default parameter. (none)
format="..." Format: ... "$name"

Examples

  • %EXAMPLEVAR{}% expands to: Cogito ergo sum.

Plugin Installation Instructions

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 Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright: 2001-2013, 2001-2015 TWiki:Main.PeterThoeny , TWiki.org ;
2001-2015 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 2013-09-27 2015-01-10
2013-09-27: 2015-01-10: TWikibug:Item7354 TWikibug:Item7604 : Align TWiki::Plugins::VERSION with TWiki release version, Switch from GPL v2 to v3 e.g. 6.00 for TWiki-6.0.0
2013-02-16: 2013-09-27: TWikibug:Item7123 TWikibug:Item7354 : Use TWISTY in installation instructions and change history Align TWiki::Plugins::VERSION with TWiki release version, e.g. 6.00 for TWiki-6.0.0
2013-02-11: 2013-02-16: TWikibug:Item7142 TWikibug:Item7123 : iewRedirectHandler() Use TWISTY in plug-ins -- installation instructions and change history TWiki:Main.HideyoImazu
2012-12-12: 2013-02-11: TWikibug:Item7077 TWikibug:Item7142 : Small doc fix iewRedirectHandler() in plug-ins -- TWiki:Main.PeterThoeny TWiki:Main.HideyoImazu
2012-11-15: 2012-12-12: TWikibug:Item7020 TWikibug:Item7077 : Add category to Small doc fix -- VarEXAMPLEVAR variable doc -- TWiki:Main.PeterThoeny
2011-05-22: 2012-11-15: TWikibug:Item6724 TWikibug:Item7020 : Pass text Add category and meta data to registerTagHandler callback -- VarEXAMPLEVAR variable doc -- TWiki:Main.PeterThoeny
2011-05-17: 2011-05-22: TWikibug:Item6725 TWikibug:Item6724 : Change global package variables from Pass text and meta data "use vars" to "ours"; doc registerTagHandler callback improvements -- TWiki:Main.PeterThoeny
2011-03-06: 2011-05-17: TWikibug:Item6656 TWikibug:Item6725 : Add meta data Change global package variables from "use vars" to attachment save handlers "ours"; doc improvements -- TWiki:Main.PeterThoeny
2011-02-08: 2011-03-06: TWikibug:Item6593 TWikibug:Item6656 : Doc improvements; adding Add meta data to attachment save handlers VarEXAMPLEVAR variable documentation
2010-05-08: 2011-02-08: TWikibug:Item6433 TWikibug:Item6593 : Doc improvements; replacing adding TWIKIWEB with SYSTEMWEB VarEXAMPLEVAR variable documentation
2007-05-20: 2010-05-08: Added renderWikiWordHandler TWikibug:Item6433 : Doc improvements; replacing TWIKIWEB with SYSTEMWEB
2006-02-01: 2007-05-20: Dakar changes Added renderWikiWordHandler
2004-03-21: 2006-02-01: Added afterSaveHandler Dakar changes
2001-07-14: 2004-03-21: Changed to Added afterSaveHandler plug&play
2001-02-27: 2001-07-14: Initial version Changed to plug&play
2001-02-27: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.4
Dependencies: %$DEPENDENCIES
Plugin 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

Related Topics: VarEXAMPLEVAR, TWikiPlugins, TWikiFuncDotPm, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

 
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.