documentation/commands.md

   1 <!--
   2 This is part of the VimFx documentation.
   3 Copyright Simon Lydell 2015.
   4 See the file README.md for copying conditions.
   5 -->
   6
   7 # Commands
   8
   9 Most of VimFx’s commands are straight-forward enough to not need any
  10 documentation. For some commands, though, there is a bit more to know.
  11
  12 In this document, many commands are referred to by their default shortcut. You
  13 can of course [change those] if you like.
  14
  15 [change those]: shortcuts.md
  16
  17 ## Counts
  18
  19 Some commands support _counts._ That means that you can type a number before a
  20 command and it will change its behavior based on that number—the count. For
  21 example, typing `12x` would close 12 tabs.
  22
  23 (As opposed to vim, you may only supply a count _before_ a command, not in the
  24 middle of one. This is because VimFx’s commands are simple sequences, while
  25 vim’s are operators and motions.)
  26
  27 ### `gu`
  28
  29 Goes _count_ levels up in the URL hierarchy.
  30
  31 ### `H` and `L`
  32
  33 Goes _count_ pages backward/forward in history.
  34
  35 ### Scrolling commands
  36
  37 Specifying a count make them scroll _count_ times as far.
  38
  39 ### `J`, `K`
  40
  41 Selects the tab _count_ tabs backward/forward.
  42
  43 If the count is greater than one they don’t wrap around when reaching the ends
  44 of the tab bar, unless:
  45
  46 - the first tab is selected and `J` is used.
  47 - the last tab is selected and `K` is used.
  48
  49 They only wrap around _once._
  50
  51 ### `gJ`, `gK`
  52
  53 Moves the current tab _count_ tabs forward/backward.
  54
  55 As opposed to `J` and `K`, pinned and non-pinned tabs are handled separately.
  56 The first non-pinned tab wraps to the last tab, and the last tab wraps to the
  57 first non-pinned tab, and vice versa for non-pinned tabs. Use `gp` to move a tab
  58 between the pinned and non-pinned parts of the tab bar.
  59
  60 Other than the above, the count and wrap semantics work like `J` and `K`.
  61
  62 ### `g0`, `g^`, `g$`
  63
  64 `g0` selects the tab at index _count,_ counting from the start.
  65
  66 `g^` selects the tab at index _count,_ counting from the first non-pinned tab.
  67
  68 `g$` selects the tab at index _count,_ counting from the end.
  69
  70 ### `x`
  71
  72 Closes the current tab and _count_ minus one of the following tabs.
  73
  74 ### `X`
  75
  76 Restores the _count_ last closed tabs.
  77
  78 ### `I`
  79
  80 Passes on the next _count_ keypresses to the page, without activating VimFx
  81 commands.
  82
  83 ### The `f` commands
  84
  85 Explained in the their own section below.
  86
  87 ### `gi`
  88
  89 Explained in its own section below.
  90
  91
  92 ## Scrolling commands
  93
  94 Firefox lets you scroll with the arrow keys, page down, page up, home, end and
  95 space by default. VimFx provides similar scrolling commands (and actually
  96 overrides `<space>`), but they work a little bit differently.
  97
  98 They scroll _the currently focused element._ If the currently focused element
  99 isn’t scrollable, or there is no (apparent) currently focused element, the
 100 entire page is scrolled. Finally, if the entire page isn’t scrollable, the
 101 largest scrollable element on the page (if any) is scrolled.
 102
 103 You can focus scrollable elements using the `zf` command (or the `f` command).
 104 The right border of hint markers for scrollable elements is styled to remind of
 105 a scroll bar, making them easier to recognize among hints for links.
 106
 107
 108 ## `gi`
 109
 110 `gi` focuses the text input you last used, or the first one on the page. Note
 111 that a [prevented autofocus] still counts as having focused and used a text
 112 input. This allows you to have your cake and eat it too: You can enable
 113 autofocus prevention, and type `gi` when you wish you hadn’t.
 114
 115 `gi` takes a count. It then selects the `counth` text input on the page. Note
 116 that `gi` and `1gi` are different: The latter _always_ focuses the first input
 117 of the page, regradless of which input you used last.
 118
 119 After having focused a text input using `gi`, `<tab>` and `<s-tab>` will _only
 120 cycle between text inputs,_ instead of moving the focus between _all_ focusable
 121 elements as they usually do. (See also the [`focus_previous_key` and
 122 `focus_next_key`] advanced options.)
 123
 124 [prevented autofocus]: options.md#prevent-autofocus
 125 [`focus_previous_key` and `focus_next_key`]: options.md#focus_previous_key-and-focus_next_key
 126
 127
 128 ## The `f` commands
 129
 130 When invoking one of the `f` commands you enter Hints mode. In Hints mode,
 131 markers with hints are shown for some elements. By typing the letters of a hint
 132 something is done to that element, depending on the command.
 133
 134 Which elements get hints depends on the command as well:
 135
 136 - `f` and `af`: Anything clickable—links, buttons, form controls.
 137 - `F` and `gf`: Anything that can be opened in a new tabs—links.
 138 - `yf`: Anything that has something useful to copy—links (their URL) and text
 139   inputs (their text).
 140 - `zf`: Anything focusable—links, buttons, form controls, scrollable elements,
 141   frames.
 142
 143 It might seem simpler to match the same set of elements for _all_ of the
 144 commands. The reason that is not the case is because the fewer elements the
 145 shorter the hints. (Also, what should happen if you tried to `F` a button?)
 146
 147 Another way to make hints shorter is to assign the same hint to all links with
 148 the same URL. So don’t get surprised if you see the same hint repeated several
 149 times.
 150
 151 VimFx also tries to give you shorter hints for elements that you are more likely
 152 to click. This is done by the surprisingly simple rule: The larger the element,
 153 the shorter the hint.
 154
 155 There are standardized elements which are always clickable—_semantically_
 156 clickable elements. Unfortunately, many sites use unclickable elements and then
 157 make them clickable using JavaScript—<em>un</em>semantically clickable elements.
 158 Such elements are difficult to find. VimFx has a few techniques for doing so,
 159 which works many times but not always, but unfortunately they sometimes produce
 160 false positives. Many times those false positives are pretty large elements,
 161 which according to the last paragraph would give them really short hints, making
 162 other more important elements suffer by getting longer ones. Therefore VimFx
 163 favors semantic elements over unsemantic ones and takes that into account when
 164 deciding the hint length for elements.
 165
 166 Some hint characters are easier to type than others. The ones on the home row
 167 are of course the best. When customizing the [hint chars] option you should put
 168 the best keys to the left and the worst ones to the right. VimFx favors keys to
 169 the left, so that should give you the optimal hints.
 170
 171 Hints are added on top of the corresponding element. If they obscure the display
 172 too much you can hold shift to make them transparent. (See [Styling] if you’d
 173 like to change that.) The hints can also sometimes cover each other. Press
 174 `<space>` and `<s-space>` to switch which one should be on top.
 175
 176 When giving a count to an `f` command, all markers will be re-shown after you’ve
 177 typed the hint characters of one of them, _count_ minus one times. All but the
 178 last time, the marker’s link will be opened in a new background tab. The last
 179 time the command opens links as normal (in the current tab (`f`) or in a new
 180 background (`F`) or foreground tab (`gf`)).
 181
 182 Note that the `f` command adds markers not only to links, but to buttons and
 183 form controls as well. What happens the _count_ minus one times then? Buttons,
 184 checkboxes and the like are simply clicked, allowing you to quickly check many
 185 checkboxes in one go, for example. Text inputs cancel the command.
 186
 187 `af` works as if you’d supplied an infinite count to `f`. (In fact, the `af`
 188 command is implemented by running the same function as for the `f` command,
 189 passing `Infinity` as the `count` argument!) Therefore the `af` command does not
 190 accept a count itself.
 191
 192 The `zf` and `yf` commands do not accept counts.
 193
 194 Press `<enter>` to increase the count by one. This is useful when you’ve already
 195 entered Hints mode but realize that you want to interact with yet a marker. This
 196 can be faster than going into Hints mode once more.
 197
 198 If you’ve pressed `f` but realize that you’d rather open a link in a new tab you
 199 can hold ctrl while typing the last hint character. This is similar to how you
 200 can press `<c-enter>` on a focused link to open it in a new tab (while just
 201 `<enter>` would have opened it in the same tab). Hold alt to open in a new
 202 foreground tab. In other words, holding ctrl works as if you’d pressed `F` from
 203 the beginning, and holding alt works as if you’d pressed `gf`.
 204
 205 For the `F` and `gf` commands, holding ctrl makes them open links in the same
 206 tab instead, as if you’d used the `f` command. Holding alt toggles whether to
 207 open tabs in the background or foreground—it makes `F` work like `gf`, and `gf`
 208 like `F`.
 209
 210 (Also see the advanced prefs [hints\_toggle\_in\_tab] and
 211 [hints\_toggle\_in\_background].)
 212
 213 [hint chars]: options.md#hint-chars
 214 [Styling]: styling.md
 215 [hints\_toggle\_in\_tab]: options.md#hints_toggle_in_tab
 216 [hints\_toggle\_in\_background]: options.md#hints_toggle_in_background
 217
 218
 219 ## Ignore mode `<s-f1>`
 220
 221 Ignore mode is all about ignoring VimFx commands and sending the keys to the
 222 page instead. Sometimes, though, you might want to run some VimFx command even
 223 when in Insert mode.
 224
 225 One way of doing that is to press `<s-escape>` to exit Ignore mode, run your
 226 command and then enter Ignore mode again using `i`. However, it might be
 227 inconvenient having to remember to re-enter Ignore mode, and sometimes that’s
 228 not even possible, such as if you ran the `K` command to get to the next tab.
 229
 230 Another way is to press `<s-f1>` followed by the Normal mode command you wanted
 231 to run. (`<s-f1>` is essentially the inverse of the `I` command, which passes
 232 the next keypress on to the page. Internally they’re called “quote” and
 233 “unquote.”) This is handy if you’d like to switch away from a [blacklisted]
 234 page: Just press for example `<s-f1>K`.
 235
 236 `<s-f1>` was chosen as the default shortcut because on a typical keyboard `<f1>`
 237 is located just beside `<escape>`, which makes it very similar to `<s-escape>`,
 238 which is used to exit Ignore mode. Both of those are uncommonly used by web
 239 pages, so they shouldn’t be in the way. If you ever actually do need to send any
 240 of those to the page, you can prefix them with `<s-f1>`, because if the key you
 241 press after `<s-f1>` is not part of any Normal mode command, the key is sent to
 242 the page. (Another way is for example `<s-f1>I<s-escape>`.)
 243
 244 [blacklisted]: options.md#blacklist
 245
 246
 247 ## Ex commands
 248
 249 vim has something called “ex” commands. Want something similar in VimFx? True to
 250 its spirit, VimFx embraces a standard Firefox feature for this purpose: The
 251 [Developer Toolbar]. That link also includes instructions on how to extend it
 252 with your own commands.
 253
 254 In the future VimFx might even ship with a few extra “ex” commands by default.
 255 We’re open for suggestions!
 256
 257 [Developer Toolbar]: https://developer.mozilla.org/en-US/docs/Tools/GCLI