documentation/modes.md

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