Skip to content

Commit

Permalink
docs: Add Config Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Pylogmon committed Nov 8, 2023
1 parent 73b0e2c commit 2e714da
Show file tree
Hide file tree
Showing 6 changed files with 161 additions and 4 deletions.
39 changes: 39 additions & 0 deletions vitepress/docs/config/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,42 @@
title: Pot
titleTemplate: 备份设置
---

# 备份设置

## 备份内容

1. 配置文件 `config.json`
2. 安装的插件
3. 历史记录 `history.db`

## 本地备份

### 备份

1. 选择 `本地备份` 后点击备份按钮
2. 选择保存路径
3. pot会将所有备份内容打包为zip保存到选择的路径

### 恢复

1. 选择 `本地备份` 后点击恢复备份按钮
2. 选择备份文件
3. pot会将备份内容恢复到指定路径

## WebDav

### 备份

1. 选择 `WebDav`
2. 填写账号信息,所有支持WebDav的服务都是可以的
3. 填写完成后点击备份
4. pot会将所有备份内容打包后上传

### 恢复

1. 选择 `WebDav`
2. 填写账号信息,所有支持WebDav的服务都是可以的
3. 填写完成后点击恢复备份备份
4. 在备份列表中选择需要恢复的备份
5. pot会将备份文件下载后恢复到指定路径
11 changes: 11 additions & 0 deletions vitepress/docs/config/hotkey.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,14 @@
title: Pot
titleTemplate: 快捷键设置
---

# 快捷键设置

软件的四个基本功能都支持分别设置快捷键
注意,pot只支持标准的组合按键,不支持双击之类的非标准快捷键,以后也不会支持,如有需求请借助第三方按键映射来实现。

## 快捷键设置失败

### Wayland

Tauri的快捷键方案暂时还不支持Wayland,所以pot内的快捷键设置在Wayland下无法使用,请参考 [外部调用](/docs/invoke.html) 在系统自定义快捷键中通过`curl`命令来调用pot。
4 changes: 0 additions & 4 deletions vitepress/docs/config/index.md

This file was deleted.

22 changes: 22 additions & 0 deletions vitepress/docs/config/recognize.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,25 @@
title: Pot
titleTemplate: 文字识别设置
---

# 文字识别设置

## 识别语言

大多数识别引擎都需要指定识别语言,一些在线的引擎支持自动检测语言,所以请根据需求来考虑是否设置为自动检测,不支持自动检测的识别引擎如果设置为自动检测,会自动使用中文或英文进行识别。

## 自动删除换行

识别完成后删除文本中的换行符。

## 自动复制

识别完成后自动复制识别结果。

## 失去焦点时关闭窗口

窗口失去焦点时自动关闭窗口

## 隐藏识别窗口

配合自动复制使用,开启此选项后,截图后不会出现识别窗口,识别完成后自动复制到剪切板。
12 changes: 12 additions & 0 deletions vitepress/docs/config/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,15 @@
title: Pot
titleTemplate: 服务设置
---

# 服务设置

服务设置为pot软件的核心设置,所有接口设置都在这里配置。

## 内置服务

pot内置了很多接口,这些接口有些是不需要配置可以直接使用的,有些是需要自己申请API服务的,如有需要请参考[API 服务申请 ](/docs/api/)

## 外部插件

参考 [外部插件](/docs/plugin) 章节
77 changes: 77 additions & 0 deletions vitepress/docs/config/translate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,80 @@
title: Pot
titleTemplate: 翻译设置
---

# 翻译设置

## 源语言

所翻译内容的语言,建议选择`自动检测`

## 目标语言

翻译后的默认目标语言

## 第二目标语言

当检测到源语言与目标语言相同时会自动翻译为第二目标语言,这在两种语言互相翻译时非常有用。

## 语种检测引擎

用来检测语种的引擎,本地引擎速度很快,不需要联网,但是内存占用很高,请按需选择。

另外,如果无法访问Google,请不要选择`Google`,这样会导致无法翻译。

## 自动复制

翻译后自动复制内容,支持复制`原文``译文``原文+译文`

## 增量翻译

开启此选项之后,划词翻译后保持翻译窗口不要关闭,再次触发划词翻译可以将所选内容追加到翻译窗口中,这在翻译多页内容时非常有用。

## 动态翻译

开启此选项之后,在输入翻译时会自动触发翻译,不需要点击翻译按钮或按回车。

## 自动删除换行

开启此选项后将会自动删除划词翻译所选内容中的换行符,这在pdf中进行划词翻译时非常有用。

## 记住目标语言

开启此选择之后,在翻译面包中切换目标语言会更改设置中的目标语言选项。

## 字体大小

注意,字体大小只对翻译窗口中的原文和译文有效。

## 窗口位置

- 跟随鼠标:默认模式,翻译窗口会在鼠标所在位置出现。
- 记住位置:翻译窗口会在上次关闭时的位置出现。

:::warning 多屏幕用户请注意
如果你最后一次关闭翻译窗口时,翻译窗口在第二屏幕上,如果这时候你拆除第二屏幕,pot保存的位置还是在第二屏幕,这会导致下次使用时在主屏幕上找不到翻译窗口。这时候只需要切换到`跟随鼠标`模式即可。
:::

## 记住窗口大小

开启此选项后,调整翻译窗口大小后会保存窗口大小,下次使用时会恢复到上次的大小。

## 失去焦点时关闭窗口

开启此选项后,翻译窗口会在失去焦点(即点击翻译窗口以外的其他地方)时自动关闭。

## 窗口默认置顶

开启此选项后,翻译窗口会默认保存在窗口最前端,此时失去焦点不会关闭窗口。

## 隐藏原文

不显示翻译面板中的原文区域。

## 隐藏语言栏

不显示翻译面板中的语言栏。

## 隐藏翻译窗口

此功能需要配合自动复制功能使用,开启此选项后,划词翻译时不弹出翻译窗口,翻译完成后将第一个翻译接口的结果复制到剪切板。

0 comments on commit 2e714da

Please sign in to comment.