Difference between revisions of "Developing Plugins"
TimPatrick (talk | contribs) |
(Cosmetics; added category and a note that it's about an unreleased feature) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | ''(This page describes a [[SoC_plugin_repository|feature]] that is not yet available in a released version.)'' | ||
| + | |||
== Introduction == | == Introduction == | ||
To allow your plugin to be automatically installed by a user from the repository, you must develop it (or convert it) to use the autoinstall.php method of installation. | To allow your plugin to be automatically installed by a user from the repository, you must develop it (or convert it) to use the autoinstall.php method of installation. | ||
| − | You must follow the Directory Layout for your plugin as outlined here [[ | + | You must follow the Directory Layout for your plugin as outlined here: [[Suggested and Required Directory Layout and Files]]. |
As well, there are four files that must be included in the root directory of your plugin archive. These files are: | As well, there are four files that must be included in the root directory of your plugin archive. These files are: | ||
| − | autoinstall.php [[ | + | autoinstall.php [[Plugin Autoinstall]] |
| + | |||
| + | autouninstall.php [[Plugin Auto-Uninstall]] | ||
| + | |||
| + | functions.inc [[Functions.inc - Listing of the Plugin Functions]] | ||
| + | |||
| + | install_defaults.php [[Install Defaults]] | ||
| + | |||
| + | |||
| + | == Uploading == | ||
| + | |||
| + | If your plugin includes these files, then it will be offered for auto install via the repository (and download and manual install if the user so wishes). | ||
| − | + | However, if any of these files are missing, a warning will be shown and the plugin will ONLY be offered for manual download. This can be fixed at any time, however, by simply editing your plugin in the repository, and uploading your fixed archive. Supported archives to the repository are .tar.gz, .tar, .tar.bz2, and .zip. Once you upload a plugin, it will be displayed when you go to the Repository Manager, and you will be able to edit it, upload patches for it, and upload upgrades for it, as well as remove it. | |
| − | |||
| − | + | [[Category:Plugin Development]] | |
Latest revision as of 17:25, 14 November 2009
(This page describes a feature that is not yet available in a released version.)
Introduction
To allow your plugin to be automatically installed by a user from the repository, you must develop it (or convert it) to use the autoinstall.php method of installation.
You must follow the Directory Layout for your plugin as outlined here: Suggested and Required Directory Layout and Files.
As well, there are four files that must be included in the root directory of your plugin archive. These files are:
autoinstall.php Plugin Autoinstall
autouninstall.php Plugin Auto-Uninstall
functions.inc Functions.inc - Listing of the Plugin Functions
install_defaults.php Install Defaults
Uploading
If your plugin includes these files, then it will be offered for auto install via the repository (and download and manual install if the user so wishes).
However, if any of these files are missing, a warning will be shown and the plugin will ONLY be offered for manual download. This can be fixed at any time, however, by simply editing your plugin in the repository, and uploading your fixed archive. Supported archives to the repository are .tar.gz, .tar, .tar.bz2, and .zip. Once you upload a plugin, it will be displayed when you go to the Repository Manager, and you will be able to edit it, upload patches for it, and upload upgrades for it, as well as remove it.
