added annotationColouring to whats new and updated IO and cursorMode
[jalview.git] / help / html / keys.html
index 86e8415..6db5df4 100755 (executable)
@@ -2,50 +2,89 @@
 <head><title>Key Strokes</title></head>\r
 <body>\r
 <p><strong>Key Strokes</strong></p>\r
-<p>Jalview recognises the following keystrokes.</p>\r
-<p>Escape - Clears the current selection region, highlighted columns and highlghted \r
-  residues</p>\r
-<p>Control 'A' - Selects all sequences in the alignment.</p>\r
-<p>Control 'C' - Copies the selected region, in Fasta format (Not applet, as no \r
-  clipboard is available)</p>\r
-<p>Control 'V' - Pastes the selected file (Can be external to Jalview) to a new \r
-  alignment window.</p>\r
-<p>Control 'X' - Cuts the selected region from the alignment window.</p>\r
-<p>Control 'Z' - Undoes the last sequence edit. </p>\r
-<p>Control 'F' - Launches the search window. </p>\r
-<p>Up Arrow - Moves selected sequence(s) up the alignment</p>\r
-<p>Down Arrow - Moves selected sequence(s) down the alignment.</p>\r
-<p>F1 - Show Help Documentation</p>\r
-<p>F2 - Toggle Cursor mode on / off</p>\r
-<p>With Cursor mode on....</p>\r
-<ul>\r
-  <li>Cursor keys - Move cursor around the alignment.</li>\r
-</ul>\r
-<ul>\r
-  <li>Space - Insert a gap at the cursor position. <br>\r
-    To insert 12 spaces at the current cursor, type 12 before pressing Space.<br>\r
-    To group insert, hold control or shift together with space.</li>\r
-</ul>\r
-<ul>\r
-  <li>Delete - Delete a gap at the cursor position.<br>\r
-    To delete 12 spaces at the current cursor, type 12 before pressing Delete.<br>\r
-    To group delete, hold down control or shift together with Delete.</li>\r
-</ul>\r
-<ul>\r
-  <li>S - Type a number x then press 'S' to jump to sequence x.</li>\r
-</ul>\r
-<ul>\r
-  <li>C - Type a number x then press 'C' to jump to column x.</li>\r
-</ul>\r
-<ul>\r
-  <li>P - Type a number x then press 'P' to jump to position x in current sequence.</li>\r
-</ul>\r
-<ul>\r
-  <li>Q - Define the top left corner of the selection area</li>\r
-</ul>\r
-<ul>\r
-  <li>M - Define the bottom right corner of the selection area</li>\r
-</ul>\r
+<p>\r
+Jalview responds a number of key strokes, and has two distinct modes of\r
+keyboard operation. The <em>F2</em> key switches between 'Normal' and\r
+<a href="features/cursorMode.html">'Cursor'</a> mode operation.\r
+</p>\r
+<table border="1">\r
+<tr>\r
+<td><strong>Key</strong></td><td><strong>Which Mode</strong></td><td><strong>Action</strong></td>\r
+</tr>\r
+<!--<tr>\r
+<td><strong>Escape</strong></td><td>Both</td>\r
+<td>The Panic button.</td></tr>\r
+<tr> -->\r
+<td><strong>\r
+Escape</strong></td><td>Normal</td>\r
+<td>Clears the current selection region,\r
+highlighted columns and highlghted residues.\r
+</td></tr><tr>\r
+<td><strong>Escape</strong></td><td>Cursor</td>\r
+As in normal mode, but also cancels any partially entered commands</td>\r
+</tr>\r
+<tr>\r
+<td><strong><em>F1</em></strong></td><td>Both</td>Show Help Documentation</td></tr>\r
+<tr>\r
+<td><strong><em>F2</em></strong></td><td></td><td>Toggle Cursor mode on / off</td>\r
+</tr>\r
+<tr>\r
+<td><strong>Control 'Z'</strong></td><td>Both</td><td>Undoes the last sequence edit</td>\r
+</tr>\r
+<tr>\r
+<td><strong>Up Arrow</strong></td><td>Normal</td>Moves selected sequence(s) up the\r
+alignment</td></tr>\r
+<tr>\r
+<td><strong>Down Arrow</strong></td><td>Normal</td>Moves selected sequence(s) down the\r
+alignment.</td></tr>\r
+<tr><strong>Cursor Keys<br>(Arrow Keys)</strong></td><td>Cursor</td><td>Move cursor around alignment</td>\r
+</tr>\r
+<tr>\r
+<td><strong>Control 'A'</strong></td><td>Both</td><td>Selects all sequences in the alignment</td>\r
+</tr>\r
+<tr>\r
+<td><strong>Control 'C'</strong></td><td>Both</td><td>Copies the selected region into\r
+the clipboard as a Fasta format file<br><em>nb. not available in applet, as no clipboard is available</em></td>\r
+</tr>\r
+<tr><td><strong>Control 'V'</strong></td><td>Both</td>Pastes the contents of the clipboard\r
+to a new \r
+  alignment window. (same as the Alignment Window menu Edit->Paste\r
+  command)<br><em>nb. if the paste is from a Jalview alignment, any\r
+  sequence and alignment annotations will also be copied over.</em></td>\r
+</tr>\r
+<tr>\r
+<td><strong>Control 'X'</strong></td><td>Both</td><td>Cuts the (fully) selected\r
+sequences from the alignment.<!-- not yet in this version \r
+This will not happen if only some\r
+columns are selected, you should use the <a href="features/regionHiding.html">Hide Regions feature</a> instead.--></td>\r
+</tr>\r
+<tr>\r
+<td><strong>Control 'F'</strong></td><td>Both</td><td>Launches the search\r
+window</td></tr>\r
+</table>\r
+<p>The compound commands available in the Cursor mode are summarised\r
+below. Single letter commands can be prefixed by digits to specify a repetition\r
+number, and some more complex commands take one or more numeric\r
+parameters (prefixing the command key and separated by commas).</p>\r
+<table border=1><tr><td><strong>Compound\r
+Command</strong></td><td>Mode</td><td>Action (and parameter description)</td></tr>\r
+<tr><td><strong>0-9</strong></td><td>Cursor</td><td>Begin entering a\r
+numeric parameter (<strong><em>p</em></strong>) or repetition number for a cursor movement or edit\r
+command.</td></tr>\r
+<tr><td><strong>,</strong></td><td>Cursor</td><td>Separates one or\r
+more numeric parameters (<em>e.g. <strong>p1</strong>,<strong>p2</strong></em>) for a command.</td></tr>\r
+<tr><td><strong><strong><em>p1</em></strong>,<strong><em>p2</em></strong><br>Return</strong></td><td>Cursor</td><td>Move cursor to a particular column (<strong><em>p1</em></strong>) and row (<strong><em>p2</em></strong>) in the alignment.<br><em>e.g. '5,6&lt;Return&gt;' moves the cursor to the 5th column in the 6th sequence.</em></td></tr>\r
+<tr><td><strong><em>p</em>S</strong></td><td>Cursor</td><td>Jump to the <strong><em>p</em></strong>'th sequence in the alignment.</td></tr>\r
+<tr><td><strong><em>p</em>P</strong></td><td>Cursor</td><td>Jump to <em><strong>p</strong></em>'th amino acid in current sequence.</td></tr>\r
+<tr><td><strong><em>p</em>C</strong></td><td>Cursor</td><td>Jump to <em><strong>p</strong></em>'th column in the alignment.</td></tr>\r
+<tr><td><strong>Q</strong></td><td>Cursor</td><td>Marks the top left corner of the selection area</td></tr>\r
+<tr><td><strong>M</strong></td><td>Cursor</td><td>Marks the bottom right corner of the selection area</td></tr>\r
+<tr><td><strong><em>[p]</em><br>Space</strong></td><td>Cursor</td><td>Inserts\r
+one (or optionally <strong><em>p</em></strong>) gaps at the current position.<br><em>Hold down Control or Shift to insert gaps over a sequence group</em></td></tr>\r
+<tr><td><strong><em>[p]</em><br>Delete<br></strong></td><td>Cursor</td><td>Removes\r
+one (or optionally <strong><em>p</em></strong>) gaps at the cursor position.<br><em>Hold down Control or Shift to insert gaps over a sequence group</em></td></tr>\r
+<tr><td><strong><em>[p]</em><br>Backspace<br></strong></td><td>Cursor</td><td>Removes\r
+one (or optionally <strong><em>p</em></strong>) gaps at the cursor position.<br><em>Hold down Control or Shift to insert gaps over a sequence group</em></td></tr></table>\r
 <p>&nbsp;</p>\r
 <p>&nbsp;</p>\r
 </body>\r