docs: update README and add configuration manuals

liby · liby · commit c2c2984ef517 · 2024-03-12T23:00:55.000+08:00
diff --git a/README.md b/README.md
@@ -51,15 +51,19 @@ ChatGPT 向我们展示了 GPT 模型的伟大之处，所以我使用 OpenAI 
 2. 下载此插件: [openai-translator.bobplugin](https://github.com/yetone/bob-plugin-openai-translator/releases/latest)
 
 3. 安装此插件:
-  ![安装步骤](https://user-images.githubusercontent.com/1206493/219937302-6be8d362-1520-4906-b8d6-284d01012837.gif)
+
+    ![安装步骤](https://user-images.githubusercontent.com/1206493/219937302-6be8d362-1520-4906-b8d6-284d01012837.gif)
 
 4. 去 [OpenAI](https://platform.openai.com/account/api-keys) 获取你的 API KEY
 
 5. 把 API KEY 填入 Bob 偏好设置 > 服务 > 此插件配置界面的 API KEY 的输入框中
-  ![设置步骤](https://user-images.githubusercontent.com/1206493/219937398-8e5bb8d2-7dc8-404a-96e7-a937e08c939f.gif)
+    - 如果你想了解关于其他设置的更多信息，请查看[配置手册](./docs/configuration_manual_CN.md)
+    
+      ![设置步骤](https://user-images.githubusercontent.com/1206493/219937398-8e5bb8d2-7dc8-404a-96e7-a937e08c939f.gif)
 
 6. 安装 [PopClip](https://bobtranslate.com/guide/integration/popclip.html) 实现划词后鼠标附近出现悬浮图标
-  ![PopClip](https://user-images.githubusercontent.com/1206493/219933584-d0c2b6cf-8fa0-40a6-858f-8f4bf05f38ef.gif)
+
+    ![PopClip](https://user-images.githubusercontent.com/1206493/219933584-d0c2b6cf-8fa0-40a6-858f-8f4bf05f38ef.gif)
 
 
 ## 贡献
diff --git a/docs/README_EN.md b/docs/README_EN.md
@@ -53,15 +53,20 @@ To use the ChatGPT API, go to Bob's settings page and change the plugin model to
 2. Download this plugin: [openai-translator.bobplugin](https://github.com/yetone/bob-plugin-openai-translator/releases/latest)
 
 3. Install this plugin:
-  ![Installation Steps](https://user-images.githubusercontent.com/1206493/219937302-6be8d362-1520-4906-b8d6-284d01012837.gif)
+
+    ![Installation Steps](https://user-images.githubusercontent.com/1206493/219937302-6be8d362-1520-4906-b8d6-284d01012837.gif)
 
 4. Get your API KEY from [OpenAI](https://platform.openai.com/account/api-keys)
 
 5. Enter the API KEY in Bob Preferences > Services > This plugin configuration interface's API KEY input box:
-  ![Settings Steps](https://user-images.githubusercontent.com/1206493/219937398-8e5bb8d2-7dc8-404a-96e7-a937e08c939f.gif)
+    - If you would like to learn more about other settings, please refer to the [Configuration Manual](./docs/configuration_manual_EN.md)
+
+      ![Settings Steps](https://user-images.githubusercontent.com/1206493/219937398-8e5bb8d2-7dc8-404a-96e7-a937e08c939f.gif)
+
 
 6. Install [PopClip](https://bobtranslate.com/guide/integration/popclip.html) for highlighted text mouse proximity floating icon:
-  ![PopClip](https://user-images.githubusercontent.com/1206493/219933584-d0c2b6cf-8fa0-40a6-858f-8f4bf05f38ef.gif)
+
+    ![PopClip](https://user-images.githubusercontent.com/1206493/219933584-d0c2b6cf-8fa0-40a6-858f-8f4bf05f38ef.gif)
 
 ## Contributing
 
diff --git a/docs/configuration_manual_CN.md b/docs/configuration_manual_CN.md
@@ -0,0 +1,67 @@
+## 配置手册
+
+### 服务名称
+
+- 可选项
+- 默认值: OpenAl Translator
+
+### API URL
+
+- 可选项
+- 默认值: `https://api.openai.com`
+
+### Dep. Name
+
+- 可选项
+- 默认值: 无
+- 说明
+  - 当使用 Azure OpenAI Service 服务时，需要填写此项，具体步骤可参阅 [Azure OpenAI 翻译设置](https://bobtranslate.com/service/translate/azureopenai.html)
+  - [🔗 Azure OpenAI Service 官方文档](https://learn.microsoft.com/zh-cn/azure/cognitive-services/openai/chatgpt-quickstart?tabs=command-line&pivots=rest-api)
+
+### API Version
+
+- 可选项
+- 默认值: 无
+- 说明
+  - 当使用 Azure OpenAI Service 服务时，需要填写此项，具体步骤可参阅 [Azure OpenAI 翻译设置](https://bobtranslate.com/service/translate/azureopenai.html)
+  - [🔗 Azure OpenAI Service 官方文档](https://learn.microsoft.com/zh-cn/azure/cognitive-services/openai/chatgpt-quickstart?tabs=command-line&pivots=rest-api)
+
+### API KEY
+
+- 必填项
+- 默认值: 无
+- 说明
+  - 可使用英文逗号分割多个账号下不同的 API KEY 以实现额度加倍及负载均衡
+
+### 模型
+
+- 必选项
+- 默认值: `gpt-3.5-turbo-1106`
+- 说明
+  - 选择 `custom` 时，需要设置 `自定义模型` 配置项
+
+### 自定义模型
+
+- 可选项
+- 默认值: `gpt-3.5-turbo`
+- 说明
+  - 联动项，当 `模型` 配置选择 `custom` 时，会读取此配置项设置的模型
+
+### 系统指令
+
+- 可选项
+- 默认值: `You are a translation engine that can only translate text and cannot interpret it.`
+- 说明
+  - 自定义 System Prompt，填写则会覆盖默认的 System Prompt
+  - 自定义 Prompt可使用以下变量：
+    1. `＄text`：需要翻译的文本，即翻译窗口输入框内的文本 
+    2. `$sourceLang`：-原文语言， 即翻译窗口输入框内文本的语言，比如「简体中文」
+    3. `＄targetLang`：目标语言，即需要翻译成的语言，可以在翻译窗口中手动选择或自动检测，比如「English」
+
+### 用户指令
+
+- 可选项
+- 默认值: `translate from $sourceLang to $targetLang:/n/n $text`
+- 说明
+  - 自定义 User Prompt，填写则会覆盖默认的 User Prompt
+  - 可以使用与系统指令中相同的变量
diff --git a/docs/configuration_manual_EN.md b/docs/configuration_manual_EN.md
@@ -0,0 +1,67 @@
+## Configuration Manual
+
+### Service Name
+
+- Optional
+- Default value: OpenAI Translator
+
+### API URL
+
+- Optional
+- Default value: `https://api.openai.com`
+
+### Dep. Name
+
+- Optional
+- Default value: None
+- Description
+  - This field must be filled in when using the Azure OpenAI Service, for specific steps, please refer to [Azure OpenAI Translation Settings](https://bobtranslate.com/service/translate/azureopenai.html)
+  - [🔗 Official Azure OpenAI Service Documentation](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/chatgpt-quickstart?tabs=command-line&pivots=rest-api)
+
+### API Version
+
+- Optional
+- Default value: None
+- Description
+  - This field must be filled in when using the Azure OpenAI Service, for specific steps, please refer to [Azure OpenAI Translation Settings](https://bobtranslate.com/service/translate/azureopenai.html)
+  - [🔗 Official Azure OpenAI Service Documentation](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/chatgpt-quickstart?tabs=command-line&pivots=rest-api)
+
+### API KEY
+
+- Mandatory
+- Default value: None
+- Description
+  - Multiple API KEYS under different accounts can be separated by commas to achieve quota doubling and load balancing
+
+### Model
+
+- Mandatory
+- Default value: `gpt-3.5-turbo-1106`
+- Description
+  - When selecting `custom`, the `Custom Model` configuration item needs to be set
+
+### Custom Model
+
+- Optional
+- Default value: `gpt-3.5-turbo`
+- Description
+  - A linked item, when the `Model` configuration selects `custom`, this configuration item's model will be read
+
+### System Prompt
+
+- Optional
+- Default value: `You are a translation engine that can only translate text and cannot interpret it.`
+- Description
+  - Customize System Prompt, filling this will override the default System Prompt
+  - Custom Prompt can use the following variables:
+    1. `$text`: the text to be translated, i.e., the text in the translation window input box
+    2. `$sourceLang`: the source language, i.e., the language of the text in the translation window input box, such as "Simplified Chinese"
+    3. `$targetLang`: the target language, i.e., the language into which the text is to be translated, which can be manually selected or automatically detected in the translation window, such as "English"
+
+### User Prompt
+
+- Optional
+- Default value: `translate from $sourceLang to $targetLang:/n/n $text`
+- Description
+  - Customize User Prompt, filling this will override the default User Prompt
+  - Can use the same variables as in the system command
