Skip to content

Commit 31ad1be

Browse files
committed
Update README
1 parent 5e22ae5 commit 31ad1be

File tree

3 files changed

+51
-61
lines changed

3 files changed

+51
-61
lines changed

README.md

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,54 @@
11
# AndroidLocalizePlugin
2-
:earth_asia: Android/IDEA localization plugin. support multiple languages, no need to apply for key. ([中文文档](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/README_CN.md))
2+
[![Plugin Version](https://img.shields.io/jetbrains/plugin/v/11174)](https://plugins.jetbrains.com/plugin/11174-androidlocalize)
3+
[![Plugin Rating](https://img.shields.io/jetbrains/plugin/r/rating/11174)](https://plugins.jetbrains.com/plugin/11174-androidlocalize)
34

4-
# Feature
5-
- Support 104 languages.
6-
- No need to apply for key.
5+
:earth_asia: Android/IDEA localization plugin. supports multiple languages and multiple translators. ([中文文档](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/README_CN.md))
6+
7+
# Features
8+
- Multiple translator support:
9+
- Google translator.
10+
- Baidu translator.
11+
- Youdao translator.
12+
- Supports up to 100+ languages.
713
- One key generates all translation files.
814
- Support no translation of existing string.
915
- Support for specifying that text is not translated.
16+
- Support for caching translated strings.
1017

1118
# Preview
1219
![image](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/preview/preview.gif)
20+
![image](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/preview/settings.png)
1321

1422
# Install
15-
## Online installation
16-
- Step 1: Open AndroidStudio or IDEA.
17-
- Step 2: Preferences -> Plugins -> Browse repositories...
18-
- Step 3: Search AndroidLocalize and install. Then restart IDE.
19-
20-
## Local installation
21-
- Step 1: Download AndroidLocalizePlugin.zip file.
22-
- Step 2: Open AndroidStudio or IDEA.
23-
- Step 3: Preferences -> Plugins -> Install plugin from disk...
24-
- Step 4: Select AndroidLocalizePlugin.zip and Restart IDE.
23+
[![Install Plugin](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/preview/install.png)](https://plugins.jetbrains.com/plugin/11174-androidlocalize)
2524

2625
# Usage
2726
- Step 1: Select the values/strings.xml.
28-
- Step 2: Right-click and select Convert to other languages.
29-
- Step 3: Select the language to be translated.
30-
- Step 4: Click ok.
27+
- Step 2: Right click and select "Translate to Other Languages".
28+
- Step 3: Select the languages to be translated.
29+
- Step 4: Click OK.
3130

3231
# FAQ
33-
- Q1: Empty characters after translation?
34-
35-
A: You need to set an proxy or replace an proxy address or wait a while before trying. set proxy:
36-
37-
![image](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/preview/setproxy.png)
32+
- Q: How to ignore translation?
3833

39-
- Q2: How to ignore translation?
40-
41-
A: Use the translatable or xliff:g tags. for example:
34+
A: Use the [translatable or xliff:g](https://developer.android.com/guide/topics/resources/localization#managing-strings) tags. for example:
4235
```
43-
<string name="name" translatable="false">AndroidLocalizePlugin</string>
44-
<string name="detail">detail<xliff:g>: %1$s</xliff:g></string>
36+
<string name="app_name" translatable="false">HelloAndroid</string>
37+
<string name="star_rating">Check out our 5<xliff:g id="star">\u2605</xliff:g></string>
38+
<string name="app_home_url">Visit us at <xliff:g id="application_homepage">https://github.com/Airsaid/AndroidLocalizePlugin</xliff:g></string>
39+
<string name="prod_name">Learn more at <xliff:g id="game_group">Muggle Game Studio</xliff:g></string>
4540
```
41+
**Note: Display one line without extra line breaks and spaces in between.**
4642
47-
# Thanks
48-
- MTrans:[https://github.com/hujingshuang/MTrans](https://github.com/hujingshuang/MTrans)
43+
# ChangeLog
44+
[Change Log List](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/CHANGELOG.md)
4945
5046
# ContactMe
5147
- Telegram: [https://t.me/airsaids/](https://t.me/airsaids/)
5248
5349
# Invite me for coffee :coffee:
5450
If this project has helped you, you can [invite me for coffee](https://25e37ece.wiz03.com/wapp/pages/view/share/s/0BUTXe15Q4mk28KWtW0l7BLh1Y6ijp02l4Ct2gxqhW0OmYvl).
5551
56-
5752
# License
5853
```
5954
Copyright 2018 Airsaid. https://github.com/airsaid
@@ -69,4 +64,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
6964
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
7065
See the License for the specific language governing permissions and
7166
limitations under the License.
72-
```
67+
```

README_CN.md

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,54 @@
11
# AndroidLocalizePlugin
2-
:earth_asia: Android/IDEA 本地化插件。 支持多种语言,无需申请 KEY。
2+
[![Plugin Version](https://img.shields.io/jetbrains/plugin/v/11174)](https://plugins.jetbrains.com/plugin/11174-androidlocalize)
3+
[![Plugin Rating](https://img.shields.io/jetbrains/plugin/r/rating/11174)](https://plugins.jetbrains.com/plugin/11174-androidlocalize)
4+
5+
:earth_asia: Android/IDEA 本地化插件,支持多种语言和翻译器。
36

47
# 功能
5-
- 支持 104 种语言。
6-
- 无需申请任何 KEY。
8+
- 多翻译器支持:
9+
- Google 翻译
10+
- 百度翻译
11+
- 有道翻译
12+
- 支持最多 100+ 语言。
713
- 一键生成所有翻译文件。
8-
- 支持对已存在的文本不翻译。
9-
- 支持对指定的文本不参与翻译。
14+
- 支持不翻译已经存在的 string。
15+
- 支持不翻译指定的文本。
16+
- 支持缓存已翻译的 strings。
1017

1118
# 预览
1219
![image](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/preview/preview.gif)
20+
![image](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/preview/settings.png)
1321

1422
# 安装
15-
## 在线安装
16-
- 第一步:打开 AndroidStudio 或 IDEA。
17-
- 第二步:打开 Preferences -> Plugins -> Browse repositories。
18-
- 第三步:搜索 AndroidLocalize 并安装,然后重新启动 IDE。
19-
20-
## 本地安装
21-
- 第一步:下载 AndroidLocalizePlugin.zip 文件。
22-
- 第二步:打开 AndroidStudio 或 IDEA。
23-
- 第三步:打开 Preferences -> Plugins -> Install plugin from disk。
24-
- 第四步:选择 AndroidLocalizePlugin.zip 文件安装,并重新启动 IDE。
23+
[![Install Plugin](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/preview/install.png)](https://plugins.jetbrains.com/plugin/11174-androidlocalize)
2524

2625
# 使用
2726
- 第一步:选择 values/strings.xml 文件。
28-
- 第二步:右键选择 Convert to other languages
27+
- 第二步:右键选择:“Translate to Other Languages”
2928
- 第三步:勾选上需要翻译的语言。
3029
- 第四步:点击 OK。
3130

3231
# 常见问题
33-
- 问题一:翻译后得到的是空的文本?
34-
35-
回答:你需要设置代理或替换代理地址,或者等待一段时间后再次尝试。代理设置:
32+
- 问题:如何忽略不让其翻译?
3633

37-
![image](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/preview/setproxy.png)
38-
39-
- 问题二:如何忽略不让其翻译?
40-
41-
回答:可以使用 translatable 或者 xliff:g 标签。示例:
34+
回答:可以使用 [translatable 或 xliff:g](https://developer.android.com/guide/topics/resources/localization#managing-strings) 标签。示例:
4235
```
43-
<string name="name" translatable="false">AndroidLocalizePlugin</string>
44-
<string name="detail">detail<xliff:g>: %1$s</xliff:g></string>
36+
<string name="app_name" translatable="false">HelloAndroid</string>
37+
<string name="star_rating">Check out our 5<xliff:g id="star">\u2605</xliff:g></string>
38+
<string name="app_home_url">Visit us at <xliff:g id="application_homepage">https://github.com/Airsaid/AndroidLocalizePlugin</xliff:g></string>
39+
<string name="prod_name">Learn more at <xliff:g id="game_group">Muggle Game Studio</xliff:g></string>
4540
```
41+
**注意:一行展示,中间不要有多余的换行和空格。**
4642
47-
# 感谢
48-
- MTrans:[https://github.com/hujingshuang/MTrans](https://github.com/hujingshuang/MTrans)
43+
# 更新日志
44+
[更新日志列表](https://github.com/Airsaid/AndroidLocalizePlugin/blob/master/CHANGELOG.md)
4945
5046
# 联系我
5147
- Telegram: [https://t.me/airsaids/](https://t.me/airsaids/)
5248
5349
# 请我喝咖啡 :coffee:
5450
如果这个项目给你带来了帮助,你可以[请我喝咖啡](https://25e37ece.wiz03.com/wapp/pages/view/share/s/0BUTXe15Q4mk28KWtW0l7BLh1Y6ijp02l4Ct2gxqhW0OmYvl)。
5551
56-
5752
# 许可证
5853
```
5954
Copyright 2018 Airsaid. https://github.com/airsaid

src/main/resources/META-INF/plugin.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<li>Select the values/strings.xml.</li>
3131
<li>Right click and select "Translate to Other Languages".</li>
3232
<li>Select the languages to be translated.</li>
33-
<li>Click ok.</li>
33+
<li>Click OK.</li>
3434
</ol>
3535
]]></description>
3636

0 commit comments

Comments
 (0)