2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
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>
23 <!-- content start -->
24 <h2><a 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>
32 <td><a href="http://www.jalview.org/builds/develop/examples/JmolApplet-14.2.14_2015.06.11.jar">JmolApplet-14.2.14_2015.06.11.jar</a> </td>
33 <td>Jmol Applet Jar</td>
36 <td><a href="http://www.jalview.org/builds/develop/examples/java-json.jar">java-json.jar</a></td>
37 <td>Required for BioJSON Generation</td>
40 <td><a href="http://www.jalview.org/builds/develop/examples/json_simple-1.1.jar">json_simple-1.1.jar</a></td>
41 <td>Required for BioJSON Generation</td>
46 <li>Package all your data files into a single (or multiple) zip / jar
47 files. This is very useful to reduce download time of large data files.
48 The applet archive tag can take multiple entries separated by commas,
50 <pre><applet code="jalview.bin.JalviewLite"<em><strong>
51 archive="jalviewApplet.jar, mydata.zip"</strong></em>>
53 <li> Use Jalview for input to a HTML form. For an example of how to
54 code this using Javascript, click <a href="javascript:doSubmit('formComplete')">here</a>.
57 <li>Embed Jalview into the web page, without the "Start Jalview"
58 button by setting the embed parameter to true;<br>
59 <param name="embedded"
60 value="true"> </li>
61 <li><a href="javascript:doSubmit('appletParameters')">View full list of supported parameters here.</a> </li>
64 <p><strong>**NEW FEATURES** in Jalview 2.9</strong></p>
66 <li>Split Views for cDNA and Protein alignments<br/>Specify second alignment with 'file2' parameter, and set cDNA/Protein column scaling with scaleProteinAsCdna
68 <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>
69 <li>The Jmol jar must be updated from <b>'JmolApplet-12.2.4.jar'</b> to <b>'JmolApplet-14.2.14_2015.06.11.jar'</b> in the applet archive argument as highlighted in red below:<br>
70 <pre>archive="jalviewApplet.jar,<font color="red">JmolApplet-14.2.14_2015.06.11.jar,</font>java-json.jar,json_simple-1.1.jar"</pre>
72 <li>BioJson - A Json file format for representing a single multiple sequence alignment.
73 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>
74 <pre>archive="jalviewApplet.jar,JmolApplet-14.2.14_2015.06.11.jar,<font color="red">java-json.jar,json_simple-1.1.jar</font>"</pre>
78 <p><strong>**NEW FEATURES** in Jalview 2.8</strong></p>
80 <li>Normalised sequence logo display
82 <li>RNA secondary structure annotation row
84 <li>Jmol compatibility updated to Jmol 12.2.x series - <a href="JmolApplet-12.2.4.jar">download the JmolApplet here</a></li>
85 <li>To use Jmol as the structure viewer for Jalview, you must include
86 the jar file in the applet archive argument thus:<br>
87 <pre>archive="jalviewApplet.jar,Jmol-12.2.4.jar"</pre>
89 <li>Jmol 12.2.x requires at least Java 1.6 to run in the clients web browser. If the client does not have
90 Java 1.6, or if the Jmol-12.2.jar is not added to the archive, the
91 original Jalview structure viewer will still be available. <br>
95 <p><strong>**NEW FEATURES** in Jalview 2.7</strong></p>
97 <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>
98 <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 (<param name="mayscript" value="true"/;gt;) or as a bare attribute in the applet html tag).</li></ul>
100 <li>New <a href="javascript:doSubmit('jalviewLiteJs')">jalviewLite java api</a> methods for selecting, highlighting, scrolling and reordering sequences in an alignment view.
102 <p><strong>**NEW FEATURES** in Jalview 2.6</strong></p>
104 <li>Jmol compatibility updated to Jmol 12.1.x series</li>
105 <li>Jalview 2.6 works only with Jmol version 12.1.13 or later. You can use the JmolApplet.jar from
106 the Jmol binary distribution available at the Jmol Sourceforge site,
107 or <a href="JmolApplet-12.1.13.jar">download the Jmol applet from here</a></li>
108 <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>
110 <br><strong>**NEW FEATURES** in Jalview 2.5</strong></p>
112 <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>
114 <br><strong>**NEW FEATURES** in Jalview 2.4</strong></p>
116 <li>New applet API methods for feature display control, views, and obtaining current selection via javascript.</li>
117 <li>Group show and hide parameters:
118 "showfeaturegroups" and
119 "hidefeaturegroups". Both take a list
120 of feature group names (separarated by "|" by default) to hide or show on the displayed
123 <li>Regular expressions can be used in URL links for sequence IDs.</li>
124 <li>"debug" parameter to control verbosity of the applet's console output.</li>
125 <li>"showbutton" parameter to disable launch button and open JalviewLite immediatly.</li>
126 <li>"nojmol" parameter to disable check for Jmol classes.</li>
128 <strong>**NEW FEATURES** in Jalview 2.3</strong></p>
130 <li>Note that Parameter "PDBFile" now takes
131 the PDB file followed by a space separated list of alignment sequence
132 ids to associate the structure to. It is also possible to associate
133 multiple PDB files by adding an incremental value to PDBFile (up to
134 10). It is also possible to map specific sequences to specific chains
135 by using the following notation:<br>
138 <param name="PDBFile" value="First.pdb SeqA SeqB
140 <param name="PDBFile2" value="Second.pdb
141 A=SeqA B=SeqB C=SeqC"><br>
142 <param name="PDBFile3" value="Third.pdb
143 D=SeqX B=SeqY C=SeqZ"><br>
146 <li>Note parameter "PDBSeq" is no longer required.<br>
148 <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>
152 <strong>**NEW FEATURES** in Jalview 2.1</strong>
154 <li>Jalview Applet can read and display JNet secondary structure annotation
155 directly via the <strong>jnetfile</strong> parameter. <br>
157 <li>Param "UserDefinedColour" - specify your own colours for each residue using a semi colon
158 separated list. Multiple residues can be assigned the same colour
159 using commas. eg:<br>
160 <pre><param name="userDefinedColour"
161 value="D,E=red; K,R,H=0022FF; C=yellow"></pre>
163 <li>Param "showFeatureSettings"
164 - this will display the feature settings window when the applet starts.
166 <li>Param "Application_URL" value="http://www.jalview.org/services/launchApp"<br/>
167 This calls a servlet which creates a JNLP file with the alignment
168 file, annotations file and features file of the applet as arguments.
169 If the user has Java installed, the returned JNLP file should start
170 up the full Jalview Application. BUT this does not currently work
171 for alignment files added to the applet in a zip file.
172 <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.
174 <li>Alignment file can be a series of parameters using eg PFAM format
176 <pre><param name="sequence1"
177 value="Q93XJ9_SOLTU/11-26 TSFLPRKPVVTSLKAI"><br>
178 <param name="sequence2" value="FER1_PEA/14-29 TSFLRTQPMPMSVTTT"><br>
179 </pre>(All the usual Jalview File formats are valid, however each
180 new line in an alignment file must be entered as a parameter)</li>