Awesome

Table of Contents

• Installing
• Features
• Usage
• Building from source
• Contributing
• Contributors

Installing

• Firefox Add-ons
• Chrome Web Store
• Edge Web Store
• App Store (Safari)
• Thunderbird

Features

• Pitch accent information

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/pitch-accent-cropped.png" alt="Screenshot showing pitch accent information" title="Pitch accent information" width="640">

• Support for non-English dictionaries

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/german-cropped.png" alt="Screenshot showing German translation" title="German translation" width="640">

• Dictionaries that update automatically twice a week by fetching just the updated entries

• Easy to read dictionary entries

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/word-display-cropped.png" alt="Screenshot showing how definitions are grouped by part-of-speech" title="Some of the features of word display" width="640">

• Automatic translation of Japanese-era years into Gregorian years (e.g. 昭和５６年、令和元年、平成三十一年)

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/year-translation-cropped.png" alt="Screenshot showing translation of 明治四十二年 into 1909年" title="Year translation" width="640">

• Automatic translation between 畳/帖 measurements and square meters (e.g. 四畳半、12.6 帖、25 平米、6m²)

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/jou-conversion-cropped.png" alt="Screenshot showing translation of 四畳半 into 7.29 square meters" title="Area translation" width="640">

• Recognition of a wide range of grammatical forms (e.g. irregular inflections of する-verbs like 罰せられる, irregular verbs like いらっしゃいます, continuous forms like 食べてた, ん as a negative form like 分からん、知らん, words with ー like じーちゃん、頑張ろー、そーゆー, ぬ verbs, とく・どく forms like 買っとく, causative passive, させる for verbs ending in す e.g. 起こさせる)

• Automatic preview of name entries when there is a better match in the name dictionary

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/name-dictionary-cross-ref-cropped.png" alt="Screenshot showing 小池百合子 being automatically looked up from the names dictionary" title="Name dictionary cross-reference" width="640">

• Handling of a wide range of characters including ㋕, ㌀, ㋿, 𠏹沢, ８月, Ｂ級グルメ, オーサカ

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/encircled-character-cropped.png" alt="Screenshot showing recognition of 弾道㋯㋚㋑㋸防衛 (弾道ミサイル防衛)" title="Encircled characters" width="640"> <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/kabushiki-gaisha-cropped.png" alt="Screenshot showing recognition of ㍿ (株式会社)" title="Composed characters" width="640">

• Localized into Japanese (so you can study Japanese while you study Japanese!) and Simplified Chinese

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/localized-cropped.png" alt="Screenshot showing various parts-of-speech and other information translated into Japanese" title="Localized popup" width="640">

• Prioritization of common matches

• Support for displaying romaji

• Copy feature that allows selecting which entry and in what format to copy to the clipboard

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/copy-feature-cropped.png" alt="Screenshot showing 河川敷 being selected and the various formats available for copying" title="Copy feature" width="640">

• Smart popup positioning

• Support for vertical text and text in SVG images

• Minimal memory usage

• Kanji data for Kanji kentei, Conning references, updated educational levels, heavily reworked kanji components etc.

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/kanji-view.png" alt="Screenshot of kanji view" title="Kanji dictionary" width="640">

• Intuitive settings window

  <img src="https://raw.githubusercontent.com/birchill/10ten-ja-reader/main/docs/options-window-cropped-more.png" alt="Screenshot of options window" title="Options window" width="401">

• Isolation of styles so that the popup always looks correct

• Handling of ruby text in YouTube

Usage

By default, you can enable the 10ten Japanese Reader by either:

• Pressing the toolbar button (you may need to add it to the browser toolbar yourself in some browsers)
• Pressing <kbd>Alt</kbd>+<kbd>R</kbd>
• Choosing to enable it from the context menu

Alternatively, a lot of users find it helpful to have the extension permanently enabled but configured to only show the pop-up when either <kbd>Alt</kbd> or <kbd>Ctrl</kbd> is pressed.

The other keys are as follows:

Building a release from source

You may also build the add-ons using a source package from the Releases page and running the following commands:

export RELEASE_BUILD=1
pnpm install
pnpm package:firefox
# Or `yarn package:firefox` for versions 0.20.0 and earlier
# Or `yarn package` for versions 0.5.8 and earlier

(Note that you may ignore the .js files associated with each release. These are published simply to provide a public URL for each version of the source files to associating stack traces from error reports.)

The above builds the package for Firefox. Use pnpm package:chrome to build the Chrome package, pnpm package:edge for Edge, pnpm package:safari for Safari, or pnpm package:thunderbird for Thunderbird.

Note: For versions prior to and including 0.5.5 pnpm install will try to install husky but fail so you will need to run pnpm install --ignore-scripts.

To build the latest trunk version please see CONTRIBUTING.md.

Contributing

Please see CONTRIBUTING.md.

Contributors

Thank you to everyone who has contributed including the following people (emoji key):

This project follows the all-contributors specification. Contributions are very welcome!