Wiki App Installer Plugin
Enable users to share/test drive Foswiki Wiki Apps
Wiki Applications (Wiki Apps) are applications built from one or more wiki topics that usually contain macros
. Most Wiki Apps require no additional software to be installed on your server, and can be used as-is, or can be used as templates for your own custom wiki apps.
Many wiki apps are useful to a lot of people and have been shared on foswiki.org. However the process of evaluating and installing the applications has in the past been rather clumsy and error prone. This plugin addresses this problem.
The plugin provides simple ways to:
- try out Wiki Apps on foswiki.org in a personal Sandbox "playpen",
- create/package Wiki Apps to share with the Foswiki community,
- install Wiki Apps in a reliable and repeatable way.
(At the time of writing the installer is not ready, but is planned for a future release.)
Allowing users to try out Wiki Apps
The simplest way to try out a wiki applications is to install the application and play
with it. This plugin helps with this by supporting the installation of the application
in a personalized "playpen" web under the Sandbox web.
Wiki Apps have to be rooted at an application topic
which provides a portal for the application to be used. To allow a user to test a Wiki App, simply add the following macro
anywhere in the application topic.
Alternatively, create a separate overview topic for the application, and add the macro there (this is the preferred method).
In the same topic, define a preference
. This must be a comma-separated list of topic names, the first of which is assumed to be the application topic.
* Set MANIFEST = MeetingMinutes, CreateNewMeeting, MeetingTemplate
When the topic containing the
macro is viewed, the macro will be expanded to a button which, when pressed, will:
- Create a playpen called
Sandbox/%WIKINAME% e.g. Sandbox/WikiGuest. If it already exists, the existing web will be re-used.
- Check that any required extensions (e.g. Plugins) are installed,
- Verify that the topics exist, and copy them to the playpen web,
- Add a default Sandbox/WikiGuest/WebHome topic, listing the Wiki Apps available in the playpen web, and advise the user that it is a temporary area which will be cleared down after a defined period of inactivity.
- Redirect the view to the application topic just created in the playpen web,
This action can be repeated any number of times, with all subsequent copied topics overwriting any existing topics in the playpen
Simplifying installation of Wiki Apps
Installing a Wiki App involves creating the topics listing in the
in the user's local installation of Foswiki. To simplify this, add the following macro anywhere in the same topic as the
When expanded, this macro will provide a bullet list of the topics. When the topics in this list are clicked, a new window will open up displaying the raw text of the topic. This raw text can then be copy/pasted to a topic of the same name in your local install of Foswiki.
(This is definitely an area which will be improved in future releases)
for Wiki App examples and how this plugin is used.
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. Use "Find More Extensions" to get a list of available extensions. Select "Install".
If you have any problems, or if the extension isn't available in
, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions
for more help.