doc: update readme

This commit is contained in:
Gabe
2025-08-10 12:48:40 +08:00
parent 0c6d5c3c61
commit c82cdd7f8f
2 changed files with 74 additions and 16 deletions

View File

@@ -74,30 +74,58 @@ A simple, open source [bilingual translation extension & Greasemonkey script](ht
## Frequently Asked Questions ## Frequently Asked Questions
### How to Turn Off Automatic Translation
You can achieve this through `Rules Setting` with the following methods:
- Personal Rules: RULES-> Global Rule -> Translate Switch -> Disaabled
- Subscription Rules: SUBSCRIBE -> Select the third option `kiss-rules-off.json`
- Override Subscription Rules: OVERWRITE -> Translate Switch -> Disaabled
- Add a Personal Rule for a Specific Website: Translate Switch -> Disaabled
### How to Set Keyboard Shortcuts
Set this in the extension management page, for example:
- chrome [chrome://extensions/shortcuts](chrome://extensions/shortcuts)
- firefox [cabout:addons](about:addons)
### How to Turn Off Selection Translation
Set this in the `Rules Setting`: RULES -> Global Rule -> If translate selected -> Disable
### How to Set it to Show Only the Translation
Set this in the `Rules Setting`: RULES -> Global Rule -> Show Only Translations -> Enable
### How to Set Mouse Hover Translation
Set this in the `Rules Setting`: RULES -> Global Rule -> TTrigger Mode
### Why are some web pages not fully translated? ### Why are some web pages not fully translated?
> This extension's webpage translation is based on CSS selectors. Generic rules cannot adapt to all websites, and sometimes you need to manually add site-specific rules. If you don't know how to write rules, you can seek help here: This extension's webpage translation is based on CSS selectors. Generic rules cannot adapt to all websites, and sometimes you need to manually add site-specific rules. If you don't know how to write rules, you can seek help here:
https://github.com/fishjar/kiss-rules/issues https://github.com/fishjar/kiss-rules/issues
### What is the priority order of rule settings? ### What is the priority order of rule settings?
> Personal Rules > Override Subscription Rules > Subscription Rules > Global Rules Personal Rules > Override Subscription Rules > Subscription Rules > Global Rules
> Among these, Global Rules have the lowest priority but are very important as they serve as the default rules.
Among these, Global Rules have the lowest priority but are very important as they serve as the default rules.
### Why are YouTube subtitles translated in broken sentences? ### Why are YouTube subtitles translated in broken sentences?
> This extension has no special development for video content. Support for YouTube is also treated as regular webpage translation. Auto-generated subtitles are streamed and output progressively, resulting in poorer support. This extension has no special development for video content. Support for YouTube is also treated as regular webpage translation. Auto-generated subtitles are streamed and output progressively, resulting in poorer support.
> To disable this extension's subtitle translation, add a rule. Reference:
https://github.com/fishjar/kiss-translator/issues/62 To disable this extension's subtitle translation, add a rule. Reference: https://github.com/fishjar/kiss-translator/issues/62
### Local Ollama interface cannot be used ### Local Ollama interface cannot be used
> If encountering a 403 error, refer to: If encountering a 403 error, refer to: https://github.com/fishjar/kiss-translator/issues/174
https://github.com/fishjar/kiss-translator/issues/174
### Custom API doesn't work in Tampermonkey scripts ### Custom API doesn't work in Tampermonkey scripts
> Tampermonkey scripts require adding domains to the whitelist; otherwise, requests cannot be sent. Tampermonkey scripts require adding domains to the whitelist; otherwise, requests cannot be sent.
## Development Guidelines ## Development Guidelines

View File

@@ -74,27 +74,57 @@
## 常见问题 ## 常见问题
### 如何关闭自动翻译
通过规则设置,以下方法均可实现:
- 个人规则:全局规则 -> 开启翻译 -> 默认关闭
- 订阅规则:选择第三个 `kiss-rules-off.json`
- 覆写订阅规则:开启翻译 -> 默认关闭
- 添加一条针对某个网站的个人规则:开启翻译 -> 默认关闭
### 如何设置快捷键
在插件管理那里设置,例如:
- chrome [chrome://extensions/shortcuts](chrome://extensions/shortcuts)
- firefox [cabout:addons](about:addons)
### 如何关闭划词翻译
通过规则设置:个人规则 -> 全局规则 -> 是否启用划词翻译 -> 禁用
### 如何设置仅显示译文
通过规则设置:个人规则 -> 全局规则 -> 仅显示译文 -> 启用
### 如何设置鼠标悬停翻译
通过规则设置:个人规则 -> 全局规则 -> 触发方式
### 为什么有些网页翻译不全 ### 为什么有些网页翻译不全
> 本插件的网页翻译是基于CSS选择器的通用规则不能适配所有网页有时需要自行添加相应网站的单独规则。如果不会写规则可以到这里求助 https://github.com/fishjar/kiss-rules/issues 本插件的网页翻译是基于CSS选择器的通用规则不能适配所有网页有时需要自行添加相应网站的单独规则。如果不会写规则可以到这里求助 https://github.com/fishjar/kiss-rules/issues
### 规则设置的优先级是如何的 ### 规则设置的优先级是如何的
> 个人规则>覆写订阅规则>订阅规则>订阅规则>全局规则 个人规则 > 覆写订阅规则 > 订阅规则 > 订阅规则 > 全局规则
> 其中全局规则优先级最低,但非常重要,相当于默认规则。
其中全局规则优先级最低,但非常重要,相当于默认规则。
### 为什么油管字幕一句话会断开翻译 ### 为什么油管字幕一句话会断开翻译
> 本插件没有针对视频做特殊开发,对油管的支持也是当做网页翻译看待,自动生成字幕是流式生成并输出的,所以支持较差。 本插件目前没有针对视频做特殊开发,对油管的支持也是当做网页翻译看待,自动生成字幕是流式生成并输出的,所以支持较差。
> 如果需要关闭本插件的字幕翻译增加一条规则即可参考https://github.com/fishjar/kiss-translator/issues/62
如果需要关闭本插件的字幕翻译增加一条规则即可参考https://github.com/fishjar/kiss-translator/issues/62
### 本地的Ollama接口不能使用 ### 本地的Ollama接口不能使用
> 如果出现403的情况参考https://github.com/fishjar/kiss-translator/issues/174 如果出现403的情况参考https://github.com/fishjar/kiss-translator/issues/174
### 填写的接口在油猴脚本不能使用 ### 填写的接口在油猴脚本不能使用
> 油猴脚本需要增加域名白名单,否则不能发出请求。 油猴脚本需要增加域名白名单,否则不能发出请求。
## 开发指引 ## 开发指引