You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by rg...@apache.org on 2007/01/03 23:50:35 UTC
svn commit: r492330 -
/forrest/trunk/whiteboard/forrest2/core/src/docs/createAPlugin.html
Author: rgardler
Date: Wed Jan 3 14:50:35 2007
New Revision: 492330
URL: http://svn.apache.org/viewvc?view=rev&rev=492330
Log:
Updated input plugin instructions
Modified:
forrest/trunk/whiteboard/forrest2/core/src/docs/createAPlugin.html
Modified: forrest/trunk/whiteboard/forrest2/core/src/docs/createAPlugin.html
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/docs/createAPlugin.html?view=diff&rev=492330&r1=492329&r2=492330
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/docs/createAPlugin.html (original)
+++ forrest/trunk/whiteboard/forrest2/core/src/docs/createAPlugin.html Wed Jan 3 14:50:35 2007
@@ -56,26 +56,12 @@
<h3>Create a class file that will be the controller for the plugin.</h3>
<p>This should extend the abstact class <br/>
- org.apache.forrest.core.plugins.input.AbstractInputPlugin</p>
+ org.apache.forrest.core.plugin.AbstractInputPlugin</p>
-<p>You must implement the following two methods:</p>
+<p>You must implement the following method:</p>
<div class="code"><pre>
public IDocument process(IDocument doc)
- public String getInputType()
</pre></div>
-
-<p>The getInputType method returns a string that uniquely identifies
-the document type that this plugin is able to process. It is advisable
-to follow a naming convention here. We suggest:</p>
-
-<p>If the document has a suitably unique mime-type then use that.</p>
-
-<p>If the document is an XML document with a Doctype then use the URI
-of that doctype.</p>
-
-<p>If the above guidelines do not suggest a suitable type string then
-we recommend you us a notation similar to the naming of java classes.
-For example org.foo.document.type.</p>
<p>The process method should create an instance of an
org.apache.forrest.core.document.InternalDocument by performing whatever