JAL-1432 updated copyright notices
[jalview.git] / examples / appletParameters.html
index 427c8b7..a1af716 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 2.8.0b1)
+ * Copyright (C) 2014 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,6 +176,11 @@ 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>
@@ -300,7 +310,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 +323,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> 
@@ -546,7 +556,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,8 +591,14 @@ document.onclick = mclose;
             new line in an alignment file must be entered as a parameter)</li>
         </ul>
         
-</div>
-</div>
+
+<!-- content end -->
+
+
+</div> <!-- end content div -->
+
+</div> <!-- content -->
+</div> <!-- pagewrap -->
 <div id ="footer">
 <div id="innerFooter">
 <div id="copyright"><p>Published under <a href="http://creativecommons.org/licenses/by-sa/3.0/">CC-SA 3.0</a></p></div>
@@ -599,18 +615,5 @@ Bioinformatics 25 (9) 1189-1191 <a href="http://dx.doi.org/10.1093/bioinformatic
 </div>
 </div>
 </div>
-
-<script type="text/javascript">
-    var gaJsHost = (("https:" == document.location.protocol) ?
- "https://ssl." : "http://www.");
-    document.write(unescape("%3Cscript src=\'" + gaJsHost +
- "google-analytics.com/ga.js\' type=\'text/javascript\'%3E%3C/script%3E"));
-</script>
-<script type="text/javascript">
-try{
-    var pageTracker = _gat._getTracker("'UA-9060947-1'");
-    pageTracker._trackPageview();
-} catch(err) {}
-</script>
 </body>
 </html>