From f689ec4506721217629a4ae2aecdeb7d7525e4cc Mon Sep 17 00:00:00 2001 From: Simon Lydell Date: Sun, 9 Oct 2016 10:28:00 +0200 Subject: [PATCH] Consistently refer to keypresses as "keypresses" Not "key presses" and not "key press". --- documentation/button.md | 10 +++++----- documentation/modes.md | 11 +++++------ documentation/questions-and-answers.md | 2 +- documentation/shortcuts.md | 6 +++--- extension/lib/commands.coffee | 2 +- extension/lib/events.coffee | 2 +- extension/lib/vimfx.coffee | 2 +- 7 files changed, 17 insertions(+), 18 deletions(-) diff --git a/documentation/button.md b/documentation/button.md index 54e1594..52466aa 100644 --- a/documentation/button.md +++ b/documentation/button.md @@ -8,15 +8,15 @@ See the file README.md for copying conditions. VimFx has a toolbar button. It looks like this: ![VimFx button icon]. -If you focus a text input, the icon is greyed out. This is to show that your key -presses will be passed into the text input rather than activating VimFx +If you focus a text input, the icon is greyed out. This is to show that your +keypresses will be passed into the text input rather than activating VimFx commands. (Except _some_ commands: See the [``] special key.) When in Normal mode, clicking it opens VimFx’s Keyboard Shortcuts help dialog, just like the `?` shortcut does. In other [modes], clicking it returns you to normal mode. If you feel like VimFx -does not respond to any of your key presses, it might be because you’re not in +does not respond to any of your keypresses, it might be because you’re not in Normal mode. If you don’t know how to exit that mode (or have accidentally removed the keyboard shortcut to do so), clicking the button is the way to “escape” back to Normal mode. (On such occasions, you can hover the button and @@ -25,8 +25,8 @@ its tooltip will say what mode you’re currently in.) In Ignore mode, the icon also turns red, like this: ![VimFx button icon red]. ([Blacklisted] sites enter Ignore mode automatically.) The reason is that the whole point of Ignore mode is to “ignore” all of VimFx’s commands, passing your -key presses to the page instead. It is helpful to know that you’re really in -Ignore mode, so you can be confident that your key presses do what you expect +keypresses to the page instead. It is helpful to know that you’re really in +Ignore mode, so you can be confident that your keypresses do what you expect them to. (See [Styling] if you’d like to highlight Ignore mode, or any mode for that matter, some other way.) diff --git a/documentation/modes.md b/documentation/modes.md index b4234d8..29cfd76 100644 --- a/documentation/modes.md +++ b/documentation/modes.md @@ -49,12 +49,11 @@ A mode does three things. while the point of Ignore mode is to have as few as possible. This is the most important point of modes. -- It decides what happens when you press keys on your keyboard. If your key - press is part of the [shortcut] for a command, it is usually consumed by - VimFx. If not, Normal mode and Ignore mode pass the key press on (letting it - behave as if VimFx wasn’t even installed), while in [Hints mode][hint-commands] - _all_ key presses are captured, allowing you to type the letters of a hint - marker. +- It decides what happens when you press keys on your keyboard. If your keypress + is part of the [shortcut] for a command, it is usually consumed by VimFx. If + not, Normal mode and Ignore mode pass the keypress on (letting it behave as if + VimFx wasn’t even installed), while in [Hints mode][hint-commands] _all_ + keypresses are captured, allowing you to type the letters of a hint marker. - It tells all parts of VimFx what mode you’re in. (How surprising!) Some features are only enabled in certain modes. For example, [autofocus diff --git a/documentation/questions-and-answers.md b/documentation/questions-and-answers.md index 54c9f80..d8c49bc 100644 --- a/documentation/questions-and-answers.md +++ b/documentation/questions-and-answers.md @@ -13,7 +13,7 @@ to reflect this. As you can see in VimFx’s Keyboard Shortcuts help dialog (which you can open by pressing `?`), Ignore mode only has two shortcuts. That means that almost all -key presses will be ignored by VimFx, and will be handled as if VimFx wasn’t +keypresses will be ignored by VimFx, and will be handled as if VimFx wasn’t installed. By adding `*currentdomain.com*` to the [blacklist] option you can make VimFx diff --git a/documentation/shortcuts.md b/documentation/shortcuts.md index 71b3d06..32de15e 100644 --- a/documentation/shortcuts.md +++ b/documentation/shortcuts.md @@ -99,7 +99,7 @@ keyboard layout] option. If you’d like see what VimFx interprets a key stroke as, you can (ab)use the [`m`] command. Press `m` followed by your desired key stroke. A [notification] -will appear, including the interpreted key notation for that key press. +will appear, including the interpreted key notation for that keypress. [Ignore keyboard layout]: options.md#ignore-keyboard-layout [`m`]: commands.md#marks-m-and- @@ -151,10 +151,10 @@ mode.” ### `` The `` special key makes the shortcut in question run _after_ the handling -of key presses in the current page, allowing the current page to override it. +of keypresses in the current page, allowing the current page to override it. Normally, all of VimFx’s shortcuts are triggered _before_ the current page gets -the key presses. This makes the VimFx shortcuts work consistently regardless of +the keypresses. This makes the VimFx shortcuts work consistently regardless of what the current page happens to be up to. Sometimes, though, it is useful to let the page override a shortcut. For diff --git a/extension/lib/commands.coffee b/extension/lib/commands.coffee index 943c19b..59700f3 100644 --- a/extension/lib/commands.coffee +++ b/extension/lib/commands.coffee @@ -481,7 +481,7 @@ helper_follow = ({name, callback}, {vim, count, callbackOverride = null}) -> return callback(marker, timesLeft, keyStr) # Enter Hints mode immediately, with an empty set of markers. The user might - # press keys before any hints have been generated. Those key presses should be + # press keys before any hints have been generated. Those keypresses should be # handled in Hints mode, not Normal mode. vim._enterMode('hints', { markerContainer, count diff --git a/extension/lib/events.coffee b/extension/lib/events.coffee index e8e71d1..c819a7f 100644 --- a/extension/lib/events.coffee +++ b/extension/lib/events.coffee @@ -264,7 +264,7 @@ class UIEventManager anyPopupsOpen: -> # The autocomplete popup in text inputs (for example) is technically a - # panel, but it does not respond to key presses. Therefore + # panel, but it does not respond to keypresses. Therefore # `[ignorekeys="true"]` is excluded. # # coffeelint: disable=max_line_length diff --git a/extension/lib/vimfx.coffee b/extension/lib/vimfx.coffee index 2af9be2..dbc6d3c 100644 --- a/extension/lib/vimfx.coffee +++ b/extension/lib/vimfx.coffee @@ -19,7 +19,7 @@ # This file defines a top-level object to hold global state for VimFx. It keeps # track of all `Vim` instances (vim.coffee), all options and all keyboard -# shortcuts. It can consume key presses according to its commands, and return +# shortcuts. It can consume keypresses according to its commands, and return # the commands for UI presentation. There is only one `VimFx` instance. notation = require('vim-like-key-notation') -- 2.39.3