documentation/modes.md

   1 # Modes
   2
   3 ## Summary
   4
   5 VimFx’s functionality is contained in an hierarchy.
   6
   7 1. There are several _modes._
   8
   9    Modes decide how VimFx works.
  10
  11 2. Each mode has several _commands._
  12
  13    Commands do things.
  14
  15 3. Each command has several _shortcuts._
  16
  17    Shortcuts tell which keys to press to activate a command.
  18
  19 These are the modes of VimFx:
  20
  21 - Normal mode. This is where you’ll stay most of the time, while only
  22   occasionally popping into another mode for a bit, before returning to Normal
  23   mode again.
  24
  25 - Ignore mode. When you want VimFx to get out of the way. In some pages it might
  26   make sense to [enter Ignore mode by default][blacklist] and stay in Ignore
  27   mode most of the time, occasionally popping into Normal mode.
  28
  29 - Hints mode. Entered when using the [hint commands][hint-commands] and lets you
  30   click things by typing the letters of hint markers.
  31
  32 - Caret mode. Entered when using some of the [`v` commands][v-commands] and lets
  33   you copy text using the keyboard.
  34
  35 If you’re unsure which mode you’re in, have a look at VimFx’s toolbar [button].
  36
  37
  38 ## Details
  39
  40 A mode does three things.
  41
  42 - It decides which _commands_ are available. Normal mode has lots of commands,
  43   while the point of Ignore mode is to have as few as possible. This is the most
  44   important point of modes.
  45
  46 - It decides what happens when you press keys on your keyboard. If your keypress
  47   is part of the [shortcut] for a command, it is usually consumed by VimFx. If
  48   not, Normal mode and Ignore mode pass the keypress on (letting it behave as if
  49   VimFx wasn’t even installed), while in [Hints mode][hint-commands] _all_
  50   keypresses are captured, allowing you to type the letters of a hint marker.
  51
  52 - It tells all parts of VimFx what mode you’re in. (How surprising!) Some
  53   features are only enabled in certain modes. For example, [autofocus
  54   prevention] in only enabled in Normal mode.
  55
  56 All modes have a way to return to Normal mode. By default, you usually press
  57 `<escape>`. To enter other modes, you usually run some command. For example, the
  58 default shortcut for running the command to enter Normal mode is `i`.
  59
  60 Note that the mode is per tab, not global.
  61
  62
  63 [blacklist]: options.md#blacklist
  64 [autofocus prevention]: options.md#prevent-autofocus
  65 [shortcut]: shortcuts.md
  66 [hint-commands]: commands.md#the-hint-commands--hints-mode
  67 [v-commands]: commands.md#the-v-commands--caret-mode
  68 [button]: button.md