forrest-svn mailing list archives

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

Modified:
   forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml
Log:
fleshing out the document

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:07:35
2004
@@ -63,17 +63,54 @@
       <title>Type of Plugin</title>
 
       <p>There are three types of plugin, each with a clear purpose, you
-      must first decide which type of plugin you need to build.</p>
+      must first decide which 
+      <a href="site:documentation/developers/pluginInfrastructure">type of plugin</a>
+      you need to build.</p>
       
-      <section id="input">
-        <title>Input Plugins</title>
-      </section>
-      <section id="output">
-        <title>Output Plugins</title>
-      </section>
-      <section id="internal">
-        <title>Internal Plugins</title>
-      </section>
+      
+    </section>
+    
+    <section>
+      <title>Create Plugin Directory Structure</title>
+      <p>Regardless of the type of plugin you are building, the directory
+      structure is almost identical. See 
+      <a href="site:documentation/developers/pluginInfrastructure">What Does 
+      a Forrest Plugin Look Like?</a></p>
+    </section>
+    
+    <section>
+      <title>Create the Plugin XMap file</title>
+      <p>The plugin <code>xmap</code> file is a Cocoon sitemap that is
mounted
+      at a strategic place in the Forrest pipeline. It is in this file
+      that you will instruct Forrest how to operate. An input plugin
+      must provide a <code>input.xmap</code> file, an ouput plugin
+      must provide a <code>output.xmap</code> file, whilst an internal
+      plugin provides a <code>sitemap.xmap</code> file.</p>
+    </section>
+    
+    <section>
+      <title>Create the Necessary Resource Files</title>
+      <fixme author="rdg">Discuss the XSL files and other such resources</fixme>
+    </section>
+    
+    <section>
+      <title>Create the Documentation</title>
+      <fixme author="rdg">Plugin documentation should provide (as a minimum) an
+      index page that provides an overview and a set of samples that demonstrate
+      the functionlaity of the plugin.</fixme>
+    </section>
+    
+    <section>
+      <title>Register the Plugin with Apache Forrest</title>
+      <fixme author="rdg">Describe the plugins.xml file</fixme>
+      <fixme author="rdg">Describe making a request of Forrest devs for 
+      inclusion</fixme>
+    </section>
+    
+    <section>
+      <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 id="extension">

Mime
View raw message