docs: 文档更新

This commit is contained in:
ZiuChen 2023-11-16 23:24:07 +08:00
parent 0b16bed85a
commit f55842e2ac
10 changed files with 29 additions and 222 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 234 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 200 KiB

View File

@ -6,71 +6,21 @@ aside: false
# 使用指南
## 快捷键一览
## 二进制监听程序在 MacOS 的特殊配置
- 按下`空格`进入多选模式,连续向下选择 支持**跨标签**合并复制/粘贴
- `鼠标左键`复制并粘贴 `鼠标右键`仅复制
- `↑` `↓`选中历史记录 按下`↵`直接粘贴 `Ctrl+C`仅复制
- `←` `→`切换分类 `Tab`键连续切换分类
- `Ctrl+数字键`快速粘贴 `Alt+数字键`快速复制
- `输入任意字母或数字/Ctrl+F`聚焦搜索框并输入 支持使用`空格`同时检索多个关键词
- `Ctrl/Command+鼠标左键`点击文本/图片/文件 直接进入预览/打开所在文件夹 <Badge type="warning" text="插件会员" />
- <code>`</code>快速展开/收起预览面板 <Badge type="warning" text="插件会员" />
- `H` `J` `K` `L`键盘操作模式下Vim快捷键 支持上下左右移动 <Badge type="warning" text="插件会员" />
## 如何手动安装`clipboard-event-handler`
新版 `超级剪贴板` 对剪贴板内容更新事件的监听,依赖于可执行文件:
- Windows系统: `clipboard-event-handler-win32.exe`
- Linux系统: `clipboard-event-handler-linux`
- MacOS系统: `clipboard-event-handler-mac`
::: warning
适配了Apple M1芯片的监听程序 [clipboard-event-handler-mac-apple-silicon-arm64-M1](https://github.com/wangyw6716/clipboard-event-handler-mac-apple-silicon-arm64-M1)
由于此仓库不在超级剪贴板开发者维护范围内,请自行注意辨别文件安全性。
:::
插件每次启动时,将自动检查剪贴板数据文件所在目录下是否存在剪贴板监听程序,如存在,则使用性能更优秀的新的监听策略,如不存在,则仍然使用旧的策略。
----
### 1. 下载监听程序
请[点击此处(百度网盘)](https://pan.baidu.com/s/14GJIXWDU2F4jsqDDq73aFg?pwd=Ziuc)或访问[node-clipboard-event](https://github.com/sudhakar3697/node-clipboard-event/tree/master/platform)手动下载**对应系统**的文件,并将其移动到**剪贴板数据文件所在目录**下
插件使用的二进制文件拷贝自[node-clipboard-event](https://github.com/sudhakar3697/node-clipboard-event),请避免从其它不可信的来源下载文件,并在下载文件后比较哈希,有能力的也可以从仓库源代码自行编译
### 2. 找到剪贴板数据文件所在目录
进入设置页(顶部导航栏/齿轮图标),点击数据库路径这一项右侧的打开按钮
### 3. 将监听程序拷贝到目录中
#### Windows:
![](../assets/gi3.png)
#### Linux:
![](../assets/gi3-2.png)
#### Mac:
![](../assets/gi3-3.png)
### 4. 注意事项
#### MacOS 的特殊配置
针对`MacOS`系统,在将剪贴板监听程序拷贝到指定目录后,请在重启插件后,**进入设置页,检查监听程序是否生效**
针对`MacOS`系统,在将剪贴板监听程序拷贝到指定目录后,请在重启插件后,检查监听程序是否生效
如果监听程序未生效,可能是:
1. 需要下载对应芯片的监听程序
2. 需要对程序进行签名与授权
::: warning
适配了Apple M1芯片的监听程序 [clipboard-event-handler-mac-apple-silicon-arm64-M1](https://github.com/wangyw6716/clipboard-event-handler-mac-apple-silicon-arm64-M1)
由于此仓库不在超级剪贴板开发者维护范围内,请自行承担文件安全性带来的风险。
:::
**1. 签名**
打开终端输入以下命令
@ -87,20 +37,10 @@ sudo codesign --force --deep --sign -
**2. 授权**
*左上角🍎* -> *系统偏好设置* -> *安全性与隐私* -> *通用* -> *点击允许*
左上角🍎 / 系统偏好设置 / 安全性与隐私 / 通用 / 点击允许
![](../assets/mac-chmod.jpg)
#### 监听程序不生效如何排查?
请务必完整按照教程完成安装,如果程序仍未生效,请按照如下方式排查:
- 监听程序拷贝完成后,需要重启插件方可生效
- 设置页`剪贴板监听程序状态`选项是否为`已安装`
- 系统进程管理器中是否存在`clipboard-event-handler-xxxxx`的进程
使用中遇到任何问题,请尝试通过论坛或入群反馈
## 如何创造自己的功能按钮
超级剪贴板为用户提供了自定义功能按钮的能力

View File

@ -21,7 +21,6 @@ aside: false
{ content: '⭐ 开源代码', target: 'https://github.com/ZiuChen/ClipboardManager' },
{ content: '🚀 使用指南', target: './guide/' },
{ content: '🌎 疑难解答', target: './statement/' },
{ content: '👑 插件会员', target: './vip/' },
{ content: '🚚 更新日志', target: './log/' },
]
}
@ -46,22 +45,14 @@ aside: false
**首次安装需要设置“跟随主程序同时启动”**
- ✅ 监听剪贴板并持续将新内容更新到本地磁盘 数据读写**完全本地化**
- ✅ 快速`收藏`/`转存`/`分词`/`复制`/`删除`/`打开文件&目标文件夹`
- ✅ 功能按钮 定义**无限可能** `OCR识别` `百度搜索` `百度识图` `统计文本字数` `颜色管理` `识别图片中二维码` `上传到图床` `翻译`
- ✅ `鼠标左键` 复制并粘贴 `鼠标右键` 仅复制
- ✅ 按下`空格`进入**多选模式** 连续选择多条内容合并复制 支持**跨标签**合并复制/粘贴
- ✅ 键盘 `↑` `↓` 选中历史记录,按下回车直接粘贴
- ✅ 键盘 `←` `→`切换分类 `Tab`键连续切换分类
- ✅ 使用 `Ctrl/Alt+数字键` 快速粘贴
- ✅ 插件内`输入任意字母或数字`自动聚焦搜索框 支持使用`空格`同时检索**多个关键词**
- ✅ **超级Markdown**合并剪贴板内容导出图文 **超级粘贴** 直接转存为文件 **智慧分词** 快速拖选指定内容
- ✅ 优雅的界面动效与交互 跟随系统的深色模式
- ✅ 优秀的剪贴板监听性能 强大的自定义功能按钮 自搭建多端同步 ···
- ✅ 监听剪贴板并持续将新内容更新到本地磁盘 数据加密保存在本地
- ✅ 支持置顶、收藏、编辑、转存、多选、WebDAV同步、局域网共享等强大功能
- ✅ 强大的工具栏,支持自定义快捷动作,定制自己的工作流
- ✅ 优雅的界面动效与交互 高度自定义的配置选项 深色模式模式适配
## 📚 安装方式
- 官方插件市场安装
- 离线插件安装:[百度网盘](https://pan.baidu.com/s/14GJIXWDU2F4jsqDDq73aFg?pwd=Ziuc)
[催更群 769115389](https://qm.qq.com/cgi-bin/qm/qr?k=9qfHKTaQuWqYN1ys1yiQPdJ4iIlHwgL5&jump_from=webapi) [Github](https://github.com/ZiuChen)
[Github](https://github.com/ZiuChen)

View File

@ -6,26 +6,28 @@ aside: false
# Q&A
## 如何设置快捷键快速打开插件
uTools 个人中心 / 全局快捷键 / 将 `Clipboard` 设置为你想要的快捷键
即可通过快捷键快速唤出超级剪贴板插件
## 插件启动时报错/白屏
请依次尝试以下方法:
请尝试以下方法:
1. 完全退出插件后重新启动插件
2. 重新启动 uTools
3. 删除本地数据库文件位于C盘用户根目录下 文件名为`_utools_clipboard_manager_storage`
4. 格式化 uTools 内的插件数据 (账号与数据/查看存储的文档数据)
3. 格式化 uTools 内的插件数据 (个人中心/数据存储) 这不会清空你的本地数据
4. 删除本地数据库目录(全局搜索 `super-clipboard-data` 文件夹)
如果上述方法都无法解决你的问题,欢迎论坛回帖或加入QQ群 769115389 交流具体情况
如果上述方法都无法解决你的问题,欢迎论坛回帖交流具体情况
## 自动粘贴(自动上屏)功能失灵了
目前已知:自动粘贴功能在 `Windows微信` 的聊天输入框内是不可用的。在其他场景下,此功能都能够正常使用
## 插件内操作延迟、卡顿
插件内复制/收藏/删除操作卡顿,可能是因为数据文件过大。
当插件内的操作有明显延迟卡顿时,请尝试清理无用的图片记录,可以帮你显著地降低数据文件体积,提高插件响应速度
此外,建议你保持 uTools 与插件版本更新,避免使用旧版 uTools 导致兼容性问题
## 剪贴板记录丢失
@ -37,39 +39,15 @@ aside: false
- 在插件列表主动退出了插件
- 插件在高频复制的场景下,可能会漏掉某些记录
## 如何设置快捷键快速打开插件?
uTools偏好设置 / 全局快捷键 / 将`Clipboard`设置为你想要的快捷键
后续通过快捷键即可快速唤出插件
## 为什么偶尔CPU占用特别高? 为什么预览图片时插件卡顿?
这是由`超级剪贴板`监听剪贴板内容更新的机制决定的,为了不漏数据,`超级剪贴板`的监听策略为每`300ms`读取一次剪贴板内容并与上一次读取到的内容作比较。如果剪贴板当前位置是一张大图片,那么插件会反复读取这张图片,导致大量计算被用在了无意义的读取与对比上。
插件市场中相同原理的同类插件的处理方法是:
- 轮询比较两次剪贴板内容,如果检查到当前剪贴板内容数据量较大,则降低轮询时间间隔。
- 这避免了读取大图片/长文本时的高占用,然而这很容易导致漏数据
- 轮询比较两次剪贴板内容,由用户自定义轮询时间
- 用户设置的轮询间隔时间长,读取大图片/长文本时不会导致高占用,但很容易漏数据。
- 用户设置的轮询间隔时间较短,则又会造成高占用
`v1.4.0`版本更新中,`超级剪贴板`换用了[`clipboard-event`](https://github.com/sudhakar3697/node-clipboard-event)库监听剪贴板更新事件这种方式性能更优不需要反复读取剪贴板内容来做比较而只需要在检查到剪贴板更新事件时通知插件读取一次剪贴板即可完全解决了CPU占用高、浏览图片卡顿的问题。
然而该库包含了二进制文件这触发了uTools插件市场的安全限制而**无法上架**。所以自`v1.4.2`起,插件不再内置监听剪贴板更新事件的二进制文件,用户要使用**低占用、高性能的剪贴板监听方案**,可以自行下载并将其移动到剪贴板数据库文件所在目录,详见[如何手动安装`clipboard-event-handler`](../guide/),插件会自动判断使用新的抑或是旧的方案监听剪贴板更新。同时,自`v1.4.3`起,你可以在设置页查看当前剪贴板监听程序的运行状态。
## 为什么官方的剪贴板插件没有CPU占用高这个问题?
官方的剪贴板内容更新事件监听函数也是从一个二进制文件引出的,这个二进制文件跟随主程序启动,不受剪贴板插件的打开或关闭的影响。
使用中遇到任何问题,请通过论坛反馈
## 我对这个插件的安全性有担忧, 插件偷窃我的隐私怎么办?
首先, 我写这个插件不是为了获取你的隐私的, 我对你的隐私没有兴趣, 这一点你完全可以放心;
其次uTools官方在插件上架前会对代码进行审查, 如果插件有高危行为, 那也不会过审;
其次 uTools 官方在插件上架前会对代码进行审查, 如果插件有高危行为, 那也不会过审;
再其次, uTools大部分用户是程序员, 如果我真的在代码里藏了"毒", 那他们也有办法发现, 如果你真的对你的隐私十分关心, 可以选择从[开源仓库](https://githubcom/ZiuChen/ClipboardManager)下载代码自行构建
再其次, uTools 大部分用户是程序员, 如果我真的在代码里藏了"毒", 那他们也有办法发现, 如果你真的对你的隐私十分关心, 可以选择从[开源仓库](https://githubcom/ZiuChen/ClipboardManager)下载代码自行构建
## 开源版本和插件市场版本的区别?

View File

@ -1,92 +0,0 @@
---
navbar: false
sidebar: false
aside: false
---
# 插件会员
:::tip
超级剪贴板是一款 “随心所欲” 的软件。您可以永久免费使用它。
但是,如果您真的喜欢它,您可以付费支持它的发展。作为答谢,您将获得更多更方便的功能。这取决于您,如果您不想,也没关系。谢谢你,祝你有美好的一天!☀️
:::
## 会员权益
- **插件会员**
- `WebDav数据多端同步` <Badge type="tip" text="已上线" />
- `支持保存2000条历史记录` <Badge type="tip" text="已上线" />
- `不限制历史记录过期时间` <Badge type="tip" text="已上线" />
- `文本/图片/文件预览增强, 按住Ctrl/Command点击 解锁更多操作` <Badge type="tip" text="已上线" />
- `键盘操作模式 Vim快捷键` <Badge type="tip" text="已上线" />
- `简洁模式 隐藏页面中不必要的组件与元素` <Badge type="tip" text="已上线" />
- `自定义分类排序` <Badge type="tip" text="已上线" />
- `预览页代码高亮 预览快捷键` <Badge type="tip" text="已上线" />
- `关闭剪贴板图片记录` <Badge type="tip" text="已上线" />
- `插件使用统计` <Badge type="tip" text="已上线" />
- **...**
- **uTools会员**
- `插件使用统计` <Badge type="tip" text="已上线" />
## 会员定价
::: warning
- **插件会员为大版本买断制,购买后即可享用当前版本(2.x)后续所有更新的会员内容**
- 插件会员为虚拟商品,购买后不支持退款
- 插件会员的价格是浮动的,随着功能和权益的增加,不排除涨价的可能
- 购买插件会员后若未能及时到账,请[加入QQ群](https://jq.qq.com/?_wv=1027&k=fURjGVJr)反馈
:::
插件会员定价`9.9元`,登录 uTools 账号后,点击插件导航栏中个人中心图标进入购买页面
购买后可使用会员功能,不购买不影响基本功能的使用,希望大家多多理解,按需购买
## WebDav同步功能
:::warning
如果剪贴板数据体积过大,可能出现同步时间过长、同步失败等问题
建议及时删除保存在超级剪贴板内的图片,或**关闭记录图片到剪贴板**
:::
插件会员支持通过WebDav同步剪贴板数据
获取服务器地址、账号、密钥后,仅需在**插件内的设置页面**添加WebDav配置
每次本地数据库发生变化,都会将最新数据同步到同步到服务器(须开启插件内的自动同步 否则需要手动同步)
![WebDav](../assets/vip-webdav.png)
- 如果配置了WebDav 则每天第一次进入插件时会自动从服务器拉取最新数据
- 如果设置了自动同步 每次本地数据变化将自动同步本地数据到服务器
- 插件会缓存云端数据文件的ETag 如果云端数据有更新 则采用云端数据覆盖本地数据
- 数据文件的上传和下载都开启了gzip以节省流量与带宽
- **清空本地数据库的同时也会触发云端文件清空**
- 可以选择**关闭图片记录** 以降低同步的数据文件体积 提高同步效率
- 插件仅在每次启动时主动从云端拉取数据 云端数据的更新不会自动同步到本地
- 可以通过点击工具栏按钮主动拉取云端数据到本地或上传数据到云端
相关链接:
- [Infini Cloud](https://infini-cloud.net/en/) (国内可用 无限制)
- [坚果云 WebDav](https://help.jianguoyun.com/?tag=webdav)(国内可用 限制调用次数)
- [2022年还有哪些支持WebDAV的网盘](https://www.zhihu.com/question/347182171)
## 代码高亮功能
插件使用Shiki作为代码高亮库为了压缩插件体积、提高代码执行效率其相关依赖都将从CDN动态加载
支持在设置页修改代码高亮的主题、可选语言、CDN地址**设置的首个语言为展开预览后的默认语言**
![HighLight](../assets/vip-highlight.png)
- 默认CDN地址: `https://unpkg.com/shiki@0.14.1/`
- 默认主题: `one-dark-pro`
- 默认语言: `javascript` `css` `html` `json` `markdown` `php` `python` `ruby` `shellscript` `sql` `java` `c` `cpp` `csharp` `go`
更多可用主题/语言见Github仓库[Shiki](https://github.com/shikijs/shiki)
## 更多内容
[疑难解答](../statement/index.md)

View File

@ -12,15 +12,5 @@ aside: false
----
- Q: 我支付了,但是没有收到额度
- A: 支付成功后,插件会自动获取最新用户信息,如果信息没有自动更新,请尝试退出插件后重新进入,如果仍未收到额度,请加入[QQ群 769115389](https://qm.qq.com/cgi-bin/qm/qr?k=9qfHKTaQuWqYN1ys1yiQPdJ4iIlHwgL5&jump_from=webapi)并联系我,我会尽快核实并为你解决
----
- Q: 我之前赞赏过,可以有优惠吗
- A: 2022年9月13日0:00前赞赏过我的uTools用户请发送
- `UUID`(超级分词插件内展示)
- `赞赏金额`
- `赞赏时间`
- `支付截图`
- 到邮箱`ZiuChen@outlook.com`,邮箱主题为:`申请超级分词赞赏额度`,我将在核实后为你提供`赞赏金额+15%`的额度,感谢你的支持!💖。
- A: 支付成功后,插件会自动获取最新用户信息,如果信息没有自动更新,请尝试退出插件后重新进入,如果仍未收到额度,请通过论坛联系我,我会尽快核实并为你解决