JAL-1551 spotlessApply
[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>Cursor Keys<br> (Arrow Keys)
82       </strong></td>
83       <td>Cursor</td>
84       <td>Move cursor around alignment.<br /> Press SHIFT to move
85         cursor from an aligned region to next gap, or to the next
86         aligned region when at a gap.
87       </td>
88     </tr>
89     <tr>
90       <td><strong>Cursor Keys<br> (Arrow Keys)
91       </strong></td>
92       <td>Normal<br />
93       <em>(+Alt in Cursor)</em></td>
94       <td>Moves selected sequence(s) up, down, left, or right
95         according to the direction pressed.<br>
96       <br>
97       <em>Alt+Arrow key to move selection or sequence under cursor
98           in cursor mode.</em>
99       </td>
100     </tr>
101     <tr>
102       <td><strong>Page Up</strong></td>
103       <td>Both</td>
104       <td>Scroll up the alignment view</td>
105     </tr>
106     <tr>
107       <td><strong>Page Down</strong></td>
108       <td>Both</td>
109       <td>Scroll down the alignment view</td>
110     </tr>
111     <tr>
112       <td><strong>Control 'A'</strong></td>
113       <td>Both</td>
114       <td>Selects all sequences in the alignment</td>
115     </tr>
116     <tr>
117       <td><strong>Control 'I'</strong></td>
118       <td>Both</td>
119       <td>Invert sequence selection.</td>
120     </tr>
121     <tr>
122       <td><strong>Control Alt 'I'</strong></td>
123       <td>Both</td>
124       <td>Invert column selection.</td>
125     </tr>
126     <tr>
127       <td><strong>Control 'C'</strong></td>
128       <td>Both</td>
129       <td>Copies the selected region into the clipboard as a Fasta
130         format file<br> <em>nb. not available in applet, as no
131           clipboard is available</em>
132       </td>
133     </tr>
134     <tr>
135       <td><strong>Control Shift 'C'</strong></td>
136       <td>Both</td>
137       <td>Copies highlighted regions, such as from Find or a
138         structure based highlight, as new sequences in the clipboard.</td>
139     </tr>
140     <tr>
141       <td><strong>Control 'V'</strong></td>
142       <td>Both</td>
143       <td>Paste the contents of the clipboard to the current
144         alignment window. (Alignment Window->Edit->Paste->Add to this
145         Alignment)<br> <em>nb. if the paste is from a Jalview
146           alignment, any sequence and alignment annotations will also be
147           copied over.</em>
148       </td>
149     </tr>
150     <tr>
151       <td><strong>Control Shift 'V'</strong></td>
152       <td>Both</td>
153       <td>Paste the contents of the clipboard to a new alignment
154         window. (Alignment Window->Edit->Paste->To New Alignment)</td>
155     </tr>
156     <tr>
157       <td><strong>Control 'X'</strong></td>
158       <td>Both</td>
159       <td>Cuts the (fully) selected sequences from the alignment. <!-- not yet in this version 
160 This will not happen if only some
161 columns are selected, you should use the <a href="features/hiddenRegions.html">Hide Regions feature</a> instead.-->
162       </td>
163     </tr>
164     <tr>
165       <td><strong>Control 'F'</strong></td>
166       <td>Both</td>
167       <td>Launches the search window</td>
168     </tr>
169     <tr><td><strong>B</strong></td>
170       <td>Both</td>
171       <td>Add highlighted columns to current column selection</td>
172     </tr>
173     <tr><td><strong>Alt 'B'</strong></td>
174       <td>Both</td>
175       <td>Add all but the currently highlighted columns to current selection</td>
176     </tr>
177     <tr><td><strong>Control 'B'</strong></td>
178       <td>Both</td>
179       <td>Toggle the column selection marks for the currently highlighted 
180           columns (or all others if Alt is also pressed)</td>
181     </tr>
182     <tr>
183       <td><strong>H</strong></td>
184       <td>Both</td>
185       <td>Hides / Reveals selected columns and sequences</td>
186     </tr>
187     <tr>
188       <td><strong>Control 'H'</strong></td>
189       <td>Both</td>
190       <td>Hides / Reveals selected columns</td>
191     </tr>
192     <tr>
193       <td><strong>Shift 'H'</strong></td>
194       <td>Both</td>
195       <td>Hides / Reveals selected sequences</td>
196     </tr>
197     <tr>
198       <td><strong>Control + Shift 'H'</strong></td>
199       <td>Both</td>
200       <td>Hides everything but the current selection</td>
201     </tr>
202     <tr>
203       <td><strong>Control 'O'</strong></td>
204       <td>Both</td>
205       <td>Input new alignment from file</td>
206     </tr>
207     <tr>
208       <td><strong>Control 'S'</strong></td>
209       <td>Both</td>
210       <td>Save alignment with current filename and format</td>
211     </tr>
212     <tr>
213       <td><strong>Control Shift 'S'</strong></td>
214       <td>Both</td>
215       <td>Save alignment as a new file or with a different format</td>
216     </tr>
217     <tr>
218       <td><strong>Control 'P'</strong></td>
219       <td>Both</td>
220       <td>Opens the print dialog box to print the current view</td>
221     </tr>
222     <tr>
223       <td><strong>Control 'W'</strong></td>
224       <td>Both</td>
225       <td>Closes the current view or the current alignment</td>
226     </tr>
227     <tr>
228       <td><strong>Backspace</strong></td>
229       <td>Normal</td>
230       <td>Delete the currently selected rows or columns from the
231         alignment.</td>
232     </tr>
233     <tr>
234       <td><strong>Control 'L'</strong></td>
235       <td>Left</td>
236       <td>Remove columns to left of left-most column marker.</td>
237     </tr>
238     <tr>
239       <td><strong>Control 'R'</strong></td>
240       <td>Both</td>
241       <td>Remove columns to right of right-most column marker.</td>
242     </tr>
243     <tr>
244       <td><strong>Control 'E'</strong></td>
245       <td>Both</td>
246       <td>Remove gapped columns</td>
247     </tr>
248     <tr>
249       <td><strong>Control Shift 'E'</strong></td>
250       <td>Both</td>
251       <td>Remove all gaps</td>
252     </tr>
253     <tr>
254       <td><strong>Control 'D'</strong></td>
255       <td>Both</td>
256       <td>Open the 'Remove redundancy' Dialog box.</td>
257     </tr>
258     <tr>
259       <td><strong></strong></td>
260       <td>Normal</td>
261       <td></td>
262     </tr>
263   </table>
264   <p>The compound commands available in the Cursor mode are
265     summarised below. Single letter commands can be prefixed by digits
266     to specify a repetition number, and some more complex commands take
267     one or more numeric parameters (prefixing the command key and
268     separated by commas).</p>
269   <table border=1>
270     <tr>
271       <td><strong>Compound Command</strong></td>
272       <td>Mode</td>
273       <td>Action (and parameter description)</td>
274     </tr>
275     <tr>
276       <td><strong>0-9</strong></td>
277       <td>Cursor</td>
278       <td>Begin entering a numeric parameter (<strong><em>p</em></strong>)
279         or repetition number for a cursor movement or edit command.
280       </td>
281     </tr>
282     <tr>
283       <td><strong>,</strong></td>
284       <td>Cursor</td>
285       <td>Separates one or more numeric parameters (<em>e.g. <strong>p1</strong>,<strong>p2</strong></em>)
286         for a command.
287       </td>
288     </tr>
289     <tr>
290       <td><strong><strong><em>p1</em></strong>,<strong><em>p2</em></strong><br>Return</strong></td>
291       <td>Cursor</td>
292       <td>Move cursor to a particular column (<strong><em>p1</em></strong>)
293         and row (<strong><em>p2</em></strong>) in the alignment.<br>
294         <em>e.g. '5,6&lt;Return&gt;' moves the cursor to the 5th
295           column in the 6th sequence.</em></td>
296     </tr>
297     <tr>
298       <td><strong><em>p</em>S</strong></td>
299       <td>Cursor</td>
300       <td>Jump to the <strong><em>p</em></strong>'th sequence in
301         the alignment.
302       </td>
303     </tr>
304     <tr>
305       <td><strong><em>p</em>P</strong></td>
306       <td>Cursor</td>
307       <td>Jump to <em><strong>p</strong></em>'th amino acid in
308         current sequence.
309       </td>
310     </tr>
311     <tr>
312       <td><strong><em>p</em>C</strong></td>
313       <td>Cursor</td>
314       <td>Jump to <em><strong>p</strong></em>'th column in the
315         alignment.
316       </td>
317     </tr>
318     <tr>
319       <td><strong>Q</strong></td>
320       <td>Cursor</td>
321       <td>Marks the top left corner of the selection area</td>
322     </tr>
323     <tr>
324       <td><strong>M</strong></td>
325       <td>Cursor</td>
326       <td>Marks the bottom right corner of the selection area</td>
327     </tr>
328     <tr>
329       <td><strong><em>[p]</em><br>Space</strong></td>
330       <td>Cursor</td>
331       <td>Inserts one (or optionally <strong><em>p</em></strong>)
332         gaps at the current position.<br> <em>Hold down
333           Control or Shift to insert gaps over a sequence group</em></td>
334     </tr>
335     <tr>
336       <td><strong><em>[p]</em><br>Delete<br></strong></td>
337       <td>Cursor</td>
338       <td>Removes one (or optionally <strong><em>p</em></strong>)
339         gaps at the cursor position.<br> <em>Hold down Control
340           or Shift to insert gaps over a sequence group</em></td>
341     </tr>
342     <tr>
343       <td><strong><em>[p]</em><br>Backspace<br></strong></td>
344       <td>Cursor</td>
345       <td>Removes one (or optionally <strong><em>p</em></strong>)
346         gaps at the cursor position.<br> <em>Hold down Control
347           or Shift to insert gaps over a sequence group</em></td>
348     </tr>
349   </table>
350   <p>&nbsp;</p>
351   <p>&nbsp;</p>
352 </body>
353 </html>