aboutsummaryrefslogtreecommitdiff
path: root/book/src/keymap.md
diff options
context:
space:
mode:
authorTim Siegel2022-10-10 18:32:05 +0000
committerMichael Davis2022-10-12 23:12:54 +0000
commit425df93fb88ecfd0f87025705de348051cd40ccf (patch)
treed0593762ba85e2ec4c5f2c1495d1acee61415c49 /book/src/keymap.md
parente542f2e08f143ef2fd59ca2957842ba82338b63f (diff)
book: Refer to keys by key names, not representations
This is an attempt to clean up the inconsistent way that keys are written in various places. These rules require the fewest changes to the existing text. Use the "Key name", as defined in remapping.md, which uses "Some-Modifiers-PascalCaseKey". The "Representation", which uses "S-M-lowercasekey", is only used for configuration entries. For key combinations which do not present a popup, just present the keys one after the other, with no intervening space, like `]p`. For key combinations which present a popup, separate them with ` + `, like `Space + f`. The Ctrl modifier is called Ctrl, not Control.
Diffstat (limited to 'book/src/keymap.md')
-rw-r--r--book/src/keymap.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/book/src/keymap.md b/book/src/keymap.md
index 9bc1c31e..7fd146a6 100644
--- a/book/src/keymap.md
+++ b/book/src/keymap.md
@@ -129,7 +129,7 @@
| `X` | Extend selection to line bounds (line-wise selection) | `extend_to_line_bounds` |
| `Alt-x` | Shrink selection to line bounds (line-wise selection) | `shrink_to_line_bounds` |
| `J` | Join lines inside selection | `join_selections` |
-| `A-J` | Join lines inside selection and select space | `join_selections_space` |
+| `Alt-J` | Join lines inside selection and select space | `join_selections_space` |
| `K` | Keep selections matching the regex | `keep_selections` |
| `Alt-K` | Remove selections matching the regex | `remove_selections` |
| `Ctrl-c` | Comment/uncomment the selections | `toggle_comments` |
@@ -278,7 +278,7 @@ This layer is a kludge of mappings, mostly pickers.
| `/` | Global search in workspace folder | `global_search` |
| `?` | Open command palette | `command_palette` |
-> TIP: Global search displays results in a fuzzy picker, use `space + '` to bring it back up after opening a file.
+> TIP: Global search displays results in a fuzzy picker, use `Space + '` to bring it back up after opening a file.
##### Popup
@@ -311,8 +311,8 @@ Mappings in the style of [vim-unimpaired](https://github.com/tpope/vim-unimpaire
| `]t` | Go to previous test (**TS**) | `goto_prev_test` |
| `]p` | Go to next paragraph | `goto_next_paragraph` |
| `[p` | Go to previous paragraph | `goto_prev_paragraph` |
-| `[space` | Add newline above | `add_newline_above` |
-| `]space` | Add newline below | `add_newline_below` |
+| `[Space` | Add newline above | `add_newline_above` |
+| `]Space` | Add newline below | `add_newline_below` |
## Insert mode
@@ -414,8 +414,8 @@ Keys to use within prompt, Remapping currently not supported.
| `Alt-d`, `Alt-Delete`, `Ctrl-Delete` | Delete next word |
| `Ctrl-u` | Delete to start of line |
| `Ctrl-k` | Delete to end of line |
-| `backspace`, `Ctrl-h` | Delete previous char |
-| `delete`, `Ctrl-d` | Delete next char |
+| `Backspace`, `Ctrl-h` | Delete previous char |
+| `Delete`, `Ctrl-d` | Delete next char |
| `Ctrl-s` | Insert a word under doc cursor, may be changed to Ctrl-r Ctrl-w later |
| `Ctrl-p`, `Up` | Select previous history |
| `Ctrl-n`, `Down` | Select next history |