style change.
[jalview.git] / help / html / features / seqfeatures.html
index 467818d..88a4d5d 100755 (executable)
@@ -1,21 +1,45 @@
 <html>\r
+<head><title>Sequence Features</title></head>\r
 <body>\r
-<p><strong>Sequence Features</strong></p>\r
-<p>This displays Uniprot sequence features on the alignment if a 100% sequence\r
-  match is found. </p>\r
-<p>The first step in this process is to match the id (name) of each sequence with\r
-  Uniprot. If there is no match, a Blast search is performed to try to obtain\r
-  the Uniprot Id for each sequence. You will be notified of any 100% matches with\r
-  Uniprot, which you must manually assign to each sequence in your input alignment,\r
-  then save the file.</p>\r
+<p><strong>View&#8594;Sequence Features</strong></p>\r
+<p>When this option is selected, sequence features extracted from the\r
+  <a href="http://www.ebi.uniprot.org/">Uniprot</a> record for each\r
+  sequence are displayed on the alignment.</p>\r
+<p>Currently, sequence features are rendered in red or blue, dependent\r
+  upon their type:</p><ul>\r
+  <li>Features associated with a particular residue are coloured\r
+  red<br><em>e.g. an active site residue</em></li>\r
+  <li>Features which span a region are coloured blue<br>\r
+<em>e.g. a region of sequence with known structure</em>\r
+</li>\r
+</ul></p>\r
+<p>More information about the feature is given in a tooltip, which are\r
+  viewed by moving the mouse pointer over a sequence feature. The\r
+  associated text for the feature will then be displayed in a small\r
+  label will appear near the pointer.</p>\r
+<p>After the Sequence Features option is selected, there may be some delay before\r
+  the features are actually rendered, as jalview must first determine if a\r
+  sequence is contained in uniprot and then retrieve its sequence\r
+  record. This delay should only happen once for a particular\r
+  alignment, as jalview caches uniprot records in a file in your home\r
+  directory called '.jalview.uniprot.xml'.\r
+\r
+<p>The first step in this process is to try to use the ID (name) of\r
+  each sequence as an ID search in Uniprot. If there is no match, The\r
+  EBI Blast search is used in an attempt to obtain the Uniprot Id for\r
+  each sequence. You will be  notified of any 100% matches with\r
+  Uniprot, but you must then manually change the name of the sequence,\r
+  by right clicking on the sequence ID and selecting\r
+  Sequence&#8594;Edit Name, before Jalview will show its sequence\r
+  features.<ul>\r
+  <li>remember to save your alignment if you have updated any of the\r
+  sequence IDs!\r
+  </li>\r
+  </ul></p>\r
 <p>\r
-  The input sequence will be matched with the returned Uniprot record, the start\r
-  and end residues can then be correctly assigned to each sequence. </p>\r
-<p>Sequence features which are 1 residue in length are coloured red. Features\r
-  which span a region are coloured blue. </p>\r
-<p>By moving the mouse pointer over a sequence feature on the alignment a small\r
-  label will appear with the description of that sequence feature.</p>\r
-<p>A local cache of retrieved uniprot entries is recorded on your local machine.\r
-</p>\r
+  If a uniprot record (or set of records) is found for a sequence,\r
+  then the sequence in aligned to the one in the Uniprot record\r
+  to determine the correct start and end residue positions that will be\r
+  displayed when the 'Show Full Sequence ID' option is set.</p>\r
 </body>\r
 </html>\r