Rikaisama Anki Real-Time Import Guide

---- How to use Rikaisama's Anki Real-Time Import Feature ----

Prerequisites:
Anki - http://ankisrs.net/
Rikaisama - http://rikaisama.sourceforge.net/
Real-Time Import add-on for Anki - https://ankiweb.net/shared/info/2512410601

Now, open up Firefox, make your way over to the add-ons management page*, locate the Rikaisama add-on, and hit the "Preferences" button to open up the Rikaisama options window. We are interested in two tabs here: "Clipboard & Save" and "Anki"**.
* https://a.pomf.cat/xbnfje.png
** https://a.pomf.cat/zvfmpz.png

First of all, we will go to the "Clipboard & Save" tab. The only thing we are interested in here is the "Saved audio" field (you can skip this part if you are not interested in having audio on your cards). You need to point this field to Anki's "collection.media" folder, which should be located inside a folder called "Anki" within your computer's "Documents" folder.

Now, onto the "Anki" tab. The two fields we are interested in here are:
"Save format"
This is where we tell Rikaisama what information we want it to save about a particular word. Here is a typical example:
$d$t$r$t$n$t[sound:$a]
This might look confusing, but it is actually quite simple. There is a key below the "Save format" field explaining what all of this does. The $d option saves the dictionary form of the word you have hovered over (meaning 食べます, for example, would be saved as 食べる). The $t option is used to denote the end of one field (i.e. those in the "Field names" field) and the beginning of another. The $r option saves the reading of the word (i.e. the word's pronunciation written in hiragana). Finally, $a saves an audio clip of the word (if available).

You will notice in the above example that $a has not been used alone, but rather enclosed in square brackets and preceded by "sound:". The reason for this is simple - audio files must be formatted this way in order for Anki to understand that you want to play them. If you only put "audio.mp3" into one of your Anki fields (as opposed to "[sound:audio.mp3]"), then you would simply get the text "audio.mp3" on your card.

"Field names"
This tells Rikaisama to which fields in our Anki deck the information specified in the "Save format" field should be added. A typical example would be:
Vocabulary Reading Definition Audio

These fields MUST exist in our Anki deck in order for this to work, so with that in mind, let us now open up Anki and create our deck. Once we have Anki open, we need to click the "Add" button* to begin creating our deck. This will present us with a window with various options. We will begin by clicking the "Deck" button**, then "Add"***. A Window will pop up prompting you to type in the name of the deck that you want to create - enter a name (e.g. Mining Deck) and hit "OK".
* https://a.pomf.cat/dgdksx.png
** https://a.pomf.cat/rhkgko.png
*** https://a.pomf.cat/hiouim.png

Okay, so now we have our mining deck and we've given it a name, but we still need to add the required fields to it, so next we will hit the "Fields..." button*. Since all decks must have at least one field, we will first click "Add"**, type in "Vocabulary" and then hit "OK". We should now have a field called "Vocabulary" in our deck, so we can go ahead and delete the default fields "Front" and "Back" by selecting them and clicking "Delete". Now repeat the adding process for the other required fields: "Reading", "Definition" and "Audio". Once done, hit "Close"***.
* https://a.pomf.cat/mhsqxv.png
** https://a.pomf.cat/zenodf.png
*** https://a.pomf.cat/jxwaff.png

Now all that's left to do is edit the appearance of our cards. To do this, click the "Cards..." button*. This is outside the scope of this tutorial, but at the following pastebin link you will find a sample which you can copy and paste: http://pastebin.com/HWk3Nnm6
* https://a.pomf.cat/kwczkb.png

Once you're done, hit "Close"* and then "Close"** again.
* https://a.pomf.cat/ioyexp.png
** https://a.pomf.cat/vfyafw.png

And that's it! Now open your deck* by clicking on it and try adding your very first word: 中出し - just hover over it with your mouse with Rikaisama enabled and hit "r"!
* https://a.pomf.cat/kfxxcf.png