Updating README.md
This commit is contained in:
parent
e6eea28174
commit
007ebddab4
100
README.md
100
README.md
@ -5,44 +5,108 @@ texts which would be otherwise too difficult tackle. This extension was inspired
|
||||
[Rikaichan](https://addons.mozilla.org/en-US/firefox/addon/rikaichan/) and
|
||||
[Rikaikun](https://chrome.google.com/webstore/detail/rikaikun/jipdnfibhldikgcjhfnomkfpcebammhp?hl=en), but it stands
|
||||
apart in its goal of being a all-encompassing learning tool as opposed to a mere browser-based dictionary. It is the
|
||||
natural evolution of the [Yomichan](https://foosoft.net/projects/yomichan) plugin that I developed for Anki when I was starting to learn
|
||||
Japanese back in 2011.
|
||||
natural evolution of the [Yomichan](https://foosoft.net/projects/yomichan) plugin that I developed for Anki when I began learning Japanese
|
||||
in early 2011.
|
||||
|
||||
<iframe width="800" height="500" src="https://www.youtube.com/embed/90_A1VpTnMk" frameborder="0" allowfullscreen></iframe>
|
||||
|
||||
## Requirements ##
|
||||
|
||||
For building:
|
||||
For basic functionality:
|
||||
|
||||
* [Google Chrome](https://www.google.com/chrome/browser/desktop/)
|
||||
|
||||
For automatic flash card creation:
|
||||
|
||||
* [AnkiConnect](https://foosoft.net/projects/anki-connect/)
|
||||
* [Anki](http://ankisrs.net/)
|
||||
|
||||
For development:
|
||||
|
||||
* [7-Zip](http://www.7-zip.org/)
|
||||
* [Git LFS](https://git-lfs.github.com/)
|
||||
* [Go](https://golang.org/)
|
||||
* [Handlebars](http://handlebarsjs.com/)
|
||||
* [Node.js](https://nodejs.org/)
|
||||
* [Python 3](https://www.python.org/downloads/releases/3.0)
|
||||
|
||||
For AnkiConnect:
|
||||
|
||||
* [Anki](http://ankisrs.net/)
|
||||
|
||||
## Installation ##
|
||||
|
||||
The simplest way to install this extension is to download it from the [Chrome Web
|
||||
Store](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami).
|
||||
Yomichan can downloaded free of charge from the [Chrome Web
|
||||
Store](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami). If you find this extension
|
||||
helpful and appreciate the time that was spent developing it, I would kindly ask that you leave a positive review. Your
|
||||
support and feedback encourages continued development of this tool.
|
||||
|
||||
## Usage ##
|
||||
|
||||
1. Click on the Yomichan browser action button in the upper right corner of the window (labeled ヨミ).
|
||||
2. Hold down the <kbd>Shift</kbd> or the middle mouse button while you move your mouse over Japanese text.
|
||||
3. Resize the definition window by dragging the bottom right corner of the window.
|
||||
4. Clicking on a Kanji will display the Kanji information page, including a Kanji stroke diagram.
|
||||
5. Users of [AnkiConnect](https://foosoft.net/projects/anki-connect) will see buttons that can be used to create new flash cards.
|
||||
6. Right click on the Yomichan browser action button and select *Options* to configure the extension.
|
||||
Yomichan can be used as a standalone extension, or in conjunction with [Anki](http://ankisrs.net) via
|
||||
[AnkiConnect](https://foosoft.net/projects/anki-connect).
|
||||
|
||||
### Basic Functionality ###
|
||||
|
||||
1. Left-click on the  icon to enable or disable Yomichan for the current browser instance.
|
||||
2. Right-click on the  icon and select *Options* to display the Yomichan options page.
|
||||
3. Hold down <kbd>Shift</kbd> or the middle mouse button as you move your cursor over text to display definitions.
|
||||
4. Resize the definition window by dragging the bottom-left corner inwards or outwards.
|
||||
5. Click on the Kanji links in the definition window to view additional information about those characters.
|
||||
6. Click on the  icon to hear the term pronounced by a native speaker.
|
||||
|
||||
### Anki Integration ###
|
||||
|
||||
1. Open the *Install Add-on* dialog by the selecting *Tools* > *Add-ons* > *Browse & Install* in Anki.
|
||||
2. Input *2055492159* into the text box labeled *Code* and press the *OK* button to proceed.
|
||||
3. Restart Anki when prompted to do so in order to complete the installation of AnkiConnect.
|
||||
4. In Chrome, open the Yomichan options page by right-clicking the  icon and selecting *Options*.
|
||||
5. Check the *Enable AnkiConnect* checkbox in the *General Options* group.
|
||||
6. Activate the *Terms* or the *Kanji* tab, depending on the type of card template you wish to configure.
|
||||
7. Select the Anki deck and model to use when creating new cards (see the [Anki Manual](http://ankisrs.net/docs/manual.html) for more details).
|
||||
8. Populate the model fields with markup representing contextual properties for the current vocabulary term or Kanji:
|
||||
* **Term Markers**
|
||||
* `{{audio}}`: Audio sample of a native speaker's pronunciation in MP3 format (if available).
|
||||
* `{{expression}}`: Term written in Kanji (will be written in Kana if Kanji is not available).
|
||||
* `{{glossary-list}}`: List of definitions with items expressed as a numbered list.
|
||||
* `{{glossary}}`: List of definitions with items delimited using semicolons.
|
||||
* `{{reading}}`: Kana reading for the term (empty for terms where the expression is the reading).
|
||||
* `{{sentence}}`: Sentence, quote, or phrase in which the term appears in the source content.
|
||||
* `{{tags}}`: Grammar and usage tags providing additional information about the term.
|
||||
* `{{url}}`: Address of the web page in which the current vocabulary term appeared in.
|
||||
* **Kanji Markers**
|
||||
* `{{character}}` Unicode glyph representing the current Kanji.
|
||||
* `{{glossary-list}}`: List of definitions with items expressed as a numbered list.
|
||||
* `{{glossary}}`: List of definitions with items delimited using semicolons.
|
||||
* `{{kunyomi}}`: Kunyomi (Japanese reading) for the current Kanji expressed in Katakana.
|
||||
* `{{onyomi}}`: Onyomi (Chinese reading) for the current Kanji expressed in Hiragana.
|
||||
* `{{url}}`: Address of the web page in which the current vocabulary term appeared in.
|
||||
9. Click on the  icon to add the current expression using Kanji (e.g. 食べる).
|
||||
10. Click on the  icon to add the current expression using the reading alone (e.g. たべる).
|
||||
|
||||
## Frequently Asked Questions ##
|
||||
|
||||
* **When are you going to port Yomichan to $MYBROWSER?**
|
||||
|
||||
I am considering creating a Firefox port once I am satisfied with the feature set of the Chrome extension. I may
|
||||
consider other browsers in the future, as long as porting would be trivial and the browser in question runs natively
|
||||
on Linux. This is not a high priority Firefox already has good extensions for Japanese learning (and I use Chrome
|
||||
exclusively).
|
||||
|
||||
* **When are you going to add support for $MYLANGUAGE?**
|
||||
|
||||
Developing Yomichan required a significant understanding of Japanese sentence structure and grammar. I presently
|
||||
have no time to invest in learning yet another language; therefore other languages will not be supported. I will
|
||||
also not be accepting pull request containing this functionality, as I will ultimately be the one maintaining your
|
||||
code.
|
||||
|
||||
* **When are you going to add support for [EPWING](https://ja.wikipedia.org/wiki/EPWING) J-J dictionaries?**
|
||||
|
||||
This is a long-term goal, and I do not yet have a timeline for this feature. That being said, I believe that I have
|
||||
figured out how to make this work in the restrictive Chrome extension environment, and mostly have to develop a new
|
||||
tool to support extraction of data from this format.
|
||||
|
||||
## Screenshots ##
|
||||
|
||||
[](https://foosoft.net/projects/yomichan-chrome/img/vocab.png)
|
||||
[](https://foosoft.net/projects/yomichan-chrome/img/term.png)
|
||||
[](https://foosoft.net/projects/yomichan-chrome/img/kanji.png)
|
||||
[](https://foosoft.net/projects/yomichan-chrome/img/options.png)
|
||||
[](https://foosoft.net/projects/yomichan-chrome/img/options-general.png)
|
||||
[](https://foosoft.net/projects/yomichan-chrome/img/options-anki.png)
|
||||
|
||||
## License ##
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user