一、概述

小书匠从 7.8.7 版本起，开始支持自定义快捷键功能。通过自定义快捷键，配合小书匠提供的内置命令，可以让用户编辑效率大幅度提升，达到事半功倍的效果。

二、快捷键管理

从小书匠主按钮>按键入口，可以进入快捷键管理界面。在该界面下可以管理快捷键与命令的映射关系。

一条命令可以添加多个快捷键映射，但一个快捷键无法执行多条命令。

三、应用内快捷键

1. 命令

小书匠提供了多种命令，不同的命令有不同的默认快捷键及监听范围，详细命令可以查看 小书匠命令说明。

1-1. ace 编辑器命令

1-2. codemirror 编辑器命令

1-3. 小书匠应用命令

2. 监听范围

系统提供的默认快捷键映射都有监听范围限制，小书匠应用命令只有在操作区，也就是非编辑区，非预览区内按键才会生效。而 ace 编辑器命令只有当用户使用了 ace 的内置编辑器，并且当前在编辑区内活动状态下，按键才会生效。 codemirror 编辑器命令也是一样的效果 ，只有当用户使用了 codemirror 的内置编辑器，并且当前在编辑区内活动状态下，按键才会生效。

通过自定义快捷键后，用户可以修改监听范围，对于用户新添加的快捷键，默认在编辑区和操作区都能监听到。

2-1. 编辑区

用户输入文字编辑的区域。用户在编辑区下输入或者选择文字等操作，就激活了编辑区。

2-2. 操作区

除去编辑区和预览区，剩下的区域就是操作区，比如文件列表面板， 工具栏等。

2-3. 预览区

目前小书匠没有实现预览区自定义快捷键功能，用户在预览区内按下的任何快捷键，都会返回给系统层面进行管理。

比如在 web 版本的小书匠里，在预览区激活状态下(可以在预览区里选中一些文字)，按下 ctrl+f，这时候只会触发浏览器自身的搜索功能，而不是在编辑区下对应的搜索框。

2-4. 全部

这里的全部仅指编辑区和操作区，不包括预览区和操作系统。

3. 按键定义

3-1. 单键

单键就是只需要按下一个键，就可以触发相应的命令。一般单键由常规的字符键组成，不建议使用 ctrl shift alt command 这些修饰键做为单键来使用。

过多的使用单键来映射命令，容易造成键盘上的按键不够使用，这时可以考虑使用组合键或者顺序键。

3-2. 组合键

组合键就是定义了需要同时按下的几个键才能触发相应的命令，组合键需要由 ctrl shift alt command 中的一个或者多个修饰键配合单键，也就是常见的字符键组成。

3-3. 顺序键

顺序键就是需要在一定时间内，依次按下键后才能触发执行相应的命令。顺序键可以由多个单键组成，也可以配合组合键来实现。

多个单键的顺序键, 比如 g i f, 当在键盘上顺序按下这些键时，就会触发相应的命令。

单键与组合键结合使用的顺序键， 比如 ctrl+f i t, 需要先同时按下 ctrl 和 f 两个键，然后松开，再依次按下 i 和 t 两个键才会触发相应的命令。

注: 如果定义了组合键映射命令，然后定义的顺序键映射命令里按键定义包含了组合键按键定义，则组合键对应的映射命令将失效。比如 ctrl+s 组合键映射命令为 save， 然后定义了顺序键 ctrl+s f 映射命令为 saveAs，则 ctrl+s 的组合键将失效，无法执行 save 命令。

3-3-1. 如何定义一个顺序按键

在定义完一个单键或者组合键后，等待一秒左右的时间，在按键录制区的左侧出现刚刚录制的按键信息后，就可以继续在按键录制区定义下一个顺序按键了。

四、操作系统快捷键

操作系统快捷键和应用快捷键不同，操作系统定义的快捷键映射的命令只能是小书匠客户端命令，无法使用其他命令，同样的，应用快捷键映射的命令只能是非小书匠客户端命令。

操作系统快捷键有最高的优先级，如果同时定义了操作系统快捷键和应用快捷键，将只会触发操作系统快捷键。

比如定义了操作系统范围的 ctrl+shift+h 按键到 toggleWindow 命令，同时定义了应用范围的 ctrl+shift+h 按键到 xsj_heading 命令，当按下快捷键 ctrl+shift+h, 只会执行 toggleWindow 命令。

操作系统快捷键并不需要当前小书匠处理活动状态，在小书匠窗口最小化，或者操作其他应用时，按下预先定义的快捷键，也会触发该快捷键对应的命令。（需要该操作系统快捷键不与其他应用冲突）

操作系统快捷键只支持单键或者组合键，不支持顺序键。

1. 小书匠客户端命令

操作系统级的快捷键只在小书匠客户端版本进行支持，用户每次修改后，需要重新启动小书匠来让快捷键生效。

定义操作系统快捷键对应的命令只能是小书匠客户端命令，其他命令(比如小书匠应用命令，ace 编辑器命令, codemirror 编辑器命令)无效。

所有小书匠客户端命令默认都没有快捷键，需要用户定义后才能生效。

详细的客户端命令，可以参考命令说明文档。

2. 如何定义一个操作系统快捷键

1. 在小书匠客户端下，快捷键管理界面的左下角有一个定义系统级按键

2. 在操作系统管理界面下定义快捷键

操作系统快捷键的定义与应用内的快捷键定义不同，除了每次修改完成后，需要重启才能生效外，操作系统快捷键定义需要用户输入合法的 json 数据格式来完成定义。

示例

将 ctrl+shift+h 快捷键定义成隐藏或者显示窗口

3. 按键名称

操作系统快捷键需要自己定义快捷键信息，没有像应用快捷键定义那样，提供一个按键录制功能。下面列出了操作系统快捷键支持的按键名称

1. 修饰按键

• Ctrl
• Alt
• Shift
• Command: Command 对应苹果系统的 (⌘) 按键与 Windows / Linux 的 按键

2. 其他支持的按键

• Alphabet: A-Z
• Digits: 0-9
• Function Keys: F1-F24
• Comma
• Period
• Tab
• Home / End / PageUp / PageDown / Insert / Delete
• Up / Down / Left / Right
• MediaNextTrack / MediaPlayPause / MediaPrevTrack / MediaStop
• Comma or ,
• Period or .
• Tab or \t
• Backquote or `
• Enter or \n
• Minus or -
• Equal or =
• Backslash or \
• Semicolon or ;
• Quote or '
• BracketLeft or [
• BracketRight or ]
• Escape

五、相关

1. 小书匠支持的命令说明