2.3 updates
[jalview.git] / help / html / keys.html
index 1b0339c..61c55cc 100755 (executable)
 <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<br>\r
-  </li>\r
-  <li>65,82&lt;return&gt; - Quick jump to column 65, sequence 82</li>\r
-</ul>\r
+<p>\r
+Jalview has two distinct modes of keyboard operation - in 'Normal'\r
+ mode, single keystrokes (including those shown next to menu items)\r
+ provide short cuts to common commands. In <a\r
+ href="features/cursorMode.html">'Cursor'</a> mode (enabled by\r
+ <em>F2</em>), some of these are disabled and more complex 'Compound\r
+ Keystrokes' can be entered to perform precise navigation, selection\r
+ and editing operations.\r
+</p>\r
+<table border="1">\r
+  <tr> \r
+    <td><strong>Key</strong></td>\r
+    <td><strong>Which Mode</strong></td>\r
+    <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
+  <tr> \r
+    <td><strong> Escape</strong></td>\r
+    <td>Normal</td>\r
+    <td>Clears the current selection region, highlighted columns and highlghted \r
+      residues. </td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Escape</strong></td>\r
+    <td>Cursor</td>\r
+    <td>As in normal mode, but also cancels any partially entered commands</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong><em>F1</em></strong></td>\r
+    <td>Both</td>\r
+    <td>Show Help Documentation</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong><em>F2</em></strong></td>\r
+    <td></td>\r
+    <td>Toggle Cursor mode on / off</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'Z'</strong></td>\r
+    <td>Both</td>\r
+    <td>Undoes the last sequence edit</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'Y'</strong></td>\r
+    <td>Both</td>\r
+    <td>Redo the last sequence edit undone.</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Up Arrow</strong></td>\r
+    <td>Normal</td>\r
+    <td>Moves selected sequence(s) up the alignment</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Down Arrow</strong></td>\r
+    <td>Normal</td>\r
+    <td>Moves selected sequence(s) down the alignment.</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Left Arrow</strong></td>\r
+    <td>Normal </td>\r
+    <td>Slides selected sequence(s) left. Press Alt key to slide in cursor mode</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Right Arrow</strong></td>\r
+    <td>Normal</td>\r
+    <td>Slides selected sequence(s) right. Press Alt key to slide in cursor mode</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Cursor Keys<br>\r
+      (Arrow Keys)</strong></td>\r
+    <td>Cursor</td>\r
+    <td>Move cursor around alignment</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Page Up</strong></td>\r
+    <td>Both</td>\r
+    <td>Scroll up the alignment view</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Page Down</strong></td>\r
+    <td>Both</td>\r
+    <td>Scroll down the alignment view</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'A'</strong></td>\r
+    <td>Both</td>\r
+    <td>Selects all sequences in the alignment</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'I'</strong></td>\r
+    <td>Both </td>\r
+    <td>Invert sequence selection. </td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control Alt 'I'</strong></td>\r
+    <td>Both </td>\r
+    <td>Invert column selection. </td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'C'</strong></td>\r
+    <td>Both</td>\r
+    <td>Copies the selected region into the clipboard as a Fasta format file<br> \r
+      <em>nb. not available in applet, as no clipboard is available</em></td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'V'</strong></td>\r
+    <td>Both</td>\r
+    <td> Paste the contents of the clipboard to the current alignment window. \r
+      (Alignment Window->Edit->Paste->Add to this Alignment)<br> <em>nb. if the \r
+      paste is from a Jalview alignment, any sequence and alignment annotations \r
+      will also be copied over.</em></td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control Shift 'V'</strong></td>\r
+    <td>Both</td>\r
+    <td>Paste the contents of the clipboard to a new alignment window. (Alignment \r
+      Window->Edit->Paste->To New Alignment)</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'X'</strong></td>\r
+    <td>Both</td>\r
+    <td>Cuts the (fully) selected sequences from the alignment. \r
+      <!-- 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.-->\r
+    </td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'F'</strong></td>\r
+    <td>Both</td>\r
+    <td>Launches the search window</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>H</strong></td>\r
+    <td>Both</td>\r
+    <td>Hides / Reveals selected columns and sequences</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'H'</strong></td>\r
+    <td>Both</td>\r
+    <td>Hides / Reveals selected columns</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Shift 'H'</strong></td>\r
+    <td>Both</td>\r
+    <td>Hides / Reveals selected sequences</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'O'</strong></td>\r
+    <td>Both</td>\r
+    <td>Input new alignment from file</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'S'</strong></td>\r
+    <td>Both</td>\r
+    <td>Save alignment with current filename and format</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control Shift 'S'</strong></td>\r
+    <td>Both</td>\r
+    <td>Save alignment as a new file or with a different format</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'P'</strong></td>\r
+    <td>Both</td>\r
+    <td>Opens the print dialog box to print the current view</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'W'</strong></td>\r
+    <td>Both</td>\r
+    <td>Closes the current view or the current alignment</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Backspace</strong></td>\r
+    <td>Normal</td>\r
+    <td>Delete the currently selected rows or columns from the alignment.</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'L'</strong></td>\r
+    <td>Left</td>\r
+    <td>Remove columns to left of left-most column marker.</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'R'</strong></td>\r
+    <td>Both</td>\r
+    <td>Remove columns to right of right-most column marker.</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'E'</strong></td>\r
+    <td>Both</td>\r
+    <td>Remove gapped columns</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control Shift 'E'</strong></td>\r
+    <td>Both</td>\r
+    <td>Remove all gaps</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong>Control 'D'</strong></td>\r
+    <td>Both</td>\r
+    <td>Open the 'Remove redundancy' Dialog box.</td>\r
+  </tr>\r
+  <tr> \r
+    <td><strong></strong></td>\r
+    <td>Normal</td>\r
+    <td></td>\r
+  </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