diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 12 insertions, 31 deletions
@@ -12,7 +12,7 @@ > > Since the owner requested forks be uniquely named, we have chosen a new name: _yomitan_. (_-tan_ is an honorific used for anthropomorphic moe characters.) While we've renamed the codebase and made judicious use of find-and-replace, it is entirely the hard work of foosoft and numerous other open source contributors from 2016-2023 and we do not claim any credit. > -> Since this is a distributed effort, we highly welcome new contributors! Feel free to browse the issue tracker, and you can find us on [TheMoeWay Discord](https://discord.gg/UGNPMDE7zC) at [#yomitan](https://discord.com/channels/617136488840429598/1081538711742844980) +> Since this is a distributed effort, we highly welcome new contributors! Feel free to browse the issue tracker, and you can find us on [TheMoeWay Discord](https://discord.gg/UGNPMDE7zC) at [#yomitan-development](https://discord.com/channels/617136488840429598/1081538711742844980) Yomitan turns your web browser into a tool for building Japanese language literacy by helping you to decipher texts which would be otherwise too difficult tackle. This extension is similar to @@ -96,12 +96,12 @@ Due to security concerns, an alternate implementation of Handlebars is being use This revealed a bug in four of Yomitan's template helpers, which have now been fixed in the default templates. If your custom templates use the following helpers, please ensure their use matches the corrected forms. -Helper | Example | Corrected --------|---------|---------- -`formatGlossary` | `{{#formatGlossary ../dictionary}}{{{.}}}{{/formatGlossary}}` | `{{formatGlossary ../dictionary .}}` -`furigana` | `{{#furigana}}{{{definition}}}{{/furigana}}` | `{{furigana definition}}` -`furiganaPlain` | `{{~#furiganaPlain}}{{{.}}}{{/furiganaPlain~}}` | `{{~furiganaPlain .~}}` -`dumpObject` | `{{#dumpObject}}{{{.}}}{{/dumpObject}}` | `{{dumpObject .}}` +| Helper | Example | Corrected | +| ---------------- | ------------------------------------------------------------- | ------------------------------------ | +| `formatGlossary` | `{{#formatGlossary ../dictionary}}{{{.}}}{{/formatGlossary}}` | `{{formatGlossary ../dictionary .}}` | +| `furigana` | `{{#furigana}}{{{definition}}}{{/furigana}}` | `{{furigana definition}}` | +| `furiganaPlain` | `{{~#furiganaPlain}}{{{.}}}{{/furiganaPlain~}}` | `{{~furiganaPlain .~}}` | +| `dumpObject` | `{{#dumpObject}}{{{.}}}{{/dumpObject}}` | `{{dumpObject .}}` | Authors of custom templates may be interested to know that other helpers previously used and documented in the block form (e.g. `{{#set "key" "value"}}{{/set}}`), while not broken by this change, may also be replaced with the less verbose @@ -114,32 +114,13 @@ different languages. You must download and import the dictionaries you wish to u 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 the non-English dictionaries contain fewer entries than their English counterparts. Even if your primary +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. -- **[JMdict](https://www.edrdg.org/jmdict/edict_doc.html)** (Japanese vocabulary) - - [jmdict_dutch.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmdict_dutch.zip) - - [jmdict_english.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmdict_english.zip) - - [jmdict_french.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmdict_french.zip) - - [jmdict_german.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmdict_german.zip) - - [jmdict_hungarian.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmdict_hungarian.zip) - - [jmdict_russian.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmdict_russian.zip) - - [jmdict_slovenian.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmdict_slovenian.zip) - - [jmdict_spanish.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmdict_spanish.zip) - - [jmdict_swedish.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmdict_swedish.zip) -- **[JMnedict](https://www.edrdg.org/enamdict/enamdict_doc.html)** (Japanese names) - - [jmnedict.zip](https://github.com/themoeway/yomitan/raw/dictionaries/jmnedict.zip) -- **KireiCake (upstream project dead)** (Japanese slang) - - [kireicake.zip](https://github.com/themoeway/yomitan/raw/dictionaries/kireicake.zip) -- **[KANJIDIC](http://nihongo.monash.edu/kanjidic2/index.html)** (Japanese kanji) - - [kanjidic_english.zip](https://github.com/themoeway/yomitan/raw/dictionaries/kanjidic_english.zip) - - [kanjidic_french.zip](https://github.com/themoeway/yomitan/raw/dictionaries/kanjidic_french.zip) - - [kanjidic_portuguese.zip](https://github.com/themoeway/yomitan/raw/dictionaries/kanjidic_portuguese.zip) - - [kanjidic_spanish.zip](https://github.com/themoeway/yomitan/raw/dictionaries/kanjidic_spanish.zip) -- **[Innocent Corpus](https://web.archive.org/web/20190309073023/https://forum.koohii.com/thread-9459.html#pid168613)** (Term and kanji frequencies across 5000+ novels) - - [innocent_corpus.zip](https://github.com/themoeway/yomitan/raw/dictionaries/innocent_corpus.zip) -- **[Kanjium](https://github.com/mifunetoshiro/kanjium)** (Pitch dictionary, see [related project page](https://github.com/toasted-nutbread/yomichan-pitch-accent-dictionary) for details) - - [kanjium_pitch_accents.zip](https://github.com/themoeway/yomitan/raw/dictionaries/kanjium_pitch_accents.zip) +- [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. ## Basic Usage |