NewPluginTemplate

Introduction

Describe the plugin here

Syntax Rules

%EXAMPLEVAR{"..."}%

Examples

• %EXAMPLEVAR{}% expands to: %EXAMPLEVAR{}%

Plugin Installation & Configuration

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 NewPluginTemplate.zip in your twiki installation directory. Content:

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

  • 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 = one line description here

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences