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     p       Navigate to the address in the clipboard
  47     P       Open new tab and navigate to the address in the clipboard
  48     yf      Copy link url to the clipboard
  49     yy      Copy current page link to the clipboard
  50     r       Reload current page
  51     R       Reload current page and all the assets (js, css, etc.)
  52     ar      Reload pages in all tabs
  53     aR      Reload pages in all tabs including assets (js, css, img)
  54
  55 ### Navigating
  56
  57     gg      Scroll to the Top of the page
  58     G       Scroll to the Bottom of the page
  59     j c-e   Scroll Down
  60     k c-y   Scroll Up
  61     h       Scroll Left
  62     l       Scroll Right
  63     d       Scroll half a Page Down
  64     u       Scroll half a Page Up
  65     c-f     Scroll full Page Down
  66     c-b     Scroll full Page Up
  67
  68 ### Tabs
  69
  70     t       Open New Blank tab
  71     J gT    Go to the Previous tab
  72     K gt    Go to the Next tab
  73     c-J     Move current tab to the Left
  74     c-K     Move current tab to the Right
  75     gH g0   Go to the First tab
  76     gL g$   Go to the Last tab
  77     x       Close current tab
  78     X       Restore last closed tab
  79
  80 ### Browsing
  81
  82     f       Follow a link on the current page
  83     F       Follow a link on the current page in a new tab
  84     H       Go Back in history
  85     L       Go Forward in history
  86
  87 ### Misc
  88
  89     /       Enter Find mode
  90     n       Go ot the next Find match
  91     N       Go ot the previous Find match
  92     ?       Show Help Dialog
  93     Esc     Close this dialog and cancel hint markers
  94
  95 ## Release Notes
  96
  97 0.1 (26 Oct 2012)
  98
  99 - Initial Release
 100
 101 0.1.1 (27 Oct 2012)
 102
 103 - Just to deal with AMO - no changes
 104
 105 0.2 (5 Nov 2012)
 106
 107 - document.designMode='on' is now honored. Will also provide hint markers for iframes on the page.
 108 - Bug fixed where it would completely reset the toolbar while installing the toolbar button.
 109 - Bug fixed where it's not possible to change the text in the blaclisting textbox
 110 - Changed u/d to scroll half a page, added c-f/c-b to scroll full page
 111 - Added tab movement commands: c-J and c-K.
 112 - Invisible markers bug fixed.
 113 - Global hotkey to disable the commands (equal to the toolbar button click): Alt-Shift V
 114 - ^u and ^d are removed from the command list. ^u is commonly used to show the page source code
 115 - Opening new tab with now focuses the Address Bar
 116 - Other small bugs nailed down.
 117
 118 0.3 (19 Nov 2012)
 119
 120 - Fixed [Desktop](https://addons.mozilla.org/en-us/firefox/addon/desktop/) extension compatibility problem
 121 - 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
 122 - Scrolling with G will now reach the bottom of the page
 123 - Implemented localization, currently there is only Russian localization. Community is welcome
 124   [to contribute your localizations](https://github.com/akhodakivskiy/VimFx/tree/master/extension/locale)!
 125 - Implemented simple smooth scolling
 126
 127 0.3.2, 0.3.2, 0.3.3 (20-21 Nov 2012)
 128
 129 - Hotfixes for the build script to include localization related files and folders
 130
 131 0.4 (9 Dec 2012)
 132
 133 - Implemented find with `/` and `n/N`
 134 - Added `ar` and `aR` commands to reload pages in all open tabs.
 135 - Added a preference that enables bluring from any element that has input focus in the browser on Esc keydown (on by default)
 136 - Fixed bug where markers and help dialog would blow up some of the pages.
 137 - Marker hints are now sorted with respect to the underlying element area. Elements with larger area get shorter hints
 138 - Added *mail.google.com* to the default black list
 139 - Various bug fixed and improvements.