2017-02-26 23:08:29 +00:00
# Yomichan #
2016-04-10 05:48:13 +00:00
2017-02-26 23:08:29 +00:00
Yomichan turns your browser into a tool for building Japanese language literacy by helping you to decipher texts which
would be otherwise too difficult tackle. This extension was inspired in part by
2016-05-30 18:46:15 +00:00
[Rikaichan ](https://addons.mozilla.org/en-US/firefox/addon/rikaichan/ ) and
2016-05-19 00:03:51 +00:00
[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
2017-02-26 23:08:29 +00:00
evolution of the [Yomichan ](https://foosoft.net/projects/yomichan-anki ) plugin that I developed for Anki when I began studying Japanese.
2016-05-30 18:46:15 +00:00
2016-07-10 20:39:47 +00:00
## Requirements ##
2016-08-18 16:07:21 +00:00
For basic functionality:
2017-02-26 23:08:29 +00:00
* [Google Chrome ](https://www.google.com/chrome/browser/desktop/ ) (versions 45+)
* [Mozilla Firefox ](https://www.mozilla.org/en-US/firefox/new/ ) (versions 51+)
2016-08-18 16:07:21 +00:00
For development:
2016-07-05 06:09:39 +00:00
2016-07-10 20:39:47 +00:00
* [Git LFS ](https://git-lfs.github.com/ )
2016-08-18 16:07:21 +00:00
* [Go ](https://golang.org/ )
2016-07-10 05:46:16 +00:00
* [Handlebars ](http://handlebarsjs.com/ )
* [Node.js ](https://nodejs.org/ )
2016-07-10 20:39:47 +00:00
## Installation ##
2016-05-30 18:46:15 +00:00
2016-08-18 16:07:21 +00:00
Yomichan can downloaded free of charge from the [Chrome Web
2017-02-27 00:48:54 +00:00
Store](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami) and the [Firefox
2017-03-06 03:00:05 +00:00
Marketplace](https://addons.mozilla.org/en-US/firefox/addon/yomichan/). If you find this extension helpful and
2017-02-27 00:48:54 +00:00
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.
2016-05-19 00:03:51 +00:00
2017-03-06 03:00:05 +00:00
[](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami)
[](https://addons.mozilla.org/en-US/firefox/addon/yomichan/)
At present, Yomichan is sitting in a queue to be reviewed and signed by Mozilla. If you don't want to wait for several
weeks for approval and wish to use this extension in Firefox today, you can follow the steps below:
1. Type `about:config` into the browser address bar.
2. Skip past the "voiding your warranty" nag screen.
3. Type `xpinstall.signatures.required` into the search bar on top.
4. Double-click the displayed entry to set its value to `false` .
5. Install extension as usual from the [Firefox Marketplace ](https://addons.mozilla.org/en-US/firefox/addon/yomichan/ ).
2016-08-24 16:25:00 +00:00
2016-10-26 02:16:28 +00:00
## Basic Functionality ##
2016-08-18 16:07:21 +00:00
2017-02-26 23:08:29 +00:00
1. Click on the  icon in the browser toolbar to open the Yomichan options page.
2017-02-26 18:59:02 +00:00
2. Import the dictionaries (bundled or custom) you wish to use for term and Kanji searches.
3. Hold down < kbd > Shift</ kbd > (or the middle mouse button) as you hover over text to see term definitions.
2017-02-26 23:08:29 +00:00
4. Click on the  icon to hear the term pronounced by a native speaker (if audio is available).
2017-02-26 18:59:02 +00:00
5. Click on Kanji in the definition window to view additional information about that character.
2016-12-30 01:34:58 +00:00
## Custom Dictionaries ##
2017-02-26 23:08:29 +00:00
Yomichan supports importing of custom dictionaries including the esoteric but popular
[EPWING ](https://ja.wikipedia.org/wiki/EPWING ) format. For more information about how to use this feature, please see
the [Yomichan Import ](https://foosoft.net/projects/yomichan-import ) project page.
2016-08-18 16:07:21 +00:00
2016-10-26 02:16:28 +00:00
## Anki Integration ##
2016-08-18 16:07:21 +00:00
2016-10-21 16:10:11 +00:00
Yomichan features automatic flashcard creation for [Anki ](http://ankisrs.net/ ), a free application designed to help you
2017-01-12 04:41:44 +00:00
retain knowledge. This functionality requires prior installation of the
[AnkiConnect ](https://foosoft.net/projects/anki-connect/ ) plugin. The installation process can be done in three steps:
2016-10-21 16:10:11 +00:00
2016-08-24 16:25:00 +00:00
1. Open the *Install Add-on* dialog by selecting *Tools* > *Add-ons* > *Browse & Install* in Anki.
2016-08-18 16:07:21 +00:00
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.
2016-10-21 16:10:11 +00:00
When using AnkiConnect, Anki must be kept running in the background for automatic flashcard creation to function.
2016-10-26 02:16:28 +00:00
### Flashcard Configuration ###
2016-10-21 16:10:11 +00:00
Before flashcards can be automatically created through Yomichan, Anki must be configured as follows:
2017-03-01 06:25:51 +00:00
1. In your web browser, open the Yomichan options page by clicking the  icon.
2016-10-21 16:10:11 +00:00
2. Activate the *Terms* or the *Kanji* tab, depending on the type of card template you wish to configure.
3. Select the Anki deck and model to use when creating new flashcards (see the [Anki Manual ](http://ankisrs.net/docs/manual.html ) for more details).
4. Populate the model fields with markup representing contextual properties for the current vocabulary term or Kanji:
2016-10-26 02:16:28 +00:00
2017-01-28 20:06:18 +00:00
#### Markers for Term Cards ####
2016-10-26 02:16:28 +00:00
Marker | Description
-------|------------
`{audio}` | Audio sample of a native speaker's pronunciation in MP3 format (if available).
2017-01-28 20:06:18 +00:00
`{dictionary}` | Name of the dictionary from which the card is being created (unavailable in *grouped* mode).
`{expression}` | Term expressed as Kanji (will be displayed in Kana if Kanji is not available).
`{furigana}` | Term expressed as Kanji with Furigana displayed above it (e.g. < ruby > 日本語< rt > にほんご</ rt ></ ruby > ).
`{glossary}` | List of definitions for the term (output format depends on whether running in *grouped* mode).
2016-10-26 02:16:28 +00:00
`{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.
2017-01-28 20:06:18 +00:00
`{tags}` | Grammar and usage tags providing information about the term (unavailable in *grouped* mode).
`{url}` | Address of the web page in which the term appeared in.
2016-10-26 02:16:28 +00:00
2017-01-28 20:06:18 +00:00
#### Markers for Kanji Cards ####
2016-10-26 02:16:28 +00:00
Marker | Description
-------|------------
`{character}` | Unicode glyph representing the current Kanji.
2017-01-28 20:06:18 +00:00
`{dictionary}` | Name of the dictionary from which the card is being created.
`{glossary}` | List of definitions for the Kanji.
`{kunyomi}` | Kunyomi (Japanese reading) for the Kanji expressed as Katakana.
`{onyomi}` | Onyomi (Chinese reading) for the Kanji expressed as Hiragana.
`{url}` | Address of the web page in which the Kanji appeared in.
2016-10-26 02:16:28 +00:00
2017-02-26 23:08:29 +00:00
5. Click on the  icon to add the current expression using Kanji (e.g. 食べる). If the icon
2016-10-21 16:10:11 +00:00
appears grayed out, this means that a new flashcard cannot be created with the current configuration (please verify
your Anki deck and model settings).
2017-02-26 23:08:29 +00:00
6. Click on the  icon to add the current expression using the reading alone (e.g. たべる). If
2016-10-21 16:10:11 +00:00
the icon appears grayed out, this means that a new flashcard cannot be created with the current configuration
(please verify your Anki deck and model settings).
2016-08-18 16:07:21 +00:00
## Frequently Asked Questions ##
2017-01-12 04:41:44 +00:00
* **What happened to AnkiWeb integration? Why was it removed?**
The author of Anki wants to maintain tight control of AnkiWeb by restricting automated web requests, while at the
2017-01-28 20:06:18 +00:00
same time not providing an API for adding or removing flash cards. As circumventing these limitations led to account
restrictions placed on users of this extension, I was forced to remove this feature. Note that it is still possible
to automatically generate flashcards with the [AnkiConnect ](https://foosoft.net/projects/anki-connect ) plugin.
2017-01-12 04:41:44 +00:00
2016-09-25 02:28:39 +00:00
* **Is it possible to use Yomichan with files saved locally on my computer?**
2017-02-26 23:08:29 +00:00
It in order to be able use Yomichan with local files in Chrome, you must first tick the *Allow access to file URLs*
checkbox for Yomichan on the Chrome extensions page. Due to restrictions placed on browser extensions by Chrome, it
will likely never be possible to use Yomichan with PDF files.
2016-08-18 16:07:21 +00:00
* **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.
2016-05-19 00:03:51 +00:00
## Screenshots ##
2017-02-26 23:08:29 +00:00
[](https://foosoft.net/projects/yomichan/img/term.png)
[](https://foosoft.net/projects/yomichan/img/kanji.png)
[](https://foosoft.net/projects/yomichan/img/options-general.png)
[](https://foosoft.net/projects/yomichan/img/options-anki.png)
2016-06-11 23:01:32 +00:00
2016-05-19 00:03:51 +00:00
## License ##
GPL
