%META:TOPICINFO{author="ProjectContributor" date="1457496285" format="1.1" version="1"}%
%META:TOPICPARENT{name="Plugins"}%
---+!! Empty Plugin
%FORMFIELD{"Description"}%

%TOC%

Learn how to create your own plugin in %SYSTEMWEB%.DevelopingPlugins.
Documentation for Plugin API is in [[%SYSTEMWEB%.PerlDoc?module=Foswiki::Plugins::EmptyPlugin][PerlDoc for EmptyPlugin.pm]].

<div class="foswikiHelp">%T% Note that EmptyPlugin is documentation only.  Its
settings are ignored by =configure= and it cannot be enabled.</div>

---++ Preferences

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

You can also use [[%SYSTEMWEB%.PreferenceSettings][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 -&gt; "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!)
<verbatim>
cd /path/to/foswiki
perl tools/extension_installer <NameOfExtension> install
</verbatim>

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
%TABLE{columnwidths="7em" tablewidth="100%"}%
| | |

%META:FORM{name="PackageForm"}%
%META:FIELD{name="Author" title="Author" value="%25$CREATED_AUTHOR%25"}%
%META:FIELD{name="Version" title="Version" value="1.00"}%
%META:FIELD{name="Release" title="Release" value="15 Mar 2026"}%
%META:FIELD{name="Description" title="Description" value="%25$CREATED_SHORTDESCRIPTION%25"}%
%META:FIELD{name="Copyright" value="%25$CREATEDYEAR%25, %25$CREATED_AUTHOR%25, All Rights Reserved"}%
%META:FIELD{name="License" value="GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]])"}%
%META:FIELD{name="Repository" value="https://github.com/foswiki/EmptyPlugin"}%
%META:FIELD{name="Home" value="https://foswiki.org/Extensions/EmptyPlugin"}%
%META:FIELD{name="Support" value="https://foswiki.org/Support/EmptyPlugin"}%
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
