JAL-1788 added help documentation for biojson
[jalview.git] / help / html / features / bioJsonFormat.html
diff --git a/help/html/features/bioJsonFormat.html b/help/html/features/bioJsonFormat.html
new file mode 100644 (file)
index 0000000..341e3e2
--- /dev/null
@@ -0,0 +1,52 @@
+<html>
+<!--
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ -->
+<head>
+<title>BioJson-1.0 A JSON File Format</title>
+</head>
+<body>
+       <h1>BioJson (version-1.0)</h1>
+       BioJson is a standardise JavaScript Object Notation (JSON) format for exchange of Bio-informatics Sequence Alignment data.      
+       BioJSon-1.0 schema/documentation is available <a href="http://www.jalview.org/builds/develop/examples/biojson-doc/">here</a>.
+       You can keep up to date with BioJson development and latest news <a href="https://github.com/jalview/biojson/wiki">here</a>.
+       
+       <h2>Features supported</h2>
+       Export/Import of the following alignment elements are supported in BioJson-1.0:
+       <ul>
+               <li>Alignment Sequences</li>
+               <li>Alignment Features</li>
+               <li>Alignment Annotations</li>
+               <li>Sequence Groups</li>
+               <li>Color Scheme</li>
+               <li>Hidden Sequences</li>
+               <li>Hidden Columns</li>
+       </ul>
+
+       <h2>Features not yet supported</h2>
+       Export/Import of the following alignment elements are not supported in BioJson-1.0:
+       <ul>
+               <li>Reference sequence</li>
+               <li>Representative sequence</li>
+               <li>Trees</li>
+               <li>3D Structures</li>
+       </ul>
+</body>
+</html>