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