2.5.1 release branding
[jalview.git] / help / html / menus / alwannotations.html
1 #-------------------------------------------------------------------------------
2 # Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)
3 # Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
4
5 # This file is part of Jalview.
6
7 # Jalview is free software: you can redistribute it and/or
8 # modify it under the terms of the GNU General Public License 
9 # as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
10
11 # Jalview is distributed in the hope that it will be useful, but 
12 # WITHOUT ANY WARRANTY; without even the implied warranty 
13 # of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14 # PURPOSE.  See the GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17 #-------------------------------------------------------------------------------
18 <html>
19 <!--
20  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
21  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
22  * 
23  * This file is part of Jalview.
24  * 
25  * Jalview is free software: you can redistribute it and/or
26  * modify it under the terms of the GNU General Public License 
27  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
28  * 
29  * Jalview is distributed in the hope that it will be useful, but 
30  * WITHOUT ANY WARRANTY; without even the implied warranty 
31  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
32  * PURPOSE.  See the GNU General Public License for more details.
33  * 
34  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
35 -->
36 <head>
37 <title>Annotation Panel Menus</title>
38 </head>
39 <body>
40 <p><strong>Annotation Panel Menus</strong></p>
41 <ul>
42   <li> <strong>Annotation Label Popup Menu</strong><br>
43     <em>This menu is opened by clicking anywhere on the annotation row labels 
44     area (below the sequence ID area).</em> 
45     <ul>
46       <li><strong> Add New Row</strong><br>
47         <em>Adds a new, named annotation row (a dialog box will pop up for you 
48         to enter the label for the new row). </em> </li>
49       <li><strong>Hide Row</strong><br>
50         <em>Hides the annotation row whose label was clicked in order to bring 
51         up the menu.</em> </li>
52       <li><strong>Delete Row</strong><br>
53         <em>Deletes the annotation row whose label was clicked in order to bring 
54         up the menu.</em> </li>
55       <li><strong>Show All Hidden Rows</strong><br>
56         <em>Shows all hidden annotation rows.</em> </li>
57       <li><strong>Export Annotation</strong> <em>(Application only)</em><br>
58        <em>Annotations can be saved to file or output to a text window in either the 
59         Jalview annotations format or as a spreadsheet style set of comma separated values (CSV). </em> </li>
60       <li><strong>Show Values in Text Box</strong> <em>(applet only)</em><br>
61         <em>Opens a text box with a list of comma-separated values corresponding 
62         to the annotation (numerical or otherwise) at each position in the row. 
63         This is useful to export alignment quality measurements for further analysis.</em> 
64       </li>
65    </ul>
66    <em>The following additional entries are avalable when the popup menu is opened on a consensus sequence annotation row:</em> 
67    <ul>
68       <li><strong>Ignore Gaps in Consensus</strong><br>
69         If this checkbox is selected, all consensus calculations performed in 
70         the current Alignment window will be done without counting gaps as a consensus 
71         character.</li>
72       <li><strong>Copy Consensus Sequence</strong><br>
73         Copies the consensus sequence to the clipboard in Fasta format, to allow 
74         the consensus sequence to be added to an alignment. Note the copied sequence 
75         is not accessible to other programs if Jalview is running as an applet 
76         in a web page.</li>
77     </ul>
78   </li>
79   <li><strong>Annotation Popup Menu<br>
80     </strong><em>This menu is opened when right-clicking on the selected positions 
81     of an annotation.</em> 
82     <ul>
83       <li><strong>Helix</strong><br>
84         <em>Mark selected positions with a helix glyph (a red oval), and optional 
85         text label (see below). Consecutive ovals will be rendered as an unbroken 
86         red line.</em> </li>
87       <li><strong>Sheet</strong><br>
88         <em>Mark selected positions with a sheet glyph (a green arrow oriented 
89         from left to right), and optional text label (see below). Consecutive 
90         arrows will be joined together to form a single green arrow.</em> </li>
91       <li><strong>Label</strong><br>
92         <em>Sets the text label at the selected positions. If more that one consecutive 
93         position is marked with the same label, only the first position's label 
94         will be rendered.</em> </li>
95       <li><strong>Colour</strong><br>
96         <em>Changes the colour of the annotation text label.</em> </li>
97       <li><strong>Remove Annotation</strong><br>
98         <em>Blanks any annotation at the selected positions on the row. Note: 
99         <strong>This cannot be undone</strong></em> </li>
100     </ul>
101   </li>
102 </ul>
103 </body>
104 </html>