Skip to content

Commit

Permalink
Remove redundant info that is now published on jitendex.org
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenmk committed Feb 17, 2024
1 parent bbc4220 commit 88486c6
Show file tree
Hide file tree
Showing 26 changed files with 2 additions and 41,905 deletions.
3 changes: 0 additions & 3 deletions HOW_TO_INSTALL.md

This file was deleted.

156 changes: 2 additions & 154 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,158 +2,6 @@

Jitendex is a free, offline, and openly licensed Japanese-to-English dictionary. Updated versions with new content are published every week.

# Installation
See the instructions provided with [the latest release](https://github.com/stephenmk/Jitendex/releases/latest).
Visit [jitendex.org](https://jitendex.org/) to learn more and to download the dictionary.

# Design and Features
The following examples provide a quick overview of the design and features of Jitendex.

## Example 1: Entry Layout
The design goal of Jitendex is to allow readers to retrieve
all of the important information from an entry at a glance.

Compare Jitendex with the reigning champ of free Japanese dictionaries, [Jisho.org](https://jisho.org/).

<table>
<tr>
<th>Jitendex (viewed in GoldenDict-ng)</th>
<th>Jisho.org</th>
</tr>
<tr>
<td><img alt='Screenshot of the Jitendex entry for ばね in GodlenDict-ng' src='https://github.com/stephenmk/Jitendex/raw/main/img/bane_jitendex.webp'/></td>
<td><img alt='Screenshot of the Jisho.org entry for ばね' src='https://github.com/stephenmk/Jitendex/raw/main/img/bane_jisho.webp'/></td>
</tr>
<tr>
<td colspan="2"><br>Jitendex replaces lengthy explanations with short tags. The full explanation text is accessible by hovering over these tags.</td>
</tr>
<tr>
<td align='center'><img alt='Screenshot of the first sense of the Jitendex entry for ばね in GodlenDict-ng' src='https://github.com/stephenmk/Jitendex/raw/main/img/bane_jitendex_1.webp'/></td>
<td><img alt='Screenshot of the first sense of the Jisho.org entry for ばね' src='https://github.com/stephenmk/Jitendex/raw/main/img/bane_jisho_1.webp'/></td>
</tr>
<tr>
<td colspan="2"><br>Repetition is reduced by combining sections with identical metadata tags into a single group.</td>
</tr>
<tr>
<td align='center'><img alt='Screenshot of the second and third senses of the Jitendex entry for ばね in GodlenDict-ng' src='https://github.com/stephenmk/Jitendex/raw/main/img/bane_jitendex_2.webp'/></td>
<td><img alt='Screenshot of the second and third senses of the Jisho.org entry for ばね' src='https://github.com/stephenmk/Jitendex/raw/main/img/bane_jisho_2.webp'/></td>
</tr>
<td colspan="2"><br>Variant kanji forms and readings in Jitendex are displayed in a tidy table.</td>
</tr>
<tr>
<td align='center'><img alt='Screenshot of the variant forms table in the Jitendex entry for ばね in GodlenDict-ng' src='https://github.com/stephenmk/Jitendex/raw/main/img/bane_jitendex_3.webp'/></td>
<td><img alt='Screenshot of the "Other Forms" and "Notes" sections of the Jisho.org entry for ばね' src='https://github.com/stephenmk/Jitendex/raw/main/img/bane_jisho_3.webp'/></td>
</tr>
</table>

## Example 2: Pronunciation audio
The MDict version of Jitendex contains high-quality audio clips produced by native Japanese speakers in roughly 8,230 entries.
About 930 of those entries contain multiple clips from different speakers (male and female).
Most of these audio clips are also accompanied by [pitch accent](https://en.wikipedia.org/wiki/Japanese_pitch_accent) information.

<table>
<tr><th colspan="2">Jitendex (viewed in GoldenDict-ng)</th></tr>
<tr>
<td><img alt="Screenshot of the entry for 弁護士 in Jitendex featuring example audio and pitch accent information" src="https://github.com/stephenmk/Jitendex/raw/main/img/bengoshi_jitendex.webp"/></td>
<td><img alt="Screenshot of the entry for 美容院 in Jitendex featuring two example audio clips and pitch accent information" src="https://github.com/stephenmk/Jitendex/raw/main/img/biyouin_jitendex.webp"/></td>
</tr>
</table>

## Example 3: Missing Information
Compare Jitendex with the original version of [JMdict for Yomichan](https://foosoft.net/projects/yomichan/index.html#dictionaries).

Jitendex (viewed in Yomitan) | JMdict for Yomichan
:--: | :--:
![Screenshot of the Jitendex entry for ケーワイ【KY】 in Yomitan](https://github.com/stephenmk/Jitendex/raw/main/img/ky_jitendex.webp) | ![Screenshot of FooSoft's 'JMdict' entry for ケーワイ【KY】 in Yomitan](https://github.com/stephenmk/Jitendex/raw/main/img/ky_jmdict.webp)

The original version is missing a variety of supplemental information from the EDRDG's [JMdict database](https://www.edrdg.org/wiki/index.php/JMdict-EDICT_Dictionary_Project).
This information has all been implemented in Jitendex.

* Example sentences
* Usage notes
* Etymology notes
* Cross references
* Antonyms
* Language of origin information
* Definition notes (such as "*Figuratively*", *"Literally"*, etc.)

## Example 4: Multiple Search Results
I previously
[designed](https://github.com/FooSoft/yomichan/issues/2111)
[and](https://github.com/FooSoft/yomichan/issues/2183)
[also](https://github.com/FooSoft/yomichan-import/pull/40)
[developed](https://github.com/FooSoft/yomichan-import/pull/41)
new versions of JMdict/JMnedict dictionaries for Yomichan which addressed
[the](https://github.com/FooSoft/yomichan/issues/1165)
[many](https://github.com/FooSoft/yomichan/issues/1716#issuecomment-1214436766)
[long](https://github.com/FooSoft/yomichan/issues/2057)-[standing](https://github.com/FooSoft/yomichan/issues/2058)
[issues](https://github.com/FooSoft/yomichan/issues/2210)
with the original version displayed in Example 3 above. This new version was
sometimes referred to as "JMdict Extra" in order to distinguish it from
the original version. Jitendex is a continuation of that project with support
for more app formats, more ambitious goals, and more design improvements.

Compare the search results for けいそつ from Jitendex and
my previous version of JMdict for Yomichan.

Jitendex (viewed in Yomitan) | stephenmk's "JMdict Extra"
:--: | :--:
![Screenshot of the Jitendex entries for けいそつ in Yomitan](https://github.com/stephenmk/Jitendex/raw/main/img/keisotsu_jitendex.webp) | ![Screenshot of the 'JMDict Extra' entries for けいそつ in Yomitan](https://github.com/stephenmk/Jitendex/raw/main/img/keisotsu_jmdict.webp)

In Jitendex, you can clearly tell that the 軽卒 form (the bottom
search result) is found in two different entries. In the first
entry it refers to a type of soldier, and in the second entry it is
a rare spelling of 軽率 (the top search result).

## Other miscellaneous examples
<details>
<summary>Entry for 猫の手も借りたい in GoldenDict-ng</summary>

![Screenshot of the Jitendex entry for 猫の手も借りたい in GoldenDict-ng](https://github.com/stephenmk/Jitendex/raw/main/img/nekonote_jitendex.webp)
</details>

<details>
<summary>Entry for ばね in Yomitan (compact glossary mode disabled; dark mode)</summary>

![Screenshot of the Jitendex entry for ばね in Yomitan](https://github.com/stephenmk/Jitendex/raw/main/img/bane_yomitan.webp)
</details>

<details>
<summary>Entry for 頂く in Yomitan (compact glossary mode enabled; light mode)</summary>

![Screenshot of the Jitendex entry for 頂く in Yomitan](https://github.com/stephenmk/Jitendex/raw/main/img/itadaku_yomitan.webp)
</details>

<details>
<summary>Entry for 現在 in Yomitan (compact glossary mode disabled; dark mode)</summary>

![Screenshot of the Jitendex entry for 現在 in Yomitan](https://github.com/stephenmk/Jitendex/raw/main/img/genzai_yomitan.webp)
</details>

<details>
<summary>Entry for 素姓 in Yomitan (compact glossary mode enabled; dark mode)</summary>

![Screenshot of the Jitendex entry for 素姓 in Yomitan](https://github.com/stephenmk/Jitendex/raw/main/img/sujou_yomitan.webp)
</details>

# Feedback
If you see any errors or incorrect information in the dictionary
data, please feel free to report them in the
[GitHub discussions forum](https://github.com/stephenmk/Jitendex/discussions).

> [!TIP]
> You can customize the appearance of Jitendex. Example customizations are provided in the [GitHub wiki](https://github.com/stephenmk/Jitendex/wiki/Custom-Styles-in-Yomitan).
# Legal
© CC BY-SA 4.0 Stephen Kraus 2023-2024

You are free to use, modify, and redistribute Jitendex files under the terms of the [Creative Commons Attribution-ShareAlike License (V4.0)](https://creativecommons.org/licenses/by-sa/4.0/).

Jitendex includes material from several copyrighted sources in compliance with the terms and conditions of those projects.
* JMdict (EDICT, etc.) dictionary data is provided by the Electronic Dictionaries Research Group. Visit [edrdg.org](https://www.edrdg.org/) for more information.
* Example sentences (Japanese and English) are provided by [Tatoeba](https://tatoeba.org/en/downloads). This data is licensed [CC BY 2.0 FR](https://creativecommons.org/licenses/by/2.0/fr/).
* Example pronunciation audio is provided by the [Kanji alive](https://github.com/kanjialive/kanji-data-media) project under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).
* Positional information for the furigana displayed in headwords is provided by the [JmdictFurigana project](https://github.com/Doublevil/JmdictFurigana). This data is distributed under a Creative Commons Attribution-ShareAlike License.


# Version History
See [VERSION_HISTORY.md](VERSION_HISTORY.md).
The purpose of this GitHub repository is to track issues, to provide a discussion forum, and to host new uploads of dictionary files.
19 changes: 0 additions & 19 deletions VERSION_HISTORY.md

This file was deleted.

19 changes: 0 additions & 19 deletions img/.gitattributes

This file was deleted.

3 changes: 0 additions & 3 deletions img/bane_jisho.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/bane_jisho_1.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/bane_jisho_2.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/bane_jisho_3.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/bane_jitendex.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/bane_jitendex_1.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/bane_jitendex_2.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/bane_jitendex_3.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/bane_yomitan.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/bengoshi_jitendex.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/biyouin_jitendex.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/genzai_yomitan.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/itadaku_yomitan.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/keisotsu_jitendex.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/keisotsu_jmdict.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/ky_jitendex.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/ky_jmdict.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/nekonote_jitendex.webp

This file was deleted.

3 changes: 0 additions & 3 deletions img/sujou_yomitan.webp

This file was deleted.

0 comments on commit 88486c6

Please sign in to comment.