Empty TWiki Plugin

Page contents

• Introduction
• Syntax Rules
• Examples
• Plugin Installation Instructions
• Plugin Info

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.

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, TWiki:TWiki.TWikiContributor License: GPL (GNU General Public License) Plugin Version: 2013-09-27

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