---
hide:
  - footer
---



# Errors & Warnings { .text-yellow }
This section documents frequent errors that
may show up on the info circle at the top right.

<figure markdown>
{{ img("info circle error example", "assets/info_circle/error.gif") }}
</figure>




## (Error) AnkiConnect failed to issue request.
This is an indication that Anki-Connect is failing.
There are two main reasons that Anki-Connect can fail:

1. Ensure that Anki-Connect is installed. If it is installed, be sure to restart Anki
    to ensure the add-on is actually running.

2. If you are using an older version of Anki (2.1.49 and below),
    see the note in the Anki-Connect setup section
    [here](setupanki.md#anki-connect).




## (Warning) JPMNOpts was not defined in the options file. Was there an error?

There are two reasons why you would be getting this warning:

1. You updated your note from a version before `0.12.0.0`,
    to `0.12.0.0` or higher.
    In this case, you will have to
    [update your config file](setupchanges.md#v0-12-0-0-config-rework).

1. You are using Anki version 2.1.49 or below.

    Please check your Anki version to confirm this:

    > Main Window →  `Help` →  `About...`

    ??? example "How to fix {{ CLICKHERE }}"

        If your Anki version is indeed 2.1.49 or below, then this should only appear on
        the front side of your first card of the session.
        To check, try flipping the card and back. This warning should dissappear once you do.

        The only side effect of this is that the user-defined runtime options
        will not be used for the front side of the first card,
        and the defaults will be used instead.

        There are two ways to fix this:

        1. [Update Anki](setupanki.md#updating-anki) to a higher version. <small>(highly recommended)</small>
        1. Compile the card with [hard-coded defaults](moddingtips.md#custom-runtime-options).

        ??? info "Why this happens <small>(click here)</small>"

            The `<script ... src="_jpmn-options.js">` tag seems to runs asynchronously on 2.1.49 and below,
            meaning that the order of when this is ran is not constant compared to the main javascript block.
            With that being said, the exact tag seems to run synchronously on 2.1.50 and above,
            so it is guaranteed to run before the main javascript block on these versions.

            With my current knowledge, the only way to guarantee the order of this import is asynchronous functions,
            or some other asynchronous features.
            For example, a simple `await import(...)` should work.
            However, asynchronous features have been avoided throughout the development of this,
            as it currently seems to
            [behave unpredictably](moddingtips.md#avoid-asynchronous-javascript-features-in-anki)
            within Anki.


## (Warning) Cannot find own card
This warning usually only appears if you renamed the note from `JP Mining Note` to something else.
If you rename the note, certain features will no longer function as expected, such as:

- Kanji Hover
- Word Indicators
- Most batch commands
- Automatic duplicate `Key` field checks

To remedy this, it is recommended that you change the note name back to `JP Mining Note`.


## My error isn't listed, or the steps above do not work

If none of the above worked, follow the [general troubleshooting steps](#general-troubleshooting).

---




# Troubleshooting { .text-yellow }



## The font on the card template is incorrect

TODO bullet pt to sentences

TODO example picture of the wrong font

- if everything is correct, then fonts should actually be japanese (see: 直す)
- easy way to check for correct fonts: look at bolded serif font
    - should look good (example picture)
- if not, wrong fonts are likely being used

- steps
    - ensure fonts are downloaded and in the correct folder (media folder)
        - show screenshot of this!
    - ensure fonts are valid (could be corrupted)
        - show gif of opening in windows
    - restart your entire computer
        - sometimes, restarting Anki isn't enough




## The font on the card editor is incorrect

- TODO link to setupanki.md




## The `SentenceReading` field is not updated / is different from the `Sentence` field

This happens because programs such as
[mpvacious](https://github.com/Ajatt-Tools/mpvacious)
and
[asbplayer](https://github.com/killergerbah/asbplayer)
update the sentence manually.
For example, assume the subtitles are the following:

1. だって、麻衣さんは遅刻してきた男を、健気に一時間三十八分も
2. <span class="highlight-bold">待っているような可愛げのある女じゃない！さては<b>偽物</b>だな！</span>

If you make a card from the highlighted 偽物,
the `Sentence` and `SentenceReading` field will only contain the text from the 2nd subtitle.
If you then use mpvacious or asbplayer to grab both subtitles,
the `Sentence` field will be updated, but the `SentenceReading` field will **not be updated**.

!!! info "Partial solutions"

    Sometimes, the problem appears because one subtitle can span multiple lines.
    These partial solutions work to solve that problem. However, these do not work
    for when lines span multiple subtitles.

    * For mpvacious, use a texthooker that can remove all whitespace
        (i.e. [Renji's Texthooker](https://github.com/Renji-XD/texthooker-ui)).

    * For asbplayer, you can remove the line breaks in the subtitle file itself
        (i.e. with [SubtitleEdit](https://github.com/SubtitleEdit/subtitleedit))

The only full solution I know to this is to
[disabling automatic furigana generation on card add](faq.md#how-do-i-disable-furigana-on-card-generation).
If you still want furigana on your cards,
[bulk generate it](faq.md#how-do-i-bulk-generate-furigana) after each session.





## The word is incorrectly highlighted / not highlighted at all.

The word is usually highlighted by default, but the word may not be highlighted for the following reasons:

- The sentence field got updated by an external program.
- The card was imported from an older deck that did not highlight the tested word.

As of version `0.12.0.0`, the card will automatically attempt to highlight the word
if the word was not highlighted in the first place.
However, this highlight may yield incorrect results.
*This is expected behavior*, and you are expected to manually bold the sentence
if the highlight is incorrect.

See [here](ui.md#automatic-word-highlighting) for more info.




## The `Tools` →  `Check Media` interface removes the font files.
This is a known bug, and unfortunately, this bug will not be fixed by default. [^1]

If you accidentally removed the fonts,
[redownload the fonts](https://github.com/Aquafina-water-bottle/jp-mining-note/tree/master/media)
and re-add them into the [media folder](faq.md#where-is-the-x-folder-in-anki) of your profile.
Alternatively, updating the note with JPMN manager should automatically re-install the required font files.

It is possible to fix this by using the following workaround:

1. Within the [media folder](faq.md#where-is-the-x-folder-in-anki),
    rename all the font files such that they all have `_` at the beginning.
    For example, `NotoSerifJP-Regular.otf` should be renamed to `_NotoSerifJP-Regular.otf`.
2. Add the following {{C_CSS}} to the very bottom (do not modify the existing CSS!):

    ```
    @font-face {
      font-family: notoserif;
      src: url("_NotoSerifJP-Regular.otf");
    }
    @font-face {
      font-family: notoserif;
      src: url("_NotoSerifJP-Bold.otf");
      font-weight: bold;
    }
    @font-face {
      font-family: notosans;
      src: url("_NotoSansJP-Regular.otf");
    }
    @font-face {
      font-family: notosans;
      src: url("_NotoSansJP-Bold.otf");
      font-weight: bold;
    }
    ```

[^1]:
    This will not be fixed by default because to make debugging easier for the developer.
    When a user is asked to export a card, the exported file will not contain the font files,
    meaning that the result `.apkg` file will be about 1MB instead of some 20MB,
    allowing it to be shared easily on a place like Discord.



## The Show/Hide button doesn't do anything.
The show/hide button requires that the displayed sentence has a bolded element.
For example, this means if the currently displayed sentence comes from the `AltDisplay`
field and nothing in that field is bolded, then the show/hide button will do nothing.



## The replay audio button plays the sentence, word, and then sentence.
This is playing the audio from the front of the card,
and then the back of the card, in sequence.
To fix it so you only hear the audio displayed in the back of the card,
go to:

`Decks` (main anki browser) <br>
→  Deck settings (the gear beside your deck) <br>
→  `Options` <br>
→  `Audio` section <br>
→  Toggle `Skip question when replaying answer`


## General Troubleshooting

The following will be some general troubleshooting tips
that can help you figure out what is causing the issue:

<!-- Un-comment this when any conflicting add-ons are actually discovered
1. Do you have a [conflicting addon](setup.md#conflicting-add-ons) installed?
-->

1. **Disable all of your add-ons.**

    To do this, start Anki while holding ++shift++.
    Note that it is expected that you will get an Anki-Connect error (since Anki-Connect will be disabled).

    If the issue was fixed after this step, please let me know which add-on(s) conflicts with this note type!
    To do this, re-enable the add-ons one-by-one (remembering to restart Anki each time!).

1. **Upgrade Anki to the latest version.**

    After doing this, try disabling all of your add-ons again and see if the issue persists.

1. If you manually added any custom CSS and/or runtime / compile options,
    make a [backup of your collection](#how-do-i-backup-my-anki-data)
    and then **remove all of those options**.
    If it works after this, try re-adding those one-by-one until you find the issue.


If you can't manage to fix it, please [let me know](#contact-info)!


---


<!--

author note: Pretty much all of these problems have been solved.
There is value in keeping the info for disabling unnecessary modules and/or auto filling
certain fields, but that can be discussed somewhere else.
TODO where to move it?

## This card template loads slower than other card templates.

Usually, this is not very noticeable on faster computers.
However, the card may load slower compared to others if you are on a slow computer.

!!! note "Note for Android (Ankidroid)"
    Unfortunately, it seems like Ankidroid has a specific issue where fonts are loaded
    extremely slowly. This appears to be a problem with the
    chrome webview itself
    (see: [Ankidroid issue](https://github.com/ankidroid/Anki-Android/issues/4856),
    [Chromium issue](https://bugs.chromium.org/p/chromium/issues/detail?id=954439)).
    This means outside of removing the custom fonts,
    there is **no feasible way** to considerably speed up Ankidroid.

    From person experiments, simply removing the fonts without changing anything else
    on jp-mining-note results in **almost instanteous** load times.
    This is in comparison to the same template with custom fonts included,
    which results in near **one second** load times.

There are some ways to remedying this. Both will inevitably
remove certain features of the note.

??? info "(1) Prevent document reflow"

    By default, the mobile interface will not have any
    [document reflow](https://developer.mozilla.org/en-US/docs/Glossary/Reflow),
    so nothing has to be done for mobile.

    However, on PC, the default settings forces document reflow
    every time the back-side of the card is loaded.
    On faster computers, this effect is virtually neglible.
    However, this effect is more noticeable on lower end computers.

    To prevent document reflow, you must change the following two {{ RTOs }}:

    ```json
    {
      "modules": {
        "img-utils": {
          "resize-height-mode": "fixed", // (1)!
          "primary-definition-picture": {
            "use-lenience": false, // (2)!
          }
        }
      }
    }
    ```

    1. Set this to anything OTHER THAN "auto-height". This may affect the display image
        size in an undesireably way, because the height of the
        display image will no longer be automatically adjusted.
    2. Set this to false.


??? info "(2) Using compile options"

    Outside of document reflow, it appears that most of the lag
    doesn't come from the javascript execution, but rather
    the fact that the note has a lot of HTML (Anki's internal html and template parser)
    and javascript text (javascript compilation time).
    Surprisingly, the time it takes for javascript to actually run is comparatively fast
    if the forced document reflow (see above) is remedied.

    Both the amount of HTML and javascript can be reduced at the cost of removing functionality
    using the following {{ CTOs }}:

    ```json
    "hardcoded-runtime-options": True, // (1)!

    "always-filled-fields": [], // (2)!
    "never-filled-fields": [],

    "enabled-modules": [ ... ], // (3)!
    ```

    1. This removes extra javascript.
        To customize the runtime-options, you will need to specify your options in a different file (TODO).
    2. Fill these two fields accordingly, depending on whether you use the fields or not.
    3. Remove any modules you do not need. This is the biggest change you can do to
        increase the note's performance.

    An example for a very optimized vocab card is shown
    [here](compiletimeoptions.md#optimized-vocab-card-example).
    Note that `img-utils-minimal` will still cause a document reflow unless you change the above options.

-->


<!--

author note: removed because 0.12.0.0 solves it

## The sentence quotes are on completely different lines!
If your card looks like this:

{{ img("quotes on different lines", "assets/faq/quote_different_lines.png") }}

then your `Sentence` field is likely formatted internally similar to the following example:
```html
<div>そうデスサーヴァントの凸守を<b>差し置いて</b></div>
<div>マスターと行動を共にするとは万死に値するデース</div>
```

To fix this, edit the `Sentence` [field html](faq.md#how-do-i-edit-the-fields-raw-html)
to remove the `<div>` tags, and add `<br>` tags
wherever a line break should appear.
For example, the above should be changed into:
```html
そうデスサーヴァントの凸守を<b>差し置いて</b><br>
マスターと行動を共にするとは万死に値するデース
```

??? info "Why this can happen <small>(click here)</small>"

    This happens if you copy/paste directly from certain pages into the sentence field,
    such as some texthooker pages.
    This can also happen if you copy/paste from a texthooker page to a different field,
    say `AdditionalNotes`, and then copy a section of `AdditionalNotes` to `Sentence`.

    The [updating sentence with clipboard hotkey](jpresources.md#update-sentence-with-clipboard)
    shouldn't have this problem, as `<div>` tags are not present by default.

-->


# Card Editing { .text-yellow }


<!--
## How do I set the default card type?
TODO link to [C](cardtypes2.md#default-card-type)


## How do I automatically change the value of a binary field on multiple existing cards?

You have three main options:

!!! warning
    As always, before mass editing your collection, please
    [backup your Anki data](faq.md#how-do-i-backup-my-anki-data).


1. [Batch Editing Addon](https://ankiweb.net/shared/info/291119185)

2. Python script:

    ```
    # assuming you are at the root of the repo,
    # i.e. after the `git clone ...` and `cd jp-mining-note`
    cd ./tools

    # sets all `IsSentenceCard` fields to be filled
    python3 batch.py --fill-field "IsSentenceCard"

    # empties all `IsSentenceCard` fields
    python3 batch.py --empty-field "IsSentenceCard"
    ```

3. Regex Search (TODO)

-->

## How do I disable furigana on card generation?

1. In [Yomichan's Anki Card Format](setupyomichan.md#yomichan-fields),
    ensure that the `SentenceReading` field is empty.

1. If you are using the AJT Furigana addon, navigate to:

    > `AJT` →  `Japanese Options` →  `Furigana` →  Select profile: `Add furigana for sentence` →  `Triggered by` →  Uncheck `Note Added`.

You likely want to bulk-generate the furigana if you are disabling furigana on card generation.
See the question below to do just that.


## How do I bulk generate furigana and pitch accents?

1. Head to the Card Browser window:

    > Main Window →  `Browse`

1. Select all notes without furigana, with the following search:
    ```
    "note:JP Mining Note" SentenceReading:
    ```

1. Head over to:

    > `Edit` (top left corner) →  `AJT: Bulk-generate`.

!!! note
    Bulk generating pitch accents will only batch generate the `AJTWordPitch` field.
    Pitch accent graphs and positions cannot be automatically generated.
    This is important to note if you are using colored pitch accent.
    If `PAPositions` is not filled, then the card cannot be automatically colored.

    <!-- TODO -->
    In version `0.12.0.0`, this no longer matters, because the pitch accent info is properly
    parsed from AJTWordPitch.

!!! note
    There may be some cards that still have an empty `AJTWordPitch` field.
    This is simply because the add-on did not contain the pitch data for those words.


## How do I remove an empty card without deleting the entire note?
!!! quote
    To remove the empty cards, go to `Tools` →  `Empty Cards` in the main window.
    You will be shown a list of empty cards and be given the option to delete them.

    <sup>
    Taken directly from [Anki's official documentation](https://docs.ankiweb.net/files.html#file-locations).
    </sup>



## How do I edit the field's raw HTML?
Within the card browser,
select a field to edit,
and then type ++ctrl+shift+x++.

Alternatively, on newer versions of Anki, you can click on the top-right corner
on the code button.

{{ img("Anki edit html", "assets/faq/edit_html.gif") }}



## How do I use this note type as an Anime Card?
An anime card is a vocab card with a picture and (native) sentence audio, which
is the default setup for this card.

If you want to add hints that aren't collapsed by default,
use the `HintNotHidden` field.


---




# Other Questions { .text-yellow }




## Where is the (X) folder in Anki?

You must first locate the `Anki2` folder.
The location of this folder is different for each operating system.

!!! quote

    === "Windows"

        On **Windows**, the latest Anki versions store your Anki files in your
        appdata folder. You can access it by opening the file manager, and
        typing `%APPDATA%\Anki2` in the location field. Older versions of Anki
        stored your Anki files in a folder called `Anki` in your `Documents`
        folder.

    === "Mac"

        On **Mac** computers, recent Anki versions store all their files in the
        `~/Library/Application Support/Anki2` folder. The Library folder is
        hidden by default, but can be revealed in Finder by holding down the
        option key while clicking on the Go menu. If you're on an older Anki
        version, your Anki files will be in your `Documents/Anki` folder.

    === "Linux"

        On **Linux**, recent Anki versions store your data in
        `~/.local/share/Anki2`, or `$XDG_DATA_HOME/Anki2` if you have set a
        custom data path. Older versions of Anki stored your files in
        `~/Documents/Anki` or `~/Anki`.

    <sup>
    Taken directly from [Anki's official documentation](https://docs.ankiweb.net/files.html#file-locations).
    </sup>


* Your **profile folder** is under `Anki2/PROFILE_NAME`.
* Your **media folder** is under `Anki2/PROFILE_NAME/collections.media`.
* Your **addons folder** is under `Anki2/addons21`.





## How do I backup my Anki data?

{{ img("anki export package", "assets/faq/media_export.png", 'align=right width="300"') }}

The following makes a **complete backup** of your collection, including media:

> Main Window →  `File` (top left corner) →  `Export...` →  `Anki Collection Package`

The following makes a temporary backup of your collection, not including media:

> Main Window →  `File` (top left corner) →  `Create Backup`

See [Anki's official documentation](https://docs.ankiweb.net/backups.html)
for more info.




## How do I backup Yomichan settings?

1. Navigate to Yomichan Settings.
1. Go to the `Backup` section
1. Select `Export Settings`

{{ img("how-to import Yomichan settings", "assets/faq/yomichan_import_settings.gif") }}





## How do I export notes?

1. Navigate to the Card Browser, by doing the following:

    > Main Window →  `Browse`

1. Select a note. Hold down ++ctrl++ to select multiple individual notes.

1. Right click the selected notes, and navigate to:

    > `Notes` →  `Export Notes...`






## How do I see the version of jp-mining-note?

Preview any card. The version should be displayed at the top left corner.

For mobile, the version is shown in the info circle.
Note that the version is only displayed on mobile for versions `0.12.0.0` and above.

TODO redo image for mobile

<figure markdown>
{{ img("version location", "assets/faq/jpmn_version.png") }}
</figure>




## How do I see the version of Anki?

Navigate to:

> `Help` →  `About`

<figure markdown>
{{ img("version location", "assets/faq/anki_version.png") }}
</figure>






## What card type should I use?
The short answer is: whichever one you want. :)

The long answer is: whichever one you want,
because everyone has their own preferences on what card types they like.
I recommend being open about it and experiment with them, to see which one you like.





## What is the point of the `PASilence` field?
This is a hack to not play the sentence audio on the front side,
even if you set-up your Anki client to do so.
With this field filled correctly, the play sentence audio button will appear at the front,
and will not be autoplayed.

Leaving this field empty will affect cards where you test pitch accent,
i.e. with `PAShowInfo` filled.
In particular, this will cause Anki to autoplay the sentence audio on
the front side of cards that test pitch accent, which is undesirable.





## Do you plan on supporting any other language other than Japanese?
Unfortunately, other languages outside of Japanese will not be supported.

The reason for this decision is best explained in the
"When are you going to add support for $MYLANGUAGE?" question
within [Yomichan's README](https://github.com/FooSoft/yomichan#frequently-asked-questions)

!!! quote
    Developing Yomichan requires a decent understanding of Japanese sentence structure and grammar, and other languages are likely to have their own unique set of rules for syntax, grammar, inflection, and so on. Supporting additional languages would not only require many additional changes to the codebase, it would also incur significant maintenance overhead and knowledge demands for the developers. Therefore, suggestions and contributions for supporting new languages will be declined, allowing Yomichan's focus to remain Japanese-centric.


## How was this documentation made?
Through [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
This site generator is what many other popular sites use,
including [TheMoeWay](https://learnjapanese.moe/) and [AnimeCards](https://animecards.site/).

---


# Contact Info { .text-yellow }

* **Discord**
    * Username: `aquafina_water_bottle` (user id: `244677612272746496`)
    * Servers:
        * [TheMoeWay]({{THEMOEWAY_LINK}})
            (I recommend using the
            [jp-mining-note](https://discord.com/channels/617136488840429598/1041466793094557879)
            thread in the `#resources-sharing` channel)
        * Refold (JP) server
            (I recommend using the
            [jp-mining-note](https://discord.com/channels/778787713012727809/1031068624447873055)
            thread in the `#sentence-mining-workflows` channel)

* **Github**
    * If you don't want to use Discord, please shoot your message [here](https://github.com/Aquafina-water-bottle/jp-mining-note/issues).