extended preamble and added new heading for user defined annotation
[jalview.git] / help / html / features / annotation.html
1 <html>\r
2 <head><title>Alignment Annotation</title></head>\r
3 <body>\r
4 <p><strong>Alignment Annotation</strong></p>\r
5 \r
6 <p>In addition to the definition of groups and sequence features,\r
7   Jalview can display symbols and graphs under the columns of an\r
8   alignment, and allow you to mark particular columns of an alignment and add symbols and text \r
9   in the annotation area shown below the alignment (which may be hidden if <strong>View&#8594;Show \r
10   Annotation</strong> is not ticked). </p>\r
11 <p>Web services can also add annotation to an alignment (see the\r
12   <a href="../webServices/jnet.html">JNet web service</a>), and as of Jalview 2.08 quantitative and symbolic\r
13   annotations can be added to an alignment via an <a href="annotationsFormat.html">Annotations \r
14   File</a> dragged into the alignment window or loaded from the\r
15   alignment's file menu.</p>\r
16 <p><strong>Interactive Alignment Annotation</strong></p>\r
17 <p>\r
18 Annotation rows are added using the <strong>Annotation Label</strong>\r
19 menu, which is obtained by clicking anywhere on the annotation row labels\r
20 area (below the sequence ID area).\r
21 </p>\r
22 <ul>\r
23   <li>Add New Row<br>\r
24     <em>Adds a new, named annotation row (a dialog box will pop up for you to \r
25     enter the label for the new row). </em> </li>\r
26   <li>Hide Row<br>\r
27     <em>Hides the annotation row whose label was clicked in order to bring up \r
28     the menu.</em> </li>\r
29   <li>Delete Row<br>\r
30     <em>Deletes the annotation row whose label was clicked in order to bring up \r
31     the menu.</em> </li>\r
32   <li>Show All Hidden Rows<br>\r
33     <em>Shows all hidden annotation rows.</em> </li>\r
34   <li>Show Values in Text Box<br>\r
35     <em>Opens a text box with a list of comma-separated values corresponding to \r
36     the annotation (numerical or otherwise) at each position in the row. This \r
37     is useful to export alignment quality measurements for further analysis.</em> \r
38   </li>\r
39 </ul>\r
40 <p>\r
41 <strong>Editing Label and secondary structure Annotation</strong></p>\r
42 <p>\r
43 Use the <strong>left mouse button</strong> to select a position along the row that are to\r
44 be annotated - these regions will be coloured red. <strong>Control</strong> and <strong>shift</strong> in combination\r
45 with the left-click will select more than one position, or a range of\r
46 positions on the alignment.\r
47 </p>\r
48 <p>Once the desired position has been selected, use the <strong>right mouse\r
49 button</strong> to open the <strong>annotation menu</strong>:</p>\r
50 <ul>\r
51 <li>Helix<br><em>Mark selected positions with a helix glyph (a red\r
52 oval), and optional text label (see below). A\r
53 dialog box will open for you to enter the text. Consecutive ovals\r
54 will be rendered as an unbroken red line.</em>\r
55 </li>\r
56 <li>Sheet<br><em>Mark selected positions with a sheet glyph (a green\r
57 arrow oriented from left to right), and optional text label (see\r
58 below). A dialog box will open for you to enter the text. Consecutive\r
59 arrows will be joined together to form a single green arrow.</em>\r
60 </li>\r
61 <li>Label<br><em>Set the text label at the selected positions. A\r
62 dialog box will open for you to enter the text.  If\r
63 more that one consecutive position is marked with the same label, only\r
64 the first position's label will be rendered.</em>\r
65 </li>\r
66 <li>Colour<br><em>Changes the colour of the annotation text label.</em>\r
67 </li>\r
68 <li>Remove Annotation<br><em>Blanks any annotation at the selected positions on\r
69 the row. Note: <strong>This cannot be undone</strong></em>\r
70 </li>\r
71 </ul>\r
72 <p>\r
73 User defined annotation is stored and retrieved using <a\r
74 href="../features/jalarchive.html">Jalview Archives</a>.\r
75 </p>\r
76 <p><em>Current Limitations</em></p>\r
77 \r
78 <p>In the current version of Jalview, reordering of the annotation\r
79 rows is not possible. If you save \r
80 your annotation as a Jalview file, however, it will be reloaded with user \r
81 annotations at the top (nearest the alignment), above any of the\r
82 automatically generated Conservation, Quality or consensus\r
83 annotations.</p>\r
84 </body>\r
85 </html>\r