Skip to content

Commit b199ba6

Browse files
Merge pull request #11 from PANDAJSR/main
2 parents 116d361 + 51e1776 commit b199ba6

3 files changed

Lines changed: 89 additions & 0 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@ export default defineConfig({
3939
],
4040
},
4141
],
42+
'/dev/': [
43+
{
44+
text: '开发文档',
45+
collapsed: false,
46+
items: [
47+
{ text: 'URI 协议', link: '/dev/uri' },
48+
],
49+
},
50+
],
4251
},
4352
search: {
4453
provider: "local",

docs/dev/uri.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Ink Canvas 外部协议 (URI Scheme) 说明文档
2+
3+
Ink Canvas 支持通过自定义协议 `icc://` 进行外部调用。通过此功能,其他应用程序、网页脚本或系统快捷方式可以远程控制 Ink Canvas 的运行状态。
4+
5+
## 启用方法
6+
7+
在使用外部协议之前,必须先在软件设置中启用:
8+
1. 打开 **软件设置**
9+
2. 进入 **高级选项** 面板。
10+
3. 找到 **外部协议调用** 区域。
11+
4. 开启 **“启用外部协议 (icc://)”** 开关。
12+
13+
> **注意**:此操作会自动在系统注册表中为当前用户注册协议。如果手动关闭该功能,协议将被注销。
14+
15+
---
16+
17+
## 命令列表
18+
19+
### 1. 基础控制命令
20+
21+
| 命令 | 完整 URI | 作用 |
22+
| :--- | :--- | :--- |
23+
| **Fold** | `icc://fold` | 进入**收纳模式**。如果当前处于展开状态,将清空墨迹并折叠到侧边栏。 |
24+
| **Unfold** | `icc://unfold` | 退出**收纳模式**。如果当前已折叠,将展开浮动工具栏。 |
25+
| **Toggle** | `icc://toggle` | **切换**状态。已展开则收起,已收起则展开。 |
26+
| **Show** | `icc://show` |`unfold` 作用相同,用于兼容旧版指令。 |
27+
28+
### 2. 侧边栏工具命令
29+
30+
以下命令对应收纳模式下侧边栏提供的快速工具。
31+
32+
| 命令 | 完整 URI | 作用 |
33+
| :--- | :--- | :--- |
34+
| **单次抽** | `icc://randone` | 打开随机点名窗口并执行**单次抽选**|
35+
| **随机抽** | `icc://rand` | 打开随机点名窗口并执行**随机抽选**|
36+
| **计时器** | `icc://timer` | 打开**计时器/倒计时**工具。 |
37+
| **白板** | `icc://whiteboard` | 切换到**白板模式**(也可使用 `icc://board`)。 |
38+
39+
### 3. 进阶功能命令 (隐藏功能)
40+
41+
以下功能专门用于解决与第三方侧边栏或悬浮窗程序的兼容性问题,未在常规设置界面显示。
42+
43+
| 命令 | 完整 URI | 作用 |
44+
| :--- | :--- | :--- |
45+
| **ThoroughHideOn** | `icc://thoroughHideOn` | **开启**“收起时彻底隐藏”功能。开启后,进入收纳模式时主窗口将完全不可见。 |
46+
| **ThoroughHideOff** | `icc://thoroughHideOff` | **关闭**“收起时彻底隐藏”功能。恢复默认的侧边栏边缘留痕模式。 |
47+
| **ThoroughHideToggle** | `icc://thoroughhidetoggle` | **切换**“收起时彻底隐藏”功能的开启/关闭状态。 |
48+
49+
---
50+
51+
## 使用示例
52+
53+
### A. 在浏览器中调用
54+
可以直接在浏览器地址栏输入并回车,或在 HTML 中使用超链接:
55+
```html
56+
<a href="icc://fold">立即收纳 Ink Canvas</a>
57+
```
58+
59+
### B. 在 Windows “运行”对话框中使用
60+
按下 `Win + R`,输入 `icc://toggle` 并回车。
61+
62+
### C. 在批处理或命令行中使用
63+
```cmd
64+
start icc://unfold
65+
```
66+
67+
---
68+
69+
## 开发者说明
70+
71+
### 运行机制
72+
1. **唤醒启动**:如果 Ink Canvas 尚未运行,调用 URI 会直接启动程序并执行命令。
73+
2. **进程间通信 (IPC)**:如果程序已经在运行,外部调用会启动一个临时的指令传递进程,通过系统事件和临时文件将指令发送给已运行的实例,实现无缝控制。
74+
75+
### 兼容性
76+
* 支持 Windows 7 及更高版本。
77+
* 注册表位置:`HKEY_CURRENT_USER\Software\Classes\icc` (无需管理员权限)。

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ hero:
2121
- theme: alt
2222
text: 使用指南
2323
link: /guide/instruction-manual
24+
- theme: alt
25+
text: 开发文档
26+
link: /dev/uri
2427

2528
features:
2629
- icon: 🖊️

0 commit comments

Comments
 (0)