git://source.jalview.org / jalview.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Merge branch 'releases/Release_2_10_0_Branch'
[jalview.git] / help / html / features / bioJsonFormat.html
diff --git a/help/html/features/bioJsonFormat.html b/help/html/features/bioJsonFormat.html
index 09e4197..ff24bf2 100644 (file)
--- a/help/html/features/bioJsonFormat.html
+++ b/help/html/features/bioJsonFormat.html
@@ -1,7 +1,7 @@
 <html>
 <!--
- * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
- * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2)
+ * Copyright (C) 2015 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -20,7 +20,7 @@
  * The Jalview Authors are detailed in the 'AUTHORS' file.
  -->
 <head>
-<title>BioJSON in Jalviwe</title>
+<title>BioJSON in Jalview</title>
 </head>
 <body>
   <p>
@@ -29,10 +29,12 @@
   <p>BioJSON is a JavaScript Object Notation (JSON) specification
     for the representation and exchange of multiple sequence alignment
     data.</p>
-  <p>Jalview 2.9 includes support for reading and writing BioJSON
-    v1.0 data directly, or embedded in HTML documents. It can also
-    generate HTML pages which employ the BioJS MSA viewer for
-    interactive display of BioJSON data.</p>
+  <p>
+    Jalview 2.9 includes support for reading and writing BioJSON v1.0
+    data directly, or embedded in HTML documents. It can also generate
+    HTML pages which employ the <a href="biojsmsa.html">BioJS MSA
+      viewer</a> for interactive display of BioJSON data.
+  </p>
   <p>
     <strong>Finding out more about BioJSON</strong>
   </p>
@@ -41,10 +43,25 @@
       href="http://jalview.github.io/biojson/">http://jalview.github.io/biojson/</a>.
   </p>
   <p>
+    <em>Import of BioJSON data from HTML pages</em>
+  </p>
+  <p>When importing embedded data in an HTML document, Jalview
+    searches for a hidden (usually) input or div element named
+    "seqData":</p>
+  <pre>
+    <code>&lt;div name="seqData" id="seqData" style="display: none;"&gt;#valid BioJSON data#&lt;/div&gt;</code>
+  </pre>
+  <strong>OR</strong>
+  <pre>
+    <code>&lt;input type="hidden" id="seqData" name="seqData" value='#valid BioJSON data#'/&gt;</code>
+  </pre>
+  <p>Jalview can also import BioJSON data directly.</p>
+
+  <p>
     <strong>Jalview's Support for BioJSON v1.0</strong>
   </p>
-  <p>It is currently possible to export an alignment view along with
-    the following additional data:</p>
+  <p>BioJSON exports of an alignment view include the following
+    additional data:</p>
   <ul>
     <li>Alignment Annotations</li>
     <li>Alignment Features</li>
@@ -54,10 +71,7 @@
     <li>Hidden Sequences</li>
     <li>Sequence Groups</li>
   </ul>
-  <p>
-    <strong>Jalview data not supported in BioJSON v1.0</strong>
-  </p>
-  <p>The following data are not currently preserved on export:</p>
+  <p>The following data are NOT currently preserved on export:</p>
   <ul>
     <li>Alignment Reference sequences</li>
     <li>Representative sequence groups</li>