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 @@
<header>
<title>How to Build a Plugin</title>
- <version>0.2</version>
+ <version>0.2.1</version>
<abstract>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 @@
<li>Edit status.xml to add a new section and set the release date.
Start adding changes notes.</li>
</ul>
+ </section>
+
+ <section>
+ <title>Experimental Functionality</title>
+ <warning>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.</warning>
+
+ <note>For an example of each of these features in use see the
+ <code>org.apache.forrest.internal.NoteTaking</code> plugin.</code>
+
+ <section>
+ <title>Locationmap</title>
+
+ <p>Plugins can use the Forrest locationmap to expose resources to
your
+ project and other plgins. To use this functionality add your
+ <code>locationmap.xml</code> file to the root of the plugin
directory.</p>
+
+ <p>We have an <a
href="http://issues.apache.org/jira/browse/FOR-200";>issue</a>
+ for the status of locationmap development.</p>
+ </section>
+
+ <section>
+ <title>Forrest:Views</title>
+
+ <p>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.</p>
+
+ <p>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
<code>PLUGIN_HOME/resources/themes</code>. However,
+ this, by itself, is not suficient to export your contracts. You will
also need to
+ add the following match to you plugins <code>locationmap.xml</code>
file:</p>
+
+ <source><![CDATA[
+ <match pattern="resolvePluginContract.*.**">
+ <select type="exists">
+ <location
src="{forrest:plugins}/PLUGIN_NAME/resources/themes/{project:theme}/{1}/{2}.ft"
/>
+ </select>
+ </match>
+ ]]></source>
+
+ <p>Of course, you should replace <code>PLUGIN_NAME</code> with the
name of
+ your plugin.</p>
+
+ <p>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.</p>
+ </section>
+
+ <section>
+ <title>Plugin Properties</title>
+ <p>Plugins can define properties that can be overwritten by projects.
+ For more information see the issue below.</p>
+
+ <p>We have an <a
href="http://issues.apache.org/jira/browse/FOR-588";>issue</a>
+ for the status of this new configuration system.</p>
+ </section>
</section>
</section>
