Return-Path: 
 <svn-return-5665-apmail-forrest-svn-archive=forrest.apache.org@forrest.apache.org>
Delivered-To: apmail-forrest-svn-archive@www.apache.org
Received: (qmail 83746 invoked from network); 7 Jun 2006 10:13:52 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur.apache.org with SMTP; 7 Jun 2006 10:13:52 -0000
Received: (qmail 63261 invoked by uid 500); 7 Jun 2006 10:13:51 -0000
Delivered-To: apmail-forrest-svn-archive@forrest.apache.org
Received: (qmail 63218 invoked by uid 500); 7 Jun 2006 10:13:51 -0000
Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:svn-help@forrest.apache.org>
list-unsubscribe: <mailto:svn-unsubscribe@forrest.apache.org>
List-Post: <mailto:svn@forrest.apache.org>
Reply-To: "Forrest Developers List" <dev@forrest.apache.org>
List-Id: <svn.forrest.apache.org>
Delivered-To: mailing list svn@forrest.apache.org
Received: (qmail 63206 invoked by uid 99); 7 Jun 2006 10:13:51 -0000
Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49)
    by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 07 Jun 2006 03:13:51 -0700
X-ASF-Spam-Status: No, hits=-9.4 required=10.0
	tests=ALL_TRUSTED,NO_REAL_NAME
X-Spam-Check-By: apache.org
Received-SPF: pass (asf.osuosl.org: local policy)
Received: from [140.211.166.113] (HELO eris.apache.org) (140.211.166.113)
    by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 07 Jun 2006 03:13:50 -0700
Received: by eris.apache.org (Postfix, from userid 65534)
	id AE0371A983A; Wed,  7 Jun 2006 03:13:30 -0700 (PDT)
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r412354 -
 /forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml
Date: Wed, 07 Jun 2006 10:13:29 -0000
To: svn@forrest.apache.org
From: cdupoirieux@apache.org
X-Mailer: svnmailer-1.0.8
Message-Id: <20060607101330.AE0371A983A@eris.apache.org>
X-Virus-Checked: Checked by ClamAV on apache.org
X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N

Author: cdupoirieux
Date: Wed Jun  7 03:13:27 2006
New Revision: 412354

URL: http://svn.apache.org/viewvc?rev=412354&view=rev
Log:
Some documentation about the changes of the plugin management. Cf. FOR-343, FOR-388 and FOR-741.

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/viewvc/forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml?rev=412354&r1=412353&r2=412354&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 Wed Jun  7 03:13:27 2006
@@ -124,13 +124,21 @@
       </section>
     <section id="local-deploy">
       <title>Editing plugins sources to enhance functionality</title>
-      <p>
-        Until issue
-        <a href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a>
-        is fixed to enable the use of plugins in-place, any changes to
-        sources need to be locally deployed.
-        See <a href="#more">Further reading</a> for "How to build a Plugin".
-      </p>
+      <p>If you need to enhance an existing plugin functionality, you should not edit a standard plugin sources.</p>
+      <p>First, copy the whole plugin directory either in a plugins directory in your project tree or, if the plugin is used by several projects, 
+      in a different location outside any project directory.</p>
+      <p>Then declare the new location to make Forrest search in it. There is two cases :</p>
+      <ul>
+        <li>If your plugin is specific to a project, you should edit the corresponding forrest.properties to declare the new location in 
+        the <code>project.required.plugins.src</code> property</li>
+        <li>If your plugin is shared with several project, you should edit your <code>${user.home}/forrest.properties</code></li>
+      </ul>
+      <warning>The order of the directories list in the property is important, if you keep the plugin name, you should add the new location
+      at the beginning of the list to be sure Forrest will use your version and not the standard one.</warning>
+      <fixme author="Cyriaque">We still need to describe the declaration of another remote site to store the specific plugins, with a new 
+      plugins descriptor file...</fixme>
+      <p>Finally, you can then edit your copy !</p>
+      <p>See <a href="#more">Further reading</a> for "How to build a Plugin".</p>
       </section>
     <section id="no-plugins">
       <title>Upgrading from a Version of Forrest Without Plugins</title>