Difference: EmptyPlugin ( vs. 1)

Revision 1
09 March 2016 - Main.ProjectContributor
 
META TOPICPARENT name="Plugins"

Empty Plugin

%$CREATED_SHORTDESCRIPTION%

Learn how to create your own plugin in DevelopingPlugins. Documentation for Plugin API is in PerlDoc for EmptyPlugin.pm.

TIP Note that EmptyPlugin is documentation only. Its settings are ignored by configure and it cannot be enabled.

Preferences

Plugin preferences should be set using configure, as described in DevelopingPlugins.

You can also use preference settings to define any user-controllable configuration. You are strongly advised to use the name of the plugin as a prefix, to avoid the risk of namespace clashes with other extensions that may try to use the same name.

BAD
  • Set EXAMPLE = Example setting
  • Set FORMAT = %d-%m-%y
Good
  • Set EMPTYPLUGIN_EXAMPLE = Example setting
  • Set EMPTYPLUGIN_FORMAT = %d-%m-%y

Installation

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. "Extensions Operation and Maintenance" Tab → "Install, Update or Remove extensions" Tab. Click the "Search for Extensions" button. Enter part of the extension name or description and press search. Select the desired extension(s) and click install. If an extension is already installed, it will not show up in the search results.

You can also install from the shell by running the extension installer as the web server user: (Be sure to run as the webserver user, not as root!) 
cd /path/to/foswiki
perl tools/extension_installer <NameOfExtension> install

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See https://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Dependencies

None

Change History

   

META FORM name="PackageForm"
FORM FIELD Author Author %$CREATED_AUTHOR%
FORM FIELD Version Version 1.00
FORM FIELD Release Release %$CREATED_DATE%
FORM FIELD Description Description %$CREATED_SHORTDESCRIPTION%
FORM FIELD $title Copyright %$CREATEDYEAR%, %$CREATED_AUTHOR%, All Rights Reserved
FORM FIELD $title License GPL (GNU General Public License)
FORM FIELD $title Repository https://github.com/foswiki/EmptyPlugin
FORM FIELD $title Home https://foswiki.org/Extensions/EmptyPlugin
FORM FIELD $title Support https://foswiki.org/Support/EmptyPlugin
FORM FIELD Repository Repository https://github.com/foswiki/distro
View topic | History: r1 | More topic actions...
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback