JWS-86 edited the text and added googlecode link which wasn't active.
authorSuzanne Duce <s.duce@dundee.ac.uk>
Thu, 3 Apr 2014 09:05:57 +0000 (10:05 +0100)
committerSuzanne Duce <s.duce@dundee.ac.uk>
Thu, 3 Apr 2014 09:05:57 +0000 (10:05 +0100)
website/man_server_dev.html

index 1c3354f..791709e 100644 (file)
@@ -67,9 +67,9 @@
   <p><a href="full_javadoc/index.html">Complete</a> javadoc - for developers who want to use JABAWS framework and use Engines and Executables directly</p>\r
   <h4><a name="thesrc" id="thesrc"></a>The source code</h4>\r
 <p><a name="svn">Publicly available Git repository:</a><a href="http://source.jalview.org/gitweb/?p=jabaws.git;a=summary">http://source.jalview.org/gitweb/?p=jabaws.git;a=summary</a></p>\r
-<p>Another publicly available JABAWS repository containing the code for each JABAWS public release is located at https://jabaws.googlecode.com/ </p>\r
+<p>Another publicly available JABAWS repository, containing the code for each JABAWS public release, is located at <a href="https://jabaws.googlecode.com">jabaws.googlecode.com</a></p>\r
 <p>The repositories contain a complete JABAWS <a href="http://www.eclipse.org">Eclipse</a> project. </p>\r
-<p>Of cause If you want to make a modification to the source code you would need to generate distributives yourself. To do that first generate JAX-WS artifacts using <span class="hightlight">build-server</span> task from <span class="hightlight">wsbuild.xml</span> ant script, than you could use build.xml tasks to generate any of the distributives you need. </p>\r
+<p>Of course if you want to make a modification to the source code you would need to generate distributives yourself. To do that, first generate JAX-WS artifacts using <span class="hightlight">build-server</span> task from <span class="hightlight">wsbuild.xml</span> ant script, then you could use build.xml tasks to generate any of the distributives you need. </p>\r
 <h4><a name="projstruct" id="projstruct"></a>Structure of the project</h4>\r
 <ul>\r
        <li><span class="directory">binaries</span>     contains native executables e.g. clustalw</li>\r
 \r
 <h4><a name="runtests" id="runtests"></a>Running tests</h4>\r
 <p>\r
-JABAWS uses TestNG framework for testing. The test results for the JABAWS package offered for download can be found here: \r
+JABAWS uses TestNG framework for testing. The test results for the JABAWS package offered for download can be found at: \r
 <a href="http://www.compbio.dundee.ac.uk/user/www-jws2/tests/index.html">Test Results</a><br/>\r
 JABAWS uses <a href="http://testng.org/doc/index.html">TestNG</a> for testing. There is a TestNG plugin available for Eclipse \r
 which has functionality similar to JUnit. However, no plugins are necessary to run the test cases, as testng jar is supplied \r
@@ -206,9 +206,9 @@ those that depends on the cluster.</p>
                <p>Create a testcase suit for your wrapper in <span class="hightlight">testsrc</span> and run the test cases.</p>\r
        </li><li>\r
                <p>Create parser for the output files of your executable. Suggested location \r
-               compbio.data.sequence.SequenceUtil </p>\r
+               compbio.data.sequence.SequenceUtil . </p>\r
        </li><li>\r
-               <p>Test the parser</p>\r
+               <p>Test the parser.</p>\r
        </li><li>\r
                <p>Decide which web services interfaces your executable is going to match. For example \r
                if the executable output can be represented as SequenceAnnotation then SequenceAnnotation \r
@@ -218,7 +218,7 @@ those that depends on the cluster.</p>
                implement a web service which confirms to it within a webservices source folder. </p>\r
        </li><li> \r
                <p>Register web service in <span class="hightlight">WEB-INF/web.xml</span> \r
-               and <span class="hightlight">WEB-INF/sun-jaxws.xml</span></p>\r
+               and <span class="hightlight">WEB-INF/sun-jaxws.xml</span> .</p>\r
        </li><li> \r
                <p>Add generated wsdl to wsbuild.xml ant script to generate the stubs.</p>\r
        </li><li>\r
@@ -226,12 +226,12 @@ those that depends on the cluster.</p>
                that JAXB cannot serialize some of your new data structures. Add appropriate annotations to your data types.\r
                Also check that: </p>\r
                <ul>\r
-               <li>you do not have interfaces to serialize, since JAXB cannot serialize them;</li>\r
-               <li>you have a default no args constructor (can be private if you do not need it);</li>\r
-               <li>JAXB cannot serialize Java Map class, use a custom data structure instead;</li>\r
-               <li>Enum cannot be serialized as its abstract class (do not confuse with enum which is fine);</li>\r
+               <li>you do not have interfaces to serialize, since JAXB cannot serialize them</li>\r
+               <li>you have a default no args constructor (can be private if you do not need it)</li>\r
+               <li>JAXB cannot serialize Java Map class, use a custom data structure instead</li>\r
+               <li>Enum cannot be serialized as its abstract class (do not confuse with enum which is fine)</li>\r
                <li> Fields serialization leaves a little more space for manoeuvre. \r
-                       If you do this then you may accept<br/> and return interfaces, e.g. List, Map; abstract classes etc, from your methods.\r
+                       If you do this then you may accept<br/> and return interfaces, e.g. List, Map; abstract classes etc, from your methods\r
                </li>\r
                </ul>\r
                <p>If you have the data on the server side, but nothing is coming through to the \r