forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rgard...@apache.org
Subject svn commit: rev 65612 - forrest/trunk/docs-author/content/xdocs/howto
Date Sun, 14 Nov 2004 18:16:05 GMT
Author: rgardler
Date: Sun Nov 14 10:16:05 2004
New Revision: 65612

Modified:
   forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml
Log:
add some sections for complete examples

Modified: forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml
==============================================================================
--- forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml	(original)
+++ forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml	Sun Nov 14 10:16:05
2004
@@ -25,7 +25,9 @@
     Forrest. Forrest uses plugins to add new input formats, output formats
     and to change its default behaviour. Since plugins are downloaded when
     needed and can be hosted at any location plugin code can be developed 
-    independantly of Apache Forrest.</abstract>
+    independantly of Apache Forrest. This how-to describes each of the major
+    steps in creating a plugin and then works through some examples of 
+    plugin creation in order to illustrate the materials.</abstract>
 
     <last-modified-content-date date="2004-11-14" />
   </header>
@@ -35,9 +37,10 @@
     to change the way Forrest internals work.</p>
     
     <warning>The Plugin Infrastructure is still at an early stage of design 
-    and implementation, consequently this How-To <em>may</em> be out of date.
-    If you are having problems with any of the steps described, please ask
-    for help on the developers mailing list.</warning>
+    and implementation, consequently this How-To <em>may</em> be out of date
+    and/or incomplete. If you are having problems with any of the steps 
+    described, please ask for help on the developers mailing list (and then
+    provide patches for this document).</warning>
   </audience>
 
   <purpose title="Purpose">
@@ -111,6 +114,26 @@
       <title>Publish the Plugin</title>
       <fixme author="rdg">Describe the generation of the plugin zip and
       the publication of that zip (ant dist)</fixme>
+    </section>
+    
+    <section>
+      <title>Examples</title>
+      <p>This section will provide some example plugins to help illustrate the
+      steps discussed above.</p>
+        <section>
+          <title>Input Plugin</title>
+          <fixme author="RDG">Discuss OpenOffice.org plugin here</fixme>
+        </section>
+        
+        <section>
+          <title>Output Plugin</title>
+          <fixme author="RDG">Discuss s5 plugin here</fixme>
+        </section>
+        
+        <section>
+          <title>Internal Plugin</title>
+          <fixme author="RDG">Discuss IMSManifest plugin here</fixme>
+        </section>
     </section>
 
     <section id="extension">

Mime
View raw message