7a3efa7d8ad8f23c84629188c51f4e89008a22e2
[jalview.git] / help / html / io / export.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>Exporting alignments as artwork</title>
24 </head>
25 <body>
26 <p><strong>Exporting alignments as graphics and lineart<a name="export"></a></strong></p>
27 <p>The alignment view can be printed using
28 <strong>File&#8594;Print</strong>, or exported in a number of ways via the
29 <strong>File&#8594;Export</strong> menu:
30 <ul>
31 <li>HTML<br><em>for viewing in a web browser</em>
32 </li>
33 <li>PNG - a Portable Networks Graphics image<br><em>For low quality
34 diagrams and powerpoint presentations</em>
35 </li>
36 <li>EPS - an Encapsulated Postscript Document<br><em>For high quality
37 diagrams and publications.</em>
38 <li>SVG - a Scalable Vector Graphics document<br><em>For high quality
39 diagrams in publications and on the web.</em>
40 </li>
41 <li>BioJS - A JavaScript based multiple sequence alignment visualiser. <br><em>For viewing in a web browser. Get more info about BioJS at <a href="http://msa.biojs.net/">http://msa.biojs.net/</a></em>
42 </li>
43
44 </ul>
45
46 <p>From Jalview 2.9, the HTML exporting system was re-implemented to use SVG rendering. Also, optional embedding of <a href="../features/bioJsonFormat.html">BioJSON</a> data to the generated HTML file was introduced. 
47 This is achieved using a hidden input or div element which MUST be named "seqData" as seen in the examples below:  
48 <pre><code>     &lt;div name="seqData" id="seqData" style="display: none;"&gt;#valid BioJSON data#&lt;/div&gt;
49           OR
50         &lt;input type="hidden" id="seqData" name="seqData" value='#valid BioJSON data#'/&gt;</pre></code>
51 HTML file embedded with BioJSON can be imported back to Jalview at a later date. During the import operation, Jalview uses an API called JSoup to traverse through the HTML file and extract the embedded BioJSON data from the target div or input element named <b>'seqData'</b>. The extracted data is then parsed as a BioJSON format. 
52
53
54   
55 <p><em>Tips for working with EPS Files</em></p>
56 <li>The EPS file generated by Jalview contains vector graphics which are directly 
57   editable in graphics applications such as Adobe Illustrator.</li>
58 <li>EPS files can be produced as &quot;Text&quot; or &quot;Lineart&quot;. Use 
59   &quot;Text&quot; if you want the final document to be MUCH smaller in diskspace 
60   and be able to search, edit and select text. Use &quot;Lineart&quot; if you 
61   want an exact image of the alignment as displayed in Jalview. This is useful 
62   if a 3rd Party EPS viewer does not have the same Font which the EPS file was 
63   created with.</li>
64 <li>When importing an EPS file into a Microsoft office document, a snapshot image of the
65   file will be displayed which often looks blurred. Right-click the
66   image and choose &quot;Edit image.&quot; to convert it to word
67   drawing objects which give a truer WYSIWIG representation.
68   </li>
69   <li>
70   Mac OSX users will find that eps files are automatically converted into
71   PDF files. 
72   </li>
73 </p>
74 </body>
75 </html>