diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/anki-integration.md | 2 | ||||
| -rw-r--r-- | docs/audio.md | 9 | ||||
| -rw-r--r-- | docs/dictionaries.md | 45 | ||||
| -rw-r--r-- | docs/faq.md | 10 |
4 files changed, 33 insertions, 33 deletions
diff --git a/docs/anki-integration.md b/docs/anki-integration.md index 9bd5bd94..37c7faf8 100644 --- a/docs/anki-integration.md +++ b/docs/anki-integration.md @@ -25,7 +25,7 @@ Flashcard fields can be configured with the following steps: | Marker | Description | | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | `{audio}` | Audio sample of a native speaker's pronunciation in MP3 format (if available). | + | `{audio}` | Audio of the term's pronunciation from one of the audio sources (if available). | | `{clipboard-image}` | An image which is stored in the system clipboard, if present. | | `{clipboard-text}` | Text which is stored in the system clipboard, if present. | | `{cloze-body}` | Raw, inflected term as it appeared before being reduced to dictionary form by Yomitan. | diff --git a/docs/audio.md b/docs/audio.md new file mode 100644 index 00000000..531b6688 --- /dev/null +++ b/docs/audio.md @@ -0,0 +1,9 @@ +### Audio Configuration + +Audio playback of terms' pronunciation can be configured in the `Audio` section of the _Settings_ page. + +For Japanese terms, Yomitan provides a preconfigured audio source. More audio sources can be added in `Audio` > `Configure audio playback sources`. They will be checked for pronunciations in the order they are listed. + +For other languages, the [Yomichan Forvo Server](https://ankiweb.net/shared/info/580654285) Anki add-on is one way to get pronunciation audio. After installing it, add a `Custom URL (JSON)` audio source with the URL `http://localhost:8770?term={term}&reading={reading}&language=en` (replace `en` with the desired language's ISO code). + +With at least one working audio source in place, you can click on the <img src="../ext/images/play-audio.svg" alt="" width="16" height="16"> _speaker_ button to hear the term's pronunciation. When searching for audio, the sources are checked in order until the first valid source is found. Right-clicking the <img src="../ext/images/play-audio.svg" alt="" width="16" height="16"> _speaker_ button allows choosing the source manually. If no audio is found, you will hear a short click instead. diff --git a/docs/dictionaries.md b/docs/dictionaries.md index 73307c37..df62435f 100644 --- a/docs/dictionaries.md +++ b/docs/dictionaries.md @@ -1,19 +1,31 @@ ## 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. +You must download and import the dictionaries you wish to use in order to enable Yomitan definition lookups. There are several free dictionaries available for Yomitan, some of them with glossaries available in different languages. -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. +Be aware that non-English dictionaries generally 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. +### Recommended Dictionaries + +#### Japanese + +- [Jitendex](https://github.com/stephenmk/Jitendex) - 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. +- [JMnedict](https://github.com/themoeway/jmdict-yomitan#jmnedict-for-yomitan) - Lists readings of person/place/organization names and other proper nouns. +- [KANJIDIC](https://github.com/themoeway/jmdict-yomitan#kanjidic-for-yomitan) - An English dictionary listing readings, meanings, and other info about kanji characters. + +#### Other Languages + +- [KTY](https://github.com/themoeway/kaikki-to-yomitan) - Wiktionaries in various languages converted to Yomitan format. + +#### EPWING Dictionaries + +Yomitan supports dictionaries in 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, 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. -### Importing Dictionaries + + +### Bulk Importing Dictionaries Yomitan also supports exporting and importing your entire collection of dictionaries. @@ -36,16 +48,3 @@ Yomitan also supports exporting and importing your entire collection of dictiona 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. - - diff --git a/docs/faq.md b/docs/faq.md index a972b0b9..2cd18301 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -28,7 +28,7 @@ one of the following solutions should work for you: **Will you add support for online dictionaries?** Online dictionaries will not be implemented because it is not possible to support them in a robust way. In order to -perform Japanese deinflection, Yomitan must execute dozens of database queries for every single word. Factoring in +perform deinflection, Yomitan must execute dozens of database queries for every single word. Factoring in network latency and the fragility of web scraping, it would not be possible to maintain a good and consistent user experience. @@ -48,11 +48,3 @@ the same as the time it originally took to import, which can be significant for The vast majority of EPWING dictionaries are proprietary, so they are unfortunately not able to be included in this extension due to copyright reasons. - -**When are you going to add support for $MYLANGUAGE?** - -Developing Yomitan 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 Yomitan's focus to remain Japanese-centric. |