https://github.com/windingwind/zotero-pdf-translate
Translate PDF, EPub, webpage, metadata, annotations, notes to the target language. Support 20+ translate services.
https://github.com/windingwind/zotero-pdf-translate
pdf plugin translate translation zotero zotero-plugin zotero7
Last synced: about 18 hours ago
JSON representation
Translate PDF, EPub, webpage, metadata, annotations, notes to the target language. Support 20+ translate services.
- Host: GitHub
- URL: https://github.com/windingwind/zotero-pdf-translate
- Owner: windingwind
- License: agpl-3.0
- Created: 2022-03-09T08:42:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-21T14:12:12.000Z (3 days ago)
- Last Synced: 2025-04-21T15:28:06.881Z (3 days ago)
- Topics: pdf, plugin, translate, translation, zotero, zotero-plugin, zotero7
- Language: TypeScript
- Homepage:
- Size: 5.65 MB
- Stars: 8,610
- Watchers: 25
- Forks: 395
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-zotero - Zotero PDF translate - Translate PDF, EPub, webpage, metadata, annotations, notes to the target language. (Extensions / Translations)
- awesome-zotero - Zotero PDF translate - Translate PDF, EPub, webpage, metadata, annotations, notes to the target language. (Extensions / Translations)
README
# Translate for Zotero
[](https://www.zotero.org)
[](https://github.com/windingwind/zotero-plugin-template)
_Translate for Zotero_, a.k.a. _Zotero PDF Translate_, is a [Zotero](https://www.zotero.org/) plugin.
Translate PDF, EPub, webpage, metadata, annotations, notes to the target language. Support 20+ translate services.
[中文文档](https://zotero.yuque.com/books/share/4443494c-c698-4e08-9d1e-ed253390346d)
# Quick Start Guide
## Install
- Download the plugin (.xpi file) from below.
- [Latest Stable](https://github.com/windingwind/zotero-pdf-translate/releases/latest)
- [All Releases](https://github.com/windingwind/zotero-pdf-translate/releases)
_Note_ If you're using Firefox as your browser, right-click the `.xpi` and select "Save As.."
- In Zotero click `Tools` in the top menu bar and then click `Plugins`
- Go to the Extensions page and then click the gear icon in the top right.
- Select `Install Plugin from file`.
- Browse to where you downloaded the `.xpi` file and select it.
- Finish!
## Usage
Open any PDF/EPub/webpage in the Zotero reader.
- Select text, the translations are shown on the pop-up and the item pane(v0.2.0).
- Highlight/Underline some text, the translations are added to the annotation comment(v0.3.0); Modify & retranslate the annotation text in the item pane and click the `Update Annotation` to modify the annotation text and translation(v0.6.6);
- Add selected text along with translation to note(v0.4.0); _Only works when a note editor is active._
- Translate item titles with right-click menu or shortcut `Ctrl+T`(v0.6.0).
- Translate item abstract with right-click menu(v0.8.0). Thanks @iShareStuff
- Standalone translation window available(v0.7.0). View & compare translations from multiply services in one window!
- Dictionary for single word translation(v0.7.1).
- SentenceBySentence Translation(v1.1.0). After a translation, press `shift`+`P` and select `Translate Sentences`. _Only for en2zh and en2en now_. Thanks @MuiseDestiny
- Since v2.2.0, the concat mode shortcut is ctrl (on Windows/Linux) or ⌘ (on macOS).
### Q&A
**Q** I want to translate manually.
**A** Go to `Edit->Settings->Translate->General`, uncheck the `Automatically Translate Selection`. Click the `Translate` button on the pop-up or item pane to translate.
**Q** I want a translate shortcut.
**A**
Press shortcut `Ctrl+T` after you selected some text. If you are in the collection view, the titles' translation will show/hide.
**Q** I want to concat different selections and translate them together.
**A** Press `Ctrl/⌘` or select the `Concat Mode` check box on item pane when selecting text in PDF/EPub/webpage.
**Q** Not the language I want.
**A** The default target language is the same as your Zotero language. Go to `Edit->Settings->Translate->Service` and change the language settings.
**Q** Translation not correct or report an error.
**A** See _Language Settings_ above and FAQ([#6](https://github.com/windingwind/zotero-pdf-translate/issues/6)). Make sure you use the right secret.
**Q** I want to change the font size.
**A** Go to `Edit->Settings->Translate->User Interface` and set the font size.
## Settings
### General
- Automatically Translate Selection, default `true`
- Automatically Translate Annotation: Save annotation's translation to annotation comment or annotation body, default `false`
- Enable Reader Selection Pop-up: Show results in the pop-up panel or only in the item pane, default `true`
- Show "Add Translation to Note" in Pop-up: default `true`
> Invisible if no active note editor opened.
- Replace Raw: Use translation to replace the raw text when adding to note, default `false`
- Enable Dictionary: Single word will be translated using dictionary service instead of translate service, default `true`
- Show Play Buttons: Show the word pronunciation play buttons if available, default `true`
- Auto-play Pronunciation, default `false`
### Service
The default service is Google Translate. Currently, we support:
| Translate Service | Require Secret | Supported Languages |
| ---------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Google Translate | No | [100+](https://translate.google.com/about/languages/) |
| Google Translate(API) | No | Use `translate.googleapis.com` |
| CNKI | No | |
| Haici Translate | No | |
| Youdao Translate | No | [100+?](https://ai.youdao.com/DOCSIRMA/html/%E8%87%AA%E7%84%B6%E8%AF%AD%E8%A8%80%E7%BF%BB%E8%AF%91/API%E6%96%87%E6%A1%A3/%E6%96%87%E6%9C%AC%E7%BF%BB%E8%AF%91%E6%9C%8D%E5%8A%A1/%E6%96%87%E6%9C%AC%E7%BF%BB%E8%AF%91%E6%9C%8D%E5%8A%A1-API%E6%96%87%E6%A1%A3.html) |
| Bing | No | en-zh |
| Huoshan | Yes | [50+](https://www.volcengine.com/docs/4640/127681) |
| Youdao Zhiyun | Yes | [100+](https://ai.youdao.com/DOCSIRMA/html/%E8%87%AA%E7%84%B6%E8%AF%AD%E8%A8%80%E7%BF%BB%E8%AF%91/API%E6%96%87%E6%A1%A3/%E6%96%87%E6%9C%AC%E7%BF%BB%E8%AF%91%E6%9C%8D%E5%8A%A1/%E6%96%87%E6%9C%AC%E7%BF%BB%E8%AF%91%E6%9C%8D%E5%8A%A1-API%E6%96%87%E6%A1%A3.html) |
| Niu Trans | Yes | [400+](https://niutrans.com/documents/contents/trans_text#accessMode) |
| Microsoft Translate | Yes(free 2M) | [200+](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/language-support) |
| LingoCloud(Caiyun) Translate | Yes | [zh, en, ja, es, fr, ru](https://open.caiyunapp.com/LingoCloud_API_in_5_minutes) |
| DeepL Translate | Yes(free 500k) | [100+](https://www.deepl.com/pro?cta=header-prices/#developer) |
| Aliyun Translate | Yes(free-1M) | [200+](https://help.aliyun.com/document_detail/158269.html) |
| Baidu Translate | Yes(free-QPS1/free-2M) | [200+](https://fanyi-api.baidu.com/product/11) |
| Baidu Field | Yes(free-QPS1/free-2M) | [en-zh](https://fanyi-api.baidu.com/product/12) |
| OpenL | Yes | [11](https://docs.openl.club/#/API/format) |
| Tencent Translate | Yes(QPS5, free-5M) | [15](https://cloud.tencent.com/document/product/551/7372) |
| Xftrans | Yes | [70+](https://www.xfyun.cn/doc/nlp/xftrans/API.html) |
| GPT(OpenAI) | Yes(free-$18) | [LLM-based](https://openai.com/pricing#chat) |
| Gemini | Yes(free-) | [LLM-based](https://ai.google.dev/available_regions#available_languages) |
| Qwen-MT | Yes(free-) | [LLM-based](https://help.aliyun.com/zh/model-studio/user-guide/machine-translation) |
| Claude | Yes | [LLM-based](https://docs.anthropic.com/claude/docs/getting-started-with-the-claude-api) |
> If the service you want is not yet supported, please post an issue.
**Google**
Google does not require a secret, but you can put your own API URL in the secret to replace the default URL (translate.google.com/translate.googleapi.com).
**Huoshan**
Apply [here](https://www.volcengine.com/docs/4640/65067).
The secret format is `accessKeyId#accessKeySecret`
**Youdao Zhiyun Translate 有道智云**
Apply [here](https://ai.youdao.com/login.s).
The secret format is `MY_APPID#MY_SECRET#MY_VOCABID(optional)`.
> About `VOCABID`
> 登录控制台，选择文本翻译服务，点击右侧的术语表，选择新建，填写表名称和语言方向，添加需要的术语表，然后获取对应词表 id 即可。
>
> [Official Document](https://ai.youdao.com/DOCSIRMA/html/%E8%87%AA%E7%84%B6%E8%AF%AD%E8%A8%80%E7%BF%BB%E8%AF%91/API%E6%96%87%E6%A1%A3/%E6%96%87%E6%9C%AC%E7%BF%BB%E8%AF%91%E6%9C%8D%E5%8A%A1/%E6%96%87%E6%9C%AC%E7%BF%BB%E8%AF%91%E6%9C%8D%E5%8A%A1-API%E6%96%87%E6%A1%A3.html)
**NiuTrans**
Apply [here](https://niutrans.com/NiuTransAuthCenter/login).
The secret format is `MY_APIKEY#dictNo(optional)#memoryNo(optional)`.
> [Chinese Document](https://doc.tern.1c7.me/zh/folder/setting/#%E5%B0%8F%E7%89%9B)
**Microsoft Translate**
Apply [here](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/quickstart-translator?tabs=csharp). Copy your secret and paste it into the settings.
The secret format is `MY_SECRET`.
> See [this issue](https://github.com/windingwind/zotero-pdf-translate/issues/3#issuecomment-1064688597) for detailed steps to set up the Microsoft Translate.
**LingoCloud(Caiyun) Translate**
Apply [here](https://open.caiyunapp.com/%E4%BA%94%E5%88%86%E9%92%9F%E5%AD%A6%E4%BC%9A%E5%BD%A9%E4%BA%91%E5%B0%8F%E8%AF%91_API).
**DeepL Translate**
Apply [here](https://www.deepl.com/pro?cta=header-prices/#developer).
The secret format is `secretToken` or `secretToken#glossaryId` (if you want to specify some translate glossary).
**Aliyun Translate**
Apply [here](https://www.aliyun.com/product/ai/base_alimt).
The secret format is `accessKeyId#accessKeySecret#endpoint(optional)`.
> The endpoint is the region of the service, default `https://mt.aliyuncs.com`. For `cn-hangzhou`, the endpoint is `mt.cn-hangzhou.aliyuncs.com`. See also [here](https://help.aliyun.com/zh/machine-translation/developer-reference/api-alimt-2018-10-12-endpoint?spm=a2c4g.11186623.help-menu-30396.d_4_1_0.6c702fa7WlNkX1).
> [Chinese Document](https://help.aliyun.com/document_detail/158269.html)
**Baidu Translate**
Apply [here](https://fanyi-api.baidu.com/product/11).
The secret format is `MY_APPID#MY_KEY#ACTION(optional, see https://api.fanyi.baidu.com/doc/21, default 0)`(split with '#').
**Baidu Field Translate 百度垂直领域翻译**
Apply [here](https://fanyi-api.baidu.com/product/12).
The secret format is `MY_APPID#MY_KEY#DOMAIN_CODE`(split with '#').
| Domain Code | 领域 | 支持语言方向 |
| ----------- | ------------ | ------------------------------------- |
| it | 信息技术领域 | 中文（简）-> 英语、英语 -> 中文（简） |
| finance | 金融财经领域 | 中文（简）-> 英语、英语 -> 中文（简） |
| machinery | 机械制造领域 | 中文（简）-> 英语、英语 -> 中文（简） |
| senimed | 生物医药领域 | 中文（简）-> 英语、英语 -> 中文（简） |
| novel | 网络文学领域 | 中文（简）-> 英语 |
| academic | 学术论文领域 | 中文（简）-> 英语、英语 -> 中文（简） |
| aerospace | 航空航天领域 | 中文（简）-> 英语、英语 -> 中文（简） |
| wiki | 人文社科领域 | 中文（简）-> 英语 |
| news | 新闻资讯领域 | 中文（简）-> 英语、英语 -> 中文（简） |
| law | 法律法规领域 | 中文（简）-> 英语、英语 -> 中文（简） |
| contract | 合同领域 | 中文（简）-> 英语、英语 -> 中文（简） |
> [Chinese Document](https://doc.tern.1c7.me/zh/folder/setting/#%E8%85%BE%E8%AE%AF%E4%BA%91)
**OpenL Translate**
Apply [here](https://my.openl.club/).
The secret format is `service1,service2,...#apikey`(split with '#'; split service codes with ',').
Supported service codes are: `deepl,youdao,tencent,aliyun,baidu,caiyun,wechat,sogou,azure,ibm,aws,google`, See [Service Code](https://docs.openl.club/#/API/format?id=%e7%bf%bb%e8%af%91%e6%9c%8d%e5%8a%a1%e4%bb%a3%e7%a0%81%e5%90%8d)
> [Chinese Document](https://docs.openl.club/#/)
**Tencent Translate**
Apply [here](https://cloud.tencent.com/product/tmt).
The secret format is `secretId#SecretKey#Region(optional, default ap-shanghai)#ProjectId(optional, default 0)`(split with '#').
> [Chinese Document](https://doc.tern.1c7.me/zh/folder/setting/#%E8%85%BE%E8%AE%AF%E4%BA%91)
**Xftrans**
Apply [here](https://www.xfyun.cn/doc/authentication/personal.html#%E6%93%8D%E4%BD%9C%E6%AD%A5%E9%AA%A4).
**GPT**
Apply [here](https://platform.openai.com/signup).
The secret format is `sk-#SecretKey`(split with '#').
Support third-party compatible APIs.
> [Chinese Document](https://gist.github.com/GrayXu/f1b72353b4b0493d51d47f0f7498b67b)
**Gemini**
Apply [here](https://ai.google.dev/gemini-api/docs).
The secret format is `MY_APIKEY`.
**Qwen-MT**
Apply [here](https://help.aliyun.com/zh/model-studio/user-guide/machine-translation).
The secret format is `MY_APIKEY`.
**Claude**
Apply [here](https://docs.anthropic.com/claude/docs/getting-started-with-the-claude-api).
### User Interface
- `Font Size`: The font size of result text, default `12`
- `Line Height`: The line height of result text, default `1.5`
- `Item Context Menu: Show xxx`: Show or hide Title/Abstract tanslation, default `true`
- `Item Context Menu: Show xxx`: Show or hide Title/Abstract tanslation, default `true`
- `Item Pane Section: Hold down Ctrl/⌘`: Press key to enable concat mode when selecting text in PDF/EPub/webpage if `true`, default `true`
- `Item Pane Section: Reverse Raw/Result`: Reverse the order of Raw/Result in the item pane if `true`, default `false`
- `Item Pane Info: Show xxx`: Show or hide Title/Abstract tanslation in the item info rows
- `Standalone: Keep Windows on Top`: Top the standalone translate panel if `true`, default `false`
- `Pop-up: Remember Size`: Remember size of pop-up if `true`, else automatically adjust the size, default `false`
### Advanced
- Automatically Detect Item Language
- Disable Automatic Translation when File Language is(comma-separated): If you want to disable automatic translation in `zh` and `ja` files, set `zh,ja`.
- Delimiter (between text and translation): When translating annotations, the result will be wrapped inside this character to allow safe re-translate. If set to empty, re-translating annotations will replace the annotation comment with the new translate result.
## Development & Contributing
This plugin is built based on the [Zotero Plugin Template](https://github.com/windingwind/zotero-plugin-template). See the setup and debug details there.
To startup, run
```bash
git clone https://github.com/windingwind/zotero-pdf-translate.git
cd zotero-pdf-translate
npm install
npm run build
```
The plugin is built to `./build/*.xpi`.
### Contributing
**Add new translate service**
1. Add service config to `src/utils/config.ts` > `SERVICES`;
2. Add translation task processor under `src/modules/services/${serviceId}.ts` with the same format with other services. The export function set the translation result to `data.result` if runs successfully and throw an error if fails;
3. Import the task processor function in `src/modules/services/index.ts`.
4. Add locale string `service.${serviceId}` in `addon/chrome/locale/${lang}/addon.properties`.
5. Build and test.
**Extra options for translate service**
If the service requires extra options, the minimal implement would be putting them in the `secret` input in the prefs window, like the existing services does.
If there are complex options, please bind a callback in `src/modules/settings/index.ts > secretStatusButtonData` which create a highly customizable dialog window with `ztoolkit.Dialog`. See the example of NiuTrans login here:
## Disclaimer
Use this code under AGPL. No warranties are provided. Keep the laws of your locality in mind!
## My Other Zotero Addons
- [Better Notes](https://github.com/windingwind/zotero-better-notes): Everything about note management. All in Zotero.
- [Actions & Tags](https://github.com/windingwind/zotero-tag): Automatically tag items/Batch tagging
## Sponsors
Thanks
[peachgirl100](https://github.com/peachgirl100)
and other anonymous sponsors!
If you want to leave your name here, please email me or leave a message with the donation.
## Contributors
