summaryrefslogtreecommitdiff
path: root/docs/dictionaries.md
diff options
context:
space:
mode:
authorPierce James Morris <17671699+piercemorris@users.noreply.github.com>2024-01-14 02:16:39 +0000
committerGitHub <noreply@github.com>2024-01-14 02:16:39 +0000
commit326c5335503d45daafe73daac88ae330c6bace77 (patch)
tree4b72fb68bd94fb703fec0bc6ec09dbebdb24264d /docs/dictionaries.md
parent273c2f22603abe563435a0f1d7a84c0d9037fe2c (diff)
Reworked README & supplimenting docs (#512)
* initial revision of updated README * fix broken links in doc files * descriptive links, typos, anki emphasis * add missing punctuation * add new lines and capitalise letters * move contributing section up
Diffstat (limited to 'docs/dictionaries.md')
-rw-r--r--docs/dictionaries.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/dictionaries.md b/docs/dictionaries.md
new file mode 100644
index 00000000..73307c37
--- /dev/null
+++ b/docs/dictionaries.md
@@ -0,0 +1,51 @@
+## Dictionaries
+
+There are several free Japanese dictionaries available for Yomitan, with two of them having glossaries available in
+different languages. You must download and import the dictionaries you wish to use in order to enable Yomitan
+definition lookups. If you have proprietary EPWING dictionaries that you would like to use, check the [Yomitan
+Import](https://github.com/themoeway/yomitan-import) page to learn how to convert and import them into Yomitan.
+
+Be aware that non-English dictionaries contain fewer entries than their English counterparts. Even if your primary
+language is not English, you may consider also importing the English version for better coverage.
+
+- [Jitendex](https://github.com/stephenmk/Jitendex) - Jitendex is an improved version of JMdict for Yomitan. It features better formatting and some other improvements, and is actively being improved by its author.
+- [JMdict](https://github.com/themoeway/jmdict-yomitan#jmdict-for-yomitan-1) - There are daily automatically updated builds of JMdict for Yomitan available in this repository. It is available in multiple languages and formats, but we recommend installing the more modern Jitendex for English users.
+- [JMnedict](https://github.com/themoeway/jmdict-yomitan#jmnedict-for-yomitan) - JMnedict is a dictionary that lists readings of person/place/organization names and other proper nouns.
+- [KANJIDIC](https://github.com/themoeway/jmdict-yomitan#kanjidic-for-yomitan) - KANJIDIC is an English dictionary listing readings, meanings, and other info about kanji characters.
+
+### Importing Dictionaries
+
+Yomitan also supports exporting and importing your entire collection of dictionaries.
+
+#### Importing a Dictionary Collection
+
+- Go to Yomitan's settings page (click on the extension's icon then click on the cog icon from the popup)
+- Click `Import Dictionary Collection` and select the database file you want to import
+- Wait for the import to finish then turn all the dictionaries back on from the `Dictionaries > Configure installed and enabled dictionaries` section
+- Refresh the browser tab to see the dictionaries in effect
+
+#### Exporting the Dictionary Collection
+
+- Click `Export Dictionary Collection` from the backup section of Yomitan's settings page
+- It will show you a progress report as it exports the data then initiates a
+ download for a file named something like `yomitan-dictionaries-YYYY-MM-DD-HH-mm-ss.json`
+ (e.g. `yomitan-dictionaries-2023-07-05-02-42-04.json`)
+
+### Importing and Exporting Personal Configuration
+
+Note that you can also similarly export and import your Yomitan settings from the `Backup` section of the Settings page.
+
+You should be able to replicate your exact Yomitan setup across devices by exporting your settings and dictionary collection from the source device then importing those from the destination.
+
+## Custom Dictionaries
+
+Yomitan supports the use of custom dictionaries, including the esoteric but popular
+[EPWING](https://ja.wikipedia.org/wiki/EPWING) format. They were often utilized in portable electronic dictionaries
+similar to the ones pictured below. These dictionaries are often sought after by language learners for their correctness
+and excellent coverage of the Japanese language.
+
+Unfortunately, as most of the dictionaries released in this format are proprietary, they are unable to be bundled with
+Yomitan. Instead, you will need to procure these dictionaries yourself and import them using [Yomitan
+Import](https://github.com/themoeway/yomitan-import). Check the project page for additional details.
+
+![Pocket EPWING dictionaries](../img/epwing-devices.jpg)