2.5.1 release branding
[jalview.git] / help / html / keys.html
1 #-------------------------------------------------------------------------------
2 # Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)
3 # Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
4
5 # This file is part of Jalview.
6
7 # Jalview is free software: you can redistribute it and/or
8 # modify it under the terms of the GNU General Public License 
9 # as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
10
11 # Jalview is distributed in the hope that it will be useful, but 
12 # WITHOUT ANY WARRANTY; without even the implied warranty 
13 # of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14 # PURPOSE.  See the GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17 #-------------------------------------------------------------------------------
18 <html>
19 <!--
20  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
21  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
22  * 
23  * This file is part of Jalview.
24  * 
25  * Jalview is free software: you can redistribute it and/or
26  * modify it under the terms of the GNU General Public License 
27  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
28  * 
29  * Jalview is distributed in the hope that it will be useful, but 
30  * WITHOUT ANY WARRANTY; without even the implied warranty 
31  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
32  * PURPOSE.  See the GNU General Public License for more details.
33  * 
34  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
35 -->
36 <head><title>Key Strokes</title></head>
37 <body>
38 <p><strong>Key Strokes</strong></p>
39 <p>
40 Jalview has two distinct modes of keyboard operation - in 'Normal'
41  mode, single keystrokes (including those shown next to menu items)
42  provide short cuts to common commands. In <a
43  href="features/cursorMode.html">'Cursor'</a> mode (enabled by
44  <em>F2</em>), some of these are disabled and more complex 'Compound
45  Keystrokes' can be entered to perform precise navigation, selection
46  and editing operations.
47 </p>
48 <table border="1">
49   <tr> 
50     <td><strong>Key</strong></td>
51     <td><strong>Which Mode</strong></td>
52     <td><strong>Action</strong></td>
53   </tr>
54   <!--<tr>
55 <td><strong>Escape</strong></td><td>Both</td>
56 <td>The Panic button.</td></tr>
57 <tr> -->
58   <tr> 
59     <td><strong> Escape</strong></td>
60     <td>Normal</td>
61     <td>Clears the current selection region, highlighted columns and highlghted 
62       residues. </td>
63   </tr>
64   <tr> 
65     <td><strong>Escape</strong></td>
66     <td>Cursor</td>
67     <td>As in normal mode, but also cancels any partially entered commands</td>
68   </tr>
69   <tr> 
70     <td><strong><em>F1</em></strong></td>
71     <td>Both</td>
72     <td>Show Help Documentation</td>
73   </tr>
74   <tr> 
75     <td><strong><em>F2</em></strong></td>
76     <td></td>
77     <td>Toggle Cursor mode on / off</td>
78   </tr>
79   <tr> 
80     <td><strong>Control 'Z'</strong></td>
81     <td>Both</td>
82     <td>Undoes the last sequence edit</td>
83   </tr>
84   <tr> 
85     <td><strong>Control 'Y'</strong></td>
86     <td>Both</td>
87     <td>Redo the last sequence edit undone.</td>
88   </tr>
89   <tr> 
90     <td><strong>Up Arrow</strong></td>
91     <td>Normal</td>
92     <td>Moves selected sequence(s) up the alignment</td>
93   </tr>
94   <tr> 
95     <td><strong>Down Arrow</strong></td>
96     <td>Normal</td>
97     <td>Moves selected sequence(s) down the alignment.</td>
98   </tr>
99   <tr> 
100     <td><strong>Left Arrow</strong></td>
101     <td>Normal </td>
102     <td>Slides selected sequence(s) left. Press Alt key to slide in cursor mode</td>
103   </tr>
104   <tr> 
105     <td><strong>Right Arrow</strong></td>
106     <td>Normal</td>
107     <td>Slides selected sequence(s) right. Press Alt key to slide in cursor mode</td>
108   </tr>
109   <tr> 
110     <td><strong>Cursor Keys<br>
111       (Arrow Keys)</strong></td>
112     <td>Cursor</td>
113     <td>Move cursor around alignment</td>
114   </tr>
115   <tr> 
116     <td><strong>Page Up</strong></td>
117     <td>Both</td>
118     <td>Scroll up the alignment view</td>
119   </tr>
120   <tr> 
121     <td><strong>Page Down</strong></td>
122     <td>Both</td>
123     <td>Scroll down the alignment view</td>
124   </tr>
125   <tr> 
126     <td><strong>Control 'A'</strong></td>
127     <td>Both</td>
128     <td>Selects all sequences in the alignment</td>
129   </tr>
130   <tr> 
131     <td><strong>Control 'I'</strong></td>
132     <td>Both </td>
133     <td>Invert sequence selection. </td>
134   </tr>
135   <tr> 
136     <td><strong>Control Alt 'I'</strong></td>
137     <td>Both </td>
138     <td>Invert column selection. </td>
139   </tr>
140   <tr> 
141     <td><strong>Control 'C'</strong></td>
142     <td>Both</td>
143     <td>Copies the selected region into the clipboard as a Fasta format file<br> 
144       <em>nb. not available in applet, as no clipboard is available</em></td>
145   </tr>
146   <tr> 
147     <td><strong>Control 'V'</strong></td>
148     <td>Both</td>
149     <td> Paste the contents of the clipboard to the current alignment window. 
150       (Alignment Window->Edit->Paste->Add to this Alignment)<br> <em>nb. if the 
151       paste is from a Jalview alignment, any sequence and alignment annotations 
152       will also be copied over.</em></td>
153   </tr>
154   <tr> 
155     <td><strong>Control Shift 'V'</strong></td>
156     <td>Both</td>
157     <td>Paste the contents of the clipboard to a new alignment window. (Alignment 
158       Window->Edit->Paste->To New Alignment)</td>
159   </tr>
160   <tr> 
161     <td><strong>Control 'X'</strong></td>
162     <td>Both</td>
163     <td>Cuts the (fully) selected sequences from the alignment. 
164       <!-- not yet in this version 
165 This will not happen if only some
166 columns are selected, you should use the <a href="features/regionHiding.html">Hide Regions feature</a> instead.-->
167     </td>
168   </tr>
169   <tr> 
170     <td><strong>Control 'F'</strong></td>
171     <td>Both</td>
172     <td>Launches the search window</td>
173   </tr>
174   <tr> 
175     <td><strong>H</strong></td>
176     <td>Both</td>
177     <td>Hides / Reveals selected columns and sequences</td>
178   </tr>
179   <tr> 
180     <td><strong>Control 'H'</strong></td>
181     <td>Both</td>
182     <td>Hides / Reveals selected columns</td>
183   </tr>
184   <tr> 
185     <td><strong>Shift 'H'</strong></td>
186     <td>Both</td>
187     <td>Hides / Reveals selected sequences</td>
188   </tr>
189   <tr>
190     <td><strong>Control + Shift 'H'</strong></td>
191     <td>Both</td>
192     <td>Hides everything but the current selection</td>
193   </tr>
194   <tr> 
195     <td><strong>Control 'O'</strong></td>
196     <td>Both</td>
197     <td>Input new alignment from file</td>
198   </tr>
199   <tr> 
200     <td><strong>Control 'S'</strong></td>
201     <td>Both</td>
202     <td>Save alignment with current filename and format</td>
203   </tr>
204   <tr> 
205     <td><strong>Control Shift 'S'</strong></td>
206     <td>Both</td>
207     <td>Save alignment as a new file or with a different format</td>
208   </tr>
209   <tr> 
210     <td><strong>Control 'P'</strong></td>
211     <td>Both</td>
212     <td>Opens the print dialog box to print the current view</td>
213   </tr>
214   <tr> 
215     <td><strong>Control 'W'</strong></td>
216     <td>Both</td>
217     <td>Closes the current view or the current alignment</td>
218   </tr>
219   <tr> 
220     <td><strong>Backspace</strong></td>
221     <td>Normal</td>
222     <td>Delete the currently selected rows or columns from the alignment.</td>
223   </tr>
224   <tr> 
225     <td><strong>Control 'L'</strong></td>
226     <td>Left</td>
227     <td>Remove columns to left of left-most column marker.</td>
228   </tr>
229   <tr> 
230     <td><strong>Control 'R'</strong></td>
231     <td>Both</td>
232     <td>Remove columns to right of right-most column marker.</td>
233   </tr>
234   <tr> 
235     <td><strong>Control 'E'</strong></td>
236     <td>Both</td>
237     <td>Remove gapped columns</td>
238   </tr>
239   <tr> 
240     <td><strong>Control Shift 'E'</strong></td>
241     <td>Both</td>
242     <td>Remove all gaps</td>
243   </tr>
244   <tr> 
245     <td><strong>Control 'D'</strong></td>
246     <td>Both</td>
247     <td>Open the 'Remove redundancy' Dialog box.</td>
248   </tr>
249   <tr> 
250     <td><strong></strong></td>
251     <td>Normal</td>
252     <td></td>
253   </tr>
254 </table>
255 <p>The compound commands available in the Cursor mode are summarised
256 below. Single letter commands can be prefixed by digits to specify a repetition
257 number, and some more complex commands take one or more numeric
258 parameters (prefixing the command key and separated by commas).</p>
259 <table border=1><tr><td><strong>Compound
260 Command</strong></td><td>Mode</td><td>Action (and parameter description)</td></tr>
261 <tr><td><strong>0-9</strong></td><td>Cursor</td><td>Begin entering a
262 numeric parameter (<strong><em>p</em></strong>) or repetition number for a cursor movement or edit
263 command.</td></tr>
264 <tr><td><strong>,</strong></td><td>Cursor</td><td>Separates one or
265 more numeric parameters (<em>e.g. <strong>p1</strong>,<strong>p2</strong></em>) for a command.</td></tr>
266 <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>
267 <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>
268 <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>
269 <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>
270 <tr><td><strong>Q</strong></td><td>Cursor</td><td>Marks the top left corner of the selection area</td></tr>
271 <tr><td><strong>M</strong></td><td>Cursor</td><td>Marks the bottom right corner of the selection area</td></tr>
272 <tr><td><strong><em>[p]</em><br>Space</strong></td><td>Cursor</td><td>Inserts
273 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>
274 <tr><td><strong><em>[p]</em><br>Delete<br></strong></td><td>Cursor</td><td>Removes
275 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>
276 <tr><td><strong><em>[p]</em><br>Backspace<br></strong></td><td>Cursor</td><td>Removes
277 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>
278 <p>&nbsp;</p>
279 <p>&nbsp;</p>
280 </body>
281 </html>