Updating README.md
This commit is contained in:
parent
13676f3f4c
commit
d6eb785b9a
61
README.md
61
README.md
@ -8,19 +8,12 @@ apart in its goal of being a all-encompassing learning tool as opposed to a mere
|
||||
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" allowfullscreen></iframe>
|
||||
|
||||
## Requirements ##
|
||||
|
||||
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/)
|
||||
@ -38,11 +31,6 @@ support and feedback encourages continued development of this tool.
|
||||
|
||||
[](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami)
|
||||
|
||||
## Usage ##
|
||||
|
||||
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.
|
||||
@ -54,17 +42,45 @@ Yomichan can be used as a standalone extension, or in conjunction with [Anki](ht
|
||||
|
||||
### Anki Integration ###
|
||||
|
||||
Yomichan features automatic flashcard creation for [Anki](http://ankisrs.net/), a free application designed to help you
|
||||
retain knowledge. While the [AnkiConnect](https://foosoft.net/projects/anki-connect/) plugin offers the best experience,
|
||||
it is also possible to create flashcards through [AnkiWeb](https://ankiweb.net/), provided you already have an account.
|
||||
|
||||
#### Using AnkiConnect ####
|
||||
|
||||
Installing the AnkiConnect plugin for Anki is the preferred way of enabling automatic flashcard creation in Yomichan.
|
||||
|
||||
1. Open the *Install Add-on* dialog by 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:
|
||||
|
||||
When using AnkiConnect, Anki must be kept running in the background for automatic flashcard creation to function.
|
||||
|
||||
#### Using AnkiWeb ####
|
||||
|
||||
Yomichan is able to create flashcards directly on AnkiWeb, assuming you have [registered an
|
||||
account](https://ankiweb.net/account/register). While this method can be convenient as it does not require Anki to be
|
||||
running to running in the background, some features are not supported due to technical limitations:
|
||||
|
||||
* Preventing the creation of duplicate flashcards.
|
||||
* Embedding audio in flashcards via the `{audio}` marker.
|
||||
|
||||
Your AnkiWeb login information must specified on the options page to make use of automatic flashcard creation. Note
|
||||
that AnkiWeb will temporarily block your IP address if there are too many login attempts; if this happens, just try
|
||||
again after waiting for about an hour.
|
||||
|
||||
#### Flashcard Configuration ####
|
||||
|
||||
Before flashcards can be automatically created through Yomichan, Anki must be configured as follows:
|
||||
|
||||
1. In Chrome, open the Yomichan options page by right-clicking the  icon and selecting *Options*.
|
||||
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:
|
||||
* **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).
|
||||
* `{expression-furigana}`: Term written in Kanji with Furigana displayed above it (e.g. <ruby>日本語<rt>にほんご</rt></ruby>).
|
||||
* `{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).
|
||||
@ -78,15 +94,20 @@ Yomichan can be used as a standalone extension, or in conjunction with [Anki](ht
|
||||
* `{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. たべる).
|
||||
5. Click on the  icon to add the current expression using Kanji (e.g. 食べる). If 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).
|
||||
6. Click on the  icon to add the current expression using the reading alone (e.g. たべる). If
|
||||
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).
|
||||
|
||||
## Frequently Asked Questions ##
|
||||
|
||||
* **Is it possible to use Yomichan with files saved locally on my computer?**
|
||||
|
||||
It in order to be able use Yomichan with local files, you must first tick the *Allow access to file URLs* checkbox
|
||||
for Yomichan on the chrome extensions page.
|
||||
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.
|
||||
|
||||
* **When are you going to port Yomichan to $MYBROWSER?**
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user