JAL-2416 score matrix gap symbol (if any) dynamically determined
[jalview.git] / help / html / features / biojsmsa.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 <title>BioJS MSA Viewer Export</title>
23 <body>
24   <p>
25     <strong>Exporting Alignments for viewing with the BioJS MSA
26       Viewer</strong>
27   </p>
28   <p>
29     Since Jalview 2.9, HTML files can be generated from an alignment
30     within the Jalview desktop application that show the alignment in an
31     interactive viewer called 'BioJS-MSA'. These pages embed Jalview's
32     alignment data as <a href="bioJsonFormat.html">BioJSON</a>, which
33     can be imported back into Jalview, and also interpreted by the BioJS
34     MSA viewer. The BioJS MSA Viewer is a full-featured JavaScript based
35     multiple sequence alignment visualisation system created by a
36     community of biological data visualisation developers, and is
37     developed independently of Jalview.
38   </p>
39   <p>
40     To find out more about the BioJS MSA Viewer, please go to <a
41       href="http://msa.biojs.net/">http://msa.biojs.net/</a>.
42   </p>
43
44   <p>
45     <strong>Making sure your BioJS MSA export uses the latest
46       BioJS MSA Viewer</strong>
47   </p>
48   <p>In order to allow Jalview to export data with the latest
49     version of the MSA viewer, the Jalview Desktop will download
50     templates for HTML export from our public GitHub Repository.
51     Normally, this should happen without you needing to do anything, but
52     if you do encounter problems, then please get in contact via the
53     jalview-discuss mailing list, or file a bug report.</p>
54   <p>Templates are downloaded to a directory called
55     '.biojs_templates' in your user's home storage space (e.g.
56     ~/.biojs_templates).</p>
57 </body>
58 </html>