Difference: EmptyPlugin (21 vs. 22)

Revision 222013-02-16 - TWikiContributor

 

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 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{"..."}%

Parameter Explanation Default
"..." 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.

Added:
>
>
Show details toggleopen.gif Hide details toggleclose.gif 
<--/twistyPlugin twikiMakeVisibleInline-->
 
  • 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.
Added:
>
>		 
<--/twistyPlugin-->
 

Plugin Info

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Empty Plugin used as a template for new plugins
Added:
>
>
 
Plugin Author: TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Changed:
<
<
Copyright: © 2001-2012, TWiki:TWiki.TWikiContributor
>
>
Copyright: © 2001-2013, TWiki:TWiki.TWikiContributor
 
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 24472 (2012-12-16)
Change History: 
<-- versions below in reverse order -->
 
>
>
Plugin Version: 2013-02-16
%TWISTY{
Added:
>
>		 mode="div" showlink="Show Change History http://atlaspc5.kek.jp/pub/TWiki/TWikiDocGraphics/toggleopen.gif" hidelink="Hide Change History http://atlaspc5.kek.jp/pub/TWiki/TWikiDocGraphics/toggleclose.gif" }%
2013-02-16: TWikibug:Item7123: Use TWISTY in installation instructions and change history
2013-02-11: TWikibug:Item7142: iewRedirectHandler() in plug-ins -- TWiki:Main.HideyoImazu
 
2012-12-12: TWikibug:Item7077: Small doc fix -- TWiki:Main.PeterThoeny
2012-11-15: TWikibug:Item7020: Add category to VarEXAMPLEVAR variable doc -- TWiki:Main.PeterThoeny
2011-05-22: TWikibug:Item6724: Pass text and meta data to registerTagHandler callback -- TWiki:Main.PeterThoeny
2011-05-17: TWikibug:Item6725: Change global package variables from "use vars" to "ours"; doc improvements -- TWiki:Main.PeterThoeny
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
Added:
>
>		</> 
<--/twistyPlugin-->
 
TWiki Dependency: $TWiki::Plugins::VERSION 1.4
Dependencies: %$DEPENDENCIES
Changed:
<
<
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
>
>
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

View topic | History: r23 < r22 < r21 < r20 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2025 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.