# Yomichan #
Yomichan turns your web browser into a tool for building Japanese language literacy by helping you to decipher texts
which would be otherwise too difficult tackle. This extension is similar to
[Rikaichan](https://addons.mozilla.org/en-US/firefox/addon/rikaichan/) for Firefox and
[Rikaikun](https://chrome.google.com/webstore/detail/rikaikun/jipdnfibhldikgcjhfnomkfpcebammhp?hl=en) for Chrome, but it
stands apart in its goal of being a all-encompassing learning tool as opposed to a mere browser-based dictionary.
Yomichan provides advanced features not available in other browser-based dictionaries:
* Interactive popup definition window for displaying search results.
* On-demand audio playback for select dictionary definitions.
* Kanji stroke order diagrams are just a click away for most characters.
* Custom search page for easily executing custom search queries.
* Support for multiple dictionary formats including [EPWING](https://ja.wikipedia.org/wiki/EPWING) via
the [Yomichan Import](https://foosoft.net/projects/yomichan-import) tool.
* Automatic note creation for the [Anki](https://apps.ankiweb.net/) flashcard program via
the [AnkiConnect](https://foosoft.net/projects/anki-connect) plugin.
* Clean, modern code makes it easy for developers to [contribute](https://github.com/FooSoft/yomichan) new features.
## Browser Support ##
* **Google Chrome** (versions 45+)
[](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami)
* **Mozilla Firefox** (versions 51+)
* [Locally hosted](https://foosoft.net/projects/yomichan/dl/latest.xpi) *(recommended)*: Latest and greatest, released simultaneously with the Chrome version.
* [Marketplace hosted](https://addons.mozilla.org/en-US/firefox/addon/yomichan/): Officially hosted version,
likely to be substantially out of date (queued for initial approval).
## Basic Features ##
1. Click on the  icon in the browser toolbar to open the Yomichan actions dialog.
[](https://foosoft.net/projects/yomichan/img/ui-actions.png)
2. Click on the *monkey wrench* icon in the middle to open the options page.
3. Import the dictionaries you wish to use for term and Kanji searches. If you do not have any dictionaries installed
(or enabled), Yomichan will warn you that it is not ready for use by displaying an orange exclamation mark over its
icon. This exclamation mark will disappear once you have installed and enabled at least one dictionary.
[](https://foosoft.net/projects/yomichan/img/ui-import.png)
4. Hold down the Shift key or the middle mouse button as you move your mouse over text to display a popup
window containing term definitions. This window will only be shown if definitions were found and it can be dismissed
by clicking anywhere outside of it.
[](https://foosoft.net/projects/yomichan/img/ui-terms.png)
5. Click on the  icon to hear the term pronounced by a native speaker. If an audio sample is not
available, you will hear a short click instead.
6. Click on individual Kanji in the term definition results to view additional information about those characters
including readings, meanings, and a stroke order diagram.
[](https://foosoft.net/projects/yomichan/img/ui-kanji.png)
## Custom Dictionaries ##
Yomichan supports the use of custom dictionaries including the esoteric but popular
[EPWING](https://ja.wikipedia.org/wiki/EPWING) format. They were often utilized in portable electronic dictionaries
similar to the ones pictured below. These dictionaries are often sought after by language learners for their correctness
and excellent coverage of the Japanese language.
Unfortunately, as most of the dictionaries released in this format are proprietary I am unable to bundle them with
Yomichan. You will need to procure these dictionaries yourself and import them with [Yomichan
Import](https://foosoft.net/projects/yomichan-import). Please see the project page for additional details.
[](https://foosoft.net/projects/yomichan/img/dictionary.jpg)
## Anki Integration ##
Yomichan features automatic flashcard creation for [Anki](http://ankisrs.net/), a free application designed to help you
retain knowledge. This feature requires the prior installation of an Anki plugin called [AnkiConnect](https://foosoft.net/projects/anki-connect).
Please see the respective project page for more information about how to set up this software.
### Flashcard Configuration ###
Before flashcards can be automatically created, you must configure the templates used to create term and/or Kanji notes.
If you are unfamiliar with Anki deck and model management, this would be a good time to reference the [Anki
Manual](http://ankisrs.net/docs/manual.html). In short, you must specify what information should be included in the
flashcards that Yomichan creates through AnkiConnect.
Flashcard fields can be configured with the following steps:
1. Open the Yomichan options page and scroll down to the section labeled *Anki Options*.
2. Tick the checkbox labeled *Enable Anki integration* (Anki must be running with [AnkiConnect](https://foosoft.net/projects/anki-connect) installed).
3. Select the type of template to configure by clicking on either the *Terms* or *Kanji* tabs.
4. Select the Anki deck and model to use for new creating new flashcards of this type.
5. Fill the model fields with markers corresponding to the information you wish to include (several can be used):
#### Markers for Term Cards ####
Marker | Description
-------|------------
`{audio}` | Audio sample of a native speaker's pronunciation in MP3 format (if available).
`{cloze-body}` | Raw, inflected term as it appeared before being reduced to dictionary form by Yomichan.
`{cloze-prefix}` | Text for the containing `{sentence}` from the start up to the value of `{cloze-body}`.
`{cloze-suffix}` | Text for the containing `{sentence}` from the value of `{cloze-body}` to the end.
`{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. 日本語).
`{glossary}` | List of definitions for the term (output format depends on whether running in *grouped* mode).
`{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 information about the term (unavailable in *grouped* mode).
`{url}` | Address of the web page in which the term appeared in.
#### Markers for Kanji Cards ####
Marker | Description
-------|------------
`{character}` | Unicode glyph representing the current Kanji.
`{cloze-body}` | Raw, inflected parent term as it appeared before being reduced to dictionary form by Yomichan.
`{cloze-prefix}` | Text for the containing `{sentence}` from the start up to the value of `{cloze-body}`.
`{cloze-suffix}` | Text for the containing `{sentence}` from the value of `{cloze-body}` to the end.
`{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.
`{sentence}` | Sentence, quote, or phrase in which the character appears in the source content.
`{url}` | Address of the web page in which the Kanji appeared in.
When creating your model for Yomichan, *please make sure that you pick a unique field to be first*; fields that will
contain `{expression}` or `{character}` are ideal candidates. Anki does not require duplicate flashcards to be added to
a deck and uses the first field in the model to check for duplicates. If, for example, you have `{reading}` configured
to be the first field in your model and already have 橋 in your deck, you will not be able to
create a flashcard for 箸, because they share the same reading.
### Flashcard Creation ###
Once Yomichan is configured, it becomes trivial to create new flashcards with a single click. You will see the following
icons next to term definitions.
* Clicking  adds the current expression as Kanji (e.g. 食べる).
* Clicking  adds the current expression as Hiragana or Katakana (e.g. たべる).
Below are some troubleshooting tips you can try if you are unable to create new flashcards:
* Individual icons will appear grayed out if a flashcard cannot be created for the current definition (e.g. it already exists in the deck).
* If all of the buttons appear grayed out then you should double-check your deck and model configuration settings.
* If no icons appear at all, please make sure that Anki is running in the background and that [AnkiConnect](https://foosoft.net/projects/anki-connect) has been installed.
## Keyboard Shortcuts ##
The following shortcuts are globally available:
Shortcut | Action
---------|-------
Alt + Insert | Open search page.
Alt + Delete | Toggle extension on/off.
The following shortcuts are available on search results:
Shortcut | Action
---------|-------
Esc | Cancel current search
Alt + PgUp | Page up through results.
Alt + PgDn | Page down through results.
Alt + End | Go to last result.
Alt + Home | Go to first result.
Alt + Up | Go to previous result.
Alt + Down | Go to next result.
Alt + b | Go to back to source term.
Alt + e | Add current term as expression to Anki.
Alt + r | Add current term as reading to Anki.
Alt + p | Play audio for current term.
Alt + k | Add current Kanji to Anki.
## Development ##
Working on Yomichan and related tools is very time consuming and I am always on the lookout for code contributions from
other developers who want to help out. I take pride in the high quality of the codebase and ask you to follow the
following basic guidelines when creating pull requests:
* Please discuss large features before writing code.
* Follow the conventions and style of the existing code.
* Write clean, modern ES6 code (`const`/`let`, promises, arrow functions, etc.)
* Large pull requests without a clear scope will not be merged.
* Incomplete or non-standalone features will not be merged.
### Templates ###
Yomichan uses [Handlebars](http://handlebarsjs.com/) templates for user interface and Anki note formatting. The source
templates are found in the `tmpl` directory and the compiled version is stored in the `ext/bg/js/templates.js` file. If
you modify the source templates, you will need to also recompile them. If you are developing on Linux or Mac OS X, you
can use the included `build_tmpl.sh` and `build_tmpl_auto.sh` (requires
[inotify-tools](https://github.com/rvoicilas/inotify-tools/wiki)) shell scripts to do this for you. Otherwise, simply
execute `handlebars tmpl/*.html -f ext/bg/js/templates.js` from the project's base directory.
### Dependencies ###
Yomichan relies on several third-party libraries to function. The following are links to homepages and snapshots of the
exact versions used for distribution.
* Bootstrap Toggle: [homepage](http://www.bootstraptoggle.com/) - [snapshot](https://github.com/minhur/bootstrap-toggle/archive/b76c094.zip)
* Bootstrap: [homepage](http://getbootstrap.com/) - [snapshot](https://github.com/twbs/bootstrap/releases/download/v3.3.7/bootstrap-3.3.7-dist.zip)
* Dexie: [homepage](http://dexie.org/) - [snapshot](https://github.com/dfahlander/Dexie.js/archive/v2.0.0-beta.10.zip)
* Handlebars: [homepage](http://handlebarsjs.com/) - [snapshot](http://builds.handlebarsjs.com.s3.amazonaws.com/handlebars.min-714a4c4.js)
* JQuery: [homepage](https://blog.jquery.com/) - [snapshot](https://code.jquery.com/jquery-3.2.1.min.js)
* WanaKana: [homepage](http://wanakana.com/) - [snapshot](https://raw.githubusercontent.com/WaniKani/WanaKana/f2152985f5f2953d74edfe1b6a78e0e329a7cdfb/lib/wanakana.min.js)
## Frequently Asked Questions ##
* **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
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.
* **Is it possible to use Yomichan with files saved locally on my computer?**
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.
* **Is it possible to delete individual dictionaries without resetting the database?**
Although it is technically possible to purge specific dictionaries, due to the limitations of the underlying
database system, this process is *extremely* slow. For example, it can take up to ten minutes to delete a term
dictionary of moderate size! Instead of including a borderline unusable feature in Yomichan, I disabled dictionary
deletion entirely.
* **Why doesn't Yomichan work after being removed and reinstalled on Firefox?**
Uninstalling Yomichan on Firefox may sometimes leave the dictionary database in an undefined state. Although most of
the data has been deleted, the metadata describing it appears unchanged. This can make it look like you have
dictionaries installed when you actually do not. Purge the database and reimport your dictionaries to fix this
problem.
* **Why aren't EPWING dictionaries bundled with Yomichan?**
The vast majority of EPWING dictionaries are proprietary, so unfortunately I am unable to legally include them in
this extension for copyright reasons.
* **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.
## Screenshots ##
[](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)
## License ##
GPL