Merge branch 'develop' into features/JAL-1705_ensembl
[jalview.git] / help / html / calculations / referenceseq.html
diff --git a/help/html/calculations/referenceseq.html b/help/html/calculations/referenceseq.html
new file mode 100644 (file)
index 0000000..03d24a5
--- /dev/null
@@ -0,0 +1,50 @@
+<html>
+<!--
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ -->
+<head>
+<title>Reference Sequences</title>
+</head>
+<body>
+  <p>
+    <strong>Reference Sequence Alignment Views</strong>
+  </p>
+  <p>
+    The reference sequence for an alignment is indicated by its ID being
+    shown in bold. When a reference sequence has been defined, the <strong>Format&#8594;Show
+      unconserved</strong> option highlights mutations with respect to the
+    reference sequence, rather than the alignment's consensus sequence.
+  </p>
+  <p>
+  <ul>
+    <li>Jalview automatically assigns a reference sequence when <a
+      href="../webServices/jnet.html"
+    >JPred4</a> predictions are imported.
+    </li>
+    <li><strong>Assigning a reference sequence</strong><br /> A
+      sequence can be marked as the reference sequence by right-clicking
+      on it's ID to open the popup menu, and selecting the "<strong>(Sequence
+        ID)&#8594;Mark as Reference</strong>" entry."</li>
+  </ul>
+  <p>
+    <em>Reference sequence based alignment visualisation was
+      introduced in Jalview 2.9.</em>
+  </p>
+</html>