1
Go to file
2016-07-21 14:57:20 -04:00
common@d5dde3d687 New dictionary generator 2016-05-09 11:51:33 -07:00
ui Updating extension link 2016-05-18 10:32:51 -07:00
yomi_base Fixing silly typo 2016-07-21 14:57:20 -04:00
.gitignore Creating distribution script 2013-11-16 12:39:52 -08:00
.gitmodules Fixups, adding yomichan-common submodule 2016-05-08 12:05:32 -07:00
build_dict.sh New dictionary generator 2016-05-09 11:51:33 -07:00
build_ui.sh Improved update checking 2015-02-15 15:03:46 +09:00
build_zip.sh Updating zip file script 2016-05-18 16:37:32 -07:00
README.md Updating README.md 2016-07-10 13:39:44 -07:00
yomichan.py Options code 2016-05-01 21:27:09 -07:00

Yomichan

Yomichan is an Anki plugin built to help students of Japanese learn the language by reading native media on their computer. This application's one-click flash card creation feature makes vocabulary mining trivial, allowing you to focus on enjoying your reading. Yomichan can be used in conjunction with Yomichan for Chrome to further enhance your learning experience by enabling flash card creation from your web browser.

Requirements

For running:

For building:

Installation

Yomichan can be downloaded from the its Anki shared addon page. After it is installed, this plugin will automatically notify you when new versions are available.

Usage

  1. Make sure you are running the latest version of Anki.

  2. Open your vocab deck and note the fields that are used in your deck.

    Card layout dialog

  3. Launch Yomichan from the tools menu inside Anki.

  4. Open the text file you want and you will see its contents in the Yomichan. Your layout and color scheme will look different because the screenshot shows my personal settings.

    Reader dialog

  5. To look up words hover your mouse over them while pressing the middle mouse button (usually this is your scroll wheel). You can also press and hold shift instead if you like (or your mouse has no center button).

  6. To set up your Anki deck for Yomichan select Preferences from the Edit menu and you should see a screen that looks like this:

    Preferences dialog

  7. Now you should add markers such as {expression}, {reading}, {reading} and {sentence} to specify how new cards should be created. Card fields will vary depending on your deck model. If you want to be able to use AnkiConnect tick the checkbox labeled Enable AnkiConnect as shown above.

  8. When you look up definitions you will have the option to create Anki cards for them with one click. You will see the icons for performing these actions next to each item. Icons for actions which update your decks won't show up if Anki thinks you can't add a fact with those items. This likely means that they would either be duplicates of existing cards in the deck or that Yomichan hasn't been properly set up for your deck model.

    Icons

    Here is what the icons mean (in order from left to right):

    • Add term in Kana form even it can be written in Kanji (e.g. べんきょうか).
    • Add term as it appears in the dictionary including Kanji (e.g. 勉強家).
    • Copy the expression, reading and definition for the term to the clipboard.

Keyboard Shortcuts

Yomichan features several keyboard shortcuts for ease of use:

Shortcut Command
Shift Search under cursor
] Move search cursor forwards
[ Move search cursor backwards
Shift + Ctrl + # Add current Kanji at index 0 - 9 to deck
Ctrl + # Add current term at index 0 - 9 to deck
Alt + # Add current term at index 0 - 9 to deck as Hiragana

AnkiConnect

AnkiConnect is a convenient feature, which enables external applications to communicate directly with Anki, thus allowing them to query decks and create new flash cards without user involvement. This feature must be enabled through the preference dialog prior to use. AnkiConnect is also available as a separate plugin for those who want to get this feature in a smaller package.

Importing Vocabulary

Yomichan is capable of importing vocabulary lists from plain text files and the vocabulary deck database the Amazon Kindle automatically generates when you look up words in the built-in dictionary (this file can be found as /system/vocabulary/vocab.db). Note that importing does not create flash cards automatically, but rather outputs the contents of the file to the Vocabulary and Kanji panes so that you can add facts the same way as when reading within Yomichan.

License

GPL