Hanzi2Pinyin
Anki add-on that adds Pinyin and Zhuyin readings above Chinese characters in any field.
Install / Use
/learn @alyssabedard/Hanzi2PinyinREADME
Description
This Anki add-on lets you add Pinyin and Zhuyin readings above Chinese characters (Hanzi) in any field.
It works by converting your Chinese text into ruby annotations, where the Pinyin appears as small text above the original characters, making it easier to read and study Chinese text.
Why Hanzi2Pinyin when there are other great add-ons?
⚠️ For the ruby annotation to work use this Anki note type made specifically for this add-on.
Read the Anki documentation on Ruby characters.
Looking for the Quick Start Guide? Need help? Want to raise an issue? Looking for documentation? See Contributing & Support
<div align="center"> <b>Example</b> </div>| Type | Pinyin | Zhuyin |
|---------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
| Hanzi | 你好 | 你好 |
| Hanzi to Ruby | 你[nǐ]好[hǎo] | 你[ㄋㄧˇ]好[ㄏㄠˇ] |
| HTML Code | <ruby>你<rt>nǐ</rt></ruby><ruby>好<rt>hǎo</rt></ruby> | <ruby>你<rt>ㄋㄧˇ</rt></ruby><ruby>好<rt>ㄏㄠˇ</rt></ruby> |
| HTML Output | <div align="center"><ruby>你<rt>nǐ</rt></ruby><ruby>好<rt>hǎo</rt></ruby></div> | <div align="center"><ruby>你<rt>ㄋㄧˇ</rt></ruby><ruby>好<rt>ㄏㄠˇ</rt></ruby></div> |
Demo
<div align="center"><br> <img src="docs/screenshots/demo-pinyin.gif" width="800" alt="Demo of Hanzi2Pinyin"/> <img src="docs/screenshots/demo-sentencepinyin.gif" width="500" alt="Demo"/> <div>⬇️</div> <img src="docs/screenshots/demo-sentencepinyin-html.gif" width="400" alt="Demo"/> </div> <details> <summary>Demo with Zhuyin</summary> <div align="center"><br> <img src="docs/screenshots/demo-zhuyin.gif" width="800" alt="Demo of Hanzi2Pinyin"/> </div> </details> <details> <summary>Demo Tools settings (macOS)</summary> <div align="center"><br> <img src="docs/screenshots/demo-settings.gif" width="800" alt="Demo of Hanzi2Pinyin"/> </div> </details>Features
- [x] Pinyin support - Browse editor dialog
- [x] Pinyin support - Add editor dialog
- [x] Zhuyin (Bopomofo) support
- [x] Note Type that supports ruby text for Chinese
Key benefits:
- Works with any field name of your choosing (No restrictions)
- Simple and reliable functionality
- Support both Simplified and Traditional Chinese Characters
Planned Features
| Status | Feature | Details | |--------|------------------------|----------------------------------------------------------------------| | 🔄 | Bulk add/remove | Available in tools menu | | 🔄 | Jyutping and Cantonese | Support for Cantonese pronunciation | | 🔄 | Xiao'erjing | Support for Arabic-Persian script (also known as Xiaor jin/Xiaojing) | | 🔄 | Sandhi | Support for phonological changes between adjacent tones (Note 1) |
Note 1: Sandhi refers to how tones change when certain tones/words are next to each other in speech. For example, in Mandarin, when a hanzi with the third tone is followed by another hanzi with the third tone, the first hanzi changes to second tone instead.
I plan on making additional Chinese language tools that will be released as separate add-ons to maintain simplicity as I prefer single-purpose add-ons.
Why Hanzi2Pinyin when there are other great add-ons?
This add-on focuses on simplicity and flexibility. While many add-ons offer extensive features, they often come with drawbacks:
- Break when Anki or Qt versions are updated
- Restrict you to specific field names
- Bundle multiple features you might not need
Contributing & Support
| Type | Description | |--------------------------------------------------------------------------|---------------------------------| | Issues & Requests | Bug reports or feature requests | | Contributing | Fork the repo and submit a PR | | Discussions | Getting help and questions | | Support | Support | | Quick Start Guide | Quick Start Guide | | Technical documentation | Technical documentation |
OS
This script has been primarily tested on macOS and Windows. I currently don't have access
to a Linux machine for thorough testing.
Acknowledgements
Libraries
| Library | Links | |---------|-------| | jieba | PyPi, GitHub | | pypinyin | PyPi, GitHub |
Other
| Description | Source | |---------------|----------------------------------------| | Anki SVG logo | Glutanimate |
<div align="center"><br> <p>加油</p> <img src="docs/screenshots/liuqi-jiayou.gif" width="200" alt="Demo of Hanzi2Pinyin"/> </div>