Merge branch 'develop' into features/JAL-2360colourSchemeApplicability
[jalview.git] / help / html / menus / alwannotationpanel.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>Annotation Panel Menus</title>
24 </head>
25 <body>
26   <p>
27     <strong>Annotation Panel Menus</strong>
28   </p>
29   <ul>
30     <li><strong>Annotation Label Popup Menu</strong><br> <em>This
31         menu is opened by clicking anywhere on the annotation row labels
32         area (below the sequence ID area).</em> <br />
33     <em><strong>Mac Users:</strong> pressing CTRL whilst clicking
34         the mouse/track pad is the same as a right-click. See your
35         system's settings to configure your track-pad's corners to
36         generate right-clicks.</em>
37       <ul>
38         <li><strong>Add New Row</strong><br> <em>Adds a
39             new, named annotation row (a dialog box will pop up for you
40             to enter the label for the new row). </em></li>
41         <li><strong>Edit Label/Description</strong><br> <em>This
42             opens a dialog where you can change the name (displayed
43             label), or the description (as shown on the label tooltip)
44             of the clicked annotation. </em></li>
45         <li><strong>Hide This Row</strong><br> <em>Hides
46             the annotation row whose label was clicked in order to bring
47             up the menu.</em></li>
48         <li><strong>Hide All <em>&lt;label&gt;</em></strong><br>
49           <em>Hides all annotation rows whose label matches the one
50             clicked. (This option is only shown for annotations that
51             relate to individual sequences, not for whole alignment
52             annotations. Since Jalview 2.8.2.)</em></li>
53         <li><strong>Delete Row</strong><br> <em>Deletes
54             the annotation row whose label was clicked in order to bring
55             up the menu.</em></li>
56         <li><strong>Show All Hidden Rows</strong><br> <em>Shows
57             all hidden annotation rows.</em></li>
58         <li><strong>Export Annotation</strong> <em>(Application
59             only)</em><br> <em>Annotations can be saved to file or
60             output to a text window in either the Jalview annotations
61             format or as a spreadsheet style set of comma separated
62             values (CSV). </em></li>
63         <li><strong>Show Values in Text Box</strong> <em>(applet
64             only)</em><br> <em>Opens a text box with a list of
65             comma-separated values corresponding to the annotation
66             (numerical or otherwise) at each position in the row. This
67             is useful to export alignment quality measurements for
68             further analysis.</em></li>
69       </ul> <em>The following additional entries are available when the
70         popup menu is opened on a consensus sequence annotation row:</em>
71       <ul>
72
73         <li><strong>Ignore Gaps in Consensus</strong><br> If
74           this checkbox is selected, all consensus calculations
75           performed in the current Alignment window will be done without
76           counting gaps as a consensus character.</li>
77         <li><strong>Show Consensus Histogram<br></strong>
78           Enable or disable the display of the histogram above the
79           consensus sequence.</li>
80         <li><strong>Show Consensus Logo<br></strong> Enable or
81           disable the display of the sequence logo above the consensus
82           sequence.</li>
83         <li><strong>Normalise Consensus Logo<br>
84         </strong><em>When enabled, scales all logo stacks to the same
85             height, making it easier to compare symbol diversity in
86             highly variable regions.</em></li>
87
88         <li>
89         <li><strong>Copy Consensus Sequence</strong><br>
90           Copies the consensus sequence to the clipboard in Fasta
91           format, to allow the consensus sequence to be added to an
92           alignment. Note the copied sequence is not accessible to other
93           programs if Jalview is running as an applet in a web page.</li>
94       </ul></li>
95     <li><strong>Annotation Popup Menu<br>
96     </strong><em>This menu is opened when right-clicking on the selected
97         positions of an annotation.</em>
98       <ul>
99         <li><strong>Helix</strong><br> <em>Mark selected
100             positions with a helix glyph (a red oval), and optional text
101             label (see below). Consecutive ovals will be rendered as an
102             unbroken red line.</em></li>
103         <li><strong>Sheet</strong><br> <em>Mark selected
104             positions with a sheet glyph (a green arrow oriented from
105             left to right), and optional text label (see below).
106             Consecutive arrows will be joined together to form a single
107             green arrow.</em></li>
108         <li><strong>Label</strong><br> <em>Sets the text
109             label at the selected positions. If more than one
110             consecutive position is marked with the same label, only the
111             first position's label will be rendered.</em></li>
112         <li><strong>Colour</strong><br> <em>Changes the
113             colour of the annotation text label.</em></li>
114         <li><strong>Remove Annotation</strong><br> <em>Blanks
115             any annotation at the selected positions on the row. Note: <strong>This
116               cannot be undone</strong>
117         </em></li>
118       </ul></li>
119   </ul>
120 </body>
121 </html>