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     vf      Focus element
  51     yy      Copy current page link to the clipboard
  52     r       Reload current page
  53     R       Reload current page and all the assets (js, css, etc.)
  54     ar      Reload pages in all tabs
  55     aR      Reload pages in all tabs including assets (js, css, img)
  56
  57 ### Navigating
  58
  59     gg      Scroll to the Top of the page
  60     G       Scroll to the Bottom of the page
  61     j,c-e   Scroll Down
  62     k,c-y   Scroll Up
  63     h       Scroll Left
  64     l       Scroll Right
  65     d       Scroll half a Page Down
  66     u       Scroll half a Page Up
  67     c-f     Scroll full Page Down
  68     c-b     Scroll full Page Up
  69
  70 ### Tabs
  71
  72     t       Open New Blank tab
  73     J,gT    Go to the Previous tab
  74     K,gt    Go to the Next tab
  75     c-J     Move current tab to the Left
  76     c-K     Move current tab to the Right
  77     gh      Navigate to the Home Page
  78     gH,g0   Go to the First tab
  79     gL,g$   Go to the Last tab
  80     x       Close current tab
  81     X       Restore last closed tab
  82
  83 ### Browsing
  84
  85     f       Follow a link on the current page
  86     F       Follow a link on the current page in a new tab
  87     H       Go Back in history
  88     L       Go Forward in history
  89
  90 ### Misc
  91
  92     .,/     Enter Find mode
  93     a.,a/   Enter Find mode to highlight all matches
  94     n       Go to the next Find match
  95     N       Go to the previous Find match
  96     ?,>     Show Help Dialog
  97     Esc     Close this dialog and cancel hint markers
  98
  99 ## Release Notes
 100
 101 0.1 (26 Oct 2012)
 102
 103 - Initial Release
 104
 105 0.1.1 (27 Oct 2012)
 106
 107 - Just to deal with AMO - no changes
 108
 109 0.2 (5 Nov 2012)
 110
 111 - document.designMode='on' is now honored. Will also provide hint markers for iframes on the page.
 112 - Bug fixed where it would completely reset the toolbar while installing the toolbar button.
 113 - Bug fixed where it's not possible to change the text in the blaclisting textbox
 114 - Changed u/d to scroll half a page, added c-f/c-b to scroll full page
 115 - Added tab movement commands: c-J and c-K.
 116 - Invisible markers bug fixed.
 117 - Global hotkey to disable the commands (equal to the toolbar button click): Alt-Shift V
 118 - ^u and ^d are removed from the command list. ^u is commonly used to show the page source code
 119 - Opening new tab with now focuses the Address Bar
 120 - Other small bugs nailed down.
 121
 122 0.3 (19 Nov 2012)
 123
 124 - Fixed [Desktop](https://addons.mozilla.org/en-us/firefox/addon/desktop/) extension compatibility problem
 125 - 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
 126 - Scrolling with G will now reach the bottom of the page
 127 - Implemented localization, currently there is only Russian localization. Community is welcome
 128   [to contribute your localizations](https://github.com/akhodakivskiy/VimFx/tree/master/extension/locale)!
 129 - Implemented simple smooth scolling
 130
 131 0.3.2, 0.3.2, 0.3.3 (20-21 Nov 2012)
 132
 133 - Hotfixes for the build script to include localization related files and folders
 134
 135 0.4 (9 Dec 2012)
 136
 137 - Implemented find with `/` and `n/N`
 138 - Added `ar` and `aR` commands to reload pages in all open tabs.
 139 - Added a preference that enables bluring from any element that has input focus in the browser on Esc keydown (on by default)
 140 - Fixed bug where markers and help dialog would blow up some of the pages.
 141 - Marker hints are now sorted with respect to the underlying element area. Elements with larger area get shorter hints
 142 - Added *mail.google.com* to the default black list
 143 - Various bug fixed and improvements.
 144
 145 0.4.1, 0.4.2 (12-14 Dec 2012)
 146
 147 - Small tweaks of the find feature.
 148 - Bugfix for keyboard handling on non-english keyboard layouts
 149
 150 0.4.3 (27 Dec 2012)
 151
 152 - Toolbar button bugfix
 153 - Added an option to disable individual commands via the help dialog
 154
 155 0.4.4 (30 Jan 2013)
 156
 157 - Thanks to @mozillazg and @mcomella for translation contributions.
 158 - Added `gh` command that will navigate to the home page.
 159 - Added `o` command to focus address bar.
 160 - `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.
 161 - Now hint markers for links will stay on top of all the markers for different kinds of elements.
 162 - Esc will now also close the focused default search bar.
 163 - Fixed bugs related to keyboard events handling, XUL documents, and some other issues.
 164 - Bug fixed where not all the commands could be disabled via the Help dialog.
 165
 166 0.4.5 (12 Mar 2013)
 167
 168 - `:` to open Firefox Developer Toolbar, `Esc` to close it.
 169 - Add Hungarian locale (@thenonameguy).
 170 - Add Polish locale (@grn).
 171 - Don't close pinned tabs when pressing x (@grn).
 172 - Switched to Makefile for building the extension release (@carno).
 173 - Mrakers CSS tweaks (@helmuthdu)
 174
 175 0.4.6 (27 Mar 2013)
 176
 177 - Reimplemented find mode: CJK support, performace boost
 178 - `a/` or `a.` to highlight all matches of the search string on the page
 179 - Hint markers will now reach into iframes
 180 - Key handling is disabled when a popupmenu or panel are shown
 181 - `yf` will now also focus links and copy values from text/textarea element
 182 - `vf` will show hit markers to focus the underlying element