JAL-1788 added help documentation for biojson
[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 A JSON File Format</title>
24 </head>
25 <body>
26         <h1>BioJson (version-1.0)</h1>
27         BioJson is a standardise JavaScript Object Notation (JSON) format for exchange of Bio-informatics Sequence Alignment data.      
28         BioJSon-1.0 schema/documentation is available <a href="http://www.jalview.org/builds/develop/examples/biojson-doc/">here</a>.
29         You can keep up to date with BioJson development and latest news <a href="https://github.com/jalview/biojson/wiki">here</a>.
30         
31         <h2>Features supported</h2>
32         Export/Import of the following alignment elements are supported in BioJson-1.0:
33         <ul>
34                 <li>Alignment Sequences</li>
35                 <li>Alignment Features</li>
36                 <li>Alignment Annotations</li>
37                 <li>Sequence Groups</li>
38                 <li>Color Scheme</li>
39                 <li>Hidden Sequences</li>
40                 <li>Hidden Columns</li>
41         </ul>
42
43         <h2>Features not yet supported</h2>
44         Export/Import of the following alignment elements are not supported in BioJson-1.0:
45         <ul>
46                 <li>Reference sequence</li>
47                 <li>Representative sequence</li>
48                 <li>Trees</li>
49                 <li>3D Structures</li>
50         </ul>
51 </body>
52 </html>