Advice on proxy servers
[jalview.git] / help / html / features / seqfeatures.html
index 160c1e2..6264724 100755 (executable)
@@ -1,22 +1,58 @@
 <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 is\r
+  viewed by moving the mouse pointer over a sequence feature. The\r
+  description associated with the feature will then be displayed in a small\r
+  label 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 first determines if\r
+  the sequences are contained in Uniprot and then retrieves any sequence\r
+  records. This delay will normally only happen once for a particular\r
+  set of sequences, as jalview caches uniprot records in a file in your home\r
+  directory called '.jalview.uniprot.xml'.\r
+\r
+  <p><strong>The Sequence Identification Process</strong>\r
+\r
+  </p>\r
+<p>The first step in the procedure for matching uniprot IDs to\r
+  sequences is to use the ID (name) of\r
+  each sequence to retrieve Uniprot records directly.</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
+  If a uniprot record (or set of records) is found for a sequence,\r
+  then the sequence is aligned to the one in the Uniprot record\r
+  to determine the correct start and end residue positions (which are\r
+  displayed when the 'Show Full Sequence ID' option is set).\r
 </p>\r
+\r
+<p>If the alignment reveals differences between the sequence in the\r
+  alignment and the one in the record, then Jalview will assume that\r
+  the aligned sequence is not the one in the uniprot record.\r
+\r
+  </p>\r
+\r
+  <p> \r
+  In some cases, the ID used to retrieve Uniprot records may be out of\r
+  date and you will be notified of that a 100% match between the\r
+  sequence and a Uniprot record was identified, but the sequence name\r
+  must be manually changed (by right clicking on the sequence ID and selecting\r
+  <strong>Sequence&#8594;Edit Name</strong>), 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
 </body>\r
 </html>\r