Changeset 3662

Timestamp:

Aug 14, 2007, 8:54:58 AM (16 years ago)

Author:

Martin Svensson

Message:

Fixes #551 Read "Plugin developer" section

File:

• trunk/doc/src/docbook/developerdoc/plugin_developer.xml (modified) (13 diffs)

trunk/doc/src/docbook/developerdoc/plugin_developer.xml

@@ -545 +545 @@
                 out from this method. Always use <code>try...catch</code>
                 to catch exceptions and use <code>Response.setError()</code>
-                to reporter the error back to the core.
+                to report the error back to the core.
               </important>
               
@@ -1310 +1310 @@
           <methodname>Plugin.requiresConfiguration()</methodname> and
           <methodname>Plugin.getAbout()</methodname> to find out information
-          about the plug-in. This is the only time theese methods are called.
+          about the plug-in. This is the only time these methods are called.
           The information that is returned by them are copied and stored in 
           the database for easy access.
@@ -1506 +1506 @@
         <para>
           If the web client found that the plug-in could be
-          used in a given context and the user selected the plug-in
+          used in a given context and the user selected the plug-in,
           the job configuration sequence is started. It is a wizard-like interface
           identical to the configuration wizard. In fact, the same JSP pages,
@@ -1591 +1591 @@
           <para>
           The <methodname>Plugin.run()</methodname> method is called. 
-          It is finally time for the plug-in to do the work it has bee
+          It is finally time for the plug-in to do the work it has been
           designed for. This method should not throw any exceptions.
           Use the <methodname>Response.setDone()</methodname>
@@ -1728 +1728 @@
 
     <para>
-      A plugin becoms an import plugin simply by returning 
+      A plugin becomes an import plugin simply by returning 
       <constant>Plugin.MainType.IMPORT</constant>
       from the <methodname>Plugin.getMainType()</methodname> method.
@@ -1799 +1799 @@
               Note that the input stream doesn't have to be a text file. 
               It can be any type of file, for example a binary or an XML file. 
-              In the case of an XML file you would need to validate the entiry 
+              In the case of an XML file you would need to validate the entire 
               input stream in order to be a 100% sure that it is a valid
               xml file, but we recommend that you only check the first few XML tags, 
@@ -1934 +1934 @@
         for configuring the plugin and creating a job and implement the 
         <methodname>InteractivePlugin.configure()</methodname> method for validating and 
-        storing the parameteters. You should also implement or override some methods 
+        storing the parameters. You should also implement or override some methods 
         defined by <classname>AbstractFlatFileImporter</classname>.
       </para>
@@ -2045 +2045 @@
           <classname>PluginParameter</classname> objects and has stored the values
           at the configuration level. You should override this method if you need to
-          initiailise the parser in a different way. See for example the
+          initialise the parser in a different way. See for example the
           code for the <classname>PrintMapFlatFileImporter</classname> plug-in which
           has a fixed format and doesn't use configurations.
@@ -2088 +2088 @@
           TRUE, since obviously some data has been found. A subclass may override this method
           if it wants to do more checks, for example, make that a certain header is present
-          with a certain value. It may also continut parsing the file. Here is a code example from
+          with a certain value. It may also continue parsing the file. Here is a code example from
           the <classname>PrintMapFlatFileImporter</classname> which checks if a 
           <constant>FormatName</constant> header is present and contains either 
@@ -2608 +2608 @@
         <methodname>ImmediateDownloadExporter.doExport()</methodname> method.
         Here is what you need to do in your own plug-in code (code examples are
-        take from the <classname>HelpExporter</classname>):
+        taken from the <classname>HelpExporter</classname>):
       </para>
       
@@ -3039 +3039 @@
       <para>
         The <interfacename>net.sf.basedb.core.plugin.AnalysisFilterPlugin</interfacename> 
-        is a tagging interface with no methods that all analysis plug-ins that only filters
+        is a tagging interface, with no methods, that all analysis plug-ins that only filters
         data should implement. The benefit is that they will be linked from the
         <guibutton>Filter bioassay set</guibutton> button and not just
@@ -3079 +3079 @@
         <para>
           BASE can authenticate users in two ways. Either it uses the internal 
-          authentiction or the external authentication. With internal 
+          authentication or the external authentication. With internal 
           authentication BASE stores logins and passwords in its own database. 
           With external authentication this is handled by some external 
@@ -3755 +3755 @@
               <para>
               The <varname>progress</varname> parameter, if not 
-              <constant>null</constant>, should be used to reporter the
+              <constant>null</constant>, should be used to report the
               progress back to the calling code. The plug-in should count
               the number of bytes read from the <varname>in</varname>