Setup: Installing
Overview¶
A full sentence mining workflow requires two main parts:
- Text to make the cards from.
- The card exporter, to create cards from the text.
- And optionally, the image and sentence audio from the media (if the media has either).
These next few sections (Installing, Anki and Yomichan) are all dedicated to providing the minimal setup to setup the card exporter to create cards with this note type.
Getting the text (the first part) and getting the image and sentence audio (the optional part of part two) are not heavily focused on within this site, but can be found under Setup: Everything Else page.
Note
There's quite a few things to setup to use this note. If you ever get lost, remember that this site has a search bar!
Installing Anki¶
Download and install Anki from the official website if you haven't already. I recommend downloading the latest version, to avoid having to do extra steps during the setup.
Installing jp-mining-note¶
There are two ways of installing the note:
Option 1: The Automatic Way (click here)
If you know what git and python is, here's all you have to do:
git clone "https://github.com/arbyste/jp-mining-note.git"
cd jp-mining-note
# Ensure you have Anki open, and with anki-connect running
# Also ensure that you have python 3.10+ installed.
# It *MAY* work with lower versions of python, but I make no such guarantee. ;)
# You may have to use `python3` instead of `python`.
python tools/install.py
The above does the following:
- Installs the latest stable version of the note
- Installs the fonts required for the note
If the above made no sense to you, or you just want to install this normally, see the second option below.
Option 2: The Manual Way (click here)
- Go to the
releases page
and download the cards from the latest release.
You should download the
{version}-jpmn_example_cards.apkgfile. -
After you download the cards, import them by navigating to Anki by doing the following:
File(top left corner) →Import... -
By default, the custom fonts do not come with the
.apkgfile. To install these fonts, head over to this repository's media folder and download the 4.otffiles. - Move the
.otffiles into the media folder of your profile (Anki2/PROFILENAME/collections.media).
Verifying the Note Works¶
You should see a deck JPMN-Examples in your collection.
View one of the cards and make sure the card looks similar to the one below:
Please check the following in particular:
-
The fonts should match with the above example.
If the fonts don't match, try restarting Anki. If the fonts still don't match, the note was likely installed with "Option 2: The Manual Way". Please verify you manually installed the fonts and placed them in the correct folder (see steps 3 and 4).
-
Notice how at the top left corner, the info circle (the "i" encased within the circle) is the default grey color.
If this circle is red or orange, there may be something wrong with the template. Please see this section for basic troubleshooting.
-
Clicking on the image to zoom should work out of the box.
Kanji hover may not work yet. If it doesn't work, read the Anki-Connect setup instructions on the next page.
If the image suddenly appears without a zoom animation, then you must enable animations on Anki.
-
If the furigana on your card seems to appear higher above the kanji compared to the picture, see the Fix Ruby Positioning option.
-
If the frequency list on the top right appears to be squished (with no spacing between the elements) see the FAQ on fixing the frequency list display.
Anki Setup¶
This note requires some additional setup to Anki. In particular, some add-ons are required for the note to work.