Skip to content

Latest commit

 

History

History
133 lines (83 loc) · 7.21 KB

README_CN.md

File metadata and controls

133 lines (83 loc) · 7.21 KB

Surfingkeys -- 用javascript和键盘扩展你的chrome

Surfingkeys和现有的一些插件，如philc/vimium和1995eaton/chromium-vim一样，让你尽可能的通过键盘来使用chrome浏览器，比如跳转网页，上下左右滚屏。但不只是给vim用户使用，Surfingkeys的基本特性是让你自己写一段Javascript脚本，然后通过mapkey映射到某些按键。之后当你按了那几个键以后，对应的Javascript脚本就会被执行。

我先是用了一年的vimium，大概半年前又切到了chromium-vim。之所以要自己重新造一个类似的轮子，是因为我发现要在这些插件里加上我自己的需求，需要改很多地方。比如，我就试图把下面这两个功能加入其中

  • 用某种搜索引擎搜索选中的文本
  • 双击某个单词获取中文翻译

Surfingkeys的配置全部写在一段javascript中，很容易添加自己的映射按键。如：

mapkey('c-y', 'Show me the money', function() {
    alert('a well-known phrase uttered by characters in the 1996 film Jerry Maguire');
});

配置参考.

演示

哪些功能是Surfingkeys不同于其他插件的？

  • 所有配置都用javascript描述，易于修改添加自己的按键。
  • 一个大号光标，这样visual mode不会太痛苦。
  • 我最喜欢的功能 -- 搜索选中文本，在normal mode和visual mode都好用。
  • 自动生成帮助信息。
  • 在visual mode下，按* 可以搜索当前单词。
  • 滚动操作（像e d上下翻页之类）可以在顶层页面工作，也可以在一个支持滚动的DIV中使用。
  • 在一个有多个frame的页面中，w可以切换frame。

快速上手

安装本插件以后，打开你要访问的站点。先按u或者Ctrl-i看看帮助信息，按Esc可以关掉帮助信息。

试试帮助信息里的那些按键，比如，e向上翻页，d向下翻页，se打开设置。

Surfingkeys支持的模式

Surfingkeys目前只有两种模式。

Normal mode，默认模式

通过函数mapkey添加的所有按键都只在这种模式下有用。

Visual mode，用于选中文本，以及各种针对选中文本的操作

除了通过函数vmapkey添加的所有按键在这种模式下有用，此外还有一些内置类似vim的按键，如j k h l b w``0 $等。

按v可以切换visual mode。在visual mode下，你会在页面底部看到一个提示 -- Caret或者Range，页面中还有一个大号的光标。光标做得这么大，是让人在页面中好找到它。

Caret 表明当你按jkhl时会移动光标，Range则表明你移动光标会选择文本。下面有个小练习：

  1. 按下v，确认你能看到Caret提示和光标。
  2. 使用j k h l b w``0 $试试移动光标。
  3. 再按下v，确认你看到Range提示。
  4. 使用j k h l b w``0 $试试选中文本。
  5. 按下sg看看发生了什么。
  6. 再按下v回到normal mode。

查找

查找不是模式，但是它会让你自动进入visual mode. 按/打开查找栏，输入你要查找的文字，你会看到所有匹配的文字会被高亮。按回车完成查找，这时你会自动进入visual mode -- Caret。按n定位下一个，N定位前一个。

搜索选中文本

从使用Firefox时起，我就必装的一个插件。无论Firefox还是Chrome，我用的插件都是通过右键菜单来实现的。Surfingkeys则通过按键来实现。默认情况下，当你在normal mode下按sg，Surfingkeys会打开google搜索选中文本，如果没有文字被选中，则搜索系统剪贴板里面的文字。在visual mode下，它只会搜索选中文本。

sg里面的g是个别名，用于google，还有其他一些内置的别名，如b是百度的别名。这样当你按sb的时候就是使用百度来搜索选中文本。参考在搜索栏里添加搜索别名来添加你自己的搜索别名，尤其那些用于公司内部的搜索。

类vim标示

简单说，vim中的marks就是按m，然后跟一个字符（0-9，A-Z，a-z），标示一下当前网址。之后，你随时按'跟上你定义的那个标示符，就会跳转到该网址。

除了m键创建标示外，你还可以从收藏夹里按住Ctrl，加上标示符来创建。如下：

  1. 按下b打开收藏夹。
  2. 随便输点啥，定位到你要标示的网址。
  3. 按住Ctrl，加上你选中的标示符，比如f。

之后，按'f就可以直接打开该网址来。

这个功能对那些你需要经常访问对网址很有用，两个键直达。om可以查看你已创建的标示。

配置参考

添加一个按键映射

mapkey(keystroke, help_string, action_code)
参数 含义
keystroke 触发某个操作的按键
help_string 帮助描述，会自动出现在u打开的帮助小窗里。
action_code 一段Javascript代码，或者一个Javascript函数。 
vmapkey(keystroke, help_string, action_code)

用于visual mode

在搜索栏里添加搜索别名

addSearchAlias(alias, prompt, search_url, suggestion_url, callback_to_parse_suggestion);
参数 含义
alias 一个以上字符，用作搜索别名。当你在搜索栏里输入它之后，再按空格键，会切换到对应的搜索引擎。
prompt 提示符，说明当前所用搜索引擎。
search_url 搜索引擎搜索地址。
suggestion_url[可选] 搜索自动完成URL，如果提供的话，搜索栏会列出相关关键字。
callback_to_parse_suggestion[可选] 解析suggestion_url返回的内容，列出相关关键字。 
addSearchAliasX(alias, prompt, search_url, search_leader_key, suggestion_url, callback_to_parse_suggestion);

这是一个扩展版本，除了往搜索栏里添加搜索别名，还会创建一个按键映射，由search_leader_key加上alias组成，对应的操作就是搜索选中文本。比如，下面这行，

addSearchAliasX('s', 'stackoverflow', 'http://stackoverflow.com/search?q=', 'o');

就相当于

addSearchAlias('s', 'stackoverflow', 'http://stackoverflow.com/search?q=');
mapkey('os', 'Search Selected with stackoverflow',  'searchSelectedWith("http://stackoverflow.com/search?q=")');
vmapkey('os', 'Search Selected with stackoverflow',  'searchSelectedWith("http://stackoverflow.com/search?q=")');

搜索栏辅助函数

OmnibarUtils.listWords(<array of words>)
OmnibarUtils.html(<any html snippets>)

添加一个迷你查询

迷你查询很像一个搜索引擎，不同的是，它把查询结果直接在小窗里显示出来，而不是打开一个新页。

addMiniQuery(alias, prompt, search_url, callback_to_display_result);

License

MIT License