examples/appletDeployment.html

   1 <!--
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18 -->
  19
  20
  21 <div id="view_decorated" name="view_decorated"  style="margin:8px; padding:10px; border: 2px solid red; text-align:center; display:none;"><b>Click <a href="index.html#appletDeployment"> here </a> to view decorated page</b></div>
  22
  23 <!-- content start -->
  24 <h2 name="appletDeployment"> Notes on applet deployment</h2>
  25 <table width=80% border="1">
  26   <tr><th colspan="2" align="center">Required Dependency Downloads</th></tr>
  27   <tr>
  28     <th>Dependency</th>
  29     <th>Description</th>
  30   </tr>
  31   <tr>
  32     <td><a href="http://www.jalview.org/builds/develop/examples/jalviewApplet.jar">JalviewApplet.jar</a> </td>
  33     <td>Main Jalview Applet Jar</td>
  34   </tr>
  35   <tr>
  36     <td><a href="http://www.jalview.org/builds/develop/examples/JmolApplet-14.6.4_2016.10.26.jar">JmolApplet-14.6.4_2016.10.26.jar</a> </td>
  37     <td>Jmol Applet Jar</td>
  38   </tr>
  39   <tr>
  40     <td><a href="http://www.jalview.org/builds/develop/examples/java-json.jar">java-json.jar</a></td>
  41     <td>Required for BioJSON Generation</td>
  42   </tr>
  43   <tr>
  44     <td><a href="http://www.jalview.org/builds/develop/examples/json_simple-1.1.jar">json_simple-1.1.jar</a></td>
  45     <td>Required for BioJSON Generation</td>
  46   </tr>
  47 </table>
  48
  49 <p>To run Jalview applet in your web page download the Jars listed above. The snippet below shows a minimal code for embedding Jalview applet into a web page.
  50 <pre><code>
  51 &lt;applet code="jalview.bin.JalviewLite" width="756" height="560" archive="jalviewApplet.jar,JmolApplet-14.6.4_2016.10.26.jar,java-json.jar,json_simple-1.1.jar"&gt;
  52         &lt;param name="permissions" value="sandbox" /&gt;
  53         &lt;param name="file" value="plantfdx.fa" /&gt;
  54         &lt;param name="features" value="plantfdx.features" /&gt;
  55         &lt;param name="userDefinedColour" value="C=yellow; R,K,H=FF5555; D,E=5555FF" /&gt;
  56         &lt;param name="showFullId" value="false" /&gt;
  57         &lt;param name="embedded" value="true" /&gt;
  58         &lt;param name="linkLabel_1" value="Uniprot" /&gt;
  59         &lt;param name="linkUrl_1"      value="http://www.uniprot.org/uniprot/$SEQUENCE_ID$" /&gt;
  60         &lt;param name="linkLabel_2" value="EMBL-EBI Search" /&gt;
  61         &lt;param name="linkUrl_2"      value="http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$" /&gt;
  62         &lt;param name="APPLICATION_URL" value="http://www.jalview.org/services/launchApp" /&gt;
  63 &lt;/applet&gt;
  64 </code></pre>
  65
  66
  67
  68
  69 <ul>
  70         <li>View full list of <a href="javascript:doSubmit('appletParameters')"> supported applet parameters here.</a></li>
  71         <li>Package all your data files into a single (or multiple) zip /
  72                 jar files. This is very useful to reduce download time of large data
  73                 files. The applet archive tag can take multiple entries separated by
  74                 commas, eg<br> <pre>&lt;applet code=&quot;jalview.bin.JalviewLite&quot;<em><strong> archive=&quot;jalviewApplet.jar, mydata.zip&quot;</strong></em>&gt;
  75             </pre>
  76         </li>
  77         <li>Use Jalview for input to a HTML form. For an example of how to
  78                 code this using Javascript, click <a
  79                 href="javascript:doSubmit('formComplete')">here</a>. <br>
  80         </li>
  81         <li>Embed Jalview into the web page, without the &quot;Start
  82                 Jalview&quot; button by setting the embed parameter to true;<br>
  83                 &lt;param name=&quot;embedded&quot; value=&quot;true&quot;&gt;
  84         </li>
  85         <li>For more examples, see the links to the left.</li>
  86 </ul>
  87
  88 <table border="1" width=80%>
  89         <tr><th colspan="2">Applet Release History</th>
  90         <tr>
  91                 <th>Release</th>
  92
  93                 <th>New Features / required changes</th>
  94         </tr>
  95         <tr>
  96                 <td><strong>2.9<br>(Latest)</strong></td>
  97                 <td>
  98         <ul>
  99         <li>Split Views for cDNA and Protein alignments<br/>Specify second alignment with 'file2' parameter, and set cDNA/Protein column scaling with scaleProteinAsCdna
 100         </li>
 101         <li>Jmol compatibility updated to Jmol 14.2.x series - <a href="JmolApplet-14.2.14_2015.06.11.jar">download the JmolApplet here </a></li>
 102         <li>The Jmol jar must be updated from <b>&#39;JmolApplet-12.2.4.jar&#39;</b> to <b>&#39;JmolApplet-14.2.14_2015.06.11.jar&#39;</b> in the applet archive argument as highlighted in red below:<br>
 103                 <pre>archive=&quot;jalviewApplet.jar,<font color="red">JmolApplet-14.2.14_2015.06.11.jar,</font>java-json.jar,json_simple-1.1.jar&quot;</pre>
 104         </li>
 105         <li>BioJson - A Json file format for representing a single multiple sequence alignment.
 106             Biojson uses the following external libraries: java-json and json_simple-1.1. <br>Hence the jar files highlighted in red must be included in the applet archive argument as follows:<br>
 107             <pre>archive=&quot;jalviewApplet.jar,JmolApplet-14.2.14_2015.06.11.jar,<font color="red">java-json.jar,json_simple-1.1.jar</font>&quot;</pre>
 108         </li>
 109         </ul>
 110                 </td>
 111         </tr>
 112         <tr>
 113                 <td><strong>2.8</strong></td>
 114                 <td><ul>
 115         <li>Normalised sequence logo display
 116         </li>
 117         <li>RNA secondary structure annotation row
 118         </li>
 119 <li>Jmol compatibility updated to Jmol 12.2.x series - <a href="JmolApplet-12.2.4.jar">download the JmolApplet here</a></li>
 120 <li>To use Jmol as the structure viewer for Jalview, you must include
 121             the jar file in the applet archive argument thus:<br>
 122             <pre>archive=&quot;jalviewApplet.jar,Jmol-12.2.4.jar&quot;</pre>
 123           </li>
 124           <li>Jmol 12.2.x requires at least Java 1.6 to run in the clients web browser. If the client does not have
 125             Java 1.6, or if the Jmol-12.2.jar is not added to the archive, the
 126             original Jalview structure viewer will still be available. <br>
 127           </li>
 128
 129         </ul></td>
 130         </tr>
 131         <tr>
 132                 <td><strong>2.7</strong></td>
 133                 <td><ul>
 134         <li>Javascript callbacks capabilities<ul><li>oninit parameter and methods for registering javascript handlers for selections, mouseovers and linking to Jmol applets on the page.</li>
 135         <li>To use javascript callbacks, ensure the applet tag includes the '<a href="http://download.oracle.com/javase/6/docs/technotes/guides/plugin/developer_guide/java_js.html">mayscript</a>' attribute - either as a parameter (&lt;param name="mayscript" value="true"/;gt;) or as a bare attribute in the applet html tag).</li></ul>
 136         </li>
 137         <li>New <a href="javascript:doSubmit('jalviewLiteJs')">jalviewLite java api</a> methods for selecting, highlighting, scrolling and reordering sequences in an alignment view.
 138         </li></ul>
 139         <p><strong>**NEW FEATURES** in Jalview 2.6</strong></p>
 140         <ul>
 141         <li>Jmol compatibility updated to Jmol 12.1.x series</li>
 142           <li>Jalview 2.6 works only with Jmol version 12.1.13 or later. You can use the JmolApplet.jar from
 143           the Jmol binary distribution available at the Jmol Sourceforge site,
 144           or <a href="JmolApplet-12.1.13.jar">download the Jmol applet from here</a></li>
 145           <li>Minimum recommended version of Java runtime for the applet is now 1.5 (JalviewLite v2.6 without the Jmol viewer may work ok on earlier Java environments but compatibility can no-longer be guaranteed).</li>
 146   </ul></td>
 147         </tr>
 148         <tr>
 149                 <td><strong>2.5</strong></td>
 150                 <td><ul>
 151         <li>New parameters to control display of tree annotation, width of alignment columns, and to disable the jalview button and check for Jmol on startup.</li>  </ul>
 152     </td>
 153         </tr>
 154         <tr>
 155                 <td><strong>2.4</strong></td>
 156                 <td><ul>
 157         <li>New applet API methods for feature display control, views, and obtaining current selection via javascript.</li>
 158           <li>Group show and hide parameters:
 159         &quot;showfeaturegroups&quot; and
 160         &quot;hidefeaturegroups&quot;. Both take a list
 161         of feature group names (separarated by &quot;|&quot; by default) to hide or show on the displayed
 162         alignment.
 163         </li>
 164         <li>Regular expressions can be used in URL links for sequence IDs.</li>
 165         <li>&quot;debug&quot; parameter to control verbosity of the applet's console output.</li>
 166         <li>&quot;showbutton&quot; parameter to disable launch button and open JalviewLite immediatly.</li>
 167         <li>&quot;nojmol&quot; parameter to disable check for Jmol classes.</li>
 168         </ul></td>
 169         </tr>
 170         <tr>
 171                 <td><strong>2.3</strong></td>
 172                 <td><ul>
 173           <li>Note that Parameter &quot;PDBFile&quot; now takes
 174             the PDB file followed by a space separated list of alignment sequence
 175             ids to associate the structure to. It is also possible to associate
 176             multiple PDB files by adding an incremental value to PDBFile (up to
 177             10). It is also possible to map specific sequences to specific chains
 178             by using the following notation:<br>
 179             <br>
 180             <pre>
 181             &lt;param name=&quot;PDBFile&quot; value=&quot;First.pdb SeqA SeqB
 182             SeqC&quot;&gt;<br>
 183             &lt;param name=&quot;PDBFile2&quot; value=&quot;Second.pdb
 184             A=SeqA B=SeqB C=SeqC&quot;&gt;<br>
 185             &lt;param name=&quot;PDBFile3&quot; value=&quot;Third.pdb
 186             D=SeqX B=SeqY C=SeqZ&quot;&gt;<br>
 187             </pre>
 188           </li>
 189           <li>Note parameter &quot;PDBSeq&quot; is no longer required.<br>
 190           </li>
 191           <li>Jalview 2.3 was updated to work with Jmol 11. See the <a href="/development">versions archive if you want to download the old Jmol applet</a>.</li>
 192
 193         </ul></td>
 194         </tr>
 195         <tr>
 196                 <td><strong>2.1</strong></td>
 197                 <td><ul>
 198           <li>Jalview Applet can read and display JPred secondary structure annotation
 199             directly via the <strong>jnetfile</strong> parameter. <br>
 200           </li>
 201           <li>Param &quot;UserDefinedColour&quot; - specify your own colours for each residue using a semi colon
 202             separated list. Multiple residues can be assigned the same colour
 203             using commas. eg:<br>
 204             <pre>&lt;param name=&quot;userDefinedColour&quot;
 205             value=&quot;D,E=red; K,R,H=0022FF; C=yellow&quot;&gt;</pre>
 206           </li>
 207           <li>Param &quot;showFeatureSettings&quot;
 208             - this will display the feature settings window when the applet starts.
 209           </li>
 210           <li>Param &quot;Application_URL&quot; value=&quot;http://www.jalview.org/services/launchApp&quot;<br/>
 211             This calls a servlet which creates a JNLP file with the alignment
 212             file, annotations file and features file of the applet as arguments.
 213             If the user has Java installed, the returned JNLP file should start
 214             up the full Jalview Application. BUT this does not currently work
 215             for alignment files added to the applet in a zip file.
 216             <br/>Look at the XML comments in the file downloaded from <a href="http://www.jalview.org/services/launchApp">The LaunchApp page</a> for full documentation.
 217           </li>
 218           <li>Alignment file can be a series of parameters using eg PFAM format
 219             <br>
 220             <pre>&lt;param name=&quot;sequence1&quot;
 221             value=&quot;Q93XJ9_SOLTU/11-26 TSFLPRKPVVTSLKAI&quot;&gt;<br>
 222             &lt;param name=&quot;sequence2&quot; value=&quot;FER1_PEA/14-29 TSFLRTQPMPMSVTTT&quot;&gt;<br>
 223             </pre>(All the usual Jalview File formats are valid, however each
 224             new line in an alignment file must be entered as a parameter)</li>
 225         </ul></td>
 226         </tr>
 227 </table>
 228
 229
 230 <!-- content end -->