]> Shamusworld >> Repos - ardour-manual/blob - include/keyboard-shortcuts.html
Keyboard Shortcuts: initial revision of the documentation (rebase conflict fix)
[ardour-manual] / include / keyboard-shortcuts.html
1 <p>
2         The <kbd class="window">Keyboard Shortcuts</kbd> dialog allows easily
3         redefining existing keyboard shortcuts to operations and creating new ones.
4 </p>
5
6 <figure>
7   <img style="width:50%;" src="/images/keyboard-shortcuts-window.png" alt="Keyboard Shortcuts">
8   <figcaption>
9     Keyboard Shortcuts
10   </figcaption>
11 </figure>
12
13 <h2>Contexts and Subcontexts</h2>
14
15 <p>
16         The important concept to understand here is that the same shortcut can be
17         used for different operations in different contexts. E.g. in the
18         <dfn>Editor</dfn> context, the <kbd class="button">T</kbd> key switches
19         on the <dfn>Stretch</dfn> mode to time-stretch clips on the canvas. However,
20         in the MIDI Step Entry context, <kbd class="button">T</kbd> inserts
21         an F-sharp note. The contexts are represented by tabs in this dialog, e.g.
22         Editor, MIDI, Recorder, etc.
23 </p>
24
25 <p>
26         Inside every tab, features are grouped into <dfn>subcontexts</dfn> that can
27         be expanded or collapsed by clicking the triangular-shaped button to the
28         left of the name of each subcontext. E.g. the 'Snap' subcontext lists all
29         snapping units, while the 'Region' subcontext lists all actions accessible
30         via the right-click menu.
31 </p>
32
33 <p>
34         The <dfn>Search</dfn> function at the bottom of the dialog works within
35         the currently selected context/tab only. If a search returned zero results,
36         switching to a different context is a viable solution to locating the action
37         of interest.
38 </p>
39
40 <h2>Setting New Shortcuts</h2>
41
42 <p>
43         Once an action of interest is located in the list, all it takes to set
44         a keybinding to it is selecting the action in the list, then pressing
45         the sequence of keys. The newly defined keybinding will immediately show up
46         in the <dfn>Shortcut</dfn> column.
47 </p>
48
49 <h2>Redefining Existing Shortcuts</h2>
50
51 <p>
52         An existing shortcut to an action can easily be replaced with a different
53         one by selecting the action and pressing a new sequence of keys. The newly
54         defined keybinding will immediately show up in the <dfn>Shortcut</dfn>
55         column.
56 </p>
57
58 <h2>Handling Collisions</h2>
59
60 <p>
61         Once a keybinding is assigned to an action, that keybinding is considered
62         taken. Attempting to assign that same keybinding to a different action will
63         result in a collision. Ardour will notify the user that the keybinding is
64         already taken (and by what action) and will ask to either reconsider or
65         force-set the keybinding to a new action.
66 </p>
67
68 <figure>
69   <img style="width:50%;" src="/images/keyboard-shortcuts-collision.png" alt="A keyboard shortcut collision">
70   <figcaption>
71     A keyboard shortcut collision
72   </figcaption>
73 </figure>
74
75 <p>
76         Force-setting the keybinding of choice to a new action will remove
77         the keybinding from the action it was previously assigned to. A new
78         keybinding then can be assigned to that action.
79 </p>
80
81 <h2>Removing Existing Shortcuts</h2>
82
83 <p>
84         In some cases it is desirable to remove a shortcuts entirely. Selecting an
85         action of interest, then pressing the
86         <kbd class="button">Remove shortcut</kbd> button at the bottom of the dialog
87         will do just that. The keybinding will immediately disappear from the
88         <dfn>Shortcut</dfn> column.
89 </p>
90
91 <h2>Reverting to Factory Settings</h2>
92
93 <p>
94         If applied customizations to default keyboard shortcuts didn't work out,
95         it's possible to revert to "factory settings". Clicking
96         <kbd class="button">Reset Bindings to Defaults</kbd> will remove all
97         customizations and bring back default keybindings. Important: Ardour will not
98         ask for a confirmation!
99 </p>