What plugins are available?

Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 96821 invoked by uid 99); 18 Oct 2004 14:10:46 -0000 X-ASF-Spam-Status: No, hits=-10.0 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.28) with SMTP; Mon, 18 Oct 2004 07:10:45 -0700 Received: (qmail 63677 invoked by uid 65534); 18 Oct 2004 14:10:43 -0000 Date: 18 Oct 2004 14:10:43 -0000 Message-ID: <20041018141043.63675.qmail@minotaur.apache.org> From: rgardler@apache.org To: svn@forrest.apache.org Subject: svn commit: rev 55014 - forrest/branches/sitemap-plugins/src/documentation/content/xdocs/docs X-Virus-Checked: Checked X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N Author: rgardler Date: Mon Oct 18 07:10:42 2004 New Revision: 55014 Modified: forrest/branches/sitemap-plugins/src/documentation/content/xdocs/docs/plugins.xml Log: Update the info on installing a plugin (no an automated process) Modified: forrest/branches/sitemap-plugins/src/documentation/content/xdocs/docs/plugins.xml ============================================================================== --- forrest/branches/sitemap-plugins/src/documentation/content/xdocs/docs/plugins.xml (original) +++ forrest/branches/sitemap-plugins/src/documentation/content/xdocs/docs/plugins.xml Mon Oct 18 07:10:42 2004 @@ -30,16 +30,27 @@ plugins. This document serves as an introduction to the Forrest plugin mechanism.

- What plugins are available? -

You can run the command forrest available-plugins to get - a list of the known plugins for Forrest.

+ What plugins are available? +

You can run the command forrest available-plugins to get + a list of the known plugins for Forrest.

+ +

If you would like to have your own plugin added to this list then + contact the developer mailing list.

+ + +

+ How is a Plugin Installed? + +

If a site requires a plugin then it will be named in the + project.required.plugins property in the projects + forrest.properties file. When Forrest builds the site + it will automatically discover the plugin and install it. In otherwords, + the user need do nothing.

If you would like to have your own plugin added to this list then - contact the developer mailing list.

What is a Forrest Plugin? @@ -166,41 +177,39 @@

- How is a Plugin Installed? - -

To install a plugin the user will run the command - forrest install-plugin'. This will ask the user for the name of - the plugin they wish to install and search known plugin repositories for the - plugin package. If found the plugin package will be downloaded and - extracted into the plugins directory of Forrest and an entry will be made + How does Installation work? +

When Forrest installs a plugin it downloads a zip of the plugin code and + extracts it into the plugins directory of Forrest and an entry is made in src/plugins/stitemap.xmap. For example, installing the IMSManifest plugin described above will result in the following entry being added to the plugin sitemap:

- - - -]]> - -

Installed plugins are managed by the file - FORREST_INSTALL_DIR/plugings/sitemap.xmap. This file is mounted by main - Forrest sitemap with the following code:

- - - - -]]> - - The plugin sitemap.xmap file is automatically managed by Forrest, the - end user need never edit this file. -

+ + + + + + ]]> + +

Installed plugins are managed by the file + FORREST_INSTALL_DIR/plugings/sitemap.xmap. This file is mounted by main + Forrest sitemap with the following code:

+ + + + + ]]> + + The plugin sitemap.xmap file is automatically managed by Forrest, the + end user need never edit this file. +