aboutsummaryrefslogtreecommitdiff
path: root/docs/anki-integration.md
diff options
context:
space:
mode:
authorKuuuube <61125188+Kuuuube@users.noreply.github.com>2024-05-11 23:03:27 -0400
committerGitHub <noreply@github.com>2024-05-12 03:03:27 +0000
commit486eec15b817d6a87ad98245dea3534545286334 (patch)
treea5376ab50b4770842915c7338401cb1b2a9e4636 /docs/anki-integration.md
parent9b28e8ecf84027c4b52a015b389c6c1730732ce0 (diff)
Add option to bulk generate anki cards (#895)
* Add option to bulk generate anki cards * Fix tab replacement * Set deckname and modelname in note builder * Add addNotes to ankiconnect api implementation * Add option to send word list to anki directly * Add support for audio and media toggle * Add support for dictionary media * Remove unnecessary assignment * Remove unused css * Remove redundant html * Start of progress bar implementation * Remove redundant type annotation * Remove unused import * Rename words to terms * Print progress to console * Add confirmation to Export to file * Improve progress logs * Add unresponsive and console note * Add progress bars * Make cancel button actually cancel operation * Remove unresponsive warnings * Disable send and export buttons after they are clicked * Remove unneeded Yomichan mention * Mark as experimental * Clarify description * Add documentation on Anki Deck Generation * Add experimental note in docs * Add warning text to settings page * Switch example text based on language * Remove silly cancel function and bind directly * Rename to model * Add link to docs * Make test text less confusing * Rename deck to notes * Clarify what is being sent to anki * Fix incorrect modal header text * Clarify wording * Fix ankiconnect addNotes return types * Add error handling to send to anki * Fix wording and naming in docs * Add option to prevent sending duplicates to anki * Update anki deck and model without a page refresh * Cleanup internal html naming * Cleanup type definition styling * Update example text without a page refresh * Prevent closing the send/export confirm modal from messing up the ui and not allowing the user to see the current progress * Fix cancel getting stuck on true * Consolidate state changes * Support idle download timeout * Capitalize Failed to add cards error * Add separate variable for idleTimeout calculation * Remove redundant _cachedDictionaryEntryValue variable * Use tags option to populate tags * Include deck and tags when exporting to file * Use date down to seconds and zero pad * Remove unnecessary ternary * Limit 'path' finding function to only being able to search for 'path' * Rename _findPathsByKey to _findAllPaths
Diffstat (limited to 'docs/anki-integration.md')
-rw-r--r--docs/anki-integration.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/anki-integration.md b/docs/anki-integration.md
index 547a73c8..35ef6330 100644
--- a/docs/anki-integration.md
+++ b/docs/anki-integration.md
@@ -118,3 +118,38 @@ Below are some troubleshooting tips you can try if you are unable to create new
- If all of the buttons appear grayed out, then you should double-check your deck and model configuration settings.
- If no icons appear at all, make sure that Anki is running in the background and that [AnkiConnect](https://foosoft.net/projects/anki-connect) has been installed.
+
+### Anki Note Generation
+
+Using the `Generate Anki Notes (Experimental)...` feature in the settings page it is possible to easily generate and export large amounts of Anki cards.
+
+> [!WARNING]
+> This feature is experimental!
+
+First, get a newline separated list of terms. For example:
+
+```
+雪
+雨
+竜巻
+```
+
+Enter this list into the large text box in the `Anki Note Generator` popup window.
+
+Next, select either `Send to Anki` or `Export to File`.
+
+**Send to Anki:**
+
+`Send to Anki` will send all the terms to the active Anki deck using the active Anki model specified on the page. To change the active Anki deck or Anki model, edit them in the `Configure Anki card format...` setting.
+
+Make sure to confirm you are exporting to the correct deck and with the correct Anki model. After the notes are sent to Anki there is no way to automatically undo the changes.
+
+To include media in notes sent to Anki, make sure to enable the `Add media to notes` option. Media includes audio, images, and svgs. Exporting with media may take significantly longer than without it.
+
+To prevent duplicate notes being sent to Anki, enable the `Prevent sending duplicate notes` option. This will check for duplicate notes that already exist. The `Check for duplicates across all models` and `Duplicate card scope` settings are used to determine what is considered a duplicate card. **This does not remove duplicates in the term list.**
+
+**Export to File:**
+
+`Export to File` will export all the terms to an Anki deck file using the active Anki card format specified on the page and in Anki's `Notes in plain text (.txt)` format. After exporting completes you will be prompted to save the file. This file can later be imported into Anki.
+
+Media cannot be included when exporting in this format.