updated help to include BioJS option in export.html
authortcofoegbu <tcnofoegbu@dundee.ac.uk>
Tue, 8 Sep 2015 13:40:38 +0000 (14:40 +0100)
committertcofoegbu <tcnofoegbu@dundee.ac.uk>
Tue, 8 Sep 2015 13:40:38 +0000 (14:40 +0100)
help/html/io/export.html
help/html/io/fileformats.html

index a7a5a1a..7a3efa7 100755 (executable)
@@ -37,7 +37,20 @@ diagrams and powerpoint presentations</em>
 diagrams and publications.</em>
 <li>SVG - a Scalable Vector Graphics document<br><em>For high quality
 diagrams in publications and on the web.</em>
-</li></ul>
+</li>
+<li>BioJS - A JavaScript based multiple sequence alignment visualiser. <br><em>For viewing in a web browser. Get more info about BioJS at <a href="http://msa.biojs.net/">http://msa.biojs.net/</a></em>
+</li>
+
+</ul>
+
+<p>From Jalview 2.9, the HTML exporting system was re-implemented to use SVG rendering. Also, optional embedding of <a href="../features/bioJsonFormat.html">BioJSON</a> data to the generated HTML file was introduced. 
+This is achieved using a hidden input or div element which MUST be named "seqData" as seen in the examples below:  
+<pre><code>    &lt;div name="seqData" id="seqData" style="display: none;"&gt;#valid BioJSON data#&lt;/div&gt;
+         OR
+       &lt;input type="hidden" id="seqData" name="seqData" value='#valid BioJSON data#'/&gt;</pre></code>
+HTML file embedded with BioJSON can be imported back to Jalview at a later date. During the import operation, Jalview uses an API called JSoup to traverse through the HTML file and extract the embedded BioJSON data from the target div or input element named <b>'seqData'</b>. The extracted data is then parsed as a BioJSON format. 
+
+
   
 <p><em>Tips for working with EPS Files</em></p>
 <li>The EPS file generated by Jalview contains vector graphics which are directly 
index 16e9cc6..f1cf5dc 100755 (executable)
@@ -79,9 +79,10 @@ THISISASEQUENCE<br></td>
 </tr>
 <tr>
 <td width="17%">JSON</td>
-<td width="60%">Data starts with '{' <br>Data  ends with '}' <br><br>See <a href="../features/bioJsonFormat.html">BioJson</a> for more info about Jalview JSON format <br></td>
+<td width="60%">Data starts with '{' <br>Data  ends with '}' <br><br>See <a href="../features/bioJsonFormat.html">BioJSON</a> for more infomation about the Jalview JSON format <br></td>
 <td width="23%">.json</td>
 </tr>
+
 </table>
 <p>The file extensions are used to associate Jalview alignment icons
 with alignment files: <img src="file.png" width=12 height=12 >