Merge branch 'features/JAL-1641_JSON-tests-and-docs' into develop
[jalview.git] / examples / appletParameters.html
index 9350c4b..95a4511 100644 (file)
@@ -1,7 +1,7 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <!--
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
 -->
-<html xmlns="http://www.w3.org/1999/xhtml">
 <head>
-<TITLE>Applet Parameters</TITLE>
+  <TITLE>Applet Parameters</TITLE>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 
 
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 
-
- <link href="css/reset.css" rel="stylesheet" type="text/css" />
- <link href="css/style.css" rel="stylesheet" type="text/css" />
+  <link href="css/reset.css" rel="stylesheet" type="text/css" />
+  <link href="css/style.css" rel="stylesheet" type="text/css" />
+  
   <!--[if IE 6]>
- <link rel="stylesheet" type="text/css" href="css/ie6.css" />
-<![endif]-->
+      <link rel="stylesheet" type="text/css" href="css/ie6.css" />
+      <![endif]-->
 
-<!--[if IE 7]>
- <link rel="stylesheet" type="text/css" href="css/ie7.css" />
-<![endif]-->
+  <!--[if IE 7]>
+      <link rel="stylesheet" type="text/css" href="css/ie7.css" />
+      <![endif]-->
 
-<!-- dd menu -->
-<script type="text/javascript">
-<!--
-var timeout         = 500;
-var closetimer  = 0;
-var ddmenuitem      = 0;
+  <!-- dd menu -->
+  <script type="text/javascript">
+    <!--
+       var timeout         = 500;
+       var closetimer  = 0;
+       var ddmenuitem      = 0;
 
-// open hidden layer
-function mopen(id)
-{ 
- // cancel close timer
- mcancelclosetime();
+       // open hidden layer
+       function mopen(id)
+       { 
+       // cancel close timer
+       mcancelclosetime();
 
- // close old layer
- if(ddmenuitem) ddmenuitem.style.visibility = 'hidden';
+       // close old layer
+       if(ddmenuitem) ddmenuitem.style.visibility = 'hidden';
 
- // get new layer and show it
- ddmenuitem = document.getElementById(id);
- ddmenuitem.style.visibility = 'visible';
+       // get new layer and show it
+       ddmenuitem = document.getElementById(id);
+       ddmenuitem.style.visibility = 'visible';
 
-}
-// close showed layer
-function mclose()
-{
- if(ddmenuitem) ddmenuitem.style.visibility = 'hidden';
-}
+       }
+       // close showed layer
+       function mclose()
+       {
+       if(ddmenuitem) ddmenuitem.style.visibility = 'hidden';
+       }
 
-// go close timer
-function mclosetime()
-{
- closetimer = window.setTimeout(mclose, timeout);
-}
+       // go close timer
+       function mclosetime()
+       {
+       closetimer = window.setTimeout(mclose, timeout);
+       }
 
-// cancel close timer
-function mcancelclosetime()
-{
- if(closetimer)
- {
-  window.clearTimeout(closetimer);
-  closetimer = null;
- }
-}
+       // cancel close timer
+       function mcancelclosetime()
+       {
+       if(closetimer)
+       {
+       window.clearTimeout(closetimer);
+       closetimer = null;
+       }
+       }
 
-// close layer when click-out
-document.onclick = mclose; 
-// -->
-</script>
+       // close layer when click-out
+       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>
 
@@ -87,83 +91,84 @@ document.onclick = mclose;
 <body>
 
 
-<div id="header">
-<div id="logo"><a href="/" 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>
-</ul>
-</div>
-
-
-<div id ="nav">
-<div id="navInner">
-
-<ul id="sddm">
- <li><a href="#">Home</a></li>
- <li><a href="#" 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>
-  </div>
- </li>
- <li><a href="#">FAQ</a></li>
- <li><a href="#" 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>
+  <div id="header">
+    <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>
+    </ul>
   </div>
- </li>
- <li><a href="#" 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>
-  </div>
- </li>
- <li><a href="#" 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>
-  </div>
- </li>
- <li><a href="#" class="download-right">Download</a></li>
-</ul>
-<div style="clear:both"></div>
-</div>
 
-</div>
+  
+  <div id ="nav">
+    <div id="navInner">
 
+      <ul id="sddm">
+       <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="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="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="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="http://www.jalview.org/development" onmouseover="mopen('m4')" onmouseout="mclosetime()" class="development">Development</a>
+         <div id="m4" onmouseover="mcancelclosetime()" onmouseout="mclosetime()">
+           <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="http://www.jalview.org/training" onmouseover="mopen('m5')" onmouseout="mclosetime()" class="training">Training</a>
+         <div id="m5" onmouseover="mcancelclosetime()" onmouseout="mclosetime()">
+           <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="http://www.jalview.org/download" class="download-right">Download</a></li>
+      </ul>
+      <div style="clear:both"></div>
+    </div>
 
+  </div>
 <div id="pageWrap">
 
 <div id="sideNav">
-<ul>
-<li><a href="applets.html">JalviewLite Examples</a></li>
-<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">Jalview and Jmol demo</a></li>
-</ul>
+  <ul>
+      <li ><a href="applets.html">JalviewLite Examples</a></li>
+      <li ><a href="jalviewLiteJs.html">Javascript API</a></li>
+      <li class="jvlite-nav-small"><a href="appletParameters.html">Applet Parameters</a></li>
+      <li ><a href="embedded.html">Embedded Alignment</a></li>
+      <li ><a href="embeddedWJmol.html">Jalview and Jmol</a></li>
+      <li ><a href="formComplete.html">Access from Javascript</a></li>
+      <li ><a href="javascriptLaunch.html">Javascript Launch</a></li>
+      <li ><a href="linkedapplets_ng.html">Linked JalviewLites</a></li>
+  </ul>
 </div>
 
 <div id="content" class="content">
-        <p>
-                                               <strong>Quick Links:<ul><li>Download the applet jar file from <a
-                                                       href="jalviewApplet.jar">here</a>
-                                               </li>
-                                               <li>Parameters are described <a href="#parameters">below</a></li>
-                                               <li>The javascript API is described <a
-                                                               href="jalviewLiteJs.html">here</a></li>
-                                               </ul></strong>
-                                       </p>
-     <p>Additional <a href="#appletdeploymentnotes">applet deployment notes are below</a>.</p>
+
+
+<!-- content start -->
+<h2>JalviewLite Applet Parameter Documentation</h2>
+<p>
+The JalviewLite applet is configured through a series of applet parameters,
+which are described <a href="#parameters"> below</a>. Once initialised,
+the applet can be interacted with <em>via</em> its 
+<a href="jalviewLiteJs.html">Javascript API</a>.
+</p><p><strong>Issues arising from tightening of Java Security default settings</strong><br/>JalviewLite is provided as a signed applet with 'sandbox' permissions and wildcards that allow it to be run from any website. Unfortunately, earlier versions of Java are not compatible with these settings, so if you find that you cannot see any of the examples on the left, try the <a href="u_applets.html">unsigned applet examples</a>.
+</p>
+    <p>For additional deployment notes, <a href="#appletdeploymentnotes">see 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> 
@@ -171,12 +176,23 @@ document.onclick = mclose;
             <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>
             <td>The file to open, must be on same server as the applet.</td>
           </tr>
           <tr> 
+            <td>file2</td>
+            <td>fileName</td>
+            <td>A second file to open. If one file is nucleotide and the other peptide, and at least one peptide sequence
+            is the translation of one of the nucleotide sequences, then alignments will be displayed linked in a split frame (<em>since 2.8.3</em>).</td>
+          </tr>
+          <tr> 
             <td>sequence1,<br>
               sequence2,<br>
               sequence3</td>
@@ -226,7 +242,7 @@ document.onclick = mclose;
             <td>defaultColour</td>
             <td> <em>One of: </em><br>
               Clustal, Blosum62, % Identity, Hydrophobic, Zappo, Taylor, Helix 
-              Propensity, Strand Propensity, Turn Propensity, Buried Index, Nucleotide</td>
+              Propensity, Strand Propensity, Turn Propensity, Buried Index, Nucleotide, T-Coffee Scores, RNA Helices</td>
             <td>Default is no colour.</td>
           </tr>
           <tr> 
@@ -300,7 +316,7 @@ document.onclick = mclose;
           </tr>
           <tr> 
             <td>linkLabel_1</td>
-            <td>Uniprot</td>
+            <td>EMBL-EBI Search</td>
             <td rowspan="2"><p>Right click on sequence id to see list of available 
                 links. Any new links MUST have $SEQUENCE_ID$ as part of the linkURL_n 
                 value. For multiple links, increment the label and url name by 
@@ -313,12 +329,12 @@ document.onclick = mclose;
               <br>Regex URL links are also applied to the description line (since Jalview 2.4.+).</em></p></td>
           </tr>
           <tr> 
-            <td> <p><br>
+            <td> <p>
+            <br>
                 linkUrl_1<br>
               </p></td>
             <td><p><br>
-                http://us.expasy.org/cgi-bin/<br>
-                niceprot.pl?$SEQUENCE_ID$</p>
+                http://www.ebi.ac.uk/ebisearch/<br/>search.ebi?db=allebi&query=$SEQUENCE_ID$</p>
                                                </td>
           </tr>
           <tr> 
@@ -383,11 +399,14 @@ document.onclick = mclose;
           <td>1.0 or greater</td>
           <td>Adjust the width of each cell in the alignment grid relative to the width of a character in the alignment font. (<em>since 2.5.1</em>)</td>
           </tr>
+          <tr><td>scaleProteinAsCdna</td><td>true or false (default is false)</td>
+          <td>Set true to shown protein residues the same width as their encoding codons. 
+          For use with parameter file2 when showing a split frame of cDNA and protein. (<em>since 2.8.3</em>)</td></tr>
           <tr><td>centrecolumnlabels</td>
-          <td>true of false (default is false)</td>
+          <td>true or false (default is false)</td>
           <td>When true, text labels associated with a column in the alignment will be shown centered with respect to the column. (<em>since 2.4</em>)</td>
           <tr><td>showUnconserved</td>
-          <td>true of false (default is false)</td>
+          <td>true or false (default is false)</td>
           <td>When true, only gaps and symbols different to the consensus sequence for a column will be shown. Useful for visualizing alignments exhibiting low sequence variation, where it is important to highlight mutations. (<em>since 2.5</em>)</td>
           </tr>
           <tr><td>upperCase</td>
@@ -395,29 +414,29 @@ document.onclick = mclose;
           <td>Indicate a text style to apply to uppercase sequence symbols. Currently, only <strong>bold</strong> is supported.</td>
           </tr>
           <tr><td>automaticScrolling</td>
-          <td>true of false (default is true)</td>
+          <td>true or false (default is true)</td>
           <td>When true, alignment panels will automatically scroll to show any regions of the alignment highlighted due to javascript events or when mousing over a position in an associated structure. (<em>since 2.6</em>)</td>
           </tr>
           
           <tr><td>showGroupConsensus</td>
-          <td>true of false (default is false)</td>
+          <td>true or false (default is false)</td>
           <td>When true, shows consensus annotation row for any groups on the alignment. (<em>since 2.7</em>)</td>
           </tr>
           
           <tr><td>showGroupConservation</td>
-          <td>true of false (default is false)</td>
+          <td>true or false (default is false)</td>
           <td>When true, shows amino-acid property conservation annotation row for any groups on the alignment. (<em>since 2.7</em>)</td>
           </tr>
           <tr><td>showConsensusHistogram</td>
-          <td>true of false (default is true)</td>
+          <td>true or false (default is true)</td>
           <td>When true, shows the percentage occurence of the consensus symbol for each column as a histogram above the consensus sequence row. (<em>since 2.7</em>)</td>
           </tr>
           <tr><td>showSequenceLogo</td>
-          <td>true of false (default is false)</td>
+          <td>true or false (default is false)</td>
           <td>When true, shows a sequence logo above the consensus sequence (overlaid above the Consensus Histogram, if visible, with symbols coloured using the alignment's default colourscheme). (<em>since 2.7</em>)</td>
           </tr>
           <tr><td>normaliseSequenceLogo</td>
-          <td>true of false (default is false)</td>
+          <td>true or false (default is false)</td>
           <td>When true, all sequence logos will be normalised (all symbol stacks add up to full height of annotation row), rather than being scaled according to the fraction of symbols identical to the consensus. (<em>since 2.8</em>)</td>
           </tr>
           <tr><td>oninit</td>
@@ -546,7 +565,7 @@ document.onclick = mclose;
           </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> 
+          <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>
@@ -581,11 +600,17 @@ document.onclick = mclose;
             new line in an alignment file must be entered as a parameter)</li>
         </ul>
         
-</div>
 
+<!-- content end -->
+
+
+</div> <!-- end content div -->
+
+</div> <!-- content -->
+</div> <!-- pagewrap -->
 <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:
@@ -594,7 +619,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>