README.md

   1 # VimFx - Vim keyboard shortcuts for Firefox
   2
   3 *Extension AMO page*: https://addons.mozilla.org/en-US/firefox/addon/vimfx/
   4
   5 *Contribute your localization! See `locale` folder*
   6
   7 [VimFx](https://addons.mozilla.org/en-US/firefox/addon/vimfx/)
   8 is a [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/fx/#desktop)
   9 extension which introduces Vim-style keyboard shortcuts for browsing and navigation,
  10 significantly reducing the use of mouse, and allowing your hands to rest on the home row.
  11
  12 VimFx was inspired by [Vimperator](http://www.vimperator.org/)
  13 and designed after [Vimium](http://vimium.github.com/) for
  14 [Google Chrome](https://www.google.com/intl/en/chrome/browser/) preserving the shortcuts and behavior.
  15 If your are used to Vimium then it will be easy to get started with VimFx.
  16
  17 ## Why VimFx was created
  18
  19 Even before Vimium there was Vimperator for Firefox.  In my opinion the problem
  20 with Vimperator is that it has too many features and aggressively changes
  21 the default Firefox appearance and behavior. Vimium was developed for Google Chrome
  22 and it was exactly what I needed in terms of added functionality. That's why I decided
  23 to develop similar extension for Firefox.
  24
  25 VimFx will be nice to your browser and to your habits. Promise.
  26
  27 ## Credits
  28
  29
  30
  31 ## Key Features
  32
  33 - Concise shortcuts for most commonly performed actions
  34 - Follow and access controls on the page using hint markers
  35 - Easy access to the Help page which describes all available shortcuts (press ?)
  36
  37 ## Shortcuts
  38
  39 Might not be up to date. Please refer to the Help dialog withing the extension
  40 for the most relevant list.
  41
  42 Global shortcut to enable/disable VimFx: `Shift-Alt-v`
  43
  44 ### URLs
  45
  46     o       Focus the Address Bar
  47     p       Navigate to the address in the clipboard
  48     P       Open new tab and navigate to the address in the clipboard
  49     yf      Copy link url to the clipboard
  50     yy      Copy current page link to the clipboard
  51     r       Reload current page
  52     R       Reload current page and all the assets (js, css, etc.)
  53     ar      Reload pages in all tabs
  54     aR      Reload pages in all tabs including assets (js, css, img)
  55
  56 ### Navigating
  57
  58     gg      Scroll to the Top of the page
  59     G       Scroll to the Bottom of the page
  60     j c-e   Scroll Down
  61     k c-y   Scroll Up
  62     h       Scroll Left
  63     l       Scroll Right
  64     d       Scroll half a Page Down
  65     u       Scroll half a Page Up
  66     c-f     Scroll full Page Down
  67     c-b     Scroll full Page Up
  68
  69 ### Tabs
  70
  71     t       Open New Blank tab
  72     J gT    Go to the Previous tab
  73     K gt    Go to the Next tab
  74     c-J     Move current tab to the Left
  75     c-K     Move current tab to the Right
  76     gh      Navigate to the Home Page
  77     gH g0   Go to the First tab
  78     gL g$   Go to the Last tab
  79     x       Close current tab
  80     X       Restore last closed tab
  81
  82 ### Browsing
  83
  84     f       Follow a link on the current page
  85     F       Follow a link on the current page in a new tab
  86     H       Go Back in history
  87     L       Go Forward in history
  88
  89 ### Misc
  90
  91     .,/     Enter Find mode
  92     n       Go to the next Find match
  93     N       Go to the previous Find match
  94     ?,>     Show Help Dialog
  95     Esc     Close this dialog and cancel hint markers
  96
  97 ## Release Notes
  98
  99 0.1 (26 Oct 2012)
 100
 101 - Initial Release
 102
 103 0.1.1 (27 Oct 2012)
 104
 105 - Just to deal with AMO - no changes
 106
 107 0.2 (5 Nov 2012)
 108
 109 - document.designMode='on' is now honored. Will also provide hint markers for iframes on the page.
 110 - Bug fixed where it would completely reset the toolbar while installing the toolbar button.
 111 - Bug fixed where it's not possible to change the text in the blaclisting textbox
 112 - Changed u/d to scroll half a page, added c-f/c-b to scroll full page
 113 - Added tab movement commands: c-J and c-K.
 114 - Invisible markers bug fixed.
 115 - Global hotkey to disable the commands (equal to the toolbar button click): Alt-Shift V
 116 - ^u and ^d are removed from the command list. ^u is commonly used to show the page source code
 117 - Opening new tab with now focuses the Address Bar
 118 - Other small bugs nailed down.
 119
 120 0.3 (19 Nov 2012)
 121
 122 - Fixed [Desktop](https://addons.mozilla.org/en-us/firefox/addon/desktop/) extension compatibility problem
 123 - Removed c-b/c-f for now. c-f is a standard search hotkey. Will put c-f back when proper Vim-like search with / is implemented
 124 - Scrolling with G will now reach the bottom of the page
 125 - Implemented localization, currently there is only Russian localization. Community is welcome
 126   [to contribute your localizations](https://github.com/akhodakivskiy/VimFx/tree/master/extension/locale)!
 127 - Implemented simple smooth scolling
 128
 129 0.3.2, 0.3.2, 0.3.3 (20-21 Nov 2012)
 130
 131 - Hotfixes for the build script to include localization related files and folders
 132
 133 0.4 (9 Dec 2012)
 134
 135 - Implemented find with `/` and `n/N`
 136 - Added `ar` and `aR` commands to reload pages in all open tabs.
 137 - Added a preference that enables bluring from any element that has input focus in the browser on Esc keydown (on by default)
 138 - Fixed bug where markers and help dialog would blow up some of the pages.
 139 - Marker hints are now sorted with respect to the underlying element area. Elements with larger area get shorter hints
 140 - Added *mail.google.com* to the default black list
 141 - Various bug fixed and improvements.
 142
 143 0.4.1, 0.4.2 (12-14 Dec 2012)
 144
 145 - Small tweaks of the find feature.
 146 - Bugfix for keyboard handling on non-english keyboard layouts
 147
 148 0.4.3 (27 Dec 2012)
 149
 150 - Toolbar button bugfix
 151 - Added an option to disable individual commands via the help dialog
 152
 153 0.4.4 (30 Jan 2013)
 154
 155 - Thanks to @mozillazg and @mcomella for translation contributions.
 156 - Added `gh` command that will navigate to the home page.
 157 - Added `o` command to focus address bar.
 158 - `p` and `P` will parse the contents of the clipboard. If the string in the clipboard appears to be a url then it will navigate to this url. Otherwise it will search for the string in the clipboard using currently selected search provider.
 159 - Now hint markers for links will stay on top of all the markers for different kinds of elements.
 160 - Esc will now also close the focused default search bar.
 161 - Fixed bugs related to keyboard events handling, XUL documents, and some other issues.
 162 - Bug fixed where not all the commands could be disabled via the Help dialog.
 163
 164 0.4.5 (12 Mar 2013)
 165
 166 - `:` to open Firefox Developer Toolbar, `Esc` to close it.
 167 - Add Hungarian locale (@thenonameguy).
 168 - Add Polish locale (@grn).
 169 - Don't close pinned tabs when pressing x (@grn).
 170 - Switched to Makefile for building the extension release (@carno).
 171 - Mrakers CSS tweaks (@helmuthdu)