JAL-2416 score matrix gap symbol (if any) dynamically determined
[jalview.git] / help / html / features / bioJsonFormat.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *  
13  * Jalview is distributed in the hope that it will be useful, but 
14  * WITHOUT ANY WARRANTY; without even the implied warranty 
15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
16  * PURPOSE.  See the GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
20  * The Jalview Authors are detailed in the 'AUTHORS' file.
21  -->
22 <head>
23 <title>BioJSON in Jalview</title>
24 </head>
25 <body>
26   <p>
27     <strong>BioJSON support in Jalview</strong>
28   </p>
29   <p>BioJSON is a JavaScript Object Notation (JSON) specification
30     for the representation and exchange of multiple sequence alignment
31     data.</p>
32   <p>
33     Jalview 2.9 includes support for reading and writing BioJSON v1.0
34     data directly, or embedded in HTML documents. It can also generate
35     HTML pages which employ the <a href="biojsmsa.html">BioJS MSA
36       viewer</a> for interactive display of BioJSON data.
37   </p>
38   <p>
39     <strong>Finding out more about BioJSON</strong>
40   </p>
41   <p>
42     The BioJSON specification is published at <a
43       href="http://jalview.github.io/biojson/">http://jalview.github.io/biojson/</a>.
44   </p>
45   <p>
46     <em>Import of BioJSON data from HTML pages</em>
47   </p>
48   <p>When importing embedded data in an HTML document, Jalview
49     searches for a hidden (usually) input or div element named
50     "seqData":</p>
51   <pre>
52     <code>&lt;div name="seqData" id="seqData" style="display: none;"&gt;#valid BioJSON data#&lt;/div&gt;</code>
53   </pre>
54   <strong>OR</strong>
55   <pre>
56     <code>&lt;input type="hidden" id="seqData" name="seqData" value='#valid BioJSON data#'/&gt;</code>
57   </pre>
58   <p>Jalview can also import BioJSON data directly.</p>
59
60   <p>
61     <strong>Jalview's Support for BioJSON v1.0</strong>
62   </p>
63   <p>BioJSON exports of an alignment view include the following
64     additional data:</p>
65   <ul>
66     <li>Alignment Annotations</li>
67     <li>Alignment Features</li>
68     <li>Alignment Sequences</li>
69     <li>Color Scheme</li>
70     <li>Hidden Columns</li>
71     <li>Hidden Sequences</li>
72     <li>Sequence Groups</li>
73   </ul>
74   <p>The following data are NOT currently preserved on export:</p>
75   <ul>
76     <li>Alignment Reference sequences</li>
77     <li>Representative sequence groups</li>
78     <li>Trees</li>
79     <li>3D Structures</li>
80   </ul>
81 </body>
82 </html>