JAL-1641 updated json help doc
[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-1.0</title>
24 </head>
25 <body>
26         <h1>BioJSON 1.0</h1>
27         BioJSON is a JavaScript Object Notation (JSON) specification for the representation and exchange of bioinformatics data. 
28         The first version of the specification was developed in 2015 and implemented in Jalview 2.9. Find out more about BioJSON 
29         at <a href="http://jalview.github.io/biojson/">http://jalview.github.io/biojson/</a>.
30         
31         <h2>Features supported</h2>
32         Export and import of a single alignment along with it's properties listed below:
33         <ul>
34                 <li>Alignment Annotations</li>
35                 <li>Alignment Features</li>
36                 <li>Alignment Sequences</li>
37                 <li>Color Scheme</li>
38                 <li>Hidden Columns</li>
39                 <li>Hidden Sequences</li>
40                 <li>Sequence Groups</li>
41         </ul>
42
43         <h2>Features not yet supported</h2>
44         The following features are not supported in BioJSON-1.0:
45         <ul>
46                 <li>Export and import of Reference sequence</li>
47                 <li>Export and import of Representative sequence</li>
48                 <li>Export and import of Trees</li>
49                 <li>Export and import of 3D Structures</li>
50         </ul>
51 </body>
52 </html>