Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 13536 invoked from network); 23 Nov 2005 17:14:39 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 23 Nov 2005 17:14:39 -0000 Received: (qmail 48474 invoked by uid 500); 23 Nov 2005 17:14:36 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 48440 invoked by uid 500); 23 Nov 2005 17:14:36 -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 48429 invoked by uid 99); 23 Nov 2005 17:14:36 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 Nov 2005 09:14:36 -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; Wed, 23 Nov 2005 09:16:08 -0800 Received: (qmail 13189 invoked by uid 65534); 23 Nov 2005 17:14:15 -0000 Message-ID: <20051123171415.13188.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r348493 - /forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-buildPlugin.xml Date: Wed, 23 Nov 2005 17:14:14 -0000 To: svn@forrest.apache.org From: rgardler@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: rgardler Date: Wed Nov 23 09:14:06 2005 New Revision: 348493 URL: http://svn.apache.org/viewcvs?rev=348493&view=rev Log: add a section for experimental features, add notes about how to use the locationmap, how to expose structurer contracts and how to customise a plugin via properties. Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-buildPlugin.xml Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-buildPlugin.xml URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-buildPlugin.xml?rev=348493&r1=348492&r2=348493&view=diff ============================================================================== --- forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-buildPlugin.xml (original) +++ forrest/trunk/site-author/content/xdocs/docs_0_80/howto/howto-buildPlugin.xml Wed Nov 23 09:14:06 2005 @@ -20,7 +20,7 @@
How to Build a Plugin - 0.2 + 0.2.1 This How-To describes the steps necessary to build a plugin for Forrest. Forrest uses plugins to add new input formats, output formats @@ -387,6 +387,66 @@
  • Edit status.xml to add a new section and set the release date. Start adding changes notes.
    • + + +
    + Experimental Functionality + This section describes functionality that is considered experimental. + This functionality may be defective and is not part of the official release at + this time, use at your own risk. If you do choose to use this functionality then + we recomend that you join the Forrest dev list in order to keep abreast of the + changes as they occur. + + For an example of each of these features in use see the + org.apache.forrest.internal.NoteTaking plugin. + +
    + Locationmap + +

    Plugins can use the Forrest locationmap to expose resources to your + project and other plgins. To use this functionality add your + locationmap.xml file to the root of the plugin directory.

    + +

    We have an issue + for the status of locationmap development.

    +
    + +
    + Forrest:Views + +

    Forrest Views is the collective name for the various peices of functionality + that are intended to replace skins in the future. They allow for a much more + configurable system of defining the contents and look and feel of a site.

    + +

    Plugins can expose contracts for use in structurer files used within + Forrest:Views based sites. In order to do this you should develop your contracts + as normal and place them in PLUGIN_HOME/resources/themes. However, + this, by itself, is not suficient to export your contracts. You will also need to + add the following match to you plugins locationmap.xml file:

    + + + + + ]]> + +

    Of course, you should replace PLUGIN_NAME with the name of + your plugin.

    + +

    Once views become stable we will add this match to the default locationmap + generated when you seed a new plugin, but for now it must be done manually.

    +
    + +
    + Plugin Properties +

    Plugins can define properties that can be overwritten by projects. + For more information see the issue below.

    + +

    We have an issue + for the status of this new configuration system.

    +