NewPluginTemplate

short description here

Syntax Rules

Examples

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %NEWPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = one line description here

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• My own setting:
  • Set HOWTO = got it!

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.

• Download the ZIP file from the Plugin Home (see below)
• Unzip NewPluginTemplate.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/NewPluginTemplate.txt	Plugin topic
  data/TWiki/NewPluginTemplate.txt,v	Plugin topic repository
  lib/TWiki/Plugins/NewPluginTemplate.pm	Plugin Perl module

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed
• Test if the installation was successful:
  • enter samples here

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

%TOPICCREATE{ template="Plugins.PluginDevTemplate" topic="Dev" disable="NewPluginTemplate" parameters="pluginName=&RelatedTopics=, Appraisal" }% %TOPICCREATE{ template="Plugins.PluginAppraisalTemplate" topic="Appraisal" disable="NewPluginTemplate" parameters="RelatedTopics=, Dev" }% -- TWiki:Main.guest - 09 Jul 2008