Tags:
create new tag
, view all tags

NewPluginTemplate

one line description here

Introduction

Describe the plugin here

Syntax Rules

%EXAMPLEVAR{"..."}%

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

Examples

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

Plugin Installation & Configuration

You do not need to install anything on the browser to use this plugin. These 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 using the example above.

Plugin Info

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = one line description here
Plugin Author: TWiki:Main.guest
Copyright: © 2017 TWiki:Main.guest
© 2017 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 2017-06-16 (V1.000)
Change History:  
2017-06-16: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Benchmark: GoodStyle nn%, FormattedSearch nn%, NewPluginTemplate nn%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/NewPluginTemplate
Feedback: http://TWiki.org/cgi-bin/view/Plugins/NewPluginTemplateDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/NewPluginTemplateAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Edit | Attach | Watch | Print version | History: r31 < r30 < r29 < r28 < r27 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r31 - 2014-03-13 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.