Merge branch 'JAL-1400_signapplet' into Release_2_8_Branch
[jalview.git] / examples / appletParameters.html
index 286c26d..4779046 100644 (file)
@@ -80,7 +80,11 @@ function mcancelclosetime()
 document.onclick = mclose; 
 // -->
 </script>
-
+<script>
+<!--//--><![CDATA[//><!--
+var _gaq = _gaq || [];_gaq.push(["_setAccount", "UA-9060947-1"]);_gaq.push(["_trackPageview"]);(function() {var ga = document.createElement("script");ga.type = "text/javascript";ga.async = true;ga.src = ("https:" == document.location.protocol ? "https://ssl" : "http://www") + ".google-analytics.com/ga.js";var s = document.getElementsByTagName("script")[0];s.parentNode.insertBefore(ga, s);})();
+//--><!]]>
+</script> 
 </head>
 
 
@@ -88,10 +92,10 @@ document.onclick = mclose;
 
 
 <div id="header">
-<div id="logo"><a href="/" title="Home"></a></div>
+<div id="logo"><a href="http://www.jalview.org" title="Home"></a></div>
 <ul id="buttons">
 <li id="applet"><a href="applets.html" title="applet"></a></li>
-<li id="desktop"><a href="/webstart/jalview.jnlp" title="desktop"></a></li>
+<li id="desktop"><a href="../webstart/jalview.jnlp" title="desktop"></a></li>
 </ul>
 </div>
 
@@ -100,39 +104,38 @@ document.onclick = mclose;
 <div id="navInner">
 
 <ul id="sddm">
- <li><a href="#">Home</a></li>
- <li><a href="#" onmouseover="mopen('m1')" onmouseout="mclosetime()">About</a>
+ <li><a href="http://www.jalview.org">Home</a></li>
+ <li><a href="http://www.jalview.org/about" onmouseover="mopen('m1')" onmouseout="mclosetime()">About</a>
   <div id="m1" onmouseover="mcancelclosetime()" onmouseout="mclosetime()">
-  <a href="#">Documentation</a>
-  <a href="#">Publications</a>
-  <a href="#">Credits</a>
-  <a href="#">Screenshots</a>
+  <a href="http://www.jalview.org/about/documentation">Documentation</a>
+  <a href="http://www.jalview.org/about/citation">Publications</a>
+  <a href="http://www.jalview.org/about/credits">Credits</a>
   </div>
  </li>
- <li><a href="#">FAQ</a></li>
- <li><a href="#" onmouseover="mopen('m3')" onmouseout="mclosetime()" class="community">Community</a>
+ <li><a href="http://www.jalview.org/faq">FAQ</a></li>
+ <li><a href="http://www.jalview.org/community" onmouseover="mopen('m3')" onmouseout="mclosetime()" class="community">Community</a>
   <div id="m3" onmouseover="mcancelclosetime()" onmouseout="mclosetime()">
-  <a href="#">News Mailing List</a>
-  <a href="#">Discussion Mailing List</a>
-  <a href="#">Links</a>
-  <a href="#">Community News</a>
+  <a href="http://www.jalview.org/mailman/listinfo/jalview-announce">News Mailing List</a>
+  <a href="http://www.jalview.org/mailman/listinfo/jalview-discuss">Discussion Mailing List</a>
+  <a href="http://www.jalview.org/community/links">Links</a>
+  <a href="http://www.jalview.org/community/community-news">Community News</a>
   </div>
  </li>
- <li><a href="#" onmouseover="mopen('m4')" onmouseout="mclosetime()" class="development">Development</a>
+ <li><a href="http://www.jalview.org/development" onmouseover="mopen('m4')" onmouseout="mclosetime()" class="development">Development</a>
   <div id="m4" onmouseover="mcancelclosetime()" onmouseout="mclosetime()">
-  <a href="#">Release History</a>
-  <a href="#">Jalview Bug Tracker</a>
-  <a href="#">Jalview Git Web</a>
-  <a href="#">Development News</a>
+  <a href="http://www.jalview.org/development/release-history">Release History</a>
+  <a href="http://issues.jalview.org">Jalview Bug Tracker</a>
+  <a href="http://source.jalview.org/gitweb/">Jalview Git Web</a>
+  <a href="http://www.jalview.org/development/development-news">Development News</a>
   </div>
  </li>
- <li><a href="#" onmouseover="mopen('m5')" onmouseout="mclosetime()" class="training">Training</a>
+ <li><a href="http://www.jalview.org/training" onmouseover="mopen('m5')" onmouseout="mclosetime()" class="training">Training</a>
   <div id="m5" onmouseover="mcancelclosetime()" onmouseout="mclosetime()">
-  <a href="#">Training Courses</a>
-  <a href="#">Training News</a>
+  <a href="http://www.jalview.org/training/training-courses">Training Courses</a>
+  <a href="http://www.jalview.org/training/training-news">Training News</a>
   </div>
  </li>
- <li><a href="#" class="download-right">Download</a></li>
+ <li><a href="http://www.jalview.org/download" class="download-right">Download</a></li>
 </ul>
 <div style="clear:both"></div>
 </div>
@@ -148,8 +151,8 @@ document.onclick = mclose;
 <li class="jvlite-nav-small"><a href="appletParameters.html">Applet Parameters</a></li>
 <li><a href="jalviewLiteJs.html">Javascript API</a></li>
 <li><a href="formComplete.html">in-page API demo</a></li>
-<li><a href="linkedApplets_ng.html">Two JalviewLites demo</a></li>
-<li><a href="embeddedWJmol.html">Sequence And Structure demo</a></li>
+<li><a href="linkedapplets_ng.html">Two JalviewLites demo</a></li>
+<li><a href="embeddedWJmol.html">Jalview and Jmol demo</a></li>
 </ul>
 </div>
 
@@ -163,134 +166,19 @@ document.onclick = mclose;
                                                                href="jalviewLiteJs.html">here</a></li>
                                                </ul></strong>
                                        </p>
-                                       
-        <h3 align="left">Useful to know!!</h3>
-        <ul>
-          <li>Package all your data files into a single (or multiple) zip / jar 
-            files. This is very useful to reduce download time of large data files. 
-            The applet archive tag can take multiple entries separated by commas, 
-            eg<br>
-            <font face="Courier New, Courier, mono" align="left">&lt;applet code=&quot;jalview.bin.JalviewLite&quot;<em><strong> 
-            archive=&quot;jalviewApplet.jar, mydata.zip&quot;</strong></em>&gt;<br>
-            </font></li>
-          <li> Use Jalview for input to a HTML form. For an example of how to 
-            code this using Javascript, click <a href="formComplete.html">here</a>. 
-            <br>
-          </li>
-          <li>Embed Jalview into the web page, without the &quot;Start Jalview&quot; 
-            button by setting the embed parameter to true;<br>
-            &lt;param name=&quot;embedded&quot;
-          value=&quot;true&quot;&gt; </li>
-        </ul>
-        <p><strong><font size="2">**NEW FEATURES** in Jalview 2.8</font></strong></p>
-        <ul>
-        <li><font size="2">Normalised sequence logo display
-        </font></li>
-        <li><font size="2">RNA secondary structure annotation row
-        </font></li>
-<li><font size="2">Jmol compatibility updated to Jmol 12.2.x series - <a href="JmolApplet-12.2.4.jar">download the JmolApplet here</a></font></li>
-<li>To use Jmol as the structure viewer for Jalview, you must include 
-            the jar file in the applet archive argument thus:<br>
-            <pre>archive=&quot;jalviewApplet.jar,Jmol-12.2.4.jar&quot;</pre></font>
-          </li>
-          <li>Jmol 12.2.x requires at least Java 1.6 to run in the clients web browser. If the client does not have 
-            Java 1.6, or if the Jmol-12.2.jar is not added to the archive, the 
-            original Jalview structure viewer will still be available. <br>
-          </li>
-          
-        </ul>
-        <p><strong><font size="2">**NEW FEATURES** in Jalview 2.7</font></strong></p>
-        <ul>
-        <li><font size="2">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>
-        <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></font>
-        </li>
-        <li><font size="2">New <a href="jalviewLiteJs.html">jalviewLite java api</a> methods for selecting, highlighting, scrolling and reordering sequences in an alignment view.
-        </font></li></ul>
-        <p><strong><font size="2">**NEW FEATURES** in Jalview 2.6</font></strong></p>
-        <ul>
-        <li><font size="2">Jmol compatibility updated to Jmol 12.1.x series</font></li>
-          <li>Jalview 2.6 works only with Jmol version 12.1.13 or later. You can use the JmolApplet.jar from 
-          the Jmol binary distribution available at the Jmol Sourceforge site, 
-          or <a href="JmolApplet-12.1.13.jar">download the Jmol applet from here</a></li>
-          <li><font size="2">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).</font></li>
-               </ul>
-        <br><strong><font size="2">**NEW FEATURES** in Jalview 2.5</font></strong></p>
-        <ul>
-        <li><font size="2">New parameters to control display of tree annotation, width of alignment columns, and to disable the jalview button and check for Jmol on startup.</font></li>
-               </ul>        
-        <br><strong><font size="2">**NEW FEATURES** in Jalview 2.4</font></strong></p>
-        <ul>
-        <li><font size="2">New applet API methods for feature display control, views, and obtaining current selection via javascript.</font></li>
-          <li><font size="2">Group show and hide parameters:
-        &quot;showfeaturegroups&quot; and
-        &quot;hidefeaturegroups&quot;. Both take a list
-        of feature group names (separarated by &quot;|&quot; by default) to hide or show on the displayed
-        alignment.</font>
-        </li>
-        <li><font size="2">Regular expressions can be used in URL links for sequence IDs.</font></li>
-        <li><font size="2">&quot;debug&quot; parameter to control verbosity of the applet's console output.</font></li>
-        <li><font size="2">&quot;showbutton&quot; parameter to disable launch button and open JalviewLite immediatly.</font></li>
-        <li><font size="2">&quot;nojmol&quot; parameter to disable check for Jmol classes.</font></li>
-        </ul><br>
-        <strong><font size="2">**NEW FEATURES** in Jalview 2.3</font></strong></p>
-        <ul>
-          <li><font size="2">Note that Parameter &quot;PDBFile&quot; now takes 
-            the PDB file followed by a space separated list of alignment sequence 
-            ids to associate the structure to. It is also possible to associate 
-            multiple PDB files by adding an incremental value to PDBFile (up to 
-            10). It is also possible to map specific sequences to specific chains 
-            by using the following notation:<br>
-            <br>
-            &lt;param name=&quot;PDBFile&quot; value=&quot;First.pdb SeqA SeqB 
-            SeqC&quot;&gt; </font><br>
-            <font size="2">&lt;param name=&quot;PDBFile2&quot; value=&quot;Second.pdb 
-            A=SeqA B=SeqB C=SeqC&quot;&gt; </font><br>
-            <font size="2">&lt;param name=&quot;PDBFile3&quot; value=&quot;Third.pdb 
-            D=SeqX B=SeqY C=SeqZ&quot;&gt; </font> <br>
-          </li>
-          <li>Note parameter &quot;PDBSeq&quot; is no longer required.<br>
-          </li>
-          <li>Jalview 2.3 was updated to work with Jmol 11. See the <a href="../versions.html">versions archive if you want to download the old Jmol applet</a>.</li> 
-            <p>&nbsp;</p>
-          </li>
-        </ul>
-        <strong><font size="2">**NEW FEATURES** in Jalview 2.1</font></strong> 
-        <ul>
-          <li>Jalview Applet can read and display JNet secondary structure annotation 
-            directly via the <strong>jnetfile</strong> parameter. <br>
-          </li>
-          <li>Param <font face="Courier New, Courier, mono">UserDefinedColour</font><em> 
-            </em>- specify your own colours for each residue using a semi colon 
-            separated list. Multiple residues can be assigned the same colour 
-            using commas. eg:<br>
-            <font face="Courier New, Courier, mono">&lt;param name=&quot;userDefinedColour&quot; 
-            value=&quot;D,E=red; K,R,H=0022FF; C=yellow&quot;&gt;</font><br>
-          </li>
-          <li>Param <font face="Courier New, Courier, mono">showFeatureSettings</font>
-            - this will display the feature settings window when the applet starts.<br>
-          </li>
-          <li>Param <font face="Courier New, Courier, mono">Application_URL value=&quot;http://www.jalview.org/services/launchApp&quot;<br>
-            </font>This calls a servlet which creates a JNLP file with the alignment 
-            file, annotations file and features file of the applet as arguments. 
-            If the user has Java installed, the returned JNLP file should start 
-            up the full Jalview Application. BUT this does not currently work 
-            for alignment files added to the applet in a zip file.<br>
-          </li>
-          <li>Alignment file can be a series of parameters using eg PFAM format 
-            <br>
-            <font face="Courier New, Courier, mono">&lt;param name=&quot;sequence1&quot; 
-            value=&quot;Q93XJ9_SOLTU/11-26 TSFLPRKPVVTSLKAI&quot;&gt;<br>
-            &lt;param name=&quot;sequence2&quot; value=&quot;FER1_PEA/14-29 TSFLRTQPMPMSVTTT&quot;&gt;<br>
-            </font>(All the usual Jalview File formats are valid, however each 
-            new line in an alignment file must be entered as a parameter)<font face="Courier New, Courier, mono"><br>
-            </font> </li>
-        </ul>
-        <a name="parameters"></a>        <table width="97%" border="1" align="center" >
+     <p>Additional <a href="#appletdeploymentnotes">applet deployment notes are below</a>.</p>
+           <p><h2>Applet Parameters</h2><br/>The applet takes the following initialisation parameters.</p>
+        <a name="parameters"></a>        <table width="97%" class="borderTable" align="center" >
           <tr> 
             <td width="103" height="23"><strong>&lt;param name=&quot;&quot;</strong></td>
             <td width="80" ><strong>value=&quot;&quot;&gt;</strong></td>
             <td width="100%"><strong>Description</strong></td>
           </tr>
+          <tr>
+          <td>permissions</td>
+          <td>sandbox</td>
+          <td><strong>This parameter is necessary, and must have the value <em>sandbox</em> to allow the JalviewLite applet to run.</strong></td>
+          </tr>
           <tr> 
             <td>file</td>
             <td>fileName</td>
@@ -578,11 +466,134 @@ document.onclick = mclose;
           <td>Multiple sequences aligment scores file. Currently is supported only the T-Coffee score_ascii file format</td>
           </tr>
                   </table>
+                  <p><h2><a name="appletdeploymentnotes"/>Notes on applet deployment</h2><br/>
+        <ul>
+          <li>Package all your data files into a single (or multiple) zip / jar 
+            files. This is very useful to reduce download time of large data files. 
+            The applet archive tag can take multiple entries separated by commas, 
+            eg<br>
+            <pre>&lt;applet code=&quot;jalview.bin.JalviewLite&quot;<em><strong> 
+            archive=&quot;jalviewApplet.jar, mydata.zip&quot;</strong></em>&gt;<br>
+            </pre></li>
+          <li> Use Jalview for input to a HTML form. For an example of how to 
+            code this using Javascript, click <a href="formComplete.html">here</a>. 
+            <br>
+          </li>
+          <li>Embed Jalview into the web page, without the &quot;Start Jalview&quot; 
+            button by setting the embed parameter to true;<br>
+            &lt;param name=&quot;embedded&quot;
+          value=&quot;true&quot;&gt; </li>
+        </ul>
+        <p><strong>**NEW FEATURES** in Jalview 2.8</strong></p>
+        <ul>
+        <li>Normalised sequence logo display
+        </li>
+        <li>RNA secondary structure annotation row
+        </li>
+<li>Jmol compatibility updated to Jmol 12.2.x series - <a href="JmolApplet-12.2.4.jar">download the JmolApplet here</a></li>
+<li>To use Jmol as the structure viewer for Jalview, you must include 
+            the jar file in the applet archive argument thus:<br>
+            <pre>archive=&quot;jalviewApplet.jar,Jmol-12.2.4.jar&quot;</pre>
+          </li>
+          <li>Jmol 12.2.x requires at least Java 1.6 to run in the clients web browser. If the client does not have 
+            Java 1.6, or if the Jmol-12.2.jar is not added to the archive, the 
+            original Jalview structure viewer will still be available. <br>
+          </li>
+          
+        </ul>
+        <p><strong>**NEW FEATURES** in Jalview 2.7</strong></p>
+        <ul>
+        <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>
+        <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>
+        </li>
+        <li>New <a href="jalviewLiteJs.html">jalviewLite java api</a> methods for selecting, highlighting, scrolling and reordering sequences in an alignment view.
+        </li></ul>
+        <p><strong>**NEW FEATURES** in Jalview 2.6</strong></p>
+        <ul>
+        <li>Jmol compatibility updated to Jmol 12.1.x series</li>
+          <li>Jalview 2.6 works only with Jmol version 12.1.13 or later. You can use the JmolApplet.jar from 
+          the Jmol binary distribution available at the Jmol Sourceforge site, 
+          or <a href="JmolApplet-12.1.13.jar">download the Jmol applet from here</a></li>
+          <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>
+  </ul>
+        <br><strong>**NEW FEATURES** in Jalview 2.5</strong></p>
+        <ul>
+        <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>        
+        <br><strong>**NEW FEATURES** in Jalview 2.4</strong></p>
+        <ul>
+        <li>New applet API methods for feature display control, views, and obtaining current selection via javascript.</li>
+          <li>Group show and hide parameters:
+        &quot;showfeaturegroups&quot; and
+        &quot;hidefeaturegroups&quot;. Both take a list
+        of feature group names (separarated by &quot;|&quot; by default) to hide or show on the displayed
+        alignment.
+        </li>
+        <li>Regular expressions can be used in URL links for sequence IDs.</li>
+        <li>&quot;debug&quot; parameter to control verbosity of the applet's console output.</li>
+        <li>&quot;showbutton&quot; parameter to disable launch button and open JalviewLite immediatly.</li>
+        <li>&quot;nojmol&quot; parameter to disable check for Jmol classes.</li>
+        </ul><br>
+        <strong>**NEW FEATURES** in Jalview 2.3</strong></p>
+        <ul>
+          <li>Note that Parameter &quot;PDBFile&quot; now takes 
+            the PDB file followed by a space separated list of alignment sequence 
+            ids to associate the structure to. It is also possible to associate 
+            multiple PDB files by adding an incremental value to PDBFile (up to 
+            10). It is also possible to map specific sequences to specific chains 
+            by using the following notation:<br>
+            <br>
+            <pre>
+            &lt;param name=&quot;PDBFile&quot; value=&quot;First.pdb SeqA SeqB 
+            SeqC&quot;&gt;<br>
+            &lt;param name=&quot;PDBFile2&quot; value=&quot;Second.pdb 
+            A=SeqA B=SeqB C=SeqC&quot;&gt;<br>
+            &lt;param name=&quot;PDBFile3&quot; value=&quot;Third.pdb 
+            D=SeqX B=SeqY C=SeqZ&quot;&gt;<br>
+            </pre>
+          </li>
+          <li>Note parameter &quot;PDBSeq&quot; is no longer required.<br>
+          </li>
+          <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> 
+            <p>&nbsp;</p>
+          </li>
+        </ul>
+        <strong>**NEW FEATURES** in Jalview 2.1</strong> 
+        <ul>
+          <li>Jalview Applet can read and display JNet secondary structure annotation 
+            directly via the <strong>jnetfile</strong> parameter. <br>
+          </li>
+          <li>Param &quot;UserDefinedColour&quot; - specify your own colours for each residue using a semi colon 
+            separated list. Multiple residues can be assigned the same colour 
+            using commas. eg:<br>
+            <pre>&lt;param name=&quot;userDefinedColour&quot; 
+            value=&quot;D,E=red; K,R,H=0022FF; C=yellow&quot;&gt;</pre>
+          </li>
+          <li>Param &quot;showFeatureSettings&quot;
+            - this will display the feature settings window when the applet starts.
+          </li>
+          <li>Param &quot;Application_URL&quot; value=&quot;http://www.jalview.org/services/launchApp&quot;<br/>
+            This calls a servlet which creates a JNLP file with the alignment 
+            file, annotations file and features file of the applet as arguments. 
+            If the user has Java installed, the returned JNLP file should start 
+            up the full Jalview Application. BUT this does not currently work 
+            for alignment files added to the applet in a zip file.
+            <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.
+          </li>
+          <li>Alignment file can be a series of parameters using eg PFAM format 
+            <br>
+            <pre>&lt;param name=&quot;sequence1&quot; 
+            value=&quot;Q93XJ9_SOLTU/11-26 TSFLPRKPVVTSLKAI&quot;&gt;<br>
+            &lt;param name=&quot;sequence2&quot; value=&quot;FER1_PEA/14-29 TSFLRTQPMPMSVTTT&quot;&gt;<br>
+            </pre>(All the usual Jalview File formats are valid, however each 
+            new line in an alignment file must be entered as a parameter)</li>
+        </ul>
+        
+</div>
 </div>
-
 <div id ="footer">
 <div id="innerFooter">
-<div id="copyright"><p>Copyright all rights reserved 2012</p></div>
+<div id="copyright"><p>Published under <a href="http://creativecommons.org/licenses/by-sa/3.0/">CC-SA 3.0</a></p></div>
 <div id="cite">
 <p>
 If you use Jalview in your work, please cite this publication:
@@ -591,7 +602,7 @@ If you use Jalview in your work, please cite this publication:
 <p>
 Waterhouse, A.M., Procter, J.B., Martin, D.M.A, Clamp, M. and Barton, G. J. (2009)
 "Jalview Version 2 - a multiple sequence alignment editor and analysis workbench"
-Bioinformatics 25 (9) 1189-1191 doi: 10.1093/bioinformatics/btp033
+Bioinformatics 25 (9) 1189-1191 <a href="http://dx.doi.org/10.1093/bioinformatics/btp033">doi: 10.1093/bioinformatics/btp033</a>
 </p>
 </div>
 </div>