git://source.jalview.org / jalview.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
JAL-1620 version bump and release notes
[jalview.git] / help / html / features / annotationsFormat.html
diff --git a/help/html/features/annotationsFormat.html b/help/html/features/annotationsFormat.html
index fa6d3dd..59f3122 100755 (executable)
--- a/help/html/features/annotationsFormat.html
+++ b/help/html/features/annotationsFormat.html
@@ -1,21 +1,24 @@
 <html>
 <!--
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
+ * Copyright (C) 2014 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.
+ * 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/>.
--->
+ * 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>The Alignment Annotations File</title>
 </head>
@@ -132,13 +135,13 @@ GRAPHLINE&#9;<em>graph_name</em>&#9;<em>value</em>&#9;<em>label</em>&#9;<em>colo
 </ul></p>
 <h3><font face="Arial, Helvetica, sans-serif">(Since Jalview 2.2.1) SEQUENCE_GROUP</font></h3>
 <p>Groups of sequences can be defined using the tab delimited line</p>
-<pre>SEQUENCE_GROUP    Group_Name      Group_Start     Group_End       Sequences</pre>
+<pre>SEQUENCE_GROUP    Group_Name      Group_Start     Group_End       <em>Sequences</em></pre>
 <p>The sequences can be defined by alignment index and a range of sequences can 
   be defined in a comma delimited field such as</p>
 <p>2-5,8-15,20,22</p>
 <p>Enter * to select all groups. </p>
-<p>If the alignment indices are not known, enter -1 then a tab delimited list 
-  of sequence ids. </p>
+<p><strong>Note:</strong> If the alignment indices are not known, enter -1, followed by a tab and then a tab delimited list 
+specifying the sequence ids. </p>
 <p>If the SEQUENCE_REF has been defined, the group_start and group_end will be 
   relative to the sequence residue numbering, otherwise the group_start and group_end 
   will be the alignment column indices. </p>
@@ -178,6 +181,9 @@ property, then the idColour will also be used to colour the sequence.</li>
  <em>SEQUENCE_REF</em> sequence reference statement, the sequence representative
  for the group will be set to the referenced sequence.<!-- <br><strong>Note:</strong> if the <em>hide</em> 
  property is set then only the representative sequence for the group will be shown in the alignment.--></li>
+ <li>The interpretation of the COMBINE statement in <em>Version 2.8.1</em> was refined
+ so that only annotation line graphs with the given names ands the same 
+ <strong>SEQUENCE_REF</strong> and <strong>GROUP_REF</strong> scope are grouped.</li>
 </ul>
 <p> </p>
 <p>An example Annotation file is given below:
@@ -187,7 +193,7 @@ SEQUENCE_REF&#9;FER1_MESCR&#9;5
 BAR_GRAPH&#9;Bar Graph 1&#9;&lt;html&gt;an &lt;em&gt;html tooltip&lt;/em&gt; for Bar graph 1.&lt;/html&gt;&#9;||-100,-|-200,-|-300,-|-400,-|200,+|300,+|150,+
 LINE_GRAPH&#9;Green Values&#9;1.1|2.2|1.3|3.4|0.7|1.4|3.3|2.2|2.1|-1.1|3.2
 LINE_GRAPH&#9;Red Values&#9;2.1|3.2|1.3|-1.4|5.5|1.4|1.3|4.2|-1.1|1.1|3.2
-BAR_GRAPH&#9;Bar Graph&#9;2 1,.|2,*|3,:|4,.|5,*|4,:|3,.|2|1|1|2|3|4|5|4
+BAR_GRAPH&#9;Bar Graph 2&#9;1,.|2,*|3,:|4,.|5,*|4,:|3,.|2|1|1|2|3|4|5|4
 NO_GRAPH&#9;Icons &#9;||||E,Sheet1|E|E||||H,Sheet 2|H|H|H||||||
 NO_GRAPH&#9;Purple Letters&#9;m|y|p|r|o|t|e|i|n
 COLOUR&#9;Bar Graph 2&#9;blue
@@ -197,13 +203,14 @@ COLOUR&#9;Purple Letters&#9;151,52,228
 COMBINE&#9;Green Values&#9;Red Values
 GRAPHLINE&#9;Red Values&#9;2.6&#9;threshold&#9;black
 
-SEQUENCE_GROUP Group_A 30 50 *
-SEQUENCE_GROUP Group_B 1 351 2-5
-SEQUENCE_GROUP Group_C 12 14 -1 seq1   seq2    seq3
-PROPERTIES Group_A description=This is the description colour=Helix Propensity pidThreshold=0 outlineColour=red displayBoxes=true displayText=false    colourText=false textCol1=black textCol2=black textColThreshold=0
-PROPERTIES Group_B outlineColour=red
-PROPERTIES Group_C colour=Clustal
+SEQUENCE_GROUP&#9;Group_A&#9;30&#9;50&#9;*
+SEQUENCE_GROUP&#9;Group_B&#9;1&#9;351&#9;2-5
+SEQUENCE_GROUP&#9;Group_C&#9;12&#9;14&#9;-1&#9;seq1&#9;seq2&#9;seq3
+PROPERTIES&#9;Group_A&#9;description=This is the description&#9;colour=Helix Propensity&#9;pidThreshold=0&#9;outlineColour=red&#9;displayBoxes=true&#9;displayText=false&#9;colourText=false&#9;textCol1=black&#9;textCol2=black&#9;textColThreshold=0
+PROPERTIES&#9;Group_B&#9;outlineColour=red
+PROPERTIES&#9;Group_C&#9;colour=Clustal
 </pre>
 </p>
+<p><em>Last updated for version 2.8.1</em></p>
 </body>
 </html>