From 0bf30de288e878081a0d0fc113d140ece59f9d6d Mon Sep 17 00:00:00 2001 From: Simon Lydell Date: Sun, 9 Oct 2016 10:24:29 +0200 Subject: [PATCH] Improve documentation for shortcut customization See #823. --- documentation/questions-and-answers.md | 19 +++++++++++--- documentation/shortcuts.md | 34 ++++++++++++++++++++------ 2 files changed, 42 insertions(+), 11 deletions(-) diff --git a/documentation/questions-and-answers.md b/documentation/questions-and-answers.md index debcbf7..54c9f80 100644 --- a/documentation/questions-and-answers.md +++ b/documentation/questions-and-answers.md @@ -67,10 +67,22 @@ Head over to the [Styling] documentation to learn how to do that. [Styling]: styling.md -## How do I re-map `` to blur text inputs? +## How do I re-map Escape (which blurs text inputs)? -The default shortcut is actually ``! Don’t forget [``] at -the beginning, and your new shortcut should work fine. +… for example, **to ctrl+[ ?** + +First off, ctrl+[ is spelled `` in VimFx. (Tip: [`` helps you get the +“spelling” correct automatically][helper-shortcuts].) + +Secondly, the default shortcut is not just ``, but actually +``! Don’t forget [``] at the beginning, and your new +shortcut should work fine. For example: + + + +Or, if you’d like to you both `` _and_ something else: + + [``]: shortcuts.md#force @@ -81,6 +93,7 @@ Pressing `H` is like hitting the back button. Use `L` for the forward button. `[` clicks the link labeled “Previous” on the page, and `]` the link labeled “Next.” (See also [“Previous”/“Next” link patterns].) +[helper-shortcuts]: shortcuts.md#helper-keyboard-shortcuts [“Previous”/“Next” link patterns]: options.md#previousnext-link-patterns ## Can I search in the Keyboard Shortcuts help dialog? diff --git a/documentation/shortcuts.md b/documentation/shortcuts.md index 6c029c9..71b3d06 100644 --- a/documentation/shortcuts.md +++ b/documentation/shortcuts.md @@ -42,17 +42,35 @@ be put inside `<` and `>`. If you want to specify a modifier, then letters need to be put inside `<` and `>` as well (as in the `` example, which might be notated as “CTRL+J” in some other programs.) -If you’re usure on how to express a key press you’d like to use as part of a -shortcut, press `` while inside one of the text inputs for a command and -then press your desired key (optionally holding modifier keys). That will paste -the key notation for that particular key press into the text input. `` -pastes the default shortcut(s), and `` resets the text input to the default -entirely. You can of course use the standard `` to undo. - You can specify any number of shortcuts for every command. Separate them from each other by one or more spaces. -Here is a more formal description of all of the above: +### Helper keyboard shortcuts + +When you have focused the text input for one of all commands, there are a few +handy keyboard shortcuts that help you with editing your shortcuts: + +- ``: Use this when you’re unsure on how to express a keypress you’d like + to use as part of a shortcut. First, press ``. Then, press your desired + key (optionally holding modifier keys). That will paste the key notation for + that particular keypress into the text input. For example: First press + ``. Then hold down ctrl and press `[`. That results in `` being + inserted into the text input. + +- ``: Pastes the default shortcut(s) into the text input. + +- ``: Resets the text input to the default entirely. + +- ``: Undo. (This is simply the standard undo feature of your operating + system. It’s just mentioned because it is easy to forget that it can actually + be used here.) + +(``, `` and `` also work in other VimFx setting inputs, such as +the [“Previous”/“Next” link patterns].) + +[“Previous”/“Next” link patterns]: options.md#previousnext-link-patterns + +### A bit more formal description A _shortcut_ consists of one or more _keys_ that you need to press in order to activate the command. (See also the [timeout] option.) -- 2.39.3