TranslationPlugin README

The project's README from github.com/YiiGuxing/TranslationPlugin. As one markdown file: README.md.

TranslationPlugin TranslationPlugin

Plugin Homepage Build Status License GitHub releases Version Downloads Financial Contributors on Open Collective

Translation plugin for IntelliJ based IDEs/Android Studio.

screenshots




Getting Started 开始使用 はじめに 시작하기

Microsoft Translator      Google Translate      OpenAI Translator      DeepL Translator      Youdao Translate      Baidu Translate      Alibaba Translate

Features

Compatibility

Installation

Get from Marketplace

Restart the IDE after installation.

Using The Plugin

  1. Sign up for a translation service (optional)

    Most translation services require user registration to access their services (such as OpenAI, DeepL, Youdao Translate, etc.). Therefore, you may need to create an account, obtain an Authentication Key, and then bind the Authentication Key within the plugin：Preferences(Settings) > Tools > Translation > General > Translation Engine > Configure...

  2. Begin translating

    Select a text or hover the mouse over the text > Right-click > Translate

    Or use shortcuts for translation, as detailed in Actions.

  3. Replace with Translation

    Translate the target text and replace it. If the target language is English, the output has several formats: in camel case, with a word separator (when the output contains multiple words, the separator can be configured in the plugin configuration page: Translation Settings > Replace with Translation > Separator) and in the original format.

    Instructions: Select a text or hover the mouse over the text > Right-click > Replace with Translation (Or use shortcuts for translation, as detailed in Actions).

  4. Translate Documentation

    Quick Documentation and Inline Documentation can be translated via the context menu or shortcuts (detailed in Actions).

    Translation Settings > Other > Automatically translate documentation: When you check this option, the Quick Documentation will be automatically translated when you view it.

  5. Switch engines

    Click the engine widget in the status bar or use the shortcut Ctrl + Shift + S (macOS: Control + Meta + Y) to switch between the translation engine and the TTS engine quickly.

Actions

FAQ

If you have any questions, please ask here.

  1. What should I do if there is a network error or the network connection times out?

    A:

    • Check the network environment and make sure the network is running smoothly.
    • Check whether a proxy is preventing the plugin from accessing the translation API.
    • Check the IDE proxy configuration to see if that is the cause of the problem.

  2. What should I do if the translated content appears garbled?

    A: Garbled code generally appears when there is a lack of corresponding characters in the font. You can go to the Settings page of the plugin to modify the font in order to fix the garbled code (as shown below).

    screenshots

  3. What if I can't save the application key?

    A: You can try changing the way passwords are saved to In KeePass (Settings > Appearance & Behavior > System Settings > Passwords). For more details:

    • For macOS, please refer to #81
    • For Linux, please refer to #115

  4. What if the shortcuts don't work?

    A: The shortcut keys are most likely not working because they are being used in other plugins or external applications. You can reset shortcut keys for the corresponding operations.

Support and Donations

You can contribute and support this project by doing any of the following:

Thank you for your support!

Contributors

Technology Contributors

The CDN acceleration and security protection for this project are sponsored by Tencent EdgeOne.

Tencent EdgeOne

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Backers

Thank you to all our backers! ❤️ [Become a backer]

Sponsors

Support this project by becoming a sponsor! Your logo will show up here with a link to your website. [Become a sponsor]

Donors

Name Website Amount
丿初音 475.00 CNY
剑平 120.00 CNY
山有扶苏 github.com/fobgochod 110.00 CNY
xudley xudley.cn 100.00 CNY
朱振山 100.00 CNY
丁云波 100.00 CNY
逆行 100.00 CNY
Kimmy 100.00 CNY
LiMingjun 100.00 CNY
DarknessTM github.com/darknesstm 100.00 CNY

More donors

TranslationPlugin (YiiGuxing/TranslationPlugin)

Searching Database…

11.9K ·GitHub
TranslationPlugin
What is this?TranslationPlugin is a translation plugin for IntelliJ-based IDEs and Android Studio that lets you translate text, documentation and code symbols right inside the editor using multiple translation engines.
Is it a standalone app or a plugin inside my IDE?It's a plugin you install into an existing JetBrains-family IDE (or Android Studio/DevEco Studio); it has no separate app of its own.
Do I need an API key to use it?Most engines work out of the box, but some services like OpenAI, DeepL and Youdao Translate require you to sign up and bind an Authentication Key in the plugin's settings before use.
Any common install or runtime pitfalls?Translated text can appear garbled if the configured font lacks the right characters, and application keys sometimes fail to save unless you switch the password storage to KeePass in IDE settings; shortcuts may also conflict with other plugins.
Which IDEs does it support?It works across the whole JetBrains IDE family plus Android Studio and Huawei DevEco Studio, including IntelliJ IDEA, PyCharm, WebStorm, GoLand, CLion, PhpStorm, Rider, RubyMine, RustRover, DataGrip and more.
Does my text get sent to third-party servers?Yes — translation requests are sent to whichever external engine you choose (Microsoft, Google, DeepL, OpenAI, Youdao, Baidu or Alibaba), so text leaves your machine for translation.
Which translation engines can I pick from?Microsoft Translator, Google Translate, DeepL Translator, OpenAI Translator, Youdao Translate, Baidu Translate and Alibaba Translate, plus TTS from Microsoft Edge, Google and OpenAI.
Can it translate more than selected text?Yes — besides selecting or hovering over text, it can translate Quick Documentation, inline documentation (including batch translation of all inline docs in a file), and whole documents, and it supports a Word Book for saving words.
Can I replace code identifiers with translated text?Yes, the 'Replace with Translation' action translates selected text and can output it in camelCase, with a configurable word separator, or in its original format — handy for naming variables.
How do I switch between translation engines quickly?Click the engine widget in the status bar or press Ctrl+Shift+S (Control+Meta+Y on macOS) to cycle between translation and TTS engines without opening settings.
What are similar projects?ideavim, intellij-community, pot-desktop, p3c, kotlin, IntelliJ-IDEA-Tutorial, zotero-pdf-translate, Easydict
Which topics is it in?android-studio, translate, intellij, ide, tts, text-to-speech, translation, kotlin, chatgpt, java, plugin, openai
Creator
YiiGuxing
Size
24.7 MB
Stars
11.9K
Updated
CommitOct 12Releasev3.9.3Oct 12
Age
10y
Commits · 90 Days