JAL-1645 documentation tweaks
[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 Jalviwe</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>Jalview 2.9 includes support for reading and writing BioJSON
33     v1.0 data directly, or embedded in HTML documents. It can also
34     generate HTML pages which employ the <a href="biojsmsa.html">BioJS MSA viewer</a> for
35     interactive display of BioJSON data.</p>
36   <p>
37     <strong>Finding out more about BioJSON</strong>
38   </p>
39   <p>
40     The BioJSON specification is published at <a
41       href="http://jalview.github.io/biojson/">http://jalview.github.io/biojson/</a>.
42   </p>
43   <p>
44     <strong>Jalview's Support for BioJSON v1.0</strong>
45   </p>
46   <p>BioJSON exports of an alignment view include
47     the following additional data:</p>
48   <ul>
49     <li>Alignment Annotations</li>
50     <li>Alignment Features</li>
51     <li>Alignment Sequences</li>
52     <li>Color Scheme</li>
53     <li>Hidden Columns</li>
54     <li>Hidden Sequences</li>
55     <li>Sequence Groups</li>
56   </ul>
57   <p>The following data are NOT currently preserved on export:</p>
58   <ul>
59     <li>Alignment Reference sequences</li>
60     <li>Representative sequence groups</li>
61     <li>Trees</li>
62     <li>3D Structures</li>
63   </ul>
64 </body>
65 </html>