Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 20101 invoked from network); 29 Oct 2004 14:02:53 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur-2.apache.org with SMTP; 29 Oct 2004 14:02:53 -0000 Received: (qmail 93859 invoked by uid 500); 29 Oct 2004 14:02:46 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 93777 invoked by uid 500); 29 Oct 2004 14:02:44 -0000 Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: list-post: Reply-To: "Forrest Developers List" Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 93709 invoked by uid 99); 29 Oct 2004 14:02:43 -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; Fri, 29 Oct 2004 07:02:43 -0700 Received: (qmail 19788 invoked by uid 65534); 29 Oct 2004 14:02:37 -0000 Date: 29 Oct 2004 14:02:37 -0000 Message-ID: <20041029140237.19783.qmail@minotaur.apache.org> From: rgardler@apache.org To: svn@forrest.apache.org Subject: svn commit: rev 55970 - forrest/trunk/forrestcore/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: Fri Oct 29 07:02:37 2004 New Revision: 55970 Modified: forrest/trunk/forrestcore/src/documentation/content/xdocs/docs/plugins.xml Log: Clarify the fact that you don't need to do anything to upgrade from 0.6 (with respect to plugins). Add notes on when you do need to do something. Modified: forrest/trunk/forrestcore/src/documentation/content/xdocs/docs/plugins.xml ============================================================================== --- forrest/trunk/forrestcore/src/documentation/content/xdocs/docs/plugins.xml (original) +++ forrest/trunk/forrestcore/src/documentation/content/xdocs/docs/plugins.xml Fri Oct 29 07:02:37 2004 @@ -43,13 +43,42 @@
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 a site requires one or more plugins then the site designer will + have named them 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.

+ +
+ Upgrading from a Version of Forrest Without Plugins +

The plugin functionality was introduced in version 0.7 of Forrest. + At this time some of the functionality previously in Forrest was + extracted into a plugin. However, we have not broken backward + compatability with earlier versions. In the absence of a + project.required.plugins property in the projects + forrest.properties file all plugins that contain + functionality previously part of Forrest itself will be loaded + automatically. Unless you intend to use new functionality provided + by a plugin you will not need to make any changes top your project.

+

If you do require additional plugin functionality, be sure to + include all required plugins in the + project.required.plugins property in the projects + forrest.properties. You can view + forrestcore/src/core/context/default.forrest.properties + to see the names of plugins that provide previously core + functionality.

+ +

It is also worth noting that there is a small performance + improvement if you remove plugins that are not in use. Therefore, + if you do not use one or more of the plugins named in the + project.required.plugins property of + forrestcore/src/core/context/default.forrest.properties + it is recomended that you override this value in your projects + forrest.properties file.

+
+