Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 97100 invoked from network); 1 Apr 2006 03:22:20 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 1 Apr 2006 03:22:20 -0000 Received: (qmail 26706 invoked by uid 500); 1 Apr 2006 03:22:20 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 26660 invoked by uid 500); 1 Apr 2006 03:22:19 -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" List-Id: Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 26649 invoked by uid 99); 1 Apr 2006 03:22:19 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 31 Mar 2006 19:22:19 -0800 X-ASF-Spam-Status: No, hits=-9.4 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.29) with SMTP; Fri, 31 Mar 2006 19:22:18 -0800 Received: (qmail 96964 invoked by uid 65534); 1 Apr 2006 03:21:58 -0000 Message-ID: <20060401032158.96963.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r390583 - /forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml Date: Sat, 01 Apr 2006 03:21:58 -0000 To: svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.0.7 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: crossley Date: Fri Mar 31 19:21:55 2006 New Revision: 390583 URL: http://svn.apache.org/viewcvs?rev=390583&view=rev Log: Explain that plugins sources are not yet used in-place. Modified: forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml Modified: forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml?rev=390583&r1=390582&r2=390583&view=diff ============================================================================== --- forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml (original) +++ forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml Fri Mar 31 19:21:55 2006 @@ -31,7 +31,7 @@ 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.

@@ -41,9 +41,9 @@
-
+
How is a Plugin Installed? -
+
List of Plugins Needed by the Project

If a site requires one or more plugins then the site designer will have to list them in the project.required.plugins property @@ -59,7 +59,7 @@ to include some plugins. Currently there is only one to generate PDF output from your source documents.

-
+
What Version of Plugins will be used ?

In the absence of a version number for the plugin (as is the case in the example above) the most recent version that is applicabe to your release of Forrest will be used. This @@ -75,7 +75,7 @@ of an in-development plugin, therefore in a production environment you should always specify a known working version.

-
+
Where does Forrest look for Plugins sources ?

By default, forrest looks into the two following directories to find plugins sources : ${forrest.home}/plugins and ${forrest.home}/whiteboard/plugins. It is possible to add other sources locations by specifying the project.required.plugins.src property @@ -106,7 +106,17 @@

will add the project specific plugins descriptors file file:///${project.home}/plugins/plugins.xml to the list of descriptors.

-
+
+ Editing plugins sources to enhance functionality +

+ Until issue + FOR-388 + is fixed to enable the use of plugins in-place, any changes to + sources need to be locally deployed. + See Further reading for "How to build a Plugin". +

+
+
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 @@ -136,7 +146,7 @@

-
+
Avoiding Plugin Conflicts

Clashes between plugins can occur. For example, the simplified-docbook and full docbook plugins may try and process the same files. In this @@ -146,11 +156,11 @@ order and therefore processing precedence is under user control.

-
+
Further Reading