PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

target_installer

Write an install/uninstall script that checks dependencies, and optionally downloads and installs required zips from foswiki.org.

The install script is templated from contrib/TEMPLATE_installer and is always named module_installer (where module is your module). It is added to the release zip and is always shipped in the root directory. It will automatically be added to the manifest if it doesn't appear in MANIFEST.

The install script works using the dependency type and version fields. It will try to download from foswiki.org to satisfy any missing dependencies. Downloaded modules are automatically installed.

Note that the dependencies will only work if the module depended on follows the naming standards for zips i.e. it must be attached to the topic in foswiki.org and have the same name as the topic, and must be a zip file.

Dependencies on CPAN modules are also checked (type perl) but no attempt is made to install them.

The install script also acts as an uninstaller and upgrade script.

Note that target_install builds and invokes this install script.

At present there is no support for a caller-provided post-install script, but this would be straightforward to do if it were required.